From 559c7c6ab9db30496c44a028869f47cac475e64d Mon Sep 17 00:00:00 2001 From: Roman Langolf Date: Sat, 30 May 2026 12:41:29 +0700 Subject: [PATCH 1/2] fix forward reference compile error --- build.sbt | 4 +- .../core/shared/src/main/scala/codegen.scala | 35 +- .../src/main/resources/aiplatform_v1.json | 95944 +++++++++------- 3 files changed, 51416 insertions(+), 44567 deletions(-) diff --git a/build.sbt b/build.sbt index 5f3dc24..3427c82 100644 --- a/build.sbt +++ b/build.sbt @@ -2,7 +2,7 @@ ThisBuild / description := "Google Cloud client code generator" ThisBuild / organization := "dev.rolang" ThisBuild / licenses := Seq(License.MIT) ThisBuild / homepage := Some(url("https://github.com/rolang/google-rest-api-codegen")) -ThisBuild / scalaVersion := "3.8.2" +ThisBuild / scalaVersion := "3.8.3" ThisBuild / version ~= { v => if (v.contains('+')) s"${v.replace('+', '-')}-SNAPSHOT" else v } ThisBuild / versionScheme := Some("early-semver") ThisBuild / scmInfo := Some( @@ -46,7 +46,7 @@ val zioVersion = "2.1.23" val zioJsonVersion = "0.8.0" -val jsoniterVersion = "2.38.8" +val jsoniterVersion = "2.38.12" val munitVersion = "1.2.1" diff --git a/modules/core/shared/src/main/scala/codegen.scala b/modules/core/shared/src/main/scala/codegen.scala index 3451fad..f37be98 100644 --- a/modules/core/shared/src/main/scala/codegen.scala +++ b/modules/core/shared/src/main/scala/codegen.scala @@ -80,8 +80,7 @@ def generateBySpec( val resourcesPath = config.outDir / resourcesSplit val schemasPath = config.outDir / schemasPkg.split('.') val commonCodecsObj = "codecs" - val commonCodecsPkg = s"$schemasPkg.$commonCodecsObj" - val commonCodecsPath = schemasPath / s"$commonCodecsObj.scala" + val commonCodecsPkg = s"${config.outPkg}.$commonCodecsObj" for { _ <- Future { @@ -143,7 +142,26 @@ def generateBySpec( Some(e.description) )} case `${e.location}$locationPostfix` extends Endpoint("${e.location}", uri"${e.endpointUrl}")""".stripMargin ) - .mkString("\n") + .mkString("\n"), + "", + config.jsonCodec match + case _: JsonCodec.Jsoniter => + s"""|object $commonCodecsObj: + | import com.github.plokhotnyuk.jsoniter_scala.core.JsonValueCodec + | import com.github.plokhotnyuk.jsoniter_scala.macros.JsonCodecMaker + | + |""".stripMargin + ( + config.arrayType match + case gcp.codegen.GeneratorConfig.ArrayType.List => + " given JsonValueCodec[List[String]] = JsonCodecMaker.make" + case gcp.codegen.GeneratorConfig.ArrayType.Vector => + " given JsonValueCodec[Vector[String]] = JsonCodecMaker.make" + case gcp.codegen.GeneratorConfig.ArrayType.Array => + " given JsonValueCodec[Array[String]] = JsonCodecMaker.make" + case ArrayType.ZioChunk => + " given JsonValueCodec[zio.Chunk[String]] = JsonCodecMaker.make" + ) + case _ => "" ).mkString("\n") ) List(path.toFile()) @@ -236,7 +254,8 @@ def generateBySpec( pkg = schemasPkg, jsonCodec = config.jsonCodec, hasProps = p => specs.hasProps(p), - arrType = config.arrayType + arrType = config.arrayType, + commonCodecsPkg = commonCodecsPkg ) else // create a type alias for objects without properties @@ -404,7 +423,8 @@ def schemasCode( pkg: String, jsonCodec: JsonCodec, hasProps: SchemaPath => Boolean, - arrType: ArrayType + arrType: ArrayType, + commonCodecsPkg: String ): String = { def enums = schema.properties.collect: @@ -463,8 +483,9 @@ def schemasCode( jsonCodec match { case JsonCodec.ZioJson => "import zio.json.*" case _: JsonCodec.Jsoniter => - """|import com.github.plokhotnyuk.jsoniter_scala.core.* - |import com.github.plokhotnyuk.jsoniter_scala.macros.*""".stripMargin + s"""|import com.github.plokhotnyuk.jsoniter_scala.core.* + |import com.github.plokhotnyuk.jsoniter_scala.macros.* + |import ${commonCodecsPkg}.given""".stripMargin }, toSchemaClass(schema) ).mkString("\n") diff --git a/modules/test-resources/src/main/resources/aiplatform_v1.json b/modules/test-resources/src/main/resources/aiplatform_v1.json index b1d4bc3..88a963d 100644 --- a/modules/test-resources/src/main/resources/aiplatform_v1.json +++ b/modules/test-resources/src/main/resources/aiplatform_v1.json @@ -1,1437 +1,2034 @@ { - "description": "Train high-quality custom machine learning models with minimal machine learning expertise and effort.", + "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" + } + } + } + }, + "basePath": "", + "baseUrl": "https://aiplatform.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Aiplatform", + "description": "Build, scale, govern, and optimize sophisticated agents and models.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/vertex-ai/", + "endpoints": [ + { + "description": "Locational Endpoint", + "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://asia-south2-aiplatform.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-north2-aiplatform.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west10-aiplatform.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west15-aiplatform.googleapis.com/", + "location": "europe-west15" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://me-central1-aiplatform.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://me-central2-aiplatform.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-east7-aiplatform.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Locational Endpoint", + "endpointUrl": "https://us-west8-aiplatform.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://aiplatform.us.rep.googleapis.com/", + "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://aiplatform.eu.rep.googleapis.com/", + "location": "eu" + } + ], + "fullyEncodeReservedExpansion": true, + "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:v1", "kind": "discovery#restDescription", "mtlsRootUrl": "https://aiplatform.mtls.googleapis.com/", + "name": "aiplatform", "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", "resources": { - "operations": { + "batchPredictionJobs": { "methods": { - "list": { - "id": "aiplatform.operations.list", - "path": "v1/operations", - "flatPath": "v1/operations", - "httpMethod": "GET", + "create": { + "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", + "flatPath": "v1/batchPredictionJobs", + "httpMethod": "POST", + "id": "aiplatform.batchPredictionJobs.create", + "parameterOrder": [], "parameters": { - "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": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token.", + "parent": { + "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [], + "path": "v1/batchPredictionJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" }, "scopes": [ "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": { - "id": "aiplatform.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/operations/{operationsId}", + "description": "Gets a BatchPredictionJob", + "flatPath": "v1/batchPredictionJobs/{batchPredictionJobsId}", "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.batchPredictionJobs.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^operations/[^/]+$", + "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", "location": "path", + "pattern": "^batchPredictionJobs/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/operations/{operationsId}:cancel", - "httpMethod": "POST", + "list": { + "description": "Lists BatchPredictionJobs in a Location.", + "flatPath": "v1/batchPredictionJobs", + "httpMethod": "GET", + "id": "aiplatform.batchPredictionJobs.list", + "parameterOrder": [], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^operations/[^/]+$", - "location": "path", - "required": true, + "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 `=`, `!=`,`<`, `<=`,`>`, `>=` 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>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^operations/[^/]+$", - "location": "path", - "required": true, + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", + "location": "query", "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.", + "parent": { + "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/batchPredictionJobs", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse" }, "scopes": [ "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." + ] } } }, - "deploymentResourcePools": { + "customJobs": { "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.deploymentResourcePools.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/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`.", + "flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.customJobs.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^deploymentResourcePools/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.deploymentResourcePools.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/customJobs/{customJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.customJobs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.deploymentResourcePools.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", - "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.", + "flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.customJobs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.deploymentResourcePools.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/customJobs/{customJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.customJobs.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^customJobs/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.deploymentResourcePools.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/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.", + "flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.customJobs.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "featurestores": { + "dataLabelingJobs": { "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.featurestores.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/featurestores/{featurestoresId}/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`.", + "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.dataLabelingJobs.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^featurestores/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.featurestores.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.dataLabelingJobs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^featurestores/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.featurestores.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}", - "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.", + "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.dataLabelingJobs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^featurestores/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.featurestores.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.dataLabelingJobs.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^featurestores/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^dataLabelingJobs/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.featurestores.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/featurestores/{featurestoresId}/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.", + "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.dataLabelingJobs.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^featurestores/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } + } + } + }, + "datasets": { + "methods": { + "create": { + "description": "Creates a Dataset.", + "flatPath": "v1/datasets", + "httpMethod": "POST", + "id": "aiplatform.datasets.create", + "parameterOrder": [], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + } + }, + "path": "v1/datasets", + "request": { + "$ref": "GoogleCloudAiplatformV1Dataset" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "entityTypes": { + "delete": { + "description": "Deletes a Dataset.", + "flatPath": "v1/datasets/{datasetsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Dataset.", + "flatPath": "v1/datasets/{datasetsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource.", + "location": "path", + "pattern": "^datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Datasets in a Location.", + "flatPath": "v1/datasets", + "httpMethod": "GET", + "id": "aiplatform.datasets.list", + "parameterOrder": [], + "parameters": { + "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" + }, + "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: * `display_name` * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/datasets", + "response": { + "$ref": "GoogleCloudAiplatformV1ListDatasetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a Dataset.", + "flatPath": "v1/datasets/{datasetsId}", + "httpMethod": "PATCH", + "id": "aiplatform.datasets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^datasets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Dataset" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "annotationSpecs": { "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.featurestores.entityTypes.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/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`.", + "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.annotationSpecs.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^featurestores/[^/]+/entityTypes/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.featurestores.entityTypes.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.annotationSpecs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.featurestores.entityTypes.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", - "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.", + "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.annotationSpecs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.featurestores.entityTypes.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.annotationSpecs.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.featurestores.entityTypes.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/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.", + "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.datasets.annotationSpecs.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } - }, - "features": { + } + } + }, + "dataItems": { + "resources": { + "annotations": { "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.featurestores.entityTypes.features.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/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`.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.annotations.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.featurestores.entityTypes.features.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.dataItems.annotations.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.featurestores.entityTypes.features.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", - "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.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.annotations.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.featurestores.entityTypes.features.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.annotations.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.featurestores.entityTypes.features.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/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.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.annotations.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } - } - } - } - } - }, - "customJobs": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.customJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/customJobs/{customJobsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^customJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" + }, + "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`.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" + "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": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.dataItems.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" + "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": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" + "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": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, + } + } + } + }, + "datasetVersions": { + "methods": { + "create": { + "description": "Create a version from a Dataset.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions", + "httpMethod": "POST", + "id": "aiplatform.datasets.datasetVersions.create", "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "parent" ], - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." - }, - "get": { - "id": "aiplatform.customJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^customJobs/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path", + "pattern": "^datasets/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/datasetVersions", + "request": { + "$ref": "GoogleCloudAiplatformV1DatasetVersion" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.customJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}", + "description": "Deletes a Dataset version.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^customJobs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.datasets.datasetVersions.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`." - }, - "cancel": { - "id": "aiplatform.customJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^customJobs/[^/]+/operations/[^/]+$", + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", + "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.customJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "get": { + "description": "Gets a Dataset version.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.datasetVersions.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^customJobs/[^/]+/operations/[^/]+$", + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", + "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "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.", + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "scopes": [ "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." - } - } - } - } - }, - "dataLabelingJobs": { - "resources": { - "operations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.dataLabelingJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations", + "description": "Lists DatasetVersions in a Dataset.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions", "httpMethod": "GET", + "id": "aiplatform.datasets.datasetVersions.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^dataLabelingJobs/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", "type": "string" }, - "filter": { - "description": "The standard list filter.", + "orderBy": { + "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", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. 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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "parent": { + "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "boolean" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/datasetVersions", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse" }, "scopes": [ "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": { - "id": "aiplatform.dataLabelingJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", - "httpMethod": "GET", + "patch": { + "description": "Updates a DatasetVersion.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.datasets.datasetVersions.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", + "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", + "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" + }, + "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", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1DatasetVersion" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "scopes": [ "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": { - "id": "aiplatform.dataLabelingJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", + "restore": { + "description": "Restores a dataset version.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", + "httpMethod": "GET", + "id": "aiplatform.datasets.datasetVersions.restore", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", + "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", + "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:restore", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." - }, + ] + } + } + }, + "operations": { + "methods": { "cancel": { - "id": "aiplatform.dataLabelingJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/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`.", + "flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}:cancel", "httpMethod": "POST", + "id": "aiplatform.datasets.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", - "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^datasets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.dataLabelingJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, + "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": "v1/datasets/{datasetsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.operations.delete", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - } - } - }, - "hyperparameterTuningJobs": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.hyperparameterTuningJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^hyperparameterTuningJobs/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^datasets/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.hyperparameterTuningJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/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.", + "flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}", "httpMethod": "GET", + "id": "aiplatform.datasets.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource.", - "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^datasets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.hyperparameterTuningJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.operations.list", "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`." - }, - "cancel": { - "id": "aiplatform.hyperparameterTuningJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^datasets/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.hyperparameterTuningJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/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.", + "flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.datasets.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^datasets/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] + } + } + }, + "savedQueries": { + "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`.", + "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.savedQueries.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.savedQueries.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.savedQueries.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.savedQueries.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.datasets.savedQueries.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } } }, - "tuningJobs": { + "deploymentResourcePools": { "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.tuningJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/tuningJobs/{tuningJobsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^tuningJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, + "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": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.deploymentResourcePools.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.tuningJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/tuningJobs/{tuningJobsId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.tuningJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/tuningJobs/{tuningJobsId}/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`.", + "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.deploymentResourcePools.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.tuningJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "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": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.deploymentResourcePools.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." - } - } - } - } - }, - "indexes": { - "resources": { - "operations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.indexes.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/indexes/{indexesId}/operations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations", "httpMethod": "GET", + "id": "aiplatform.deploymentResourcePools.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^indexes/[^/]+$", "location": "path", + "pattern": "^deploymentResourcePools/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -1439,319 +2036,395 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.indexes.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/indexes/{indexesId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^indexes/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.deploymentResourcePools.operations.wait", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.indexes.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/indexes/{indexesId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^indexes/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "required": true, "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.indexes.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/indexes/{indexesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^indexes/[^/]+/operations/[^/]+$", - "location": "path", - "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.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." - }, - "wait": { - "id": "aiplatform.indexes.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/indexes/{indexesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^indexes/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." + ] } } } } }, - "indexEndpoints": { + "endpoints": { + "methods": { + "computeTokens": { + "description": "Return a list of tokens based on the input text.", + "flatPath": "v1/endpoints/{endpointsId}:computeTokens", + "httpMethod": "POST", + "id": "aiplatform.endpoints.computeTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:computeTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "countTokens": { + "description": "Perform a token counting.", + "flatPath": "v1/endpoints/{endpointsId}:countTokens", + "httpMethod": "POST", + "id": "aiplatform.endpoints.countTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:countTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1CountTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CountTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchPredictOperation": { + "description": "Fetch an asynchronous online prediction operation.", + "flatPath": "v1/endpoints/{endpointsId}:fetchPredictOperation", + "httpMethod": "POST", + "id": "aiplatform.endpoints.fetchPredictOperation", + "parameterOrder": [ + "endpoint" + ], + "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", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:fetchPredictOperation", + "request": { + "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "generateContent": { + "description": "Generate content with multimodal inputs.", + "flatPath": "v1/endpoints/{endpointsId}:generateContent", + "httpMethod": "POST", + "id": "aiplatform.endpoints.generateContent", + "parameterOrder": [ + "model" + ], + "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", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:generateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predict": { + "description": "", + "flatPath": "v1/endpoints/{endpointsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.endpoints.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predictLongRunning": { + "description": "", + "flatPath": "v1/endpoints/{endpointsId}:predictLongRunning", + "httpMethod": "POST", + "id": "aiplatform.endpoints.predictLongRunning", + "parameterOrder": [ + "endpoint" + ], + "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", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predictLongRunning", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "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.", + "flatPath": "v1/endpoints/{endpointsId}:streamGenerateContent", + "httpMethod": "POST", + "id": "aiplatform.endpoints.streamGenerateContent", + "parameterOrder": [ + "model" + ], + "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", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:streamGenerateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + }, "resources": { - "operations": { + "chat": { "methods": { - "list": { - "id": "aiplatform.indexEndpoints.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations", - "httpMethod": "GET", + "completions": { + "description": "Exposes an OpenAI-compatible endpoint for chat completions.", + "flatPath": "v1/endpoints/{endpointsId}/chat/completions", + "httpMethod": "POST", + "id": "aiplatform.endpoints.chat.completions", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^indexEndpoints/[^/]+$", + "endpoint": { + "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", + "pattern": "^endpoints/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+endpoint}/chat/completions", + "request": { + "$ref": "GoogleApiHttpBody" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleApiHttpBody" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "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`.", + "flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.endpoints.operations.cancel", + "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": { - "id": "aiplatform.indexEndpoints.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.indexEndpoints.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/indexEndpoints/{indexEndpointsId}/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`.", + "flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.endpoints.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.indexEndpoints.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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": "v1/endpoints/{endpointsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.endpoints.operations.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.indexEndpoints.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - } - } - }, - "metadataStores": { - "resources": { - "operations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.metadataStores.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/metadataStores/{metadataStoresId}/operations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/endpoints/{endpointsId}/operations", "httpMethod": "GET", + "id": "aiplatform.endpoints.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^metadataStores/[^/]+$", "location": "path", + "pattern": "^endpoints/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -1759,317 +2432,136 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.metadataStores.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^metadataStores/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.metadataStores.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^metadataStores/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." + ] }, - "cancel": { - "id": "aiplatform.metadataStores.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}: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.", + "flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^metadataStores/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.endpoints.operations.wait", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.metadataStores.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } - }, - "artifacts": { + } + } + }, + "featureGroups": { + "resources": { + "features": { "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.metadataStores.artifacts.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", - "httpMethod": "GET", + "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": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featureGroups.features.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^metadataStores/[^/]+/artifacts/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.metadataStores.artifacts.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/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.", + "flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.featureGroups.features.operations.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.metadataStores.artifacts.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.metadataStores.artifacts.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.featureGroups.features.operations.listWait", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.metadataStores.artifacts.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "The standard list filter.", + "location": "query", "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" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - } - } - }, - "contexts": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.metadataStores.contexts.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", - "httpMethod": "GET", - "parameters": { "name": { "description": "The name of the operation's parent resource.", - "pattern": "^metadataStores/[^/]+/contexts/[^/]+$", "location": "path", + "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -2077,159 +2569,269 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.metadataStores.contexts.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", - "httpMethod": "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": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featureGroups.features.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] + } + } + } + } + }, + "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`.", + "flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featureGroups.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featureGroups.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.featureGroups.operations.listWait", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featureGroups.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featureOnlineStores": { + "resources": { + "featureViews": { + "resources": { + "operations": { + "methods": { "delete": { - "id": "aiplatform.metadataStores.contexts.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/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`.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.featureOnlineStores.featureViews.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.metadataStores.contexts.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.featureViews.operations.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.metadataStores.contexts.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - } - } - }, - "executions": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.metadataStores.executions.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", + ] + }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.featureViews.operations.listWait", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^metadataStores/[^/]+/executions/[^/]+$", "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -2237,481 +2839,612 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.metadataStores.executions.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.metadataStores.executions.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." + ] }, - "cancel": { - "id": "aiplatform.metadataStores.executions.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: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.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.featureOnlineStores.featureViews.operations.wait", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.metadataStores.executions.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } - } - } - }, - "modelDeploymentMonitoringJobs": { - "resources": { + }, "operations": { "methods": { - "list": { - "id": "aiplatform.modelDeploymentMonitoringJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", - "httpMethod": "GET", + "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": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featureOnlineStores.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^modelDeploymentMonitoringJobs/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.modelDeploymentMonitoringJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/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.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource.", - "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.operations.listWait", "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`." - }, - "cancel": { - "id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/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.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.featureOnlineStores.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "migratableResources": { + "featurestores": { "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.migratableResources.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/migratableResources/{migratableResourcesId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^migratableResources/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "entityTypes": { + "resources": { + "features": { + "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`.", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.featurestores.entityTypes.features.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featurestores.entityTypes.features.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featurestores.entityTypes.features.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.featurestores.entityTypes.features.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featurestores.entityTypes.features.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "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`.", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.featurestores.entityTypes.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" + "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": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featurestores.entityTypes.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" + "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": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featurestores.entityTypes.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.featurestores.entityTypes.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" + "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": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featurestores.entityTypes.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, + } + } + } + }, + "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`.", + "flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.featurestores.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.migratableResources.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^migratableResources/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.migratableResources.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/migratableResources/{migratableResourcesId}/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`.", + "flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.featurestores.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.migratableResources.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "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": "v1/featurestores/{featurestoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featurestores.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^migratableResources/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.migratableResources.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", - "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`.", + "flatPath": "v1/featurestores/{featurestoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.featurestores.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^migratableResources/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "The standard list filter.", + "location": "query", "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" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - } - } - }, - "models": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.models.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/models/{modelsId}/operations", - "httpMethod": "GET", - "parameters": { "name": { "description": "The name of the operation's parent resource.", - "pattern": "^models/[^/]+$", "location": "path", + "pattern": "^featurestores/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -2719,319 +3452,159 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.models.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/models/{modelsId}/operations/{operationsId}", - "httpMethod": "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": "v1/featurestores/{featurestoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featurestores.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^models/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "hyperparameterTuningJobs": { + "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`.", + "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.hyperparameterTuningJobs.operations.cancel", + "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": { - "id": "aiplatform.models.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/models/{modelsId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^models/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "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`." + ] }, - "cancel": { - "id": "aiplatform.models.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/models/{modelsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.hyperparameterTuningJobs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^models/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.models.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/models/{modelsId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "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": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.hyperparameterTuningJobs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^models/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - }, - "evaluations": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.models.evaluations.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^models/[^/]+/evaluations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.models.evaluations.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.models.evaluations.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.models.evaluations.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.models.evaluations.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - } - } - } - } - }, - "notebookExecutionJobs": { - "resources": { - "operations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.notebookExecutionJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations", "httpMethod": "GET", + "id": "aiplatform.hyperparameterTuningJobs.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^notebookExecutionJobs/[^/]+$", "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -3039,159 +3612,159 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.notebookExecutionJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", - "httpMethod": "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": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.hyperparameterTuningJobs.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "indexEndpoints": { + "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`.", + "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.indexEndpoints.operations.cancel", + "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": { - "id": "aiplatform.notebookExecutionJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "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`." + ] }, - "cancel": { - "id": "aiplatform.notebookExecutionJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.indexEndpoints.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.notebookExecutionJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "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": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.indexEndpoints.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - } - } - }, - "notebookRuntimes": { - "resources": { - "operations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.notebookRuntimes.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations", "httpMethod": "GET", + "id": "aiplatform.indexEndpoints.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^notebookRuntimes/[^/]+$", "location": "path", + "pattern": "^indexEndpoints/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -3199,319 +3772,159 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.notebookRuntimes.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", - "httpMethod": "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": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.indexEndpoints.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "indexes": { + "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`.", + "flatPath": "v1/indexes/{indexesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.indexes.operations.cancel", + "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": { - "id": "aiplatform.notebookRuntimes.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.notebookRuntimes.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", - "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.notebookRuntimes.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, + "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": "v1/indexes/{indexesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.indexes.operations.delete", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - } - } - }, - "notebookRuntimeTemplates": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.notebookRuntimeTemplates.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^notebookRuntimeTemplates/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.notebookRuntimeTemplates.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/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.", + "flatPath": "v1/indexes/{indexesId}/operations/{operationsId}", "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.indexes.operations.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.notebookRuntimeTemplates.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.notebookRuntimeTemplates.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/indexes/{indexesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.indexes.operations.list", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.notebookRuntimeTemplates.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "The standard list filter.", + "location": "query", "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" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - } - } - }, - "studies": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.studies.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/studies/{studiesId}/operations", - "httpMethod": "GET", - "parameters": { "name": { "description": "The name of the operation's parent resource.", - "pattern": "^studies/[^/]+$", "location": "path", + "pattern": "^indexes/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -3519,479 +3932,683 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.studies.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/studies/{studiesId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^studies/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.studies.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/studies/{studiesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^studies/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." + ] }, - "cancel": { - "id": "aiplatform.studies.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/studies/{studiesId}/operations/{operationsId}: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.", + "flatPath": "v1/indexes/{indexesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^studies/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.indexes.operations.wait", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.studies.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/studies/{studiesId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^studies/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } - }, - "trials": { + } + } + }, + "media": { + "methods": { + "upload": { + "description": "Upload a file into a RagCorpus.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload", + "httpMethod": "POST", + "id": "aiplatform.media.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v1/{+parent}/ragFiles:upload" + } + } + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/ragFiles:upload", + "request": { + "$ref": "GoogleCloudAiplatformV1UploadRagFileRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1UploadRagFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "supportsMediaUpload": true + } + } + }, + "metadataStores": { + "resources": { + "artifacts": { "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.studies.trials.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/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`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.artifacts.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^studies/[^/]+/trials/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.studies.trials.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.artifacts.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.studies.trials.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", - "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.", + "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.artifacts.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.studies.trials.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.artifacts.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.studies.trials.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/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.", + "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.metadataStores.artifacts.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } - } - } - }, - "trainingPipelines": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.trainingPipelines.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^trainingPipelines/[^/]+$", - "location": "path", - "required": true, - "type": "string" + }, + "contexts": { + "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`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.contexts.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" + "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": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.contexts.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" + "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": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.contexts.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.contexts.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" + "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": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.contexts.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, + } + } + } + }, + "executions": { + "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`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.executions.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.executions.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.executions.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.executions.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.executions.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "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`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.trainingPipelines.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.trainingPipelines.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/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`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.trainingPipelines.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.operations.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.trainingPipelines.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - } - } - }, - "persistentResources": { - "resources": { - "operations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.persistentResources.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/persistentResources/{persistentResourcesId}/operations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/operations", "httpMethod": "GET", + "id": "aiplatform.metadataStores.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^persistentResources/[^/]+$", "location": "path", + "pattern": "^metadataStores/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -3999,159 +4616,159 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.persistentResources.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}", - "httpMethod": "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": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "migratableResources": { + "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`.", + "flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.migratableResources.operations.cancel", + "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": { - "id": "aiplatform.persistentResources.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "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`." + ] }, - "cancel": { - "id": "aiplatform.persistentResources.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^persistentResources/[^/]+/operations/[^/]+$", - "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`.", + "flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.migratableResources.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.persistentResources.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "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": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.migratableResources.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - } - } - }, - "pipelineJobs": { - "resources": { - "operations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.pipelineJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/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`.", + "flatPath": "v1/migratableResources/{migratableResourcesId}/operations", "httpMethod": "GET", + "id": "aiplatform.migratableResources.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^pipelineJobs/[^/]+$", "location": "path", + "pattern": "^migratableResources/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -4159,319 +4776,159 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.pipelineJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.pipelineJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." + ] }, - "cancel": { - "id": "aiplatform.pipelineJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}: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.", + "flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.migratableResources.operations.wait", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.pipelineJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "ragEngineConfig": { + "modelDeploymentMonitoringJobs": { "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.ragEngineConfig.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/ragEngineConfig/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^ragEngineConfig$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, + "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": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.ragEngineConfig.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/ragEngineConfig/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^ragEngineConfig/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.ragEngineConfig.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/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`.", + "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^ragEngineConfig/operations/[^/]+$", "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.ragEngineConfig.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/ragEngineConfig/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^ragEngineConfig/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.ragEngineConfig.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/ragEngineConfig/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^ragEngineConfig/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - } - } - }, - "ragCorpora": { - "resources": { - "operations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.ragCorpora.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/ragCorpora/{ragCorporaId}/operations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", "httpMethod": "GET", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^ragCorpora/[^/]+$", "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -4479,319 +4936,319 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.ragCorpora.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.ragCorpora.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." + ] }, - "cancel": { - "id": "aiplatform.ragCorpora.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}: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.", + "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.ragCorpora.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } - }, - "ragFiles": { + } + } + }, + "models": { + "resources": { + "evaluations": { "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.ragCorpora.ragFiles.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, + "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": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.models.evaluations.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.ragCorpora.ragFiles.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.ragCorpora.ragFiles.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/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`.", + "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.models.evaluations.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.ragCorpora.ragFiles.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "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": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.models.evaluations.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.ragCorpora.ragFiles.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", - "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`.", + "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.models.evaluations.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+$", "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.", + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", "location": "query", - "type": "string", - "format": "google-duration" + "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" } }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.models.evaluations.operations.wait", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } - } - } - }, - "schedules": { - "resources": { + }, "operations": { "methods": { - "list": { - "id": "aiplatform.schedules.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/schedules/{schedulesId}/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": "v1/models/{modelsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.models.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/models/{modelsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.models.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/models/{modelsId}/operations/{operationsId}", "httpMethod": "GET", + "id": "aiplatform.models.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^schedules/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/models/{modelsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.models.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^models/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -4799,159 +5256,159 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.schedules.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}", - "httpMethod": "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": "v1/models/{modelsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.models.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^schedules/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "notebookExecutionJobs": { + "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`.", + "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.notebookExecutionJobs.operations.cancel", + "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": { - "id": "aiplatform.schedules.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^schedules/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "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`." + ] }, - "cancel": { - "id": "aiplatform.schedules.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.notebookExecutionJobs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^schedules/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.schedules.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "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": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.notebookExecutionJobs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^schedules/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - } - } - }, - "specialistPools": { - "resources": { - "operations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.specialistPools.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/specialistPools/{specialistPoolsId}/operations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations", "httpMethod": "GET", + "id": "aiplatform.notebookExecutionJobs.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^specialistPools/[^/]+$", "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -4959,159 +5416,159 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.specialistPools.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}", - "httpMethod": "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": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.notebookExecutionJobs.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "notebookRuntimeTemplates": { + "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`.", + "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimeTemplates.operations.cancel", + "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": { - "id": "aiplatform.specialistPools.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "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`." + ] }, - "cancel": { - "id": "aiplatform.specialistPools.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.notebookRuntimeTemplates.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.specialistPools.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "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": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimeTemplates.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - } - } - }, - "tensorboards": { - "resources": { - "operations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.tensorboards.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/tensorboards/{tensorboardsId}/operations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", "httpMethod": "GET", + "id": "aiplatform.notebookRuntimeTemplates.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^tensorboards/[^/]+$", "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -5119,639 +5576,159 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.tensorboards.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}", - "httpMethod": "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": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimeTemplates.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^tensorboards/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "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`.", + "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimes.operations.cancel", + "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": { - "id": "aiplatform.tensorboards.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^tensorboards/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "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`." + ] }, - "cancel": { - "id": "aiplatform.tensorboards.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.notebookRuntimes.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^tensorboards/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.tensorboards.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^tensorboards/[^/]+/operations/[^/]+$", - "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": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimes.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - }, - "experiments": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.tensorboards.experiments.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.tensorboards.experiments.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.tensorboards.experiments.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.tensorboards.experiments.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.tensorboards.experiments.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } + ] }, - "runs": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.tensorboards.experiments.runs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.tensorboards.experiments.runs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.tensorboards.experiments.runs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.tensorboards.experiments.runs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.tensorboards.experiments.runs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - }, - "timeSeries": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - } - } - } - } - } - } - } - } - }, - "featureOnlineStores": { - "resources": { - "operations": { - "methods": { - "listWait": { - "id": "aiplatform.featureOnlineStores.operations.listWait", - "path": "v1/{+name}:wait", - "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations", "httpMethod": "GET", + "id": "aiplatform.notebookRuntimes.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^notebookRuntimes/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -5759,269 +5736,311 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.featureOnlineStores.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { + "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": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimes.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "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" } }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "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`.", + "flatPath": "v1/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/operations", + "httpMethod": "GET", + "id": "aiplatform.operations.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "persistentResources": { + "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`.", + "flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.persistentResources.operations.cancel", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.featureOnlineStores.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/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`.", + "flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.persistentResources.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "wait": { - "id": "aiplatform.featureOnlineStores.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "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": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.persistentResources.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - }, - "featureViews": { - "resources": { - "operations": { - "methods": { - "listWait": { - "id": "aiplatform.featureOnlineStores.featureViews.operations.listWait", - "path": "v1/{+name}:wait", - "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.featureOnlineStores.featureViews.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.featureOnlineStores.featureViews.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "wait": { - "id": "aiplatform.featureOnlineStores.featureViews.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - } - } - } - } - }, - "featureGroups": { - "resources": { - "operations": { - "methods": { - "listWait": { - "id": "aiplatform.featureGroups.operations.listWait", - "path": "v1/{+name}:wait", - "flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/persistentResources/{persistentResourcesId}/operations", "httpMethod": "GET", + "id": "aiplatform.persistentResources.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^featureGroups/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^persistentResources/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -6029,5386 +6048,5690 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.featureGroups.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}", - "httpMethod": "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": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.persistentResources.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", "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" } }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "pipelineJobs": { + "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`.", + "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.pipelineJobs.operations.cancel", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.featureGroups.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/featureGroups/{featureGroupsId}/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`.", + "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.pipelineJobs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^featureGroups/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "wait": { - "id": "aiplatform.featureGroups.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "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": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.pipelineJobs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "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`.", + "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.pipelineJobs.operations.list", + "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." - } - } - }, - "features": { - "resources": { - "operations": { - "methods": { - "listWait": { - "id": "aiplatform.featureGroups.features.operations.listWait", - "path": "v1/{+name}:wait", - "flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "get": { - "id": "aiplatform.featureGroups.features.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+$", + "required": true, + "type": "string" }, - "delete": { - "id": "aiplatform.featureGroups.features.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "wait": { - "id": "aiplatform.featureGroups.features.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." + "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" } - } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.pipelineJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } } }, - "datasets": { + "projects": { "methods": { - "create": { - "id": "aiplatform.datasets.create", - "path": "v1/datasets", - "flatPath": "v1/datasets", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [], - "request": { - "$ref": "GoogleCloudAiplatformV1Dataset" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a Dataset." - }, - "get": { - "id": "aiplatform.datasets.get", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}", + "getCacheConfig": { + "description": "Gets a GenAI cache config.", + "flatPath": "v1/projects/{projectsId}/cacheConfig", "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the Dataset resource.", - "pattern": "^datasets/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, + "id": "aiplatform.projects.getCacheConfig", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleCloudAiplatformV1Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a Dataset." - }, - "patch": { - "id": "aiplatform.datasets.patch", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}", - "httpMethod": "PATCH", "parameters": { "name": { - "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^datasets/[^/]+$", + "description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", "location": "path", + "pattern": "^projects/[^/]+/cacheConfig$", "required": true, "type": "string" - }, - "updateMask": { - "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", - "type": "string", - "format": "google-fieldmask" } }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Dataset" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Dataset" + "$ref": "GoogleCloudAiplatformV1CacheConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a Dataset." + ] }, - "list": { - "id": "aiplatform.datasets.list", - "path": "v1/datasets", - "flatPath": "v1/datasets", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - }, - "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" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "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: * `display_name` * `create_time` * `update_time`", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [], - "response": { - "$ref": "GoogleCloudAiplatformV1ListDatasetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "updateCacheConfig": { + "description": "Updates a cache config.", + "flatPath": "v1/projects/{projectsId}/cacheConfig", + "httpMethod": "PATCH", + "id": "aiplatform.projects.updateCacheConfig", + "parameterOrder": [ + "name" ], - "description": "Lists Datasets in a Location." - }, - "delete": { - "id": "aiplatform.datasets.delete", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^datasets/[^/]+$", + "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", "location": "path", + "pattern": "^projects/[^/]+/cacheConfig$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1CacheConfig" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a Dataset." + ] } }, "resources": { - "operations": { + "locations": { "methods": { - "list": { - "id": "aiplatform.datasets.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/datasets/{datasetsId}/operations", - "httpMethod": "GET", + "askContexts": { + "description": "Agentic Retrieval Ask API for RAG.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:askContexts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.askContexts", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^datasets/[^/]+$", + "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", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}:askContexts", + "request": { + "$ref": "GoogleCloudAiplatformV1AskContextsRequest" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1AskContextsResponse" }, "scopes": [ "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": { - "id": "aiplatform.datasets.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}", - "httpMethod": "GET", + "asyncRetrieveContexts": { + "description": "Asynchronous API to retrieves relevant contexts for a query.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:asyncRetrieveContexts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.asyncRetrieveContexts", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^datasets/[^/]+/operations/[^/]+$", + "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", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}:asyncRetrieveContexts", + "request": { + "$ref": "GoogleCloudAiplatformV1AsyncRetrieveContextsRequest" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.datasets.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}", - "httpMethod": "DELETE", + "augmentPrompt": { + "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.augmentPrompt", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^datasets/[^/]+/operations/[^/]+$", + "parent": { + "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}`.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}:augmentPrompt", + "request": { + "$ref": "GoogleCloudAiplatformV1AugmentPromptRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1AugmentPromptResponse" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.datasets.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}:cancel", + "corroborateContent": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:corroborateContent", "httpMethod": "POST", + "id": "aiplatform.projects.locations.corroborateContent", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^datasets/[^/]+/operations/[^/]+$", + "parent": { + "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}`.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+parent}:corroborateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1CorroborateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CorroborateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deploy": { + "description": "Deploys a model to a new endpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:deploy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploy", "parameterOrder": [ - "name" + "destination" ], + "parameters": { + "destination": { + "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+destination}:deploy", + "request": { + "$ref": "GoogleCloudAiplatformV1DeployRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.datasets.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}:wait", + "evaluateDataset": { + "description": "Evaluates a dataset based on a set of given metrics.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluateDataset", + "parameterOrder": [ + "location" + ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^datasets/[^/]+/operations/[^/]+$", + "location": { + "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, + "path": "v1/{+location}:evaluateDataset", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluateDatasetRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "evaluateInstances": { + "description": "Evaluates instances based on a given metric.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluateInstances", "parameterOrder": [ - "name" + "location" ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:evaluateInstances", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluateInstancesRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1EvaluateInstancesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateInstanceRubrics": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateInstanceRubrics", + "parameterOrder": [ + "location" ], - "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." - } - } - }, - "dataItems": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.datasets.dataItems.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", - "httpMethod": "GET", + "parameters": { + "location": { + "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:generateInstanceRubrics", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateSyntheticData": { + "description": "Generates synthetic (artificial) data based on a description", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateSyntheticData", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "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`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:generateSyntheticData", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudLocationLocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getRagEngineConfig": { + "description": "Gets a RagEngineConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.getRagEngineConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1RagEngineConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filter": { + "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).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/locations", + "response": { + "$ref": "GoogleCloudLocationListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieveContexts": { + "description": "Retrieves relevant contexts for a query.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:retrieveContexts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.retrieveContexts", + "parameterOrder": [ + "parent" + ], + "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", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:retrieveContexts", + "request": { + "$ref": "GoogleCloudAiplatformV1RetrieveContextsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1RetrieveContextsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateRagEngineConfig": { + "description": "Updates a RagEngineConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.updateRagEngineConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1RagEngineConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "batchPredictionJobs": { + "methods": { + "cancel": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.batchPredictionJobs.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^datasets/[^/]+/dataItems/[^/]+$", + "description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", "required": true, "type": "string" - }, + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.batchPredictionJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/batchPredictionJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.batchPredictionJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a BatchPredictionJob", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.batchPredictionJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists BatchPredictionJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.batchPredictionJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { "filter": { - "description": "The standard list 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 `=`, `!=`,`<`, `<=`,`>`, `>=` 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>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "parent": { + "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "boolean" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/batchPredictionJobs", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.cachedContents.create", + "parameterOrder": [ + "parent" ], - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." - }, - "get": { - "id": "aiplatform.datasets.dataItems.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The parent resource where the cached content will be created", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/cachedContents", + "request": { + "$ref": "GoogleCloudAiplatformV1CachedContent" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1CachedContent" }, "scopes": [ "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": { - "id": "aiplatform.datasets.dataItems.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "description": "Deletes cached content", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.cachedContents.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "description": "Required. The resource name referring to the cached content", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.datasets.dataItems.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "get": { + "description": "Gets cached content configurations", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.cachedContents.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "description": "Required. The resource name referring to the cached content", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1CachedContent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists cached contents in a project", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.cachedContents.list", "parameterOrder": [ - "name" + "parent" ], + "parameters": { + "pageSize": { + "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", + "location": "query", + "type": "integer" + }, + "pageToken": { + "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", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of cached contents.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/cachedContents", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1ListCachedContentsResponse" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.datasets.dataItems.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "patch": { + "description": "Updates cached content configurations", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.cachedContents.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", "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.", + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-duration" + "type": "string" } }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1CachedContent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CachedContent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "customJobs": { + "methods": { + "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": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.cancel", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelCustomJobRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a CustomJob. A created CustomJob right away will be attempted to be run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.create", + "parameterOrder": [ + "parent" ], - "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." - } - } - }, - "annotations": { - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.datasets.dataItems.annotations.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/customJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1CustomJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CustomJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a CustomJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.customJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a CustomJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1CustomJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists CustomJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` 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>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/customJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1ListCustomJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.datasets.dataItems.annotations.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.datasets.dataItems.annotations.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.customJobs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.datasets.dataItems.annotations.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "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": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.operations.list", "parameterOrder": [ "name" ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.datasets.dataItems.annotations.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } - } - } - }, - "savedQueries": { - "resources": { - "operations": { + }, + "dataLabelingJobs": { "methods": { - "list": { - "id": "aiplatform.datasets.savedQueries.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", - "httpMethod": "GET", + "cancel": { + "description": "Cancels a DataLabelingJob. Success of cancellation is not guaranteed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^datasets/[^/]+/savedQueries/[^/]+$", + "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelDataLabelingJobRequest" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.datasets.savedQueries.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", - "httpMethod": "GET", + "create": { + "description": "Creates a DataLabelingJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/dataLabelingJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1DataLabelingJob" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1DataLabelingJob" }, "scopes": [ "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": { - "id": "aiplatform.datasets.savedQueries.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", + "description": "Deletes a DataLabelingJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.dataLabelingJobs.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`." - }, - "cancel": { - "id": "aiplatform.datasets.savedQueries.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "description": "Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.datasets.savedQueries.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "get": { + "description": "Gets a DataLabelingJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1DataLabelingJob" }, "scopes": [ "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." - } - } - } - } - }, - "annotationSpecs": { - "resources": { - "operations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.datasets.annotationSpecs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", + "description": "Lists DataLabelingJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` 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>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", "type": "string" }, - "filter": { - "description": "The standard list filter.", + "orderBy": { + "description": "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": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.datasets.annotationSpecs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.datasets.annotationSpecs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.datasets.annotationSpecs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, + }, + "readMask": { + "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.", + "format": "google-fieldmask", + "location": "query", "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/dataLabelingJobs", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1ListDataLabelingJobsResponse" }, "scopes": [ "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`." - }, - "wait": { - "id": "aiplatform.datasets.annotationSpecs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait", + ] + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "datasets": { + "methods": { + "create": { + "description": "Creates a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, + "path": "v1/{+parent}/datasets", + "request": { + "$ref": "GoogleCloudAiplatformV1Dataset" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.delete", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - } - } - }, - "datasetVersions": { - "methods": { - "create": { - "id": "aiplatform.datasets.datasetVersions.create", - "path": "v1/{+parent}/datasetVersions", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^datasets/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Create a version from a Dataset." - }, - "patch": { - "id": "aiplatform.datasets.datasetVersions.patch", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a DatasetVersion." - }, - "delete": { - "id": "aiplatform.datasets.datasetVersions.delete", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a Dataset version." - }, - "get": { - "id": "aiplatform.datasets.datasetVersions.get", - "path": "v1/{+name}", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", - "location": "path", - "required": true, - "type": "string" + ] }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a Dataset version." - }, - "list": { - "id": "aiplatform.datasets.datasetVersions.list", - "path": "v1/{+parent}/datasetVersions", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^datasets/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "export": { + "description": "Exports data from a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.export", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:export", + "request": { + "$ref": "GoogleCloudAiplatformV1ExportDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "filter": { - "description": "Optional. The standard list filter.", - "location": "query", - "type": "string" + "get": { + "description": "Gets a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "Optional. The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "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" + }, + "resource": { + "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/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "Optional. The standard list page token.", - "location": "query", - "type": "string" + "import": { + "description": "Imports data into a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.import", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:import", + "request": { + "$ref": "GoogleCloudAiplatformV1ImportDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" + "list": { + "description": "Lists Datasets in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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" + }, + "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: * `display_name` * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/datasets", + "response": { + "$ref": "GoogleCloudAiplatformV1ListDatasetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "orderBy": { - "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", - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists DatasetVersions in a Dataset." - }, - "restore": { - "id": "aiplatform.datasets.datasetVersions.restore", - "path": "v1/{+name}:restore", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Restores a dataset version." - } - } - } - } - }, - "projects": { - "methods": { - "updateCacheConfig": { - "id": "aiplatform.projects.updateCacheConfig", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/cacheConfig", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", - "pattern": "^projects/[^/]+/cacheConfig$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CacheConfig" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a cache config." - }, - "getCacheConfig": { - "id": "aiplatform.projects.getCacheConfig", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/cacheConfig", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", - "pattern": "^projects/[^/]+/cacheConfig$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1CacheConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a GenAI cache config." - } - }, - "resources": { - "locations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.list", - "path": "v1/{+name}/locations", - "flatPath": "v1/projects/{projectsId}/locations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The resource that owns the locations collection, if applicable.", - "pattern": "^projects/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "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).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of results to return. If not set, the service selects a default.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", - "location": "query", - "type": "string" - }, - "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", - "location": "query", - "repeated": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudLocationListLocationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists information about the supported locations for this service." - }, - "get": { - "id": "aiplatform.projects.locations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Resource name for the location.", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudLocationLocation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets information about a location." - }, - "generateSyntheticData": { - "id": "aiplatform.projects.locations.generateSyntheticData", - "path": "v1/{+location}:generateSyntheticData", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", - "httpMethod": "POST", - "parameters": { - "location": { - "description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "location" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Generates synthetic data based on the provided configuration." - }, - "evaluateInstances": { - "id": "aiplatform.projects.locations.evaluateInstances", - "path": "v1/{+location}:evaluateInstances", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", - "httpMethod": "POST", - "parameters": { - "location": { - "description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "location" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluateInstancesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluateInstancesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Evaluates instances based on a given metric." - }, - "evaluateDataset": { - "id": "aiplatform.projects.locations.evaluateDataset", - "path": "v1/{+location}:evaluateDataset", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", - "httpMethod": "POST", - "parameters": { - "location": { - "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "location" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluateDatasetRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Evaluates a dataset based on a set of given metrics." - }, - "generateInstanceRubrics": { - "id": "aiplatform.projects.locations.generateInstanceRubrics", - "path": "v1/{+location}:generateInstanceRubrics", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics", - "httpMethod": "POST", - "parameters": { - "location": { - "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "location" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse" - }, - "scopes": [ - "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." - }, - "deploy": { - "id": "aiplatform.projects.locations.deploy", - "path": "v1/{+destination}:deploy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:deploy", - "httpMethod": "POST", - "parameters": { - "destination": { - "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "destination" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1DeployRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deploys a model to a new endpoint." - }, - "updateRagEngineConfig": { - "id": "aiplatform.projects.locations.updateRagEngineConfig", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1RagEngineConfig" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a RagEngineConfig." - }, - "getRagEngineConfig": { - "id": "aiplatform.projects.locations.getRagEngineConfig", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1RagEngineConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a RagEngineConfig." - }, - "retrieveContexts": { - "id": "aiplatform.projects.locations.retrieveContexts", - "path": "v1/{+parent}:retrieveContexts", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:retrieveContexts", - "httpMethod": "POST", - "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}`.", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1RetrieveContextsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1RetrieveContextsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Retrieves relevant contexts for a query." - }, - "augmentPrompt": { - "id": "aiplatform.projects.locations.augmentPrompt", - "path": "v1/{+parent}:augmentPrompt", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", - "httpMethod": "POST", - "parameters": { - "parent": { - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1AugmentPromptRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1AugmentPromptResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses." - }, - "corroborateContent": { - "id": "aiplatform.projects.locations.corroborateContent", - "path": "v1/{+parent}:corroborateContent", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:corroborateContent", - "httpMethod": "POST", - "parameters": { - "parent": { - "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}`.", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CorroborateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1CorroborateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." - } - }, - "resources": { - "featurestores": { - "methods": { - "setIamPolicy": { - "id": "aiplatform.projects.locations.featurestores.setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy", - "httpMethod": "POST", - "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/[^/]+/featurestores/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "patch": { + "description": "Updates a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.datasets.patch", "parameterOrder": [ - "resource" - ], - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "name" ], - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." - }, - "getIamPolicy": { - "id": "aiplatform.projects.locations.featurestores.getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy", - "httpMethod": "POST", "parameters": { - "resource": { - "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/[^/]+/featurestores/[^/]+$", + "name": { + "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "type": "string" }, - "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).", + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`", + "format": "google-fieldmask", "location": "query", - "type": "integer", - "format": "int32" + "type": "string" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Dataset" + }, "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleCloudAiplatformV1Dataset" }, "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." + ] }, - "testIamPermissions": { - "id": "aiplatform.projects.locations.featurestores.testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions", - "httpMethod": "POST", + "searchDataItems": { + "description": "Searches DataItems in a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.searchDataItems", + "parameterOrder": [ + "dataset" + ], "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "location": "path", - "required": true, + "annotationFilters": { + "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", + "repeated": true, "type": "string" }, - "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).", + "annotationsFilter": { + "deprecated": true, + "description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.", "location": "query", - "repeated": true, - "type": "string" - } - }, - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." - }, - "create": { - "id": "aiplatform.projects.locations.featurestores.create", - "path": "v1/{+parent}/featurestores", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, "type": "string" }, - "featurestoreId": { - "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.", + "annotationsLimit": { + "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "dataItemFilter": { + "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", "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Featurestore" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a new Featurestore in a given project and location." - }, - "get": { - "id": "aiplatform.projects.locations.featurestores.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the Featurestore resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "location": "path", - "required": true, + }, + "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.", + "location": "query", "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1Featurestore" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets details of a single Featurestore." - }, - "list": { - "id": "aiplatform.projects.locations.featurestores.list", - "path": "v1/{+parent}/featurestores", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + }, + "dataset": { + "description": "Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "type": "string" }, - "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\".", + "fieldMask": { + "description": "Mask specifying which fields of DataItemView to read.", + "format": "google-fieldmask", "location": "query", "type": "string" }, - "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.", + "orderBy": { + "deprecated": true, + "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": "integer", - "format": "int32" + "type": "string" }, - "pageToken": { - "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.", + "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" }, - "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` * `online_serving_config.fixed_node_count`", + "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" }, - "readMask": { - "description": "Mask specifying which fields to read.", + "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", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListFeaturestoresResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Featurestores in a given project and location." - }, - "patch": { - "id": "aiplatform.projects.locations.featurestores.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "location": "path", - "required": true, "type": "string" }, - "updateMask": { - "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`", + "pageSize": { + "description": "Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "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.", "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Featurestore" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates the parameters of a single Featurestore." - }, - "delete": { - "id": "aiplatform.projects.locations.featurestores.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "location": "path", - "required": true, "type": "string" }, - "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.)", + "savedQuery": { + "deprecated": true, + "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.", "location": "query", - "type": "boolean" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+dataset}:searchDataItems", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1SearchDataItemsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed." + ] }, - "batchReadFeatureValues": { - "id": "aiplatform.projects.locations.featurestores.batchReadFeatureValues", - "path": "v1/{+featurestore}:batchReadFeatureValues", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues", + "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": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:setIamPolicy", "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.setIamPolicy", + "parameterOrder": [ + "resource" + ], "parameters": { - "featurestore": { - "description": "Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "featurestore" - ], + "path": "v1/{+resource}:setIamPolicy", "request": { - "$ref": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequest" + "$ref": "GoogleIamV1SetIamPolicyRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "searchFeatures": { - "id": "aiplatform.projects.locations.featurestores.searchFeatures", - "path": "v1/{+location}/featurestores:searchFeatures", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures", - "httpMethod": "GET", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.testIamPermissions", + "parameterOrder": [ + "resource" + ], "parameters": { - "location": { - "description": "Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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.", + "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).", "location": "query", + "repeated": true, "type": "string" }, - "pageSize": { - "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.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "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.", - "location": "query", + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, "type": "string" } }, - "parameterOrder": [ - "location" - ], + "path": "v1/{+resource}:testIamPermissions", "response": { - "$ref": "GoogleCloudAiplatformV1SearchFeaturesResponse" + "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Searches Features matching a query in a given project." + ] } }, "resources": { - "entityTypes": { + "annotationSpecs": { "methods": { - "setIamPolicy": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy", - "httpMethod": "POST", - "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/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "get": { + "description": "Gets an AnnotationSpec.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.get", "parameterOrder": [ - "resource" - ], - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "name" ], - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." - }, - "getIamPolicy": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy", - "httpMethod": "POST", "parameters": { - "resource": { - "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/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "name": { + "description": "Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", "required": true, "type": "string" }, - "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).", + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "integer", - "format": "int32" + "type": "string" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleCloudAiplatformV1AnnotationSpec" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "dataItems": { + "methods": { + "list": { + "description": "Lists DataItems in a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.list", + "parameterOrder": [ + "parent" ], - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set." - }, - "testIamPermissions": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions", - "httpMethod": "POST", "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "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" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "type": "string" }, - "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).", + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "repeated": true, "type": "string" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+parent}/dataItems", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleCloudAiplatformV1ListDataItemsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." - }, - "readFeatureValues": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues", - "path": "v1/{+entityType}:readFeatureValues", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues", - "httpMethod": "POST", - "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`.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "entityType" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponse" + ] + } + }, + "resources": { + "annotations": { + "methods": { + "list": { + "description": "Lists Annotations belongs to a dataitem.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "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" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/annotations", + "response": { + "$ref": "GoogleCloudAiplatformV1ListAnnotationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues." + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } }, - "streamingReadFeatureValues": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues", - "path": "v1/{+entityType}:streamingReadFeatureValues", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues", - "httpMethod": "POST", - "parameters": { - "entityType": { - "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`.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, + } + } + } + }, + "datasetVersions": { + "methods": { + "create": { + "description": "Create a version from a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.datasetVersions.create", "parameterOrder": [ - "entityType" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "parent" ], - "description": "Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses." - }, - "writeFeatureValues": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues", - "path": "v1/{+entityType}:writeFeatureValues", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues", - "httpMethod": "POST", "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/[^/]+$", + "parent": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "entityType" - ], + "path": "v1/{+parent}/datasetVersions", "request": { - "$ref": "GoogleCloudAiplatformV1WriteFeatureValuesRequest" + "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "response": { - "$ref": "GoogleCloudAiplatformV1WriteFeatureValuesResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "create": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.create", - "path": "v1/{+parent}/entityTypes", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", - "httpMethod": "POST", + "delete": { + "description": "Deletes a Dataset version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.datasetVersions.delete", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "name": { + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" - }, - "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.", - "location": "query", - "type": "string" } }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1EntityType" - }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a new EntityType in a given Featurestore." + ] }, "get": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", + "description": "Gets a Dataset version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1EntityType" + "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets details of a single EntityType." + ] }, "list": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.list", - "path": "v1/{+parent}/entityTypes", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", + "description": "Lists DatasetVersions in a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", "type": "string" }, - "filter": { - "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": { + "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", "type": "string" }, "pageSize": { - "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.", + "description": "Optional. The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "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.", + "description": "Optional. The standard list page token.", "location": "query", "type": "string" }, - "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: * `entity_type_id` * `create_time` * `update_time`", - "location": "query", + "parent": { + "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, "type": "string" }, "readMask": { - "description": "Mask specifying which fields to read.", + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-fieldmask" + "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/datasetVersions", "response": { - "$ref": "GoogleCloudAiplatformV1ListEntityTypesResponse" + "$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists EntityTypes in a given Featurestore." + ] }, "patch": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", + "description": "Updates a DatasetVersion.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.datasets.datasetVersions.patch", + "parameterOrder": [ + "name" + ], "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" }, "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`", + "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", - "type": "string", - "format": "google-fieldmask" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1EntityType" + "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "response": { - "$ref": "GoogleCloudAiplatformV1EntityType" + "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates the parameters of a single EntityType." + ] }, - "delete": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", - "httpMethod": "DELETE", + "restore": { + "description": "Restores a dataset version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.restore", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" - }, - "force": { - "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.)", - "location": "query", - "type": "boolean" } }, + "path": "v1/{+name}:restore", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.operations.cancel", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed." + ] }, - "importFeatureValues": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues", - "path": "v1/{+entityType}:importFeatureValues", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { - "entityType": { - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.operations.get", "parameterOrder": [ - "entityType" + "name" ], - "request": { - "$ref": "GoogleCloudAiplatformV1ImportFeatureValuesRequest" + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "exportFeatureValues": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues", - "path": "v1/{+entityType}:exportFeatureValues", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { - "entityType": { - "description": "Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.operations.wait", "parameterOrder": [ - "entityType" + "name" ], - "request": { - "$ref": "GoogleCloudAiplatformV1ExportFeatureValuesRequest" + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "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" + } }, + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "savedQueries": { + "methods": { + "delete": { + "description": "Deletes a SavedQuery.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.savedQueries.delete", + "parameterOrder": [ + "name" ], - "description": "Exports Feature values from all the entities of a target EntityType." - }, - "deleteFeatureValues": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues", - "path": "v1/{+entityType}:deleteFeatureValues", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues", - "httpMethod": "POST", "parameters": { - "entityType": { - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "name": { + "description": "Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SavedQueries in a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.savedQueries.list", "parameterOrder": [ - "entityType" + "parent" ], - "request": { - "$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesRequest" + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "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" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "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/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } }, + "path": "v1/{+parent}/savedQueries", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1ListSavedQueriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.list", + "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." - } - } - }, - "features": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.create", - "path": "v1/{+parent}/features", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", - "httpMethod": "POST", "parameters": { - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", "required": true, "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.", + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Feature" - }, + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a new Feature in a given EntityType." + ] }, - "batchCreate": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate", - "path": "v1/{+parent}/features:batchCreate", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate", + "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": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "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", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a batch of Features in a given EntityType." - }, - "get": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", - "httpMethod": "GET", - "parameters": { - "name": { - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleCloudAiplatformV1Feature" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets details of a single Feature." - }, - "list": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.list", - "path": "v1/{+parent}/features", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", - "httpMethod": "GET", "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/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "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.", - "location": "query", - "type": "string" - }, - "pageSize": { - "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.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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" - }, - "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: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", + "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" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "latestStatsCount": { - "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", - "type": "integer", - "format": "int32" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1ListFeaturesResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Features in a given EntityType." - }, - "patch": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", - "httpMethod": "PATCH", - "parameters": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", - "location": "path", - "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)", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Feature" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Feature" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates the parameters of a single Feature." - }, - "delete": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a single Feature." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } + ] } } } } - }, - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.featurestores.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.featurestores.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.featurestores.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.projects.locations.featurestores.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.featurestores.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } } } }, - "models": { + "deploymentResourcePools": { "methods": { - "setIamPolicy": { - "id": "aiplatform.projects.locations.models.setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy", + "create": { + "description": "Create a DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploymentResourcePools.create", + "parameterOrder": [ + "parent" + ], "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/[^/]+/models/[^/]+$", + "parent": { + "description": "Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+parent}/deploymentResourcePools", "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" + "$ref": "GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest" }, "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." + ] }, - "getIamPolicy": { - "id": "aiplatform.projects.locations.models.getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy", - "httpMethod": "POST", + "delete": { + "description": "Delete a DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.deploymentResourcePools.delete", + "parameterOrder": [ + "name" + ], "parameters": { - "resource": { - "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/[^/]+/models/[^/]+$", + "name": { + "description": "Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", "required": true, "type": "string" - }, - "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).", - "location": "query", - "type": "integer", - "format": "int32" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleLongrunningOperation" }, "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." + ] }, - "testIamPermissions": { - "id": "aiplatform.projects.locations.models.testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions", - "httpMethod": "POST", + "get": { + "description": "Get a DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.get", + "parameterOrder": [ + "name" + ], "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "name": { + "description": "Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", "required": true, "type": "string" - }, - "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).", - "location": "query", - "repeated": true, - "type": "string" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "upload": { - "id": "aiplatform.projects.locations.models.upload", - "path": "v1/{+parent}/models:upload", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models:upload", - "httpMethod": "POST", + "list": { + "description": "List DeploymentResourcePools in a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.list", + "parameterOrder": [ + "parent" + ], "parameters": { + "pageSize": { + "description": "The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + }, "parent": { - "description": "Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "description": "Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1UploadModelRequest" - }, + "path": "v1/{+parent}/deploymentResourcePools", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Uploads a Model artifact into Vertex AI." + ] }, - "get": { - "id": "aiplatform.projects.locations.models.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", - "httpMethod": "GET", + "patch": { + "description": "Update a DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.deploymentResourcePools.patch", + "parameterOrder": [ + "name" + ], "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" + }, "response": { - "$ref": "GoogleCloudAiplatformV1Model" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a Model." + ] }, - "list": { - "id": "aiplatform.projects.locations.models.list", - "path": "v1/{+parent}/models", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models", - "httpMethod": "GET", + "queryDeployedModels": { + "description": "List DeployedModels that have been deployed on this DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels", + "parameterOrder": [ + "deploymentResourcePool" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "deploymentResourcePool": { + "description": "Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", "required": true, "type": "string" }, - "filter": { - "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\"`", - "location": "query", - "type": "string" - }, "pageSize": { - "description": "The standard list page size.", + "description": "The maximum number of DeployedModels to return. The service may return fewer than this value.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "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.", "location": "query", "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+deploymentResourcePool}:queryDeployedModels", "response": { - "$ref": "GoogleCloudAiplatformV1ListModelsResponse" + "$ref": "GoogleCloudAiplatformV1QueryDeployedModelsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Models in a Location." - }, - "listVersions": { - "id": "aiplatform.projects.locations.models.listVersions", - "path": "v1/{+name}:listVersions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the model to list versions for.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" + ] + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.", - "location": "query", - "type": "string" + "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": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "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\"`", - "location": "query", - "type": "string" + "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": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "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`.", - "location": "query", - "type": "string" + "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": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, + } + } + } + }, + "endpoints": { + "methods": { + "computeTokens": { + "description": "Return a list of tokens based on the input text.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.computeTokens", "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListModelVersionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "endpoint" ], - "description": "Lists versions of the specified model." - }, - "listCheckpoints": { - "id": "aiplatform.projects.locations.models.listCheckpoints", - "path": "v1/{+name}:listCheckpoints", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints", - "httpMethod": "GET", "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/[^/]+$", + "endpoint": { + "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "location": "query", - "type": "integer", - "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+endpoint}:computeTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse" + "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists checkpoints of the specified model version." + ] }, - "patch": { - "id": "aiplatform.projects.locations.models.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", - "httpMethod": "PATCH", + "countTokens": { + "description": "Perform a token counting.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.countTokens", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "name": { - "description": "The resource name of the Model.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "endpoint": { + "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/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", - "location": "query", - "type": "string", - "format": "google-fieldmask" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+endpoint}:countTokens", "request": { - "$ref": "GoogleCloudAiplatformV1Model" + "$ref": "GoogleCloudAiplatformV1CountTokensRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1Model" + "$ref": "GoogleCloudAiplatformV1CountTokensResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a Model." + ] }, - "updateExplanationDataset": { - "id": "aiplatform.projects.locations.models.updateExplanationDataset", - "path": "v1/{+model}:updateExplanationDataset", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset", + "create": { + "description": "Creates an Endpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints", "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "model": { - "description": "Required. The resource name of the Model to update. Format: `projects/{project}/locations/{location}/models/{model}`", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "endpointId": { + "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "model" - ], + "path": "v1/{+parent}/endpoints", "request": { - "$ref": "GoogleCloudAiplatformV1UpdateExplanationDatasetRequest" + "$ref": "GoogleCloudAiplatformV1Endpoint" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Incrementally update the dataset used for an examples model." + ] }, "delete": { - "id": "aiplatform.projects.locations.models.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", + "description": "Deletes an Endpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.endpoints.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the Model resource to be deleted. Format: `projects/{project}/locations/{location}/models/{model}`", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "description": "Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "deleteVersion": { - "id": "aiplatform.projects.locations.models.deleteVersion", - "path": "v1/{+name}:deleteVersion", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion", - "httpMethod": "DELETE", + "deployModel": { + "description": "Deploys a Model into this Endpoint, creating a DeployedModel within it.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.deployModel", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "name": { - "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/[^/]+$", + "endpoint": { + "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/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+endpoint}:deployModel", + "request": { + "$ref": "GoogleCloudAiplatformV1DeployModelRequest" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "mergeVersionAliases": { - "id": "aiplatform.projects.locations.models.mergeVersionAliases", - "path": "v1/{+name}:mergeVersionAliases", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases", + "directPredict": { + "description": "Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict", "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.directPredict", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "name": { - "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/[^/]+$", + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+endpoint}:directPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1DirectPredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1DirectPredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "directRawPredict": { + "description": "Perform an unary online prediction request to a gRPC model server for custom containers.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.directRawPredict", "parameterOrder": [ - "name" + "endpoint" ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:directRawPredict", "request": { - "$ref": "GoogleCloudAiplatformV1MergeVersionAliasesRequest" + "$ref": "GoogleCloudAiplatformV1DirectRawPredictRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1Model" + "$ref": "GoogleCloudAiplatformV1DirectRawPredictResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Merges a set of aliases for a Model version." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "export": { - "id": "aiplatform.projects.locations.models.export", - "path": "v1/{+name}:export", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain", "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.explain", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "name": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+endpoint}:explain", + "request": { + "$ref": "GoogleCloudAiplatformV1ExplainRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ExplainResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "fetchPredictOperation": { + "description": "Fetch an asynchronous online prediction operation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.fetchPredictOperation", "parameterOrder": [ - "name" + "endpoint" ], + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:fetchPredictOperation", "request": { - "$ref": "GoogleCloudAiplatformV1ExportModelRequest" + "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "copy": { - "id": "aiplatform.projects.locations.models.copy", - "path": "v1/{+parent}/models:copy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models:copy", + "generateContent": { + "description": "Generate content with multimodal inputs.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent", "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.generateContent", + "parameterOrder": [ + "model" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location into which to copy the Model. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+model}:generateContent", "request": { - "$ref": "GoogleCloudAiplatformV1CopyModelRequest" + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "get": { + "description": "Gets an Endpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.get", + "parameterOrder": [ + "name" ], - "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." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.models.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { + "name": { + "description": "Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Endpoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Endpoints in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "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", + "type": "string" }, - "get": { - "id": "aiplatform.projects.locations.models.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." + "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.", + "location": "query", + "type": "string" }, - "delete": { - "id": "aiplatform.projects.locations.models.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." + "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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", + "type": "string" }, - "cancel": { - "id": "aiplatform.projects.locations.models.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "wait": { - "id": "aiplatform.projects.locations.models.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." + "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" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } - } + }, + "path": "v1/{+parent}/endpoints", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEndpointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "evaluations": { + "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).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.mutateDeployedModel", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:mutateDeployedModel", + "request": { + "$ref": "GoogleCloudAiplatformV1MutateDeployedModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Endpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.endpoints.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the Endpoint.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Endpoint" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Endpoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "predict": { + "description": "", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predictLongRunning": { + "description": "", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.predictLongRunning", + "parameterOrder": [ + "endpoint" + ], + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predictLongRunning", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.rawPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:rawPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1RawPredictRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "serverStreamingPredict": { + "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.serverStreamingPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:serverStreamingPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1StreamingPredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1StreamingPredictResponse" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.streamGenerateContent", + "parameterOrder": [ + "model" + ], + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:streamGenerateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "streamRawPredict": { + "description": "Perform a streaming online prediction with an arbitrary HTTP payload.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.streamRawPredict", + "parameterOrder": [ + "endpoint" + ], + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:streamRawPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "undeployModel": { + "description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.undeployModel", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:undeployModel", + "request": { + "$ref": "GoogleCloudAiplatformV1UndeployModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Updates an Endpoint with a long running operation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the Endpoint.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:update", + "request": { + "$ref": "GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "chat": { "methods": { - "import": { - "id": "aiplatform.projects.locations.models.evaluations.import", - "path": "v1/{+parent}/evaluations:import", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import", + "completions": { + "description": "Exposes an OpenAI-compatible endpoint for chat completions.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions", "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.chat.completions", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "parent": { - "description": "Required. The name of the parent model resource. Format: `projects/{project}/locations/{location}/models/{model}`", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "endpoint": { + "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+endpoint}/chat/completions", "request": { - "$ref": "GoogleCloudAiplatformV1ImportModelEvaluationRequest" + "$ref": "GoogleApiHttpBody" }, "response": { - "$ref": "GoogleCloudAiplatformV1ModelEvaluation" + "$ref": "GoogleApiHttpBody" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Imports an externally generated ModelEvaluation." - }, - "get": { - "id": "aiplatform.projects.locations.models.evaluations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the ModelEvaluation resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ModelEvaluation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a ModelEvaluation." - }, - "list": { - "id": "aiplatform.projects.locations.models.evaluations.list", - "path": "v1/{+parent}/evaluations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project}/locations/{location}/models/{model}`", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListModelEvaluationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists ModelEvaluations in a Model." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] } - }, + } + }, + "deployedModels": { "resources": { - "operations": { + "invoke": { "methods": { - "list": { - "id": "aiplatform.projects.locations.models.evaluations.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke", "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "endpoint", + "deployedModelId", + "invokeId" ], - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." - }, - "get": { - "id": "aiplatform.projects.locations.models.evaluations.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", "location": "path", "required": true, "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.models.evaluations.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.projects.locations.models.evaluations.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + }, + "invokeId": { "location": "path", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.models.evaluations.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } + "path": "v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}", + "request": { + "$ref": "GoogleCloudAiplatformV1InvokeRequest" }, - "parameterOrder": [ - "name" - ], "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleApiHttpBody" }, "scopes": [ - "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." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] } } - }, - "slices": { + } + } + }, + "google": { + "resources": { + "science": { "methods": { - "batchImport": { - "id": "aiplatform.projects.locations.models.evaluations.slices.batchImport", - "path": "v1/{+parent}:batchImport", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport", + "inference": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/google/science/inference", "httpMethod": "POST", - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Imports a list of externally generated EvaluatedAnnotations." - }, - "get": { - "id": "aiplatform.projects.locations.models.evaluations.slices.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.endpoints.google.science.inference", "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ModelEvaluationSlice" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "endpoint" ], - "description": "Gets a ModelEvaluationSlice." - }, - "list": { - "id": "aiplatform.projects.locations.models.evaluations.slices.list", - "path": "v1/{+parent}/slices", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices", - "httpMethod": "GET", "parameters": { - "parent": { - "description": "Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter. * `slice.dimension` - for =.", + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", "location": "query", "type": "string" }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call.", - "location": "query", + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/google$", + "required": true, "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+endpoint}/science/inference", + "request": { + "$ref": "GoogleApiHttpBody" + }, "response": { - "$ref": "GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse" + "$ref": "GoogleApiHttpBody" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists ModelEvaluationSlices in a ModelEvaluation." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] } } } } - } - } - }, - "notebookRuntimeTemplates": { - "methods": { - "setIamPolicy": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy", - "httpMethod": "POST", - "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/[^/]+/notebookRuntimeTemplates/[^/]+$", - "location": "path", - "required": true, - "type": "string" + }, + "invoke": { + "methods": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.invoke.invoke", + "parameterOrder": [ + "endpoint", + "invokeId" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "invokeId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/invoke/{+invokeId}", + "request": { + "$ref": "GoogleCloudAiplatformV1InvokeRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] } - }, - "parameterOrder": [ - "resource" - ], - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." + } }, - "getIamPolicy": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy", - "httpMethod": "POST", - "parameters": { - "resource": { - "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/[^/]+/notebookRuntimeTemplates/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "openapi": { + "methods": { + "completions": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/completions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.openapi.completions", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/completions", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "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).", - "location": "query", - "type": "integer", - "format": "int32" + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.openapi.embeddings", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/embeddings", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/responses", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.openapi.responses", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/responses", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] } - }, - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "GoogleIamV1Policy" - }, - "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." + } }, - "testIamPermissions": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions", - "httpMethod": "POST", - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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).", - "location": "query", - "repeated": true, - "type": "string" - } - }, - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." - }, - "create": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.create", - "path": "v1/{+parent}/notebookRuntimeTemplates", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "notebookRuntimeTemplateId": { - "description": "Optional. User specified ID for the notebook runtime template.", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a NotebookRuntimeTemplate." - }, - "get": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a NotebookRuntimeTemplate." - }, - "list": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.list", - "path": "v1/{+parent}/notebookRuntimeTemplates", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists NotebookRuntimeTemplates in a Location." - }, - "delete": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a NotebookRuntimeTemplate." - }, - "patch": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "The resource name of the NotebookRuntimeTemplate.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: \"${updated_filed}\"}` Updatable fields: * `encryption_spec.kms_key_name`", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a NotebookRuntimeTemplate." - } - }, - "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.endpoints.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", - "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "featureOnlineStores": { + "evaluationItems": { "methods": { - "setIamPolicy": { - "id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", + "create": { + "description": "Creates an Evaluation Item.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", "httpMethod": "POST", - "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/[^/]+/featureOnlineStores/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.evaluationItems.create", "parameterOrder": [ - "resource" - ], - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "parent" ], - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." - }, - "getIamPolicy": { - "id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy", - "httpMethod": "POST", "parameters": { - "resource": { - "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/[^/]+/featureOnlineStores/[^/]+$", + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - }, - "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).", - "location": "query", - "type": "integer", - "format": "int32" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+parent}/evaluationItems", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationItem" + }, "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleCloudAiplatformV1EvaluationItem" }, "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." + ] }, - "testIamPermissions": { - "id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", - "httpMethod": "POST", - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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).", - "location": "query", - "repeated": true, - "type": "string" - } - }, + "delete": { + "description": "Deletes an Evaluation Item.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationItems.delete", "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "name" ], - "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." - }, - "create": { - "id": "aiplatform.projects.locations.featureOnlineStores.create", - "path": "v1/{+parent}/featureOnlineStores", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", - "httpMethod": "POST", "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "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/[^/]+$", "required": true, "type": "string" - }, - "featureOnlineStoreId": { - "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", - "type": "string" } }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" - }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a new FeatureOnlineStore in a given project and location." + ] }, "get": { - "id": "aiplatform.projects.locations.featureOnlineStores.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "description": "Gets an Evaluation Item.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the FeatureOnlineStore resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" + "$ref": "GoogleCloudAiplatformV1EvaluationItem" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets details of a single FeatureOnlineStore." + ] }, "list": { - "id": "aiplatform.projects.locations.featureOnlineStores.list", - "path": "v1/{+parent}/featureOnlineStores", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", + "description": "Lists Evaluation Items.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, + "filter": { + "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).", + "location": "query", "type": "string" }, - "filter": { - "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\".", + "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": { - "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.", + "description": "Optional. The maximum number of Evaluation Items to return.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "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.", + "description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, - "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`", - "location": "query", + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/evaluationItems", "response": { - "$ref": "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse" + "$ref": "GoogleCloudAiplatformV1ListEvaluationItemsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists FeatureOnlineStores in a given project and location." - }, - "patch": { - "id": "aiplatform.projects.locations.featureOnlineStores.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", - "httpMethod": "PATCH", + ] + } + } + }, + "evaluationRuns": { + "methods": { + "cancel": { + "description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationRuns.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", "required": true, "type": "string" - }, - "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`", - "location": "query", - "type": "string", - "format": "google-fieldmask" } }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelEvaluationRunRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates an Evaluation Run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationRuns.create", "parameterOrder": [ - "name" + "parent" ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationRuns", "request": { - "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" + "$ref": "GoogleCloudAiplatformV1EvaluationRun" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1EvaluationRun" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates the parameters of a single FeatureOnlineStore." + ] }, "delete": { - "id": "aiplatform.projects.locations.featureOnlineStores.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "description": "Deletes an Evaluation Run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationRuns.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", "required": true, "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Runs.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "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).", + "location": "query", + "type": "string" }, - "force": { - "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.)", + "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": "boolean" + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Runs to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationRuns", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEvaluationRunsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "evaluationSets": { + "methods": { + "create": { + "description": "Creates an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationSets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" } }, + "path": "v1/{+parent}/evaluationSets", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationSets.delete", "parameterOrder": [ "name" ], + "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" + } + }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Sets.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.list", + "parameterOrder": [ + "parent" ], - "description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews." - } - }, - "resources": { - "featureViews": { - "methods": { - "setIamPolicy": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy", - "httpMethod": "POST", - "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/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "resource" - ], - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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": { + "filter": { + "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).", + "location": "query", + "type": "string" }, - "getIamPolicy": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy", - "httpMethod": "POST", - "parameters": { - "resource": { - "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/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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).", - "location": "query", - "type": "integer", - "format": "int32" - } - }, - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "GoogleIamV1Policy" - }, - "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." + "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" }, - "testIamPermissions": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions", - "httpMethod": "POST", - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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).", - "location": "query", - "repeated": true, - "type": "string" - } - }, - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + "pageSize": { + "description": "Optional. The maximum number of Evaluation Sets to return.", + "format": "int32", + "location": "query", + "type": "integer" }, - "create": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create", - "path": "v1/{+parent}/featureViews", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "featureViewId": { - "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.", - "location": "query", - "type": "string" - }, - "runSyncImmediately": { - "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", - "type": "boolean" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1FeatureView" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a new FeatureView in a given FeatureOnlineStore." + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" }, - "get": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1FeatureView" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets details of a single FeatureView." + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationSets", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEvaluationSetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.evaluationSets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" }, - "list": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list", - "path": "v1/{+parent}/featureViews", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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.", - "location": "query", - "type": "string" - }, - "pageSize": { - "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.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "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", - "type": "string" - }, - "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: * `feature_view_id` * `create_time` * `update_time`", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListFeatureViewsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists FeatureViews in a given FeatureOnlineStore." + "updateMask": { + "description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "featureGroups": { + "methods": { + "create": { + "description": "Creates a new FeatureGroup in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureGroupId": { + "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.", + "location": "query", + "type": "string" }, - "patch": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "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`", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1FeatureView" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates the parameters of a single FeatureView." + "parent": { + "description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/featureGroups", + "request": { + "$ref": "GoogleCloudAiplatformV1FeatureGroup" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "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.)", + "location": "query", + "type": "boolean" }, - "delete": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", - "httpMethod": "DELETE", + "name": { + "description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureGroup resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1FeatureGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "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" + }, + "resource": { + "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/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureGroups in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", + "location": "query", + "type": "string" + }, + "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`", + "location": "query", + "type": "string" + }, + "pageSize": { + "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", + "location": "query", + "type": "integer" + }, + "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/featureGroups", + "response": { + "$ref": "GoogleCloudAiplatformV1ListFeatureGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + }, + "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" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1FeatureGroup" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "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).", + "location": "query", + "repeated": true, + "type": "string" + }, + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "features": { + "methods": { + "batchCreate": { + "description": "Creates a batch of Features in a given FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.batchCreate", + "parameterOrder": [ + "parent" + ], "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/[^/]+$", + "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/features:batchCreate", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a single FeatureView." + ] }, - "sync": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync", - "path": "v1/{+featureView}:sync", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", + "create": { + "description": "Creates a new Feature in a given FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "featureView": { - "description": "Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "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.", + "location": "query", + "type": "string" + }, + "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "featureView" - ], + "path": "v1/{+parent}/features", "request": { - "$ref": "GoogleCloudAiplatformV1SyncFeatureViewRequest" + "$ref": "GoogleCloudAiplatformV1Feature" }, "response": { - "$ref": "GoogleCloudAiplatformV1SyncFeatureViewResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Triggers on-demand sync for the FeatureView." + ] }, - "fetchFeatureValues": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues", - "path": "v1/{+featureView}:fetchFeatureValues", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues", - "httpMethod": "POST", + "delete": { + "description": "Deletes a single Feature.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.features.delete", + "parameterOrder": [ + "name" + ], "parameters": { - "featureView": { - "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "name": { + "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "featureView" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1FetchFeatureValuesRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Fetch feature values under a FeatureView." + ] }, - "searchNearestEntities": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities", - "path": "v1/{+featureView}:searchNearestEntities", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities", - "httpMethod": "POST", + "get": { + "description": "Gets details of a single Feature.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.get", + "parameterOrder": [ + "name" + ], "parameters": { - "featureView": { - "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "name": { + "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/[^/]+/featureGroups/[^/]+/features/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "featureView" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1SearchNearestEntitiesRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1SearchNearestEntitiesResponse" + "$ref": "GoogleCloudAiplatformV1Feature" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "directWrite": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite", - "path": "v1/{+featureView}:directWrite", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite", - "httpMethod": "POST", + "list": { + "description": "Lists Features in a given FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "featureView": { - "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "filter": { + "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", + "location": "query", + "type": "string" + }, + "latestStatsCount": { + "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 < ListFeaturesRequest.latest_stats_count, return all existing stats.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "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", + "location": "query", + "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" + }, + "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "featureView" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequest" - }, + "path": "v1/{+parent}/features", "response": { - "$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteResponse" + "$ref": "GoogleCloudAiplatformV1ListFeaturesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "generateFetchAccessToken": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken", - "path": "v1/{+featureView}:generateFetchAccessToken", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken", - "httpMethod": "POST", + "patch": { + "description": "Updates the parameters of a single Feature.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.features.patch", + "parameterOrder": [ + "name" + ], "parameters": { - "featureView": { - "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", "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)", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "featureView" - ], + "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest" + "$ref": "GoogleCloudAiplatformV1Feature" }, "response": { - "$ref": "GoogleCloudAiplatformV1GenerateFetchAccessTokenResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token." + ] } }, "resources": { "operations": { "methods": { - "listWait": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", + "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": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.features.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.operations.listWait", + "parameterOrder": [ + "name" + ], + "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -11416,177 +11739,49 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.operations.wait", "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - }, - "featureViewSyncs": { - "methods": { - "get": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1FeatureViewSync" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets details of a single FeatureViewSync." - }, - "list": { - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list", - "path": "v1/{+parent}/featureViewSyncs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "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.", - "location": "query", - "type": "string" - }, - "pageSize": { - "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", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "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", - "type": "string" - }, - "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`", + "format": "google-duration", "location": "query", "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1ListFeatureViewSyncsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists FeatureViewSyncs in a given FeatureView." + ] } } } @@ -11594,2371 +11789,2383 @@ }, "operations": { "methods": { - "listWait": { - "id": "aiplatform.projects.locations.featureOnlineStores.operations.listWait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", - "httpMethod": "GET", + "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": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.featureOnlineStores.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.featureOnlineStores.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", - "httpMethod": "DELETE", + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.operations.listWait", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.featureOnlineStores.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "featureGroups": { + "featureOnlineStores": { "methods": { - "setIamPolicy": { - "id": "aiplatform.projects.locations.featureGroups.setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy", + "create": { + "description": "Creates a new FeatureOnlineStore in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.create", + "parameterOrder": [ + "parent" + ], "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/[^/]+/featureGroups/[^/]+$", + "featureOnlineStoreId": { + "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", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+parent}/featureOnlineStores", "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" }, "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." + ] }, - "getIamPolicy": { - "id": "aiplatform.projects.locations.featureGroups.getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy", - "httpMethod": "POST", + "delete": { + "description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.delete", + "parameterOrder": [ + "name" + ], "parameters": { - "resource": { - "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/[^/]+$", + "force": { + "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.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" - }, - "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).", - "location": "query", - "type": "integer", - "format": "int32" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleLongrunningOperation" }, "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." + ] }, - "testIamPermissions": { - "id": "aiplatform.projects.locations.featureGroups.testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions", - "httpMethod": "POST", + "get": { + "description": "Gets details of a single FeatureOnlineStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.get", + "parameterOrder": [ + "name" + ], "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "name": { + "description": "Required. The name of the FeatureOnlineStore resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" - }, - "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).", - "location": "query", - "repeated": true, - "type": "string" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "create": { - "id": "aiplatform.projects.locations.featureGroups.create", - "path": "v1/{+parent}/featureGroups", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy", "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "featureGroupId": { - "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.", - "location": "query", - "type": "string" - } - }, + "id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy", "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1FeatureGroup" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "resource" ], - "description": "Creates a new FeatureGroup in a given project and location." - }, - "get": { - "id": "aiplatform.projects.locations.featureGroups.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", - "httpMethod": "GET", "parameters": { - "name": { - "description": "Required. The name of the FeatureGroup resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "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" + }, + "resource": { + "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/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+resource}:getIamPolicy", "response": { - "$ref": "GoogleCloudAiplatformV1FeatureGroup" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets details of a single FeatureGroup." + ] }, "list": { - "id": "aiplatform.projects.locations.featureGroups.list", - "path": "v1/{+parent}/featureGroups", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "description": "Lists FeatureOnlineStores in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".", + "location": "query", "type": "string" }, - "filter": { - "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\".", + "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`", "location": "query", "type": "string" }, "pageSize": { - "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.", + "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "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.", + "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.", "location": "query", "type": "string" }, - "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`", - "location": "query", + "parent": { + "description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/featureOnlineStores", "response": { - "$ref": "GoogleCloudAiplatformV1ListFeatureGroupsResponse" + "$ref": "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists FeatureGroups in a given project and location." + ] }, "patch": { - "id": "aiplatform.projects.locations.featureGroups.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "description": "Updates the parameters of a single FeatureOnlineStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureOnlineStores.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" }, "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`", + "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`", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-fieldmask" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1FeatureGroup" + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates the parameters of a single FeatureGroup." + ] }, - "delete": { - "id": "aiplatform.projects.locations.featureGroups.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", - "httpMethod": "DELETE", + "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": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy", + "parameterOrder": [ + "resource" + ], "parameters": { - "name": { - "description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" - }, - "force": { - "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.)", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions", + "parameterOrder": [ + "resource" ], - "description": "Deletes a single FeatureGroup." - } - }, - "resources": { - "operations": { - "methods": { - "listWait": { - "id": "aiplatform.projects.locations.featureGroups.operations.listWait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", - "httpMethod": "GET", + "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).", + "location": "query", + "repeated": true, + "type": "string" + }, + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "featureViews": { + "methods": { + "create": { + "description": "Creates a new FeatureView in a given FeatureOnlineStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", + "featureViewId": { + "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.", "location": "query", "type": "string" }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", + "parent": { + "description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "runSyncImmediately": { + "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", "type": "boolean" } }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.featureGroups.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } + "path": "v1/{+parent}/featureViews", + "request": { + "$ref": "GoogleCloudAiplatformV1FeatureView" }, - "parameterOrder": [ - "name" - ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.featureGroups.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "description": "Deletes a single FeatureView.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.featureGroups.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite", + "parameterOrder": [ + "featureView" + ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "featureView": { + "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+featureView}:directWrite", + "request": { + "$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteResponse" }, "scopes": [ "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." - } - } - }, - "features": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.featureGroups.features.create", - "path": "v1/{+parent}/features", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + ] + }, + "fetchFeatureValues": { + "description": "Fetch feature values under a FeatureView.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues", + "parameterOrder": [ + "featureView" + ], "parameters": { - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "featureView": { + "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "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.", - "location": "query", - "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+featureView}:fetchFeatureValues", "request": { - "$ref": "GoogleCloudAiplatformV1Feature" + "$ref": "GoogleCloudAiplatformV1FetchFeatureValuesRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a new Feature in a given FeatureGroup." + ] }, - "batchCreate": { - "id": "aiplatform.projects.locations.featureGroups.features.batchCreate", - "path": "v1/{+parent}/features:batchCreate", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate", + "generateFetchAccessToken": { + "description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken", + "parameterOrder": [ + "featureView" + ], "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/[^/]+/featureGroups/[^/]+$", + "featureView": { + "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+featureView}:generateFetchAccessToken", "request": { - "$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest" + "$ref": "GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1GenerateFetchAccessTokenResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a batch of Features in a given FeatureGroup." + ] }, "get": { - "id": "aiplatform.projects.locations.featureGroups.features.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "description": "Gets details of a single FeatureView.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1FeatureView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy", "parameterOrder": [ - "name" + "resource" ], + "parameters": { + "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" + }, + "resource": { + "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/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", "response": { - "$ref": "GoogleCloudAiplatformV1Feature" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets details of a single Feature." + ] }, "list": { - "id": "aiplatform.projects.locations.featureGroups.features.list", - "path": "v1/{+parent}/features", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "description": "Lists FeatureViews in a given FeatureOnlineStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list", + "parameterOrder": [ + "parent" + ], "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/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.", + "location": "query", "type": "string" }, - "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.", + "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: * `feature_view_id` * `create_time` * `update_time`", "location": "query", "type": "string" }, "pageSize": { - "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.", + "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "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.", + "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", "type": "string" }, - "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: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", - "location": "query", + "parent": { + "description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "latestStatsCount": { - "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", - "type": "integer", - "format": "int32" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/featureViews", "response": { - "$ref": "GoogleCloudAiplatformV1ListFeaturesResponse" + "$ref": "GoogleCloudAiplatformV1ListFeatureViewsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Features in a given FeatureGroup." + ] }, "patch": { - "id": "aiplatform.projects.locations.featureGroups.features.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "description": "Updates the parameters of a single FeatureView.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch", + "parameterOrder": [ + "name" + ], "parameters": { "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "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)", + "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", "location": "query", - "type": "string", - "format": "google-fieldmask" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1Feature" + "$ref": "GoogleCloudAiplatformV1FeatureView" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchNearestEntities": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities", + "parameterOrder": [ + "featureView" ], - "description": "Updates the parameters of a single Feature." + "parameters": { + "featureView": { + "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+featureView}:searchNearestEntities", + "request": { + "$ref": "GoogleCloudAiplatformV1SearchNearestEntitiesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1SearchNearestEntitiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "delete": { - "id": "aiplatform.projects.locations.featureGroups.features.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", - "httpMethod": "DELETE", + "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": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy", + "parameterOrder": [ + "resource" + ], "parameters": { - "name": { - "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/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "sync": { + "description": "Triggers on-demand sync for the FeatureView.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync", "parameterOrder": [ - "name" + "featureView" ], + "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" + } + }, + "path": "v1/{+featureView}:sync", + "request": { + "$ref": "GoogleCloudAiplatformV1SyncFeatureViewRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1SyncFeatureViewResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions", + "parameterOrder": [ + "resource" ], - "description": "Deletes a single Feature." + "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).", + "location": "query", + "repeated": true, + "type": "string" + }, + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { - "operations": { + "featureViewSyncs": { "methods": { - "listWait": { - "id": "aiplatform.projects.locations.featureGroups.features.operations.listWait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "get": { + "description": "Gets details of a single FeatureViewSync.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$", "required": true, "type": "string" - }, + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1FeatureViewSync" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureViewSyncs in a given FeatureView.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { "filter": { - "description": "The standard list filter.", + "description": "Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.", + "location": "query", + "type": "string" + }, + "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" }, "pageSize": { - "description": "The standard list page size.", + "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "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", "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" + "parent": { + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/featureViewSyncs", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1ListFeatureViewSyncsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete", + "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": { - "id": "aiplatform.projects.locations.featureGroups.features.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.featureGroups.features.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", - "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait", "parameterOrder": [ "name" ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.featureGroups.features.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.listWait", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, - "datasets": { + "featurestores": { "methods": { - "setIamPolicy": { - "id": "aiplatform.projects.locations.datasets.setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:setIamPolicy", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.batchReadFeatureValues", + "parameterOrder": [ + "featurestore" + ], "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/[^/]+/datasets/[^/]+$", + "featurestore": { + "description": "Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+featurestore}:batchReadFeatureValues", "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" + "$ref": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequest" }, "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." + ] }, - "getIamPolicy": { - "id": "aiplatform.projects.locations.datasets.getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:getIamPolicy", + "create": { + "description": "Creates a new Featurestore in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "resource": { - "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/[^/]+/datasets/[^/]+$", + "featurestoreId": { + "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - }, - "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).", - "location": "query", - "type": "integer", - "format": "int32" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+parent}/featurestores", + "request": { + "$ref": "GoogleCloudAiplatformV1Featurestore" + }, "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleLongrunningOperation" }, "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." + ] }, - "testIamPermissions": { - "id": "aiplatform.projects.locations.datasets.testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:testIamPermissions", - "httpMethod": "POST", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.delete", + "parameterOrder": [ + "name" + ], "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "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": { + "description": "Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" - }, - "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).", - "location": "query", - "repeated": true, - "type": "string" } }, - "parameterOrder": [ - "resource" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "create": { - "id": "aiplatform.projects.locations.datasets.create", - "path": "v1/{+parent}/datasets", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", - "httpMethod": "POST", + "get": { + "description": "Gets details of a single Featurestore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.get", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "name": { + "description": "Required. The name of the Featurestore resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Featurestore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.getIamPolicy", "parameterOrder": [ - "parent" + "resource" ], - "request": { - "$ref": "GoogleCloudAiplatformV1Dataset" + "parameters": { + "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" + }, + "resource": { + "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/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+resource}:getIamPolicy", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a Dataset." + ] }, - "get": { - "id": "aiplatform.projects.locations.datasets.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "list": { + "description": "Lists Featurestores in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores", "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "Required. The name of the Dataset resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "filter": { + "description": "Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` Featurestores created or updated after 2020-01-01. * `labels.env = \"prod\"` Featurestores with label \"env\" set to \"prod\".", + "location": "query", + "type": "string" + }, + "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` * `online_serving_config.fixed_node_count`", + "location": "query", + "type": "string" + }, + "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": { + "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "readMask": { "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-fieldmask" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/featurestores", "response": { - "$ref": "GoogleCloudAiplatformV1Dataset" + "$ref": "GoogleCloudAiplatformV1ListFeaturestoresResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a Dataset." + ] }, "patch": { - "id": "aiplatform.projects.locations.datasets.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "description": "Updates the parameters of a single Featurestore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featurestores.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`", + "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`", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-fieldmask" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1Dataset" + "$ref": "GoogleCloudAiplatformV1Featurestore" }, "response": { - "$ref": "GoogleCloudAiplatformV1Dataset" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a Dataset." + ] }, - "list": { - "id": "aiplatform.projects.locations.datasets.list", - "path": "v1/{+parent}/datasets", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", + "searchFeatures": { + "description": "Searches Features matching a query in a given project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures", "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.searchFeatures", + "parameterOrder": [ + "location" + ], "parameters": { - "parent": { - "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": { + "description": "Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, - "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" - }, "pageSize": { - "description": "The standard list page size.", + "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "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.", "location": "query", "type": "string" }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "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: * `display_name` * `create_time` * `update_time`", + "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` --> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --> 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\"` --> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with `env` as the key.", "location": "query", "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+location}/featurestores:searchFeatures", "response": { - "$ref": "GoogleCloudAiplatformV1ListDatasetsResponse" + "$ref": "GoogleCloudAiplatformV1SearchFeaturesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Datasets in a Location." + ] }, - "delete": { - "id": "aiplatform.projects.locations.datasets.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", - "httpMethod": "DELETE", + "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": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.setIamPolicy", + "parameterOrder": [ + "resource" + ], "parameters": { - "name": { - "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a Dataset." + ] }, - "import": { - "id": "aiplatform.projects.locations.datasets.import", - "path": "v1/{+name}:import", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.testIamPermissions", + "parameterOrder": [ + "resource" + ], "parameters": { - "name": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "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).", + "location": "query", + "repeated": true, + "type": "string" + }, + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ImportDataRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Imports data into a Dataset." - }, - "export": { - "id": "aiplatform.projects.locations.datasets.export", - "path": "v1/{+name}:export", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ExportDataRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Exports data from a Dataset." - }, - "searchDataItems": { - "id": "aiplatform.projects.locations.datasets.searchDataItems", - "path": "v1/{+dataset}:searchDataItems", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems", - "httpMethod": "GET", - "parameters": { - "dataset": { - "description": "Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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" - }, - "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" - }, - "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" - }, - "savedQuery": { - "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.", - "location": "query", - "deprecated": true, - "type": "string" - }, - "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.", - "location": "query", - "type": "string" - }, - "dataItemFilter": { - "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", - "type": "string" - }, - "annotationsFilter": { - "description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.", - "location": "query", - "deprecated": true, - "type": "string" - }, - "annotationFilters": { - "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", - "repeated": true, - "type": "string" - }, - "fieldMask": { - "description": "Mask specifying which fields of DataItemView to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "annotationsLimit": { - "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.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageSize": { - "description": "Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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", - "deprecated": true, - "type": "string" - }, - "pageToken": { - "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.", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [ - "dataset" - ], + "path": "v1/{+resource}:testIamPermissions", "response": { - "$ref": "GoogleCloudAiplatformV1SearchDataItemsResponse" + "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Searches DataItems in a Dataset." + ] } }, "resources": { - "operations": { + "entityTypes": { "methods": { - "list": { - "id": "aiplatform.projects.locations.datasets.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations", - "httpMethod": "GET", + "create": { + "description": "Creates a new EntityType in a given Featurestore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token.", + "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.", "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.datasets.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/entityTypes", + "request": { + "$ref": "GoogleCloudAiplatformV1EntityType" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.datasets.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", + "description": "Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.featurestores.entityTypes.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`." - }, - "cancel": { - "id": "aiplatform.projects.locations.datasets.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", "parameters": { + "force": { + "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.)", + "location": "query", + "type": "boolean" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "description": "Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.datasets.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues", + "parameterOrder": [ + "entityType" + ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "entityType": { + "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+entityType}:deleteFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesRequest" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - }, - "datasetVersions": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.datasets.datasetVersions.create", - "path": "v1/{+parent}/datasetVersions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", + ] + }, + "exportFeatureValues": { + "description": "Exports Feature values from all the entities of a target EntityType.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues", + "parameterOrder": [ + "entityType" + ], "parameters": { - "parent": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "entityType": { + "description": "Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+entityType}:exportFeatureValues", "request": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" + "$ref": "GoogleCloudAiplatformV1ExportFeatureValuesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Create a version from a Dataset." + ] }, - "patch": { - "id": "aiplatform.projects.locations.datasets.datasetVersions.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "PATCH", + "get": { + "description": "Gets details of a single EntityType.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "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/[^/]+$", + "description": "Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`", - "location": "query", - "type": "string", - "format": "google-fieldmask" } }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" + "$ref": "GoogleCloudAiplatformV1EntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a DatasetVersion." + ] }, - "delete": { - "id": "aiplatform.projects.locations.datasets.datasetVersions.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "DELETE", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy", + "parameterOrder": [ + "resource" + ], "parameters": { - "name": { - "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "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" + }, + "resource": { + "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/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+resource}:getIamPolicy", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a Dataset version." + ] }, - "get": { - "id": "aiplatform.projects.locations.datasets.datasetVersions.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "GET", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues", + "parameterOrder": [ + "entityType" + ], "parameters": { - "name": { - "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "entityType": { + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+entityType}:importFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1ImportFeatureValuesRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a Dataset version." + ] }, "list": { - "id": "aiplatform.projects.locations.datasets.datasetVersions.list", - "path": "v1/{+parent}/datasetVersions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", + "description": "Lists EntityTypes in a given Featurestore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any EntityType which has a label with 'env' as the key.", + "location": "query", "type": "string" }, - "filter": { - "description": "Optional. The standard list filter.", + "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: * `entity_type_id` * `create_time` * `update_time`", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token.", + "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": { - "description": "Optional. Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" + "parent": { + "description": "Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "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.", + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/entityTypes", "response": { - "$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse" + "$ref": "GoogleCloudAiplatformV1ListEntityTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists DatasetVersions in a Dataset." + ] }, - "restore": { - "id": "aiplatform.projects.locations.datasets.datasetVersions.restore", - "path": "v1/{+name}:restore", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", - "httpMethod": "GET", + "patch": { + "description": "Updates the parameters of a single EntityType.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featurestores.entityTypes.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" + }, + "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`", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1EntityType" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1EntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "readFeatureValues": { + "description": "Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues", + "parameterOrder": [ + "entityType" ], - "description": "Restores a dataset version." - } - } - }, - "dataItems": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.datasets.dataItems.list", - "path": "v1/{+parent}/dataItems", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems", - "httpMethod": "GET", "parameters": { - "parent": { - "description": "Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "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" } }, - "parameterOrder": [ - "parent" + "path": "v1/{+entityType}:readFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy", + "parameterOrder": [ + "resource" ], + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1ListDataItemsResponse" + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "streamingReadFeatureValues": { + "description": "Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues", + "parameterOrder": [ + "entityType" + ], + "parameters": { + "entityType": { + "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`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+entityType}:streamingReadFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "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).", + "location": "query", + "repeated": true, + "type": "string" + }, + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "writeFeatureValues": { + "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": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues", + "parameterOrder": [ + "entityType" ], - "description": "Lists DataItems in a Dataset." + "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`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+entityType}:writeFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1WriteFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1WriteFeatureValuesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { - "operations": { + "features": { "methods": { - "list": { - "id": "aiplatform.projects.locations.datasets.dataItems.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", - "httpMethod": "GET", + "batchCreate": { + "description": "Creates a batch of Features in a given EntityType.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", + "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/features:batchCreate", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.datasets.dataItems.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", - "httpMethod": "GET", + "create": { + "description": "Creates a new Feature in a given EntityType.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "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.", + "location": "query", + "type": "string" + }, + "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/features", + "request": { + "$ref": "GoogleCloudAiplatformV1Feature" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.datasets.dataItems.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "description": "Deletes a single Feature.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.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`." - }, - "cancel": { - "id": "aiplatform.projects.locations.datasets.dataItems.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.datasets.dataItems.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "get": { + "description": "Gets details of a single Feature.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "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/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1Feature" }, "scopes": [ "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." - } - } - }, - "annotations": { - "methods": { + ] + }, "list": { - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", - "path": "v1/{+parent}/annotations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", + "description": "Lists Features in a given EntityType.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", + "location": "query", "type": "string" }, - "filter": { - "description": "The standard list filter.", + "latestStatsCount": { + "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 < ListFeaturesRequest.latest_stats_count, return all existing stats.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "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", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "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" }, + "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}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, "readMask": { "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, + "path": "v1/{+parent}/features", + "response": { + "$ref": "GoogleCloudAiplatformV1ListFeaturesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Feature.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.patch", "parameterOrder": [ - "parent" + "name" ], + "parameters": { + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "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)", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Feature" + }, "response": { - "$ref": "GoogleCloudAiplatformV1ListAnnotationsResponse" + "$ref": "GoogleCloudAiplatformV1Feature" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Annotations belongs to a dataitem." + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", - "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } - } - } - }, - "savedQueries": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.datasets.savedQueries.list", - "path": "v1/{+parent}/savedQueries", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "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" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListSavedQueriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists SavedQueries in a Dataset." }, - "delete": { - "id": "aiplatform.projects.locations.datasets.savedQueries.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a SavedQuery." - } - }, - "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - } - } - }, - "annotationSpecs": { - "methods": { - "get": { - "id": "aiplatform.projects.locations.datasets.annotationSpecs.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", - "location": "path", - "required": true, - "type": "string" + ] }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1AnnotationSpec" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets an AnnotationSpec." - } - }, - "resources": { - "operations": { - "methods": { "list": { - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations", "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -13966,8064 +14173,9018 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}: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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, - "operations": { + "hyperparameterTuningJobs": { "methods": { - "list": { - "id": "aiplatform.projects.locations.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", - "httpMethod": "GET", + "cancel": { + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "description": "Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "create": { + "description": "Creates a HyperparameterTuningJob", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/hyperparameterTuningJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "description": "Deletes a HyperparameterTuningJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "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/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "get": { + "description": "Gets a HyperparameterTuningJob", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "description": "Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "list": { + "description": "Lists HyperparameterTuningJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` 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>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "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.", + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/hyperparameterTuningJobs", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse" }, "scopes": [ "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." + ] } - } - }, - "ragEngineConfig": { + }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.ragEngineConfig.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.ragEngineConfig.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.ragEngineConfig.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", - "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.ragEngineConfig.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "deploymentResourcePools": { + "indexEndpoints": { "methods": { "create": { - "id": "aiplatform.projects.locations.deploymentResourcePools.create", - "path": "v1/{+parent}/deploymentResourcePools", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", + "description": "Creates an IndexEndpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.create", + "parameterOrder": [ + "parent" + ], "parameters": { "parent": { - "description": "Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`", + "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/indexEndpoints", + "request": { + "$ref": "GoogleCloudAiplatformV1IndexEndpoint" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an IndexEndpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.indexEndpoints.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deployIndex": { + "description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.deployIndex", "parameterOrder": [ - "parent" + "indexEndpoint" ], + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+indexEndpoint}:deployIndex", "request": { - "$ref": "GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest" + "$ref": "GoogleCloudAiplatformV1DeployIndexRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "findNeighbors": { + "description": "Finds the nearest neighbors of each vector within the request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.findNeighbors", + "parameterOrder": [ + "indexEndpoint" ], - "description": "Create a DeploymentResourcePool." + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+indexEndpoint}:findNeighbors", + "request": { + "$ref": "GoogleCloudAiplatformV1FindNeighborsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1FindNeighborsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "get": { - "id": "aiplatform.projects.locations.deploymentResourcePools.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "description": "Gets an IndexEndpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexEndpoints.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "description": "Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" + "$ref": "GoogleCloudAiplatformV1IndexEndpoint" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Get a DeploymentResourcePool." + ] }, "list": { - "id": "aiplatform.projects.locations.deploymentResourcePools.list", - "path": "v1/{+parent}/deploymentResourcePools", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", + "description": "Lists IndexEndpoints in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexEndpoints.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, + "filter": { + "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\") -> The display name starts with an A. * `labels.myKey=\"myValue\"`", + "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.", + "description": "Optional. The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "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.", + "description": "Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/indexEndpoints", "response": { - "$ref": "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse" + "$ref": "GoogleCloudAiplatformV1ListIndexEndpointsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "List DeploymentResourcePools in a location." + ] }, - "patch": { - "id": "aiplatform.projects.locations.deploymentResourcePools.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", - "httpMethod": "PATCH", + "mutateDeployedIndex": { + "description": "Update an existing DeployedIndex under an IndexEndpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex", + "parameterOrder": [ + "indexEndpoint" + ], "parameters": { - "name": { - "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "indexEndpoint": { + "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Required. The list of fields to update.", - "location": "query", - "type": "string", - "format": "google-fieldmask" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+indexEndpoint}:mutateDeployedIndex", "request": { - "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" + "$ref": "GoogleCloudAiplatformV1DeployedIndex" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Update a DeploymentResourcePool." + ] }, - "delete": { - "id": "aiplatform.projects.locations.deploymentResourcePools.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", - "httpMethod": "DELETE", + "patch": { + "description": "Updates an IndexEndpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.indexEndpoints.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "description": "Output only. The resource name of the IndexEndpoint.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1IndexEndpoint" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1IndexEndpoint" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Delete a DeploymentResourcePool." + ] }, - "queryDeployedModels": { - "id": "aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels", - "path": "v1/{+deploymentResourcePool}:queryDeployedModels", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels", - "httpMethod": "GET", + "readIndexDatapoints": { + "description": "Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.readIndexDatapoints", + "parameterOrder": [ + "indexEndpoint" + ], "parameters": { - "deploymentResourcePool": { - "description": "Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "indexEndpoint": { + "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" - }, - "pageSize": { - "description": "The maximum number of DeployedModels to return. The service may return fewer than this value.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "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.", - "location": "query", - "type": "string" } }, - "parameterOrder": [ - "deploymentResourcePool" - ], + "path": "v1/{+indexEndpoint}:readIndexDatapoints", + "request": { + "$ref": "GoogleCloudAiplatformV1ReadIndexDatapointsRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1QueryDeployedModelsResponse" + "$ref": "GoogleCloudAiplatformV1ReadIndexDatapointsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "undeployIndex": { + "description": "Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.undeployIndex", + "parameterOrder": [ + "indexEndpoint" ], - "description": "List DeployedModels that have been deployed on this DeploymentResourcePool." + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+indexEndpoint}:undeployIndex", + "request": { + "$ref": "GoogleCloudAiplatformV1UndeployIndexRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.indexEndpoints.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", - "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexEndpoints.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexEndpoints.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "endpoints": { + "indexes": { "methods": { "create": { - "id": "aiplatform.projects.locations.endpoints.create", - "path": "v1/{+parent}/endpoints", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints", + "description": "Creates an Index.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes", "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexes.create", + "parameterOrder": [ + "parent" + ], "parameters": { "parent": { - "description": "Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - }, - "endpointId": { - "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.", - "location": "query", - "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/indexes", "request": { - "$ref": "GoogleCloudAiplatformV1Endpoint" + "$ref": "GoogleCloudAiplatformV1Index" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates an Endpoint." + ] }, - "get": { - "id": "aiplatform.projects.locations.endpoints.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", - "httpMethod": "GET", + "delete": { + "description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.indexes.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Index.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexes.get", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Endpoint" + "$ref": "GoogleCloudAiplatformV1Index" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets an Endpoint." + ] }, "list": { - "id": "aiplatform.projects.locations.endpoints.list", - "path": "v1/{+parent}/endpoints", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints", + "description": "Lists Indexes in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes", "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexes.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, "filter": { - "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\"`", + "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.", + "description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.", "location": "query", "type": "string" }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", - "location": "query", + "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/[^/]+$", + "required": true, "type": "string" }, - "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.", + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/indexes", "response": { - "$ref": "GoogleCloudAiplatformV1ListEndpointsResponse" + "$ref": "GoogleCloudAiplatformV1ListIndexesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Endpoints in a Location." + ] }, "patch": { - "id": "aiplatform.projects.locations.endpoints.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", + "description": "Updates an Index.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.indexes.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Output only. The resource name of the Endpoint.", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "description": "Output only. The resource name of the Index.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", + "description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Endpoint" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Endpoint" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates an Endpoint." - }, - "update": { - "id": "aiplatform.projects.locations.endpoints.update", - "path": "v1/{+name}:update", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Output only. The resource name of the Endpoint.", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates an Endpoint with a long running operation." - }, - "delete": { - "id": "aiplatform.projects.locations.endpoints.delete", "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes an Endpoint." - }, - "deployModel": { - "id": "aiplatform.projects.locations.endpoints.deployModel", - "path": "v1/{+endpoint}:deployModel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], "request": { - "$ref": "GoogleCloudAiplatformV1DeployModelRequest" + "$ref": "GoogleCloudAiplatformV1Index" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deploys a Model into this Endpoint, creating a DeployedModel within it." + ] }, - "undeployModel": { - "id": "aiplatform.projects.locations.endpoints.undeployModel", - "path": "v1/{+endpoint}:undeployModel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel", + "removeDatapoints": { + "description": "Remove Datapoints from an Index.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints", "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.indexes.removeDatapoints", "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1UndeployModelRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "index" ], - "description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using." - }, - "mutateDeployedModel": { - "id": "aiplatform.projects.locations.endpoints.mutateDeployedModel", - "path": "v1/{+endpoint}:mutateDeployedModel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel", - "httpMethod": "POST", "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "index": { + "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "endpoint" - ], + "path": "v1/{+index}:removeDatapoints", "request": { - "$ref": "GoogleCloudAiplatformV1MutateDeployedModelRequest" + "$ref": "GoogleCloudAiplatformV1RemoveDatapointsRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1RemoveDatapointsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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)." - }, - "predict": { - "id": "aiplatform.projects.locations.endpoints.predict", - "path": "v1/{+endpoint}:predict", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict", - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1PredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Perform an online prediction." + ] }, - "rawPredict": { - "id": "aiplatform.projects.locations.endpoints.rawPredict", - "path": "v1/{+endpoint}:rawPredict", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict", + "upsertDatapoints": { + "description": "Add/update Datapoints into an Index.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints", "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.indexes.upsertDatapoints", "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1RawPredictRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "index" ], - "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." - }, - "streamRawPredict": { - "id": "aiplatform.projects.locations.endpoints.streamRawPredict", - "path": "v1/{+endpoint}:streamRawPredict", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict", - "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/[^/]+$", + "index": { + "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "endpoint" - ], + "path": "v1/{+index}:upsertDatapoints", "request": { - "$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest" + "$ref": "GoogleCloudAiplatformV1UpsertDatapointsRequest" }, "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Perform a streaming online prediction with an arbitrary HTTP payload." - }, - "directPredict": { - "id": "aiplatform.projects.locations.endpoints.directPredict", - "path": "v1/{+endpoint}:directPredict", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict", - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1DirectPredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1DirectPredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks." - }, - "directRawPredict": { - "id": "aiplatform.projects.locations.endpoints.directRawPredict", - "path": "v1/{+endpoint}:directRawPredict", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict", - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1DirectRawPredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1DirectRawPredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Perform an unary online prediction request to a gRPC model server for custom containers." - }, - "serverStreamingPredict": { - "id": "aiplatform.projects.locations.endpoints.serverStreamingPredict", - "path": "v1/{+endpoint}:serverStreamingPredict", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict", - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1StreamingPredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1StreamingPredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming." - }, - "predictLongRunning": { - "id": "aiplatform.projects.locations.endpoints.predictLongRunning", - "path": "v1/{+endpoint}:predictLongRunning", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning", - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "" - }, - "fetchPredictOperation": { - "id": "aiplatform.projects.locations.endpoints.fetchPredictOperation", - "path": "v1/{+endpoint}:fetchPredictOperation", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation", - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Fetch an asynchronous online prediction operation." - }, - "explain": { - "id": "aiplatform.projects.locations.endpoints.explain", - "path": "v1/{+endpoint}:explain", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ExplainRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1ExplainResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "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." - }, - "generateContent": { - "id": "aiplatform.projects.locations.endpoints.generateContent", - "path": "v1/{+model}:generateContent", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent", - "httpMethod": "POST", - "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": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "model" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Generate content with multimodal inputs." - }, - "streamGenerateContent": { - "id": "aiplatform.projects.locations.endpoints.streamGenerateContent", - "path": "v1/{+model}:streamGenerateContent", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent", - "httpMethod": "POST", - "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": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "model" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Generate content with multimodal inputs with streaming support." - }, - "countTokens": { - "id": "aiplatform.projects.locations.endpoints.countTokens", - "path": "v1/{+endpoint}:countTokens", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CountTokensRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1CountTokensResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Perform a token counting." - }, - "computeTokens": { - "id": "aiplatform.projects.locations.endpoints.computeTokens", - "path": "v1/{+endpoint}:computeTokens", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" + "$ref": "GoogleCloudAiplatformV1UpsertDatapointsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Return a list of tokens based on the input text." + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.endpoints.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexes.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.endpoints.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.endpoints.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.indexes.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.endpoints.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "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": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexes.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.endpoints.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexes.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "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.", + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", "location": "query", - "type": "string", - "format": "google-duration" + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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." - } - } - }, - "invoke": { - "methods": { - "invoke": { - "id": "aiplatform.projects.locations.endpoints.invoke.invoke", - "path": "v1/{+endpoint}/invoke/{+invokeId}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}", + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexes.operations.wait", + "parameterOrder": [ + "name" + ], "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/[^/]+$", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "invokeId": { - "location": "path", - "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.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "parameterOrder": [ - "endpoint", - "invokeId" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1InvokeRequest" - }, + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "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." + "https://www.googleapis.com/auth/cloud-platform" + ] } } + } + } + }, + "metadataStores": { + "methods": { + "create": { + "description": "Initializes a MetadataStore, including allocation of resources.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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.)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/metadataStores", + "request": { + "$ref": "GoogleCloudAiplatformV1MetadataStore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "deployedModels": { - "resources": { - "invoke": { - "methods": { - "invoke": { - "id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke", - "path": "v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}", - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "deployedModelId": { - "description": "ID of the DeployedModel that serves the invoke request.", - "location": "path", - "required": true, - "type": "string" - }, - "invokeId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint", - "deployedModelId", - "invokeId" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1InvokeRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "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." - } - } + "delete": { + "description": "Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "deprecated": true, + "description": "Deprecated: Field is no longer supported.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "openapi": { + "get": { + "description": "Retrieves a specific MetadataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1MetadataStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists MetadataStores for a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "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", + "type": "string" + }, + "parent": { + "description": "Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/metadataStores", + "response": { + "$ref": "GoogleCloudAiplatformV1ListMetadataStoresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "artifacts": { "methods": { - "embeddings": { - "id": "aiplatform.projects.locations.endpoints.openapi.embeddings", - "path": "v1/{+endpoint}/embeddings", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings", + "create": { + "description": "Creates an Artifact associated with a MetadataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.artifacts.create", + "parameterOrder": [ + "parent" + ], "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$", + "artifactId": { + "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.)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" + } + }, + "path": "v1/{+parent}/artifacts", + "request": { + "$ref": "GoogleCloudAiplatformV1Artifact" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Artifact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Artifact.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.artifacts.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "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.", + "location": "query", + "type": "string" }, - "deployedModelId": { - "description": "ID of the DeployedModel that serves the invoke request.", + "name": { + "description": "Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a specific Artifact.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.artifacts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Artifact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Artifacts in the MetadataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.artifacts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "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", + "type": "string" + }, + "orderBy": { + "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.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "format": "int32", "location": "query", + "type": "integer" + }, + "pageToken": { + "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.)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, "type": "string" } }, + "path": "v1/{+parent}/artifacts", + "response": { + "$ref": "GoogleCloudAiplatformV1ListArtifactsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a stored Artifact.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.metadataStores.artifacts.patch", "parameterOrder": [ - "endpoint" + "name" ], + "parameters": { + "allowMissing": { + "description": "If set to true, and the Artifact is not found, a new Artifact is created.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Output only. The resource name of the Artifact.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. A FieldMask indicating which fields should be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", "request": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleCloudAiplatformV1Artifact" }, "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleCloudAiplatformV1Artifact" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "purge": { + "description": "Purges Artifacts.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.artifacts.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/artifacts:purge", + "request": { + "$ref": "GoogleCloudAiplatformV1PurgeArtifactsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "queryArtifactLineageSubgraph": { + "description": "Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph", + "parameterOrder": [ + "artifact" ], - "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." + "parameters": { + "artifact": { + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "required": true, + "type": "string" + }, + "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`.", + "location": "query", + "type": "string" + }, + "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.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v1/{+artifact}:queryArtifactLineageSubgraph", + "response": { + "$ref": "GoogleCloudAiplatformV1LineageSubgraph" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - } - }, - "google": { + }, "resources": { - "science": { + "operations": { "methods": { - "inference": { - "id": "aiplatform.projects.locations.endpoints.google.science.inference", - "path": "v1/{+endpoint}/science/inference", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/google/science/inference", + "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": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel", + "parameterOrder": [ + "name" + ], "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/google$", + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string" }, - "deployedModelId": { - "description": "ID of the DeployedModel that serves the invoke request.", + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.wait", "parameterOrder": [ - "endpoint" + "name" ], - "request": { - "$ref": "GoogleApiHttpBody" + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "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" + } }, + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "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." + "https://www.googleapis.com/auth/cloud-platform" + ] } } } } }, - "chat": { + "contexts": { "methods": { - "completions": { - "id": "aiplatform.projects.locations.endpoints.chat.completions", - "path": "v1/{+endpoint}/chat/completions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions", "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions", + "parameterOrder": [ + "context" + ], "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/[^/]+$", + "context": { + "description": "Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "endpoint" - ], + "path": "v1/{+context}:addContextArtifactsAndExecutions", "request": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest" }, "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "addContextChildren": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.addContextChildren", + "parameterOrder": [ + "context" ], - "description": "Exposes an OpenAI-compatible endpoint for chat completions." - } - } - } - } - }, - "evaluationRuns": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.evaluationRuns.create", - "path": "v1/{+parent}/evaluationRuns", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluationRun" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates an Evaluation Run." - }, - "get": { - "id": "aiplatform.projects.locations.evaluationRuns.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets an Evaluation Run." - }, - "list": { - "id": "aiplatform.projects.locations.evaluationRuns.list", - "path": "v1/{+parent}/evaluationRuns", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "parameters": { + "context": { + "description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+context}:addContextChildren", + "request": { + "$ref": "GoogleCloudAiplatformV1AddContextChildrenRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1AddContextChildrenResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "Optional. The maximum number of Evaluation Runs to return.", - "location": "query", - "type": "integer", - "format": "int32" + "create": { + "description": "Creates a Context associated with a MetadataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "contextId": { + "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.)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contexts", + "request": { + "$ref": "GoogleCloudAiplatformV1Context" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Context" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" + "delete": { + "description": "Deletes a stored Context.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.contexts.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "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.", + "location": "query", + "type": "string" + }, + "force": { + "description": "The force deletion semantics is still undefined. Users should not use this field.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "filter": { - "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).", - "location": "query", - "type": "string" + "get": { + "description": "Retrieves a specific Context.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.contexts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Context" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "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" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListEvaluationRunsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Evaluation Runs." - }, - "delete": { - "id": "aiplatform.projects.locations.evaluationRuns.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes an Evaluation Run." - }, - "cancel": { - "id": "aiplatform.projects.locations.evaluationRuns.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CancelEvaluationRunRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun." - } - } - }, - "evaluationSets": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.evaluationSets.create", - "path": "v1/{+parent}/evaluationSets", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluationSet" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates an Evaluation Set." - }, - "get": { - "id": "aiplatform.projects.locations.evaluationSets.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets an Evaluation Set." - }, - "list": { - "id": "aiplatform.projects.locations.evaluationSets.list", - "path": "v1/{+parent}/evaluationSets", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "list": { + "description": "Lists Contexts on the MetadataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.contexts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "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", + "type": "string" + }, + "orderBy": { + "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.", + "location": "query", + "type": "string" + }, + "pageSize": { + "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", + "type": "integer" + }, + "pageToken": { + "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.)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contexts", + "response": { + "$ref": "GoogleCloudAiplatformV1ListContextsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "Optional. The maximum number of Evaluation Sets to return.", - "location": "query", - "type": "integer", - "format": "int32" + "patch": { + "description": "Updates a stored Context.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.metadataStores.contexts.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "If set to true, and the Context is not found, a new Context is created.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Immutable. The resource name of the Context.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. A FieldMask indicating which fields should be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Context" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Context" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" + "purge": { + "description": "Purges Contexts.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contexts:purge", + "request": { + "$ref": "GoogleCloudAiplatformV1PurgeContextsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "filter": { - "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).", - "location": "query", - "type": "string" + "queryContextLineageSubgraph": { + "description": "Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph", + "parameterOrder": [ + "context" + ], + "parameters": { + "context": { + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+context}:queryContextLineageSubgraph", + "response": { + "$ref": "GoogleCloudAiplatformV1LineageSubgraph" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "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" + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.removeContextChildren", + "parameterOrder": [ + "context" + ], + "parameters": { + "context": { + "description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+context}:removeContextChildren", + "request": { + "$ref": "GoogleCloudAiplatformV1RemoveContextChildrenRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1RemoveContextChildrenResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListEvaluationSetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Evaluation Sets." - }, - "delete": { - "id": "aiplatform.projects.locations.evaluationSets.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.contexts.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.contexts.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.contexts.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes an Evaluation Set." + } }, - "patch": { - "id": "aiplatform.projects.locations.evaluationSets.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "executions": { + "methods": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.executions.addExecutionEvents", + "parameterOrder": [ + "execution" + ], + "parameters": { + "execution": { + "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/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+execution}:addExecutionEvents", + "request": { + "$ref": "GoogleCloudAiplatformV1AddExecutionEventsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1AddExecutionEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "updateMask": { - "description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluationSet" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates an Evaluation Set." - } - } - }, - "evaluationItems": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.evaluationItems.create", - "path": "v1/{+parent}/evaluationItems", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluationItem" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationItem" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates an Evaluation Item." - }, - "get": { - "id": "aiplatform.projects.locations.evaluationItems.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationItem" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets an Evaluation Item." - }, - "list": { - "id": "aiplatform.projects.locations.evaluationItems.list", - "path": "v1/{+parent}/evaluationItems", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "create": { + "description": "Creates an Execution associated with a MetadataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.executions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "executionId": { + "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", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/executions", + "request": { + "$ref": "GoogleCloudAiplatformV1Execution" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Execution" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "Optional. The maximum number of Evaluation Items to return.", - "location": "query", - "type": "integer", - "format": "int32" + "delete": { + "description": "Deletes an Execution.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.executions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "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.", + "location": "query", + "type": "string" + }, + "name": { + "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/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" + "get": { + "description": "Retrieves a specific Execution.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.executions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Execution" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "filter": { - "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).", - "location": "query", - "type": "string" + "list": { + "description": "Lists Executions in the MetadataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.executions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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" + }, + "orderBy": { + "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.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "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", + "type": "string" + }, + "parent": { + "description": "Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/executions", + "response": { + "$ref": "GoogleCloudAiplatformV1ListExecutionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "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" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListEvaluationItemsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Evaluation Items." - }, - "delete": { - "id": "aiplatform.projects.locations.evaluationItems.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes an Evaluation Item." - } - } - }, - "cachedContents": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.cachedContents.create", - "path": "v1/{+parent}/cachedContents", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The parent resource where the cached content will be created", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CachedContent" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1CachedContent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." - }, - "get": { - "id": "aiplatform.projects.locations.cachedContents.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The resource name referring to the cached content", - "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1CachedContent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets cached content configurations" - }, - "patch": { - "id": "aiplatform.projects.locations.cachedContents.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}", - "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The list of fields to update.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CachedContent" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1CachedContent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates cached content configurations" - }, - "delete": { - "id": "aiplatform.projects.locations.cachedContents.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The resource name referring to the cached content", - "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes cached content" - }, - "list": { - "id": "aiplatform.projects.locations.cachedContents.list", - "path": "v1/{+parent}/cachedContents", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The parent, which owns this collection of cached contents.", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "pageSize": { - "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.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "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", - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListCachedContentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists cached contents in a project" - } - } - }, - "tuningJobs": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.tuningJobs.create", - "path": "v1/{+parent}/tuningJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1TuningJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1TuningJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a TuningJob. A created TuningJob right away will be attempted to be run." - }, - "get": { - "id": "aiplatform.projects.locations.tuningJobs.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1TuningJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a TuningJob." - }, - "list": { - "id": "aiplatform.projects.locations.tuningJobs.list", - "path": "v1/{+parent}/tuningJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "Optional. The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists TuningJobs in a Location." - }, - "cancel": { - "id": "aiplatform.projects.locations.tuningJobs.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. 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 TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`." - }, - "rebaseTunedModel": { - "id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", - "path": "v1/{+parent}/tuningJobs:rebaseTunedModel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Rebase a TunedModel." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.tuningJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations", - "httpMethod": "GET", + "patch": { + "description": "Updates a stored Execution.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.metadataStores.executions.patch", + "parameterOrder": [ + "name" + ], "parameters": { + "allowMissing": { + "description": "If set to true, and the Execution is not found, a new Execution is created.", + "location": "query", + "type": "boolean" + }, "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "description": "Output only. The resource name of the Execution.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token.", + "updateMask": { + "description": "Optional. A FieldMask indicating which fields should be updated.", + "format": "google-fieldmask", "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Execution" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1Execution" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.tuningJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", - "httpMethod": "GET", + "purge": { + "description": "Purges Executions.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.executions.purge", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/executions:purge", + "request": { + "$ref": "GoogleCloudAiplatformV1PurgeExecutionsRequest" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.tuningJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs", "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "execution" ], - "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": { - "id": "aiplatform.projects.locations.tuningJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+execution}:queryExecutionInputsAndOutputs", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1LineageSubgraph" }, "scopes": [ "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`." - } - } - } - } - }, - "indexes": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.indexes.create", - "path": "v1/{+parent}/indexes", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Index" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates an Index." - }, - "get": { - "id": "aiplatform.projects.locations.indexes.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1Index" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets an Index." - }, - "list": { - "id": "aiplatform.projects.locations.indexes.list", - "path": "v1/{+parent}/indexes", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListIndexesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Indexes in a Location." - }, - "patch": { - "id": "aiplatform.projects.locations.indexes.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Output only. The resource name of the Index.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Index" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates an Index." - }, - "delete": { - "id": "aiplatform.projects.locations.indexes.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "location": "path", - "required": true, - "type": "string" + ] } }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed." - }, - "upsertDatapoints": { - "id": "aiplatform.projects.locations.indexes.upsertDatapoints", - "path": "v1/{+index}:upsertDatapoints", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints", - "httpMethod": "POST", - "parameters": { - "index": { - "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.executions.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.executions.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.executions.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.executions.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.executions.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "parameterOrder": [ - "index" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1UpsertDatapointsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1UpsertDatapointsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Add/update Datapoints into an Index." + } }, - "removeDatapoints": { - "id": "aiplatform.projects.locations.indexes.removeDatapoints", - "path": "v1/{+index}:removeDatapoints", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints", - "httpMethod": "POST", - "parameters": { - "index": { - "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "index" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1RemoveDatapointsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1RemoveDatapointsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Remove Datapoints from an Index." - } - }, - "resources": { - "operations": { + "metadataSchemas": { "methods": { - "list": { - "id": "aiplatform.projects.locations.indexes.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations", + "create": { + "description": "Creates a MetadataSchema.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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" + }, + "parent": { + "description": "Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/metadataSchemas", + "request": { + "$ref": "GoogleCloudAiplatformV1MetadataSchema" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1MetadataSchema" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a specific MetadataSchema.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "description": "Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/metadataSchemas/[^/]+$", "required": true, "type": "string" - }, + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1MetadataSchema" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists MetadataSchemas.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.list", + "parameterOrder": [ + "parent" + ], + "parameters": { "filter": { - "description": "The standard list filter.", + "description": "A query to filter available MetadataSchemas for matching results.", "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "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", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "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.)", "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" + "parent": { + "description": "Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/metadataSchemas", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1ListMetadataSchemasResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.operations.cancel", + "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": { - "id": "aiplatform.projects.locations.indexes.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.indexes.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.indexes.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "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": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.operations.list", "parameterOrder": [ "name" ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.indexes.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "indexEndpoints": { + "migratableResources": { "methods": { - "create": { - "id": "aiplatform.projects.locations.indexEndpoints.create", - "path": "v1/{+parent}/indexEndpoints", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", + "batchMigrate": { + "description": "Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate", "httpMethod": "POST", + "id": "aiplatform.projects.locations.migratableResources.batchMigrate", + "parameterOrder": [ + "parent" + ], "parameters": { "parent": { - "description": "Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "description": "Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/migratableResources:batchMigrate", "request": { - "$ref": "GoogleCloudAiplatformV1IndexEndpoint" + "$ref": "GoogleCloudAiplatformV1BatchMigrateResourcesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates an IndexEndpoint." + ] }, - "get": { - "id": "aiplatform.projects.locations.indexEndpoints.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.migratableResources.search", "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1IndexEndpoint" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "parent" ], - "description": "Gets an IndexEndpoint." - }, - "list": { - "id": "aiplatform.projects.locations.indexEndpoints.list", - "path": "v1/{+parent}/indexEndpoints", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", - "httpMethod": "GET", "parameters": { "parent": { - "description": "Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`", - "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "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\"`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/migratableResources:search", + "request": { + "$ref": "GoogleCloudAiplatformV1SearchMigratableResourcesRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1ListIndexEndpointsResponse" + "$ref": "GoogleCloudAiplatformV1SearchMigratableResourcesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists IndexEndpoints in a Location." - }, - "patch": { - "id": "aiplatform.projects.locations.indexEndpoints.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Output only. The resource name of the IndexEndpoint.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1IndexEndpoint" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1IndexEndpoint" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates an IndexEndpoint." - }, - "delete": { - "id": "aiplatform.projects.locations.indexEndpoints.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes an IndexEndpoint." - }, - "deployIndex": { - "id": "aiplatform.projects.locations.indexEndpoints.deployIndex", - "path": "v1/{+indexEndpoint}:deployIndex", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex", - "httpMethod": "POST", - "parameters": { - "indexEndpoint": { - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "indexEndpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1DeployIndexRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it." - }, - "undeployIndex": { - "id": "aiplatform.projects.locations.indexEndpoints.undeployIndex", - "path": "v1/{+indexEndpoint}:undeployIndex", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}: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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "indexEndpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1UndeployIndexRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "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." - }, - "mutateDeployedIndex": { - "id": "aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex", - "path": "v1/{+indexEndpoint}:mutateDeployedIndex", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex", - "httpMethod": "POST", - "parameters": { - "indexEndpoint": { - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "indexEndpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1DeployedIndex" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Update an existing DeployedIndex under an IndexEndpoint." - }, - "findNeighbors": { - "id": "aiplatform.projects.locations.indexEndpoints.findNeighbors", - "path": "v1/{+indexEndpoint}:findNeighbors", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors", - "httpMethod": "POST", - "parameters": { - "indexEndpoint": { - "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "indexEndpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1FindNeighborsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1FindNeighborsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Finds the nearest neighbors of each vector within the request." - }, - "readIndexDatapoints": { - "id": "aiplatform.projects.locations.indexEndpoints.readIndexDatapoints", - "path": "v1/{+indexEndpoint}:readIndexDatapoints", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints", - "httpMethod": "POST", - "parameters": { - "indexEndpoint": { - "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "indexEndpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ReadIndexDatapointsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1ReadIndexDatapointsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch." + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.indexEndpoints.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.migratableResources.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.indexEndpoints.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.migratableResources.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.indexEndpoints.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", - "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.migratableResources.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.indexEndpoints.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.migratableResources.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.indexEndpoints.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.migratableResources.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "customJobs": { + "modelDeploymentMonitoringJobs": { "methods": { "create": { - "id": "aiplatform.projects.locations.customJobs.create", - "path": "v1/{+parent}/customJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs", + "description": "Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs", "httpMethod": "POST", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.create", + "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/[^/]+$", + "description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/modelDeploymentMonitoringJobs", "request": { - "$ref": "GoogleCloudAiplatformV1CustomJob" + "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob" }, "response": { - "$ref": "GoogleCloudAiplatformV1CustomJob" + "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a CustomJob. A created CustomJob right away will be attempted to be run." + ] }, - "get": { - "id": "aiplatform.projects.locations.customJobs.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", - "httpMethod": "GET", + "delete": { + "description": "Deletes a ModelDeploymentMonitoringJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a ModelDeploymentMonitoringJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.get", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1CustomJob" + "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a CustomJob." + ] }, "list": { - "id": "aiplatform.projects.locations.customJobs.list", - "path": "v1/{+parent}/customJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs", + "description": "Lists ModelDeploymentMonitoringJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs", "httpMethod": "GET", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, "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:*`", + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` 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>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, + "parent": { + "description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, "readMask": { - "description": "Mask specifying which fields to read.", + "description": "Mask specifying which fields to read", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-fieldmask" + "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/modelDeploymentMonitoringJobs", "response": { - "$ref": "GoogleCloudAiplatformV1ListCustomJobsResponse" + "$ref": "GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists CustomJobs in a Location." + ] }, - "delete": { - "id": "aiplatform.projects.locations.customJobs.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", - "httpMethod": "DELETE", + "patch": { + "description": "Updates a ModelDeploymentMonitoringJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "description": "Output only. Resource name of a ModelDeploymentMonitoringJob.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" + }, + "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`", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a CustomJob." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.customJobs.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel", + "pause": { + "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'.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause", "httpMethod": "POST", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "description": "Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}:pause", + "request": { + "$ref": "GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:resume", "request": { - "$ref": "GoogleCloudAiplatformV1CancelCustomJobRequest" + "$ref": "GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest" }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchModelDeploymentMonitoringStatsAnomalies": { + "description": "Searches Model Monitoring Statistics generated within a given time window.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies", + "parameterOrder": [ + "modelDeploymentMonitoringJob" ], - "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`." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.customJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations", - "httpMethod": "GET", + "parameters": { + "modelDeploymentMonitoringJob": { + "description": "Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies", + "request": { + "$ref": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.customJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.customJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", - "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.customJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.customJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "dataLabelingJobs": { + "models": { "methods": { - "create": { - "id": "aiplatform.projects.locations.dataLabelingJobs.create", - "path": "v1/{+parent}/dataLabelingJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", + "copy": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models:copy", "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.copy", + "parameterOrder": [ + "parent" + ], "parameters": { "parent": { - "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location into which to copy the Model. Format: `projects/{project}/locations/{location}`", + "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/models:copy", + "request": { + "$ref": "GoogleCloudAiplatformV1CopyModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.models.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Model resource to be deleted. Format: `projects/{project}/locations/{location}/models/{model}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deleteVersion": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.models.deleteVersion", "parameterOrder": [ - "parent" + "name" ], - "request": { - "$ref": "GoogleCloudAiplatformV1DataLabelingJob" + "parameters": { + "name": { + "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`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+name}:deleteVersion", "response": { - "$ref": "GoogleCloudAiplatformV1DataLabelingJob" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.export", + "parameterOrder": [ + "name" ], - "description": "Creates a DataLabelingJob." + "parameters": { + "name": { + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:export", + "request": { + "$ref": "GoogleCloudAiplatformV1ExportModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "get": { - "id": "aiplatform.projects.locations.dataLabelingJobs.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", + "description": "Gets a Model.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Model" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.getIamPolicy", "parameterOrder": [ - "name" + "resource" ], + "parameters": { + "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" + }, + "resource": { + "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, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", "response": { - "$ref": "GoogleCloudAiplatformV1DataLabelingJob" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a DataLabelingJob." + ] }, "list": { - "id": "aiplatform.projects.locations.dataLabelingJobs.list", - "path": "v1/{+parent}/dataLabelingJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", + "description": "Lists Models in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models", "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.list", + "parameterOrder": [ + "parent" + ], "parameters": { + "filter": { + "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\"`", + "location": "query", + "type": "string" + }, + "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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.", + "location": "query", + "type": "string" + }, "parent": { - "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`", + "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/models", + "response": { + "$ref": "GoogleCloudAiplatformV1ListModelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listCheckpoints": { + "description": "Lists checkpoints of the specified model version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.listCheckpoints", + "parameterOrder": [ + "name" + ], + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:listCheckpoints", + "response": { + "$ref": "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listVersions": { + "description": "Lists versions of the specified model.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.listVersions", + "parameterOrder": [ + "name" + ], + "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:*`", + "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\"`", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the model to list versions for.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "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`.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.", "location": "query", "type": "string" }, "readMask": { - "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", - "type": "string", - "format": "google-fieldmask" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}:listVersions", "response": { - "$ref": "GoogleCloudAiplatformV1ListDataLabelingJobsResponse" + "$ref": "GoogleCloudAiplatformV1ListModelVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists DataLabelingJobs in a Location." + ] }, - "delete": { - "id": "aiplatform.projects.locations.dataLabelingJobs.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", - "httpMethod": "DELETE", + "mergeVersionAliases": { + "description": "Merges a set of aliases for a Model version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.mergeVersionAliases", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "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`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}:mergeVersionAliases", + "request": { + "$ref": "GoogleCloudAiplatformV1MergeVersionAliasesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Model" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a Model.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.models.patch", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the Model.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Model" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1Model" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a DataLabelingJob." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.dataLabelingJobs.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel", + "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": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy", "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.setIamPolicy", + "parameterOrder": [ + "resource" + ], "parameters": { - "name": { - "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+resource}:setIamPolicy", "request": { - "$ref": "GoogleCloudAiplatformV1CancelDataLabelingJobRequest" + "$ref": "GoogleIamV1SetIamPolicyRequest" }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.testIamPermissions", + "parameterOrder": [ + "resource" ], - "description": "Cancels a DataLabelingJob. Success of cancellation is not guaranteed." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - } - } - }, - "hyperparameterTuningJobs": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.create", - "path": "v1/{+parent}/hyperparameterTuningJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", - "httpMethod": "POST", "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "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).", + "location": "query", + "repeated": true, "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a HyperparameterTuningJob" - }, - "get": { - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + }, + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+resource}:testIamPermissions", "response": { - "$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob" + "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a HyperparameterTuningJob" + ] }, - "list": { - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.list", - "path": "v1/{+parent}/hyperparameterTuningJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, + "updateExplanationDataset": { + "description": "Incrementally update the dataset used for an examples model.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.updateExplanationDataset", "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "model" ], - "description": "Lists HyperparameterTuningJobs in a Location." - }, - "delete": { - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", - "httpMethod": "DELETE", "parameters": { - "name": { - "description": "Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "model": { + "description": "Required. The resource name of the Model to update. Format: `projects/{project}/locations/{location}/models/{model}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+model}:updateExplanationDataset", + "request": { + "$ref": "GoogleCloudAiplatformV1UpdateExplanationDatasetRequest" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a HyperparameterTuningJob." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel", + "upload": { + "description": "Uploads a Model artifact into Vertex AI.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models:upload", "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.upload", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "parent": { + "description": "Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/models:upload", "request": { - "$ref": "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest" + "$ref": "GoogleCloudAiplatformV1UploadModelRequest" }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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`." + ] } }, "resources": { - "operations": { + "evaluations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "description": "Gets a ModelEvaluation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}", "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.models.evaluations.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "description": "Required. The name of the ModelEvaluation resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1ModelEvaluation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", + "import": { + "description": "Imports an externally generated ModelEvaluation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import", "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.evaluations.import", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The name of the parent model resource. Format: `projects/{project}/locations/{location}/models/{model}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/evaluations:import", + "request": { + "$ref": "GoogleCloudAiplatformV1ImportModelEvaluationRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1ModelEvaluation" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "list": { + "description": "Lists ModelEvaluations in a Model.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.evaluations.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project}/locations/{location}/models/{model}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "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.", + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/evaluations", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1ListModelEvaluationsResponse" }, "scopes": [ "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." - } - } - } - } - }, - "nasJobs": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.nasJobs.create", - "path": "v1/{+parent}/nasJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1NasJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1NasJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a NasJob" - }, - "get": { - "id": "aiplatform.projects.locations.nasJobs.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" + ] } }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1NasJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Gets a NasJob" - }, - "list": { - "id": "aiplatform.projects.locations.nasJobs.list", - "path": "v1/{+parent}/nasJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.", - "location": "query", - "type": "string" + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.evaluations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.models.evaluations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.evaluations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.evaluations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.evaluations.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListNasJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists NasJobs in a Location." - }, - "delete": { - "id": "aiplatform.projects.locations.nasJobs.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "slices": { + "methods": { + "batchImport": { + "description": "Imports a list of externally generated EvaluatedAnnotations.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.evaluations.slices.batchImport", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:batchImport", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a ModelEvaluationSlice.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.evaluations.slices.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1ModelEvaluationSlice" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ModelEvaluationSlices in a ModelEvaluation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.evaluations.slices.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. * `slice.dimension` - for =.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/slices", + "response": { + "$ref": "GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a NasJob." + } }, - "cancel": { - "id": "aiplatform.projects.locations.nasJobs.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CancelNasJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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`." - } - }, - "resources": { - "nasTrialDetails": { + "operations": { "methods": { - "get": { - "id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`", - "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+/nasTrialDetails/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.models.operations.delete", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1NasTrialDetail" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.operations.get", + "parameterOrder": [ + "name" ], - "description": "Gets a NasTrialDetail." + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "list": { - "id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.list", - "path": "v1/{+parent}/nasTrialDetails", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations", "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.", + "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" } }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.operations.wait", "parameterOrder": [ - "parent" + "name" ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1ListNasTrialDetailsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "List top NasTrialDetails of a NasJob." + ] } } } } }, - "batchPredictionJobs": { + "nasJobs": { "methods": { - "create": { - "id": "aiplatform.projects.locations.batchPredictionJobs.create", - "path": "v1/{+parent}/batchPredictionJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", + "cancel": { + "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": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel", "httpMethod": "POST", + "id": "aiplatform.projects.locations.nasJobs.cancel", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "name": { + "description": "Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelNasJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a NasJob", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.nasJobs.create", "parameterOrder": [ "parent" ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/nasJobs", "request": { - "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + "$ref": "GoogleCloudAiplatformV1NasJob" }, "response": { - "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + "$ref": "GoogleCloudAiplatformV1NasJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start." + ] }, - "get": { - "id": "aiplatform.projects.locations.batchPredictionJobs.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", - "httpMethod": "GET", + "delete": { + "description": "Deletes a NasJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.nasJobs.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "description": "Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a BatchPredictionJob" + ] }, - "list": { - "id": "aiplatform.projects.locations.batchPredictionJobs.list", - "path": "v1/{+parent}/batchPredictionJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", + "get": { + "description": "Gets a NasJob", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.nasJobs.get", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "name": { + "description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", "required": true, "type": "string" - }, + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1NasJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists NasJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.nasJobs.list", + "parameterOrder": [ + "parent" + ], + "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:*`", + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` 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>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", + "description": "The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.", "location": "query", "type": "string" }, + "parent": { + "description": "Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, "readMask": { "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists BatchPredictionJobs in a Location." - }, - "delete": { - "id": "aiplatform.projects.locations.batchPredictionJobs.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", - "location": "path", - "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/nasJobs", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1ListNasJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished." - }, - "cancel": { - "id": "aiplatform.projects.locations.batchPredictionJobs.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" + ] + } + }, + "resources": { + "nasTrialDetails": { + "methods": { + "get": { + "description": "Gets a NasTrialDetail.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+/nasTrialDetails/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1NasTrialDetail" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List top NasTrialDetails of a NasJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/nasTrialDetails", + "response": { + "$ref": "GoogleCloudAiplatformV1ListNasTrialDetailsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + } } } }, - "modelDeploymentMonitoringJobs": { + "notebookExecutionJobs": { "methods": { "create": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.create", - "path": "v1/{+parent}/modelDeploymentMonitoringJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs", + "description": "Creates a NotebookExecutionJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookExecutionJobs.create", + "parameterOrder": [ + "parent" + ], "parameters": { + "notebookExecutionJobId": { + "description": "Optional. User specified ID for the NotebookExecutionJob.", + "location": "query", + "type": "string" + }, "parent": { - "description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/notebookExecutionJobs", "request": { - "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob" + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" }, "response": { - "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval." + ] }, - "searchModelDeploymentMonitoringStatsAnomalies": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies", - "path": "v1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies", - "httpMethod": "POST", + "delete": { + "description": "Deletes a NotebookExecutionJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.notebookExecutionJobs.delete", + "parameterOrder": [ + "name" + ], "parameters": { - "modelDeploymentMonitoringJob": { - "description": "Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "name": { + "description": "Required. The name of the NotebookExecutionJob resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "modelDeploymentMonitoringJob" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Searches Model Monitoring Statistics generated within a given time window." + ] }, "get": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", + "description": "Gets a NotebookExecutionJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookExecutionJobs.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "description": "Required. The name of the NotebookExecutionJob resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", + "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." + ], + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob" + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a ModelDeploymentMonitoringJob." + ] }, "list": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list", - "path": "v1/{+parent}/modelDeploymentMonitoringJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs", + "description": "Lists NotebookExecutionJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookExecutionJobs.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, + "filter": { + "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", "type": "string" }, - "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:*`", + "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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.", "location": "query", "type": "string" }, - "readMask": { - "description": "Mask specifying which fields to read", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists ModelDeploymentMonitoringJobs in a Location." - }, - "patch": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Output only. Resource name of a ModelDeploymentMonitoringJob.", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "parent": { + "description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, - "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`", + "view": { + "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", + "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." + ], "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a ModelDeploymentMonitoringJob." - }, - "delete": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a ModelDeploymentMonitoringJob." - }, - "pause": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause", - "path": "v1/{+name}:pause", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "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'." - }, - "resume": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume", - "path": "v1/{+name}:resume", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", - "location": "path", - "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest" - }, + "path": "v1/{+parent}/notebookExecutionJobs", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed." + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "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": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.list", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - } - } - }, - "publishers": { - "resources": { - "models": { - "methods": { - "predict": { - "id": "aiplatform.projects.locations.publishers.models.predict", - "path": "v1/{+endpoint}:predict", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict", - "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/[^/]+/publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "The standard list filter.", + "location": "query", "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1PredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Perform an online prediction." - }, - "rawPredict": { - "id": "aiplatform.projects.locations.publishers.models.rawPredict", - "path": "v1/{+endpoint}:rawPredict", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict", - "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/[^/]+/publishers/[^/]+/models/[^/]+$", + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "required": true, "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1RawPredictRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "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." - }, - "streamRawPredict": { - "id": "aiplatform.projects.locations.publishers.models.streamRawPredict", - "path": "v1/{+endpoint}:streamRawPredict", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict", - "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/[^/]+/publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest" - }, + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Perform a streaming online prediction with an arbitrary HTTP payload." + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "serverStreamingPredict": { - "id": "aiplatform.projects.locations.publishers.models.serverStreamingPredict", - "path": "v1/{+endpoint}:serverStreamingPredict", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict", + "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": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", "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/[^/]+/publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.wait", "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1StreamingPredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1StreamingPredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "name" ], - "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming." - }, - "predictLongRunning": { - "id": "aiplatform.projects.locations.publishers.models.predictLongRunning", - "path": "v1/{+endpoint}:predictLongRunning", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning", - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "" - }, - "fetchPredictOperation": { - "id": "aiplatform.projects.locations.publishers.models.fetchPredictOperation", - "path": "v1/{+endpoint}:fetchPredictOperation", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", - "location": "path", - "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.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" - }, + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Fetch an asynchronous online prediction operation." - }, - "generateContent": { - "id": "aiplatform.projects.locations.publishers.models.generateContent", - "path": "v1/{+model}:generateContent", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent", - "httpMethod": "POST", - "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": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "model" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Generate content with multimodal inputs." - }, - "streamGenerateContent": { - "id": "aiplatform.projects.locations.publishers.models.streamGenerateContent", - "path": "v1/{+model}:streamGenerateContent", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", - "httpMethod": "POST", - "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": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "model" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Generate content with multimodal inputs with streaming support." - }, - "embedContent": { - "id": "aiplatform.projects.locations.publishers.models.embedContent", - "path": "v1/{+model}:embedContent", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:embedContent", - "httpMethod": "POST", - "parameters": { - "model": { - "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "model" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1EmbedContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1EmbedContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Embed content with multimodal inputs." - }, - "countTokens": { - "id": "aiplatform.projects.locations.publishers.models.countTokens", - "path": "v1/{+endpoint}:countTokens", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CountTokensRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1CountTokensResponse" - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Perform a token counting." - }, - "computeTokens": { - "id": "aiplatform.projects.locations.publishers.models.computeTokens", - "path": "v1/{+endpoint}:computeTokens", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Return a list of tokens based on the input text." + ] } } } } }, - "metadataStores": { + "notebookRuntimeTemplates": { "methods": { "create": { - "id": "aiplatform.projects.locations.metadataStores.create", - "path": "v1/{+parent}/metadataStores", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores", + "description": "Creates a NotebookRuntimeTemplate.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates", "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.create", + "parameterOrder": [ + "parent" + ], "parameters": { + "notebookRuntimeTemplateId": { + "description": "Optional. User specified ID for the notebook runtime template.", + "location": "query", + "type": "string" + }, "parent": { - "description": "Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "description": "Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - }, - "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.)", - "location": "query", - "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/notebookRuntimeTemplates", "request": { - "$ref": "GoogleCloudAiplatformV1MetadataStore" + "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a NotebookRuntimeTemplate.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.delete", + "parameterOrder": [ + "name" ], - "description": "Initializes a MetadataStore, including allocation of resources." + "parameters": { + "name": { + "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/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "get": { - "id": "aiplatform.projects.locations.metadataStores.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", + "description": "Gets a NotebookRuntimeTemplate.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "description": "Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy", "parameterOrder": [ - "name" + "resource" ], + "parameters": { + "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" + }, + "resource": { + "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/[^/]+/notebookRuntimeTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", "response": { - "$ref": "GoogleCloudAiplatformV1MetadataStore" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Retrieves a specific MetadataStore." + ] }, "list": { - "id": "aiplatform.projects.locations.metadataStores.list", - "path": "v1/{+parent}/metadataStores", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores", + "description": "Lists NotebookRuntimeTemplates in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates", "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, + "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`", + "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. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "description": "Optional. The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "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.)", + "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/notebookRuntimeTemplates", "response": { - "$ref": "GoogleCloudAiplatformV1ListMetadataStoresResponse" + "$ref": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists MetadataStores for a Location." + ] }, - "delete": { - "id": "aiplatform.projects.locations.metadataStores.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", - "httpMethod": "DELETE", + "patch": { + "description": "Updates a NotebookRuntimeTemplate.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "description": "The resource name of the NotebookRuntimeTemplate.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" }, - "force": { - "description": "Deprecated: Field is no longer supported.", + "updateMask": { + "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`", + "format": "google-fieldmask", "location": "query", - "deprecated": true, - "type": "boolean" + "type": "string" } }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy", "parameterOrder": [ - "name" + "resource" ], + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions", + "parameterOrder": [ + "resource" ], - "description": "Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts)." + "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).", + "location": "query", + "repeated": true, + "type": "string" + }, + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.metadataStores.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.metadataStores.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.metadataStores.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}", - "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.metadataStores.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.metadataStores.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } + } + } + }, + "notebookRuntimes": { + "methods": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.assign", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/notebookRuntimes:assign", + "request": { + "$ref": "GoogleCloudAiplatformV1AssignNotebookRuntimeRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "artifacts": { + "delete": { + "description": "Deletes a NotebookRuntime.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.notebookRuntimes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a NotebookRuntime.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1NotebookRuntime" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists NotebookRuntimes in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "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`", + "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. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/notebookRuntimes", + "response": { + "$ref": "GoogleCloudAiplatformV1ListNotebookRuntimesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "start": { + "description": "Starts a NotebookRuntime.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.start", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:start", + "request": { + "$ref": "GoogleCloudAiplatformV1StartNotebookRuntimeRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "stop": { + "description": "Stops a NotebookRuntime.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.stop", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:stop", + "request": { + "$ref": "GoogleCloudAiplatformV1StopNotebookRuntimeRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "upgrade": { + "description": "Upgrades a NotebookRuntime.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.upgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:upgrade", + "request": { + "$ref": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { "methods": { - "create": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.create", - "path": "v1/{+parent}/artifacts", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", + "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": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "artifactId": { - "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.)", - "location": "query", - "type": "string" } }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.delete", "parameterOrder": [ - "parent" + "name" ], - "request": { - "$ref": "GoogleCloudAiplatformV1Artifact" + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Artifact" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates an Artifact associated with a MetadataStore." + ] }, "get": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "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": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Artifact" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Retrieves a specific Artifact." + ] }, "list": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.list", - "path": "v1/{+parent}/artifacts", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations", "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "The standard list filter.", + "location": "query", "type": "string" }, - "pageSize": { - "description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", - "location": "query", - "type": "integer", - "format": "int32" + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "required": true, + "type": "string" }, - "pageToken": { - "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.)", + "pageSize": { + "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "string" + "type": "integer" }, - "filter": { - "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`.", + "pageToken": { + "description": "The standard list page token.", "location": "query", "type": "string" }, - "orderBy": { - "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.", + "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": "string" + "type": "boolean" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1ListArtifactsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Artifacts in the MetadataStore." + ] }, - "patch": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", - "httpMethod": "PATCH", + "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": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Output only. The resource name of the Artifact.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Optional. A FieldMask indicating which fields should be updated.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "allowMissing": { - "description": "If set to true, and the Artifact is not found, a new Artifact is created.", + "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": "boolean" + "type": "string" } }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "persistentResources": { + "methods": { + "create": { + "description": "Creates a PersistentResource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.persistentResources.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "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" + } + }, + "path": "v1/{+parent}/persistentResources", + "request": { + "$ref": "GoogleCloudAiplatformV1PersistentResource" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a PersistentResource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.persistentResources.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a PersistentResource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.persistentResources.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1PersistentResource" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists PersistentResources in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.persistentResources.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/persistentResources", + "response": { + "$ref": "GoogleCloudAiplatformV1ListPersistentResourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a PersistentResource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.persistentResources.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Resource name of a PersistentResource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Specify the fields to be overwritten in the PersistentResource by the update method.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1PersistentResource" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "reboot": { + "description": "Reboots a PersistentResource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.persistentResources.reboot", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:reboot", + "request": { + "$ref": "GoogleCloudAiplatformV1RebootPersistentResourceRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.persistentResources.operations.cancel", "parameterOrder": [ "name" ], - "request": { - "$ref": "GoogleCloudAiplatformV1Artifact" + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1Artifact" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a stored Artifact." + ] }, "delete": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "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": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.persistentResources.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "etag": { - "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.", - "location": "query", - "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes an Artifact." + ] }, - "purge": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.purge", - "path": "v1/{+parent}/artifacts:purge", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge", - "httpMethod": "POST", + "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": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.persistentResources.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "name": { + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PurgeArtifactsRequest" - }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Purges Artifacts." + ] }, - "queryArtifactLineageSubgraph": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph", - "path": "v1/{+artifact}:queryArtifactLineageSubgraph", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations", "httpMethod": "GET", + "id": "aiplatform.projects.locations.persistentResources.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { - "artifact": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", "required": true, "type": "string" }, - "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.", + "pageSize": { + "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, - "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`.", + "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" } }, - "parameterOrder": [ - "artifact" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1LineageSubgraph" + "$ref": "GoogleLongrunningListOperationsResponse" }, "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.persistentResources.operations.wait", + "parameterOrder": [ + "name" ], - "description": "Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "wait": { - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." + "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" } - } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } + } + } + }, + "pipelineJobs": { + "methods": { + "batchCancel": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.pipelineJobs.batchCancel", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/pipelineJobs:batchCancel", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "contexts": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.pipelineJobs.batchDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/pipelineJobs:batchDelete", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.pipelineJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelPipelineJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a PipelineJob. A PipelineJob will run immediately when created.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.pipelineJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "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-/`.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/pipelineJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1PipelineJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1PipelineJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a PipelineJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.pipelineJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a PipelineJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.pipelineJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PipelineJob resource. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1PipelineJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists PipelineJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.pipelineJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "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 `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` 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>\"2020-05-18T13:30:00Z\"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time>\"2021-05-18T00:00:00Z\" OR update_time>\"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", + "type": "string" + }, + "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" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/pipelineJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1ListPipelineJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { "methods": { - "create": { - "id": "aiplatform.projects.locations.metadataStores.contexts.create", - "path": "v1/{+parent}/contexts", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts", + "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": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", + "id": "aiplatform.projects.locations.pipelineJobs.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "contextId": { - "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.)", - "location": "query", - "type": "string" } }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.pipelineJobs.operations.delete", "parameterOrder": [ - "parent" + "name" ], - "request": { - "$ref": "GoogleCloudAiplatformV1Context" + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Context" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a Context associated with a MetadataStore." + ] }, "get": { - "id": "aiplatform.projects.locations.metadataStores.contexts.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", + "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": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.pipelineJobs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Context" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Retrieves a specific Context." + ] }, "list": { - "id": "aiplatform.projects.locations.metadataStores.contexts.list", - "path": "v1/{+parent}/contexts", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations", "httpMethod": "GET", + "id": "aiplatform.projects.locations.pipelineJobs.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "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.)", - "location": "query", - "type": "string" - }, - "filter": { - "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`.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "orderBy": { - "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.", + "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": "string" + "type": "boolean" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1ListContextsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Contexts on the MetadataStore." + ] }, - "patch": { - "id": "aiplatform.projects.locations.metadataStores.contexts.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", - "httpMethod": "PATCH", + "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": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.pipelineJobs.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Immutable. The resource name of the Context.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Optional. A FieldMask indicating which fields should be updated.", + "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", - "format": "google-fieldmask" - }, - "allowMissing": { - "description": "If set to true, and the Context is not found, a new Context is created.", - "location": "query", - "type": "boolean" + "type": "string" } }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Context" - }, + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1Context" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "publishers": { + "resources": { + "models": { + "methods": { + "computeTokens": { + "description": "Return a list of tokens based on the input text.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.computeTokens", + "parameterOrder": [ + "endpoint" ], - "description": "Updates a stored Context." - }, - "delete": { - "id": "aiplatform.projects.locations.metadataStores.contexts.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", - "httpMethod": "DELETE", "parameters": { - "name": { - "description": "Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "endpoint": { + "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" - }, - "force": { - "description": "The force deletion semantics is still undefined. Users should not use this field.", - "location": "query", - "type": "boolean" - }, - "etag": { - "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.", - "location": "query", - "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+endpoint}:computeTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a stored Context." + ] }, - "purge": { - "id": "aiplatform.projects.locations.metadataStores.contexts.purge", - "path": "v1/{+parent}/contexts:purge", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge", + "countTokens": { + "description": "Perform a token counting.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens", "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.countTokens", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "parent": { - "description": "Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "endpoint": { + "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+endpoint}:countTokens", "request": { - "$ref": "GoogleCloudAiplatformV1PurgeContextsRequest" + "$ref": "GoogleCloudAiplatformV1CountTokensRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1CountTokensResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Purges Contexts." + ] }, - "addContextArtifactsAndExecutions": { - "id": "aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions", - "path": "v1/{+context}:addContextArtifactsAndExecutions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions", + "embedContent": { + "description": "Embed content with multimodal inputs.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:embedContent", "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.embedContent", + "parameterOrder": [ + "model" + ], "parameters": { - "context": { - "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/[^/]+$", + "model": { + "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "context" - ], + "path": "v1/{+model}:embedContent", "request": { - "$ref": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest" + "$ref": "GoogleCloudAiplatformV1EmbedContentRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse" + "$ref": "GoogleCloudAiplatformV1EmbedContentResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "addContextChildren": { - "id": "aiplatform.projects.locations.metadataStores.contexts.addContextChildren", - "path": "v1/{+context}:addContextChildren", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren", + "fetchPredictOperation": { + "description": "Fetch an asynchronous online prediction operation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.fetchPredictOperation", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "context": { - "description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "context" - ], + "path": "v1/{+endpoint}:fetchPredictOperation", "request": { - "$ref": "GoogleCloudAiplatformV1AddContextChildrenRequest" + "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1AddContextChildrenResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "removeContextChildren": { - "id": "aiplatform.projects.locations.metadataStores.contexts.removeContextChildren", - "path": "v1/{+context}:removeContextChildren", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren", + "generateContent": { + "description": "Generate content with multimodal inputs.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent", "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.generateContent", + "parameterOrder": [ + "model" + ], "parameters": { - "context": { - "description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "context" - ], + "path": "v1/{+model}:generateContent", "request": { - "$ref": "GoogleCloudAiplatformV1RemoveContextChildrenRequest" + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1RemoveContextChildrenResponse" + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "queryContextLineageSubgraph": { - "id": "aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph", - "path": "v1/{+context}:queryContextLineageSubgraph", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph", - "httpMethod": "GET", + "predict": { + "description": "", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.predict", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "context": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "context" - ], + "path": "v1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1LineageSubgraph" + "$ref": "GoogleCloudAiplatformV1PredictResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.metadataStores.contexts.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.metadataStores.contexts.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.metadataStores.contexts.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.projects.locations.metadataStores.contexts.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.metadataStores.contexts.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - } - } - }, - "executions": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.metadataStores.executions.create", - "path": "v1/{+parent}/executions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predictLongRunning": { + "description": "", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning", "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.predictLongRunning", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" - }, - "executionId": { - "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", - "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+endpoint}:predictLongRunning", "request": { - "$ref": "GoogleCloudAiplatformV1Execution" + "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1Execution" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates an Execution associated with a MetadataStore." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "get": { - "id": "aiplatform.projects.locations.metadataStores.executions.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", - "httpMethod": "GET", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.rawPredict", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "name": { - "description": "Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+endpoint}:rawPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1RawPredictRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1Execution" + "$ref": "GoogleApiHttpBody" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Retrieves a specific Execution." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "list": { - "id": "aiplatform.projects.locations.metadataStores.executions.list", - "path": "v1/{+parent}/executions", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions", - "httpMethod": "GET", + "serverStreamingPredict": { + "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.serverStreamingPredict", + "parameterOrder": [ + "endpoint" + ], "parameters": { - "parent": { - "description": "Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" - }, - "pageSize": { - "description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "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", - "type": "string" - }, - "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" - }, - "orderBy": { - "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.", - "location": "query", - "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+endpoint}:serverStreamingPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1StreamingPredictRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1ListExecutionsResponse" + "$ref": "GoogleCloudAiplatformV1StreamingPredictResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Executions in the MetadataStore." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "patch": { - "id": "aiplatform.projects.locations.metadataStores.executions.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", - "httpMethod": "PATCH", + "streamGenerateContent": { + "description": "Generate content with multimodal inputs with streaming support.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.streamGenerateContent", + "parameterOrder": [ + "model" + ], "parameters": { - "name": { - "description": "Output only. The resource name of the Execution.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Optional. A FieldMask indicating which fields should be updated.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "allowMissing": { - "description": "If set to true, and the Execution is not found, a new Execution is created.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+model}:streamGenerateContent", "request": { - "$ref": "GoogleCloudAiplatformV1Execution" + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1Execution" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a stored Execution." - }, - "delete": { - "id": "aiplatform.projects.locations.metadataStores.executions.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The resource name of the Execution to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "etag": { - "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.", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes an Execution." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "purge": { - "id": "aiplatform.projects.locations.metadataStores.executions.purge", - "path": "v1/{+parent}/executions:purge", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge", + "streamRawPredict": { + "description": "Perform a streaming online prediction with an arbitrary HTTP payload.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict", "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.publishers.models.streamRawPredict", "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PurgeExecutionsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "endpoint" ], - "description": "Purges Executions." - }, - "addExecutionEvents": { - "id": "aiplatform.projects.locations.metadataStores.executions.addExecutionEvents", - "path": "v1/{+execution}:addExecutionEvents", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents", - "httpMethod": "POST", "parameters": { - "execution": { - "description": "Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "execution" - ], + "path": "v1/{+endpoint}:streamRawPredict", "request": { - "$ref": "GoogleCloudAiplatformV1AddExecutionEventsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1AddExecutionEventsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." - }, - "queryExecutionInputsAndOutputs": { - "id": "aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs", - "path": "v1/{+execution}:queryExecutionInputsAndOutputs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs", - "httpMethod": "GET", - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest" }, - "parameterOrder": [ - "execution" - ], "response": { - "$ref": "GoogleCloudAiplatformV1LineageSubgraph" + "$ref": "GoogleApiHttpBody" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] } }, "resources": { - "operations": { + "invoke": { "methods": { - "list": { - "id": "aiplatform.projects.locations.metadataStores.executions.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.metadataStores.executions.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}/invoke/{invokeId}", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.invoke.invoke", "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "endpoint", + "invokeId" ], - "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": { - "id": "aiplatform.projects.locations.metadataStores.executions.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.projects.locations.metadataStores.executions.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + }, + "invokeId": { "location": "path", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.metadataStores.executions.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } + "path": "v1/{+endpoint}/invoke/{+invokeId}", + "request": { + "$ref": "GoogleCloudAiplatformV1InvokeRequest" }, - "parameterOrder": [ - "name" - ], "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleApiHttpBody" }, "scopes": [ - "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." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] } } } } + } + } + }, + "ragCorpora": { + "methods": { + "create": { + "description": "Creates a RagCorpus.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/ragCorpora", + "request": { + "$ref": "GoogleCloudAiplatformV1RagCorpus" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "metadataSchemas": { + "delete": { + "description": "Deletes a RagCorpus.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragCorpora.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "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", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a RagCorpus.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1RagCorpus" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists RagCorpora in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "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", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/ragCorpora", + "response": { + "$ref": "GoogleCloudAiplatformV1ListRagCorporaResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a RagCorpus.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.ragCorpora.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the RagCorpus.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1RagCorpus" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { "methods": { - "create": { - "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.create", - "path": "v1/{+parent}/metadataSchemas", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas", + "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": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.operations.cancel", + "parameterOrder": [ + "name" + ], "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/[^/]+$", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "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" } }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragCorpora.operations.delete", "parameterOrder": [ - "parent" + "name" ], - "request": { - "$ref": "GoogleCloudAiplatformV1MetadataSchema" + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1MetadataSchema" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a MetadataSchema." + ] }, "get": { - "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}", + "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": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/metadataSchemas/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1MetadataSchema" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Retrieves a specific MetadataSchema." + ] }, "list": { - "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.list", - "path": "v1/{+parent}/metadataSchemas", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations", "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "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.)", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "filter": { - "description": "A query to filter available MetadataSchemas for matching results.", + "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": "string" + "type": "boolean" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1ListMetadataSchemasResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.operations.wait", + "parameterOrder": [ + "name" ], - "description": "Lists MetadataSchemas." - } - } - } - } - }, - "migratableResources": { - "methods": { - "search": { - "id": "aiplatform.projects.locations.migratableResources.search", - "path": "v1/{+parent}/migratableResources:search", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search", - "httpMethod": "POST", - "parameters": { - "parent": { - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1SearchMigratableResourcesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1SearchMigratableResourcesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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." - }, - "batchMigrate": { - "id": "aiplatform.projects.locations.migratableResources.batchMigrate", - "path": "v1/{+parent}/migratableResources:batchMigrate", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1BatchMigrateResourcesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.migratableResources.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "filter": { - "description": "The standard list filter.", + "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" - }, - "pageSize": { - "description": "The standard list page size.", + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "ragFiles": { + "methods": { + "delete": { + "description": "Deletes a RagFile.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.delete", + "parameterOrder": [ + "name" + ], + "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.", "location": "query", - "type": "integer", - "format": "int32" + "type": "boolean" }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", + "name": { + "description": "Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", + "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a RagFile.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.get", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1RagFile" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Import files from Google Cloud Storage or Google Drive into a RagCorpus.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.import", + "parameterOrder": [ + "parent" ], - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." + "parameters": { + "parent": { + "description": "Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/ragFiles:import", + "request": { + "$ref": "GoogleCloudAiplatformV1ImportRagFilesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "get": { - "id": "aiplatform.projects.locations.migratableResources.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}", + "list": { + "description": "Lists RagFiles in a RagCorpus.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles", "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", + "pageSize": { + "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", + "type": "integer" + }, + "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" + }, + "parent": { + "description": "Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+parent}/ragFiles", + "response": { + "$ref": "GoogleCloudAiplatformV1ListRagFilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "ragEngineConfig": { + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.migratableResources.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.migratableResources.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "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": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.list", "parameterOrder": [ "name" ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.migratableResources.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "notebookRuntimes": { + "reasoningEngines": { "methods": { - "assign": { - "id": "aiplatform.projects.locations.notebookRuntimes.assign", - "path": "v1/{+parent}/notebookRuntimes:assign", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign", + "asyncQuery": { + "description": "Async query using a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:asyncQuery", "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.asyncQuery", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}:asyncQuery", "request": { - "$ref": "GoogleCloudAiplatformV1AssignNotebookRuntimeRequest" + "$ref": "GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "get": { - "id": "aiplatform.projects.locations.notebookRuntimes.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", - "httpMethod": "GET", + "cancelAsyncQuery": { + "description": "Cancels an AsyncQueryReasoningEngine operation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:cancelAsyncQuery", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.cancelAsyncQuery", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancelAsyncQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1NotebookRuntime" + "$ref": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a NotebookRuntime." + ] }, - "list": { - "id": "aiplatform.projects.locations.notebookRuntimes.list", - "path": "v1/{+parent}/notebookRuntimes", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes", - "httpMethod": "GET", - "parameters": { + "create": { + "description": "Creates a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.create", + "parameterOrder": [ + "parent" + ], + "parameters": { "parent": { - "description": "Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", + "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/reasoningEngines", + "request": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "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.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "executeCode": { + "description": "Executes code statelessly.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:executeCode", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.executeCode", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:executeCode", + "request": { + "$ref": "GoogleCloudAiplatformV1ExecuteCodeRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ExecuteCodeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "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" }, + "resource": { + "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/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists reasoning engines in a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.list", + "parameterOrder": [ + "parent" + ], + "parameters": { "filter": { - "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`", + "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.", + "description": "Optional. The standard list page token.", "location": "query", "type": "string" }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - }, - "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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", - "location": "query", + "parent": { + "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/reasoningEngines", "response": { - "$ref": "GoogleCloudAiplatformV1ListNotebookRuntimesResponse" + "$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists NotebookRuntimes in a Location." + ] }, - "delete": { - "id": "aiplatform.projects.locations.notebookRuntimes.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", - "httpMethod": "DELETE", + "patch": { + "description": "Updates a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.reasoningEngines.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a NotebookRuntime." + ] }, - "upgrade": { - "id": "aiplatform.projects.locations.notebookRuntimes.upgrade", - "path": "v1/{+name}:upgrade", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade", + "query": { + "description": "Queries using a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query", "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.query", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:query", "request": { - "$ref": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest" + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Upgrades a NotebookRuntime." + ] }, - "start": { - "id": "aiplatform.projects.locations.notebookRuntimes.start", - "path": "v1/{+name}:start", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start", + "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": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:setIamPolicy", "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.setIamPolicy", + "parameterOrder": [ + "resource" + ], "parameters": { - "name": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+resource}:setIamPolicy", "request": { - "$ref": "GoogleCloudAiplatformV1StartNotebookRuntimeRequest" + "$ref": "GoogleIamV1SetIamPolicyRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Starts a NotebookRuntime." + ] }, - "stop": { - "id": "aiplatform.projects.locations.notebookRuntimes.stop", - "path": "v1/{+name}:stop", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop", + "streamQuery": { + "description": "Streams queries using a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery", "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.streamQuery", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:streamQuery", "request": { - "$ref": "GoogleCloudAiplatformV1StopNotebookRuntimeRequest" + "$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.testIamPermissions", + "parameterOrder": [ + "resource" ], - "description": "Stops a NotebookRuntime." + "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).", + "location": "query", + "repeated": true, + "type": "string" + }, + "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.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { - "operations": { + "memories": { "methods": { - "list": { - "id": "aiplatform.projects.locations.notebookRuntimes.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations", + "create": { + "description": "Create a Memory.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.memories.create", + "parameterOrder": [ + "parent" + ], + "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.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/memories", + "request": { + "$ref": "GoogleCloudAiplatformV1Memory" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a Memory.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.memories.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generate": { + "description": "Generate memories.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:generate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.memories.generate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/memories:generate", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateMemoriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a Memory.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.memories.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string" - }, + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Memory" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List Memories.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.memories.list", + "parameterOrder": [ + "parent" + ], + "parameters": { "filter": { - "description": "The standard list filter.", + "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", + "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" }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. 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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" + "parent": { + "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/memories", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1ListMemoriesResponse" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.notebookRuntimes.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", - "httpMethod": "GET", + "patch": { + "description": "Update a Memory.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.reasoningEngines.memories.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Memory" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.notebookRuntimes.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", - "httpMethod": "DELETE", + "purge": { + "description": "Purge memories.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:purge", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.memories.purge", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/memories:purge", + "request": { + "$ref": "GoogleCloudAiplatformV1PurgeMemoriesRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.notebookRuntimes.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", + "retrieve": { + "description": "Retrieve memories.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:retrieve", "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.memories.retrieve", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/memories:retrieve", + "request": { + "$ref": "GoogleCloudAiplatformV1RetrieveMemoriesRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1RetrieveMemoriesResponse" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.notebookRuntimes.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", + "rollback": { + "description": "Rollback Memory to a specific revision.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}:rollback", "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.memories.rollback", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:rollback", + "request": { + "$ref": "GoogleCloudAiplatformV1RollbackMemoryRequest" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." - } - } - } - } - }, - "notebookExecutionJobs": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.notebookExecutionJobs.create", - "path": "v1/{+parent}/notebookExecutionJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "notebookExecutionJobId": { - "description": "Optional. User specified ID for the NotebookExecutionJob.", - "location": "query", - "type": "string" + ] } }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a NotebookExecutionJob." - }, - "get": { - "id": "aiplatform.projects.locations.notebookExecutionJobs.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the NotebookExecutionJob resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } }, - "view": { - "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", - "location": "query", - "type": "string", - "enumDescriptions": [ - "When unspecified, the API defaults to the BASIC view.", - "Includes all fields except for direct notebook inputs.", - "Includes all fields." - ], - "enum": [ - "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", - "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", - "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" - ] + "revisions": { + "methods": { + "get": { + "description": "Get a Memory Revision.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions/{revisionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.memories.revisions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/revisions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1MemoryRevision" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List Memory Revisions for a Memory.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.memories.revisions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "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": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/revisions", + "response": { + "$ref": "GoogleCloudAiplatformV1ListMemoryRevisionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a NotebookExecutionJob." + } }, - "list": { - "id": "aiplatform.projects.locations.notebookExecutionJobs.list", - "path": "v1/{+parent}/notebookExecutionJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "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", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs 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. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", - "location": "query", - "type": "string" + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "view": { - "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", - "location": "query", - "type": "string", - "enumDescriptions": [ - "When unspecified, the API defaults to the BASIC view.", - "Includes all fields except for direct notebook inputs.", - "Includes all fields." + "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": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.operations.delete", + "parameterOrder": [ + "name" ], - "enum": [ - "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", - "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", - "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" ] - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists NotebookExecutionJobs in a Location." - }, - "delete": { - "id": "aiplatform.projects.locations.notebookExecutionJobs.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the NotebookExecutionJob resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a NotebookExecutionJob." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/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": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -22031,1790 +23192,2356 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", - "httpMethod": "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": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "runtimeRevisions": { + "methods": { + "query": { + "description": "Queries using a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.query", + "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": { - "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:query", + "request": { + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", + "streamQuery": { + "description": "Streams queries using a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery", "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.streamQuery", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:streamQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "sandboxEnvironmentSnapshots": { + "methods": { + "delete": { + "description": "Deletes the specific SandboxEnvironmentSnapshot.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.delete", + "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": { - "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", + "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": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specific SandboxEnvironmentSnapshot.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.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", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SandboxEnvironmentSnapshots in a given reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.list", + "parameterOrder": [ + "parent" ], - "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." - } - } - } - } - }, - "persistentResources": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.persistentResources.create", - "path": "v1/{+parent}/persistentResources", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PersistentResource" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a PersistentResource." - }, - "get": { - "id": "aiplatform.projects.locations.persistentResources.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", - "httpMethod": "GET", - "parameters": { - "name": { - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1PersistentResource" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a PersistentResource." - }, - "list": { - "id": "aiplatform.projects.locations.persistentResources.list", - "path": "v1/{+parent}/persistentResources", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListPersistentResourcesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists PersistentResources in a Location." - }, - "delete": { - "id": "aiplatform.projects.locations.persistentResources.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a PersistentResource." - }, - "patch": { - "id": "aiplatform.projects.locations.persistentResources.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Immutable. Resource name of a PersistentResource.", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Specify the fields to be overwritten in the PersistentResource by the update method.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PersistentResource" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a PersistentResource." - }, - "reboot": { - "id": "aiplatform.projects.locations.persistentResources.reboot", - "path": "v1/{+name}:reboot", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot", - "httpMethod": "POST", - "parameters": { - "name": { - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1RebootPersistentResourceRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Reboots a PersistentResource." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.persistentResources.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations", - "httpMethod": "GET", "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, "filter": { - "description": "The standard list filter.", + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.", "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" + "parent": { + "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/sandboxEnvironmentSnapshots", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentSnapshotsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "sandboxEnvironmentTemplates": { + "methods": { + "create": { + "description": "Creates a SandboxEnvironmentTemplate in a given reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.create", + "parameterOrder": [ + "parent" ], - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." - }, - "get": { - "id": "aiplatform.projects.locations.persistentResources.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/sandboxEnvironmentTemplates", + "request": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.persistentResources.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "description": "Deletes the specific SandboxEnvironmentTemplate.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "description": "Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.persistentResources.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "get": { + "description": "Gets details of the specific SandboxEnvironmentTemplate.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "description": "Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.persistentResources.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "list": { + "description": "Lists SandboxEnvironmentTemplates in a given reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", "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.", + "pageSize": { + "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", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.", "location": "query", - "type": "string", - "format": "google-duration" + "type": "string" + }, + "parent": { + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" } }, + "path": "v1/{+parent}/sandboxEnvironmentTemplates", + "response": { + "$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentTemplatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "sandboxEnvironments": { + "methods": { + "create": { + "description": "Creates a SandboxEnvironment in a given reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create", "parameterOrder": [ - "name" + "parent" ], + "parameters": { + "parent": { + "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sandboxEnvironments", + "request": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironment" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specific SandboxEnvironment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete", + "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." - } - } - } - } - }, - "trainingPipelines": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.trainingPipelines.create", - "path": "v1/{+parent}/trainingPipelines", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1TrainingPipeline" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1TrainingPipeline" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run." - }, - "get": { - "id": "aiplatform.projects.locations.trainingPipelines.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1TrainingPipeline" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a TrainingPipeline." - }, - "list": { - "id": "aiplatform.projects.locations.trainingPipelines.list", - "path": "v1/{+parent}/trainingPipelines", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "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*\"`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" + "parameters": { + "name": { + "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/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.", - "location": "query", - "type": "string" + "execute": { + "description": "Executes using a sandbox environment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute", + "parameterOrder": [ + "name" + ], + "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": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:execute", + "request": { + "$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListTrainingPipelinesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists TrainingPipelines in a Location." - }, - "delete": { - "id": "aiplatform.projects.locations.trainingPipelines.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a TrainingPipeline." - }, - "cancel": { - "id": "aiplatform.projects.locations.trainingPipelines.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CancelTrainingPipelineRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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`." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.trainingPipelines.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations", + "get": { + "description": "Gets details of the specific SandboxEnvironment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" - }, + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SandboxEnvironments in a given reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { "filter": { - "description": "The standard list filter.", + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" + "parent": { + "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" } }, + "path": "v1/{+parent}/sandboxEnvironments", + "response": { + "$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "snapshot": { + "description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.snapshot", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:snapshot", + "request": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "sessions": { + "methods": { + "appendEvent": { + "description": "Appends an event to a given session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent", + "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": { - "id": "aiplatform.projects.locations.trainingPipelines.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", + "description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}:appendEvent", + "request": { + "$ref": "GoogleCloudAiplatformV1SessionEvent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1AppendEventResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.create", "parameterOrder": [ - "name" + "parent" ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "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" + } + }, + "path": "v1/{+parent}/sessions", + "request": { + "$ref": "GoogleCloudAiplatformV1Session" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.trainingPipelines.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", + "description": "Deletes details of the specific Session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", + "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.trainingPipelines.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "get": { + "description": "Gets details of the specific Session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", + "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Sessions in a given reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.list", "parameterOrder": [ - "name" + "parent" ], + "parameters": { + "filter": { + "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", + "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. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "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", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sessions", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1ListSessionsResponse" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.trainingPipelines.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "patch": { + "description": "Updates the specific Session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", + "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/[^/]+$", "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.", + "updateMask": { + "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Session" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1Session" }, "scopes": [ "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." - } - } - } - } - }, - "pipelineJobs": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.pipelineJobs.create", - "path": "v1/{+parent}/pipelineJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "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-/`.", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PipelineJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1PipelineJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a PipelineJob. A PipelineJob will run immediately when created." - }, - "get": { - "id": "aiplatform.projects.locations.pipelineJobs.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}", - "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", - "required": true, - "type": "string" + ] } }, - "parameterOrder": [ - "name" + "resources": { + "events": { + "methods": { + "list": { + "description": "Lists Events in a given session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"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", + "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. Supported fields: * `timestamp` Example: `timestamp desc`.", + "location": "query", + "type": "string" + }, + "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/events", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "schedules": { + "methods": { + "create": { + "description": "Creates a Schedule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.schedules.create", + "parameterOrder": [ + "parent" ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schedules", + "request": { + "$ref": "GoogleCloudAiplatformV1Schedule" + }, "response": { - "$ref": "GoogleCloudAiplatformV1PipelineJob" + "$ref": "GoogleCloudAiplatformV1Schedule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Schedule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.schedules.delete", + "parameterOrder": [ + "name" ], - "description": "Gets a PipelineJob." + "parameters": { + "name": { + "description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "list": { - "id": "aiplatform.projects.locations.pipelineJobs.list", - "path": "v1/{+parent}/pipelineJobs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs", + "get": { + "description": "Gets a Schedule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.schedules.get", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "name": { + "description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" - }, + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Schedule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Schedules in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.schedules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { "filter": { - "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\".", + "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:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` 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>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`", + "location": "query", + "type": "string" + }, + "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" }, "pageSize": { - "description": "The standard list page size.", + "description": "The standard list page size. Default to 100 if not specified.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.", + "description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.", "location": "query", "type": "string" }, - "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", + "parent": { + "description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/schedules", "response": { - "$ref": "GoogleCloudAiplatformV1ListPipelineJobsResponse" + "$ref": "GoogleCloudAiplatformV1ListSchedulesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists PipelineJobs in a Location." + ] }, - "delete": { - "id": "aiplatform.projects.locations.pipelineJobs.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "patch": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.schedules.patch", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a PipelineJob." - }, - "batchDelete": { - "id": "aiplatform.projects.locations.pipelineJobs.batchDelete", - "path": "v1/{+parent}/pipelineJobs:batchDelete", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete", - "httpMethod": "POST", "parameters": { - "parent": { - "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "name": { + "description": "Immutable. The resource name of the Schedule.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest" + "$ref": "GoogleCloudAiplatformV1Schedule" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1Schedule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.pipelineJobs.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel", + "pause": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause", "httpMethod": "POST", + "id": "aiplatform.projects.locations.schedules.pause", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", + "description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:pause", "request": { - "$ref": "GoogleCloudAiplatformV1CancelPipelineJobRequest" + "$ref": "GoogleCloudAiplatformV1PauseScheduleRequest" }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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`." + ] }, - "batchCancel": { - "id": "aiplatform.projects.locations.pipelineJobs.batchCancel", - "path": "v1/{+parent}/pipelineJobs:batchCancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel", + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume", "httpMethod": "POST", + "id": "aiplatform.projects.locations.schedules.resume", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "name": { + "description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}:resume", "request": { - "$ref": "GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest" + "$ref": "GoogleCloudAiplatformV1ResumeScheduleRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.pipelineJobs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.schedules.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.pipelineJobs.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.pipelineJobs.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.schedules.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.pipelineJobs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", + "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": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.schedules.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.pipelineJobs.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.schedules.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "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.", + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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": "string", - "format": "google-duration" + "type": "boolean" } }, - "parameterOrder": [ + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.schedules.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "skills": { + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.skills.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.skills.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.skills.operations.get", + "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.skills.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.skills.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." + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } } }, - "reasoningEngines": { + "specialistPools": { "methods": { - "query": { - "id": "aiplatform.projects.locations.reasoningEngines.query", - "path": "v1/{+name}:query", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query", + "create": { + "description": "Creates a SpecialistPool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", "httpMethod": "POST", + "id": "aiplatform.projects.locations.specialistPools.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "parent": { + "description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/specialistPools", "request": { - "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" + "$ref": "GoogleCloudAiplatformV1SpecialistPool" }, "response": { - "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Queries using a reasoning engine." + ] }, - "streamQuery": { - "id": "aiplatform.projects.locations.reasoningEngines.streamQuery", - "path": "v1/{+name}:streamQuery", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "delete": { + "description": "Deletes a SpecialistPool as well as all Specialists in the pool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.specialistPools.delete", "parameterOrder": [ "name" ], - "request": { - "$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Streams queries using a reasoning engine." - }, - "create": { - "id": "aiplatform.projects.locations.reasoningEngines.create", - "path": "v1/{+parent}/reasoningEngines", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", - "httpMethod": "POST", "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "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": { + "description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" - }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a reasoning engine." + ] }, "get": { - "id": "aiplatform.projects.locations.reasoningEngines.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "description": "Gets a SpecialistPool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.specialistPools.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + "$ref": "GoogleCloudAiplatformV1SpecialistPool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a reasoning engine." + ] }, "list": { - "id": "aiplatform.projects.locations.reasoningEngines.list", - "path": "v1/{+parent}/reasoningEngines", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", + "description": "Lists SpecialistPools in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", "httpMethod": "GET", + "id": "aiplatform.projects.locations.specialistPools.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "filter": { - "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "pageToken": { + "description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.", "location": "query", "type": "string" }, - "pageSize": { - "description": "Optional. The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" + "parent": { + "description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" }, - "pageToken": { - "description": "Optional. The standard list page token.", + "readMask": { + "description": "Mask specifying which fields to read. FieldMask represents a set of", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/specialistPools", "response": { - "$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" + "$ref": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists reasoning engines in a location." + ] }, "patch": { - "id": "aiplatform.projects.locations.reasoningEngines.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "description": "Updates a SpecialistPool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Mask specifying which fields to update.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, + "id": "aiplatform.projects.locations.specialistPools.patch", "parameterOrder": [ "name" ], - "request": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a reasoning engine." - }, - "delete": { - "id": "aiplatform.projects.locations.reasoningEngines.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", - "httpMethod": "DELETE", "parameters": { "name": { - "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "description": "Required. The resource name of the SpecialistPool.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" }, - "force": { - "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.", + "updateMask": { + "description": "Required. The update mask applies to the resource.", + "format": "google-fieldmask", "location": "query", - "type": "boolean" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1SpecialistPool" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a reasoning engine." + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.reasoningEngines.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.specialistPools.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.reasoningEngines.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.specialistPools.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.reasoningEngines.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", - "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.specialistPools.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.reasoningEngines.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.specialistPools.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.reasoningEngines.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.specialistPools.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } } }, - "schedules": { + "studies": { "methods": { "create": { - "id": "aiplatform.projects.locations.schedules.create", - "path": "v1/{+parent}/schedules", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", + "description": "Creates a Study. A resource name will be generated after creation of the Study.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.create", + "parameterOrder": [ + "parent" + ], "parameters": { "parent": { - "description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/studies", "request": { - "$ref": "GoogleCloudAiplatformV1Schedule" + "$ref": "GoogleCloudAiplatformV1Study" }, "response": { - "$ref": "GoogleCloudAiplatformV1Schedule" + "$ref": "GoogleCloudAiplatformV1Study" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a Schedule." + ] }, "delete": { - "id": "aiplatform.projects.locations.schedules.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", + "description": "Deletes a Study.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.studies.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a Schedule." + ] }, "get": { - "id": "aiplatform.projects.locations.schedules.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", + "description": "Gets a Study by name.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Schedule" + "$ref": "GoogleCloudAiplatformV1Study" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a Schedule." + ] }, "list": { - "id": "aiplatform.projects.locations.schedules.list", - "path": "v1/{+parent}/schedules", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", + "description": "Lists all the studies in a region for an associated project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "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:*`", - "location": "query", - "type": "string" - }, "pageSize": { - "description": "The standard list page size. Default to 100 if not specified.", + "description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.", + "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", "location": "query", "type": "string" }, - "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" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListSchedulesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists Schedules in a Location." - }, - "pause": { - "id": "aiplatform.projects.locations.schedules.pause", - "path": "v1/{+name}:pause", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "parent": { + "description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PauseScheduleRequest" - }, + "path": "v1/{+parent}/studies", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1ListStudiesResponse" }, "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." + ] }, - "resume": { - "id": "aiplatform.projects.locations.schedules.resume", - "path": "v1/{+name}:resume", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume", + "lookup": { + "description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies:lookup", "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.studies.lookup", "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ResumeScheduleRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "parent" ], - "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." - }, - "patch": { - "id": "aiplatform.projects.locations.schedules.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", - "httpMethod": "PATCH", "parameters": { - "name": { - "description": "Immutable. The resource name of the Schedule.", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "parent": { + "description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", - "location": "query", - "type": "string", - "format": "google-fieldmask" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/studies:lookup", "request": { - "$ref": "GoogleCloudAiplatformV1Schedule" + "$ref": "GoogleCloudAiplatformV1LookupStudyRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1Schedule" + "$ref": "GoogleCloudAiplatformV1Study" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.schedules.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/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": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.studies.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "description": "The standard list page token.", @@ -23822,884 +25549,940 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.schedules.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", - "httpMethod": "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": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "trials": { + "methods": { + "addTrialMeasurement": { + "description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement", + "parameterOrder": [ + "trialName" ], - "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": { + "trialName": { + "description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+trialName}:addTrialMeasurement", + "request": { + "$ref": "GoogleCloudAiplatformV1AddTrialMeasurementRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "delete": { - "id": "aiplatform.projects.locations.schedules.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", - "httpMethod": "DELETE", + "checkTrialEarlyStoppingState": { + "description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState", + "parameterOrder": [ + "trialName" + ], "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "trialName": { + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+trialName}:checkTrialEarlyStoppingState", + "request": { + "$ref": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "complete": { + "description": "Marks a Trial as complete.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.complete", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:complete", + "request": { + "$ref": "GoogleCloudAiplatformV1CompleteTrialRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1Trial" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.schedules.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel", + "create": { + "description": "Adds a user provided Trial to a Study.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+parent}/trials", + "request": { + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Trial.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.studies.trials.delete", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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`." + ] }, - "wait": { - "id": "aiplatform.projects.locations.schedules.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait", - "httpMethod": "POST", + "get": { + "description": "Gets a Trial.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.trials.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the Trials associated with a Study.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.trials.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" }, - "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.", + "pageToken": { + "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", "location": "query", - "type": "string", - "format": "google-duration" + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "required": true, + "type": "string" } }, + "path": "v1/{+parent}/trials", + "response": { + "$ref": "GoogleCloudAiplatformV1ListTrialsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listOptimalTrials": { + "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", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.listOptimalTrials", "parameterOrder": [ - "name" + "parent" ], + "parameters": { + "parent": { + "description": "Required. The name of the Study that the optimal Trial belongs to.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/trials:listOptimalTrials", + "request": { + "$ref": "GoogleCloudAiplatformV1ListOptimalTrialsRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1ListOptimalTrialsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "stop": { + "description": "Stops a Trial.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.stop", + "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." - } - } - } - } - }, - "specialistPools": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.specialistPools.create", - "path": "v1/{+parent}/specialistPools", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", - "httpMethod": "POST", + "parameters": { + "name": { + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:stop", + "request": { + "$ref": "GoogleCloudAiplatformV1StopTrialRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "suggest": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.suggest", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/trials:suggest", + "request": { + "$ref": "GoogleCloudAiplatformV1SuggestTrialsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.studies.trials.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.trials.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.trials.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "tensorboards": { + "methods": { + "batchRead": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.batchRead", + "parameterOrder": [ + "tensorboard" + ], "parameters": { - "parent": { - "description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "tensorboard": { + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" + }, + "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}`", + "location": "query", + "repeated": true, + "type": "string" } }, + "path": "v1/{+tensorboard}:batchRead", + "response": { + "$ref": "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a Tensorboard.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.create", "parameterOrder": [ "parent" ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/tensorboards", "request": { - "$ref": "GoogleCloudAiplatformV1SpecialistPool" + "$ref": "GoogleCloudAiplatformV1Tensorboard" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a SpecialistPool." + ] }, - "get": { - "id": "aiplatform.projects.locations.specialistPools.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", - "httpMethod": "GET", + "delete": { + "description": "Deletes a Tensorboard.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", + "description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Tensorboard.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.get", "parameterOrder": [ "name" ], + "parameters": { + "name": { + "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1SpecialistPool" + "$ref": "GoogleCloudAiplatformV1Tensorboard" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a SpecialistPool." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, "list": { - "id": "aiplatform.projects.locations.specialistPools.list", - "path": "v1/{+parent}/specialistPools", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", + "description": "Lists Tensorboards in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "Lists the Tensorboards that match the filter expression.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field to use to sort the list.", + "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.", + "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": { + "description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, "readMask": { - "description": "Mask specifying which fields to read. FieldMask represents a set of", + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-fieldmask" + "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/tensorboards", "response": { - "$ref": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse" + "$ref": "GoogleCloudAiplatformV1ListTensorboardsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists SpecialistPools in a Location." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "delete": { - "id": "aiplatform.projects.locations.specialistPools.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", - "httpMethod": "DELETE", + "patch": { + "description": "Updates a Tensorboard.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.tensorboards.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", + "description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" }, - "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.)", + "updateMask": { + "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", - "type": "boolean" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Tensorboard" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a SpecialistPool as well as all Specialists in the pool." + ] }, - "patch": { - "id": "aiplatform.projects.locations.specialistPools.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", - "httpMethod": "PATCH", + "readSize": { + "description": "Returns the storage size for a given TensorBoard instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.readSize", + "parameterOrder": [ + "tensorboard" + ], "parameters": { - "name": { - "description": "Required. The resource name of the SpecialistPool.", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", + "tensorboard": { + "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource.", - "location": "query", - "type": "string", - "format": "google-fieldmask" } }, + "path": "v1/{+tensorboard}:readSize", + "response": { + "$ref": "GoogleCloudAiplatformV1ReadTensorboardSizeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "readUsage": { + "description": "Returns a list of monthly active users for a given TensorBoard instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.readUsage", "parameterOrder": [ - "name" + "tensorboard" ], - "request": { - "$ref": "GoogleCloudAiplatformV1SpecialistPool" + "parameters": { + "tensorboard": { + "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+tensorboard}:readUsage", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a SpecialistPool." + ] } }, "resources": { - "operations": { + "experiments": { "methods": { - "list": { - "id": "aiplatform.projects.locations.specialistPools.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations", - "httpMethod": "GET", + "batchCreate": { + "description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", + "parent": { + "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/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}:batchCreate", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.specialistPools.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", - "httpMethod": "GET", + "create": { + "description": "Creates a TensorboardExperiment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" + }, + "tensorboardExperimentId": { + "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", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/experiments", + "request": { + "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.specialistPools.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "description": "Deletes a TensorboardExperiment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.specialistPools.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "get": { + "description": "Gets a TensorboardExperiment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.specialistPools.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "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", - "type": "string", - "format": "google-duration" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" }, "scopes": [ - "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." - } - } - } - } - }, - "tensorboards": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.tensorboards.create", - "path": "v1/{+parent}/tensorboards", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Tensorboard" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a Tensorboard." - }, - "get": { - "id": "aiplatform.projects.locations.tensorboards.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1Tensorboard" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Gets a Tensorboard." - }, - "patch": { - "id": "aiplatform.projects.locations.tensorboards.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "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.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Tensorboard" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a Tensorboard." - }, - "list": { - "id": "aiplatform.projects.locations.tensorboards.list", - "path": "v1/{+parent}/tensorboards", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "Lists the Tensorboards that match the filter expression.", - "location": "query", - "type": "string" - }, - "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.", - "location": "query", - "type": "integer", - "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" - }, - "orderBy": { - "description": "Field to use to sort the list.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListTensorboardsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Lists Tensorboards in a Location." - }, - "delete": { - "id": "aiplatform.projects.locations.tensorboards.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a Tensorboard." - }, - "readUsage": { - "id": "aiplatform.projects.locations.tensorboards.readUsage", - "path": "v1/{+tensorboard}:readUsage", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage", - "httpMethod": "GET", - "parameters": { - "tensorboard": { - "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "tensorboard" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Returns a list of monthly active users for a given TensorBoard instance." - }, - "readSize": { - "id": "aiplatform.projects.locations.tensorboards.readSize", - "path": "v1/{+tensorboard}:readSize", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize", - "httpMethod": "GET", - "parameters": { - "tensorboard": { - "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "tensorboard" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ReadTensorboardSizeResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Returns the storage size for a given TensorBoard instance." - }, - "batchRead": { - "id": "aiplatform.projects.locations.tensorboards.batchRead", - "path": "v1/{+tensorboard}:batchRead", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead", - "httpMethod": "GET", - "parameters": { - "tensorboard": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "location": "path", - "required": true, - "type": "string" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "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}`", - "location": "query", - "repeated": true, - "type": "string" - } - }, - "parameterOrder": [ - "tensorboard" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse" - }, - "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." - } - }, - "resources": { - "operations": { - "methods": { "list": { - "id": "aiplatform.projects.locations.tensorboards.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations", + "description": "Lists TensorboardExperiments in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "Lists the TensorboardExperiments that match the filter expression.", + "location": "query", "type": "string" }, - "filter": { - "description": "The standard list filter.", + "orderBy": { + "description": "Field to use to sort the list.", "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "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" }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.tensorboards.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", + "parent": { + "description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.tensorboards.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/experiments", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse" }, "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`." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "cancel": { - "id": "aiplatform.projects.locations.tensorboards.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "patch": { + "description": "Updates a TensorboardExperiment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.tensorboards.experiments.patch", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.tensorboards.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - }, - "experiments": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.tensorboards.experiments.create", - "path": "v1/{+parent}/experiments", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" }, - "tensorboardExperimentId": { - "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-/`.", + "updateMask": { + "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.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}", "request": { "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" }, @@ -24708,579 +26491,413 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a TensorboardExperiment." + ] }, - "get": { - "id": "aiplatform.projects.locations.tensorboards.experiments.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", - "httpMethod": "GET", + "write": { + "description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.write", + "parameterOrder": [ + "tensorboardExperiment" + ], "parameters": { - "name": { - "description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "tensorboardExperiment": { + "description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+tensorboardExperiment}:write", + "request": { + "$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Gets a TensorboardExperiment." - }, - "patch": { - "id": "aiplatform.projects.locations.tensorboards.experiments.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "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.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a TensorboardExperiment." - }, - "list": { - "id": "aiplatform.projects.locations.tensorboards.experiments.list", - "path": "v1/{+parent}/experiments", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "Lists the TensorboardExperiments that match the filter expression.", - "location": "query", - "type": "string" - }, - "pageSize": { - "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.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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" - }, - "orderBy": { - "description": "Field to use to sort the list.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Lists TensorboardExperiments in a Location." - }, - "delete": { - "id": "aiplatform.projects.locations.tensorboards.experiments.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a TensorboardExperiment." - }, - "batchCreate": { - "id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate", - "path": "v1/{+parent}:batchCreate", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate", - "httpMethod": "POST", - "parameters": { - "parent": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment." - }, - "write": { - "id": "aiplatform.projects.locations.tensorboards.experiments.write", - "path": "v1/{+tensorboardExperiment}:write", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write", - "httpMethod": "POST", - "parameters": { - "tensorboardExperiment": { - "description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "tensorboardExperiment" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse" + "$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse" }, "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." + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.get", - "path": "v1/{+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`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", - "httpMethod": "GET", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete", - "path": "v1/{+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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", - "httpMethod": "DELETE", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait", - "path": "v1/{+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": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } }, "runs": { "methods": { - "create": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.create", - "path": "v1/{+parent}/runs", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", + "batchCreate": { + "description": "Batch create TensorboardRuns.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate", "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate", + "parameterOrder": [ + "parent" + ], "parameters": { "parent": { - "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "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.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" - }, - "tensorboardRunId": { - "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-/`.", - "location": "query", - "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/runs:batchCreate", "request": { - "$ref": "GoogleCloudAiplatformV1TensorboardRun" + "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardRun" + "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a TensorboardRun." + ] }, - "batchCreate": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate", - "path": "v1/{+parent}/runs:batchCreate", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate", + "create": { + "description": "Creates a TensorboardRun.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.create", + "parameterOrder": [ + "parent" + ], "parameters": { "parent": { - "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.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" + }, + "tensorboardRunId": { + "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-/`.", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/runs", "request": { - "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest" + "$ref": "GoogleCloudAiplatformV1TensorboardRun" }, "response": { - "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse" + "$ref": "GoogleCloudAiplatformV1TensorboardRun" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Batch create TensorboardRuns." + ] }, - "get": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.get", - "path": "v1/{+name}", + "delete": { + "description": "Deletes a TensorboardRun.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", - "httpMethod": "GET", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardRun" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Gets a TensorboardRun." + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "patch": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch", - "path": "v1/{+name}", + "get": { + "description": "Gets a TensorboardRun.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", - "httpMethod": "PATCH", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" - }, - "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" } }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1TensorboardRun" - }, + "path": "v1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1TensorboardRun" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a TensorboardRun." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, "list": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.list", - "path": "v1/{+parent}/runs", + "description": "Lists TensorboardRuns in a Location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, "filter": { "description": "Lists the TensorboardRuns that match the filter expression.", "location": "query", "type": "string" }, + "orderBy": { + "description": "Field to use to sort the list.", + "location": "query", + "type": "string" + }, "pageSize": { "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "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" }, - "orderBy": { - "description": "Field to use to sort the list.", - "location": "query", + "parent": { + "description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "required": true, "type": "string" }, "readMask": { "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-fieldmask" + "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/runs", "response": { "$ref": "GoogleCloudAiplatformV1ListTensorboardRunsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Lists TensorboardRuns in a Location." + ] }, - "delete": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete", - "path": "v1/{+name}", + "patch": { + "description": "Updates a TensorboardRun.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", - "httpMethod": "DELETE", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" + }, + "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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1TensorboardRun" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1TensorboardRun" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a TensorboardRun." + ] }, "write": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.write", - "path": "v1/{+tensorboardRun}:write", + "description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write", "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.write", + "parameterOrder": [ + "tensorboardRun" + ], "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "tensorboardRun" - ], + "path": "v1/{+tensorboardRun}:write", "request": { "$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest" }, @@ -25289,179 +26906,181 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned." + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get", - "path": "v1/{+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`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete", - "path": "v1/{+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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", - "httpMethod": "DELETE", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait", - "path": "v1/{+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": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } }, "timeSeries": { "methods": { "create": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create", - "path": "v1/{+parent}/timeSeries", + "description": "Creates a TensorboardTimeSeries.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create", + "parameterOrder": [ + "parent" + ], "parameters": { "parent": { "description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" }, @@ -25471,9 +27090,7 @@ "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/timeSeries", "request": { "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" }, @@ -25482,399 +27099,398 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a TensorboardTimeSeries." + ] }, - "get": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get", - "path": "v1/{+name}", + "delete": { + "description": "Deletes a TensorboardTimeSeries.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", - "httpMethod": "GET", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "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", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Gets a TensorboardTimeSeries." + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "patch": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", - "httpMethod": "PATCH", + "exportTensorboardTimeSeries": { + "description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries", + "parameterOrder": [ + "tensorboardTimeSeries" + ], "parameters": { - "name": { - "description": "Output only. Name of the TensorboardTimeSeries.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "tensorboardTimeSeries": { + "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "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.", - "location": "query", - "type": "string", - "format": "google-fieldmask" } }, + "path": "v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries", + "request": { + "$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a TensorboardTimeSeries.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get", "parameterOrder": [ "name" ], - "request": { - "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" + "parameters": { + "name": { + "description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a TensorboardTimeSeries." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, "list": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list", - "path": "v1/{+parent}/timeSeries", + "description": "Lists TensorboardTimeSeries in a Location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, "filter": { "description": "Lists the TensorboardTimeSeries that match the filter expression.", "location": "query", "type": "string" }, + "orderBy": { + "description": "Field to use to sort the list.", + "location": "query", + "type": "string" + }, "pageSize": { "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.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { "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", "type": "string" }, - "orderBy": { - "description": "Field to use to sort the list.", - "location": "query", + "parent": { + "description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, "type": "string" }, "readMask": { "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "string", - "format": "google-fieldmask" + "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/timeSeries", "response": { "$ref": "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Lists TensorboardTimeSeries in a Location." + ] }, - "delete": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete", - "path": "v1/{+name}", + "patch": { + "description": "Updates a TensorboardTimeSeries.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", - "httpMethod": "DELETE", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "description": "Output only. Name of the TensorboardTimeSeries.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "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.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a TensorboardTimeSeries." + ] }, "read": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read", - "path": "v1/{+tensorboardTimeSeries}:read", + "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read", "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read", + "parameterOrder": [ + "tensorboardTimeSeries" + ], "parameters": { - "tensorboardTimeSeries": { - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "Reads the TensorboardTimeSeries' data that match the filter expression.", + "location": "query", "type": "string" }, "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", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, - "filter": { - "description": "Reads the TensorboardTimeSeries' data that match the filter expression.", - "location": "query", + "tensorboardTimeSeries": { + "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}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, "type": "string" } }, - "parameterOrder": [ - "tensorboardTimeSeries" - ], + "path": "v1/{+tensorboardTimeSeries}:read", "response": { "$ref": "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "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." + ] }, "readBlobData": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData", - "path": "v1/{+timeSeries}:readBlobData", + "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData", "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData", + "parameterOrder": [ + "timeSeries" + ], "parameters": { - "timeSeries": { - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, "blobIds": { "description": "IDs of the blobs to read.", "location": "query", "repeated": true, "type": "string" - } - }, - "parameterOrder": [ - "timeSeries" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "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." - }, - "exportTensorboardTimeSeries": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries", - "path": "v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries", - "httpMethod": "POST", - "parameters": { - "tensorboardTimeSeries": { - "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}`", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + }, + "timeSeries": { + "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}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "tensorboardTimeSeries" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest" - }, + "path": "v1/{+timeSeries}:readBlobData", "response": { - "$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse" + "$ref": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses." + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get", - "path": "v1/{+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`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", - "httpMethod": "GET", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete", - "path": "v1/{+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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", - "httpMethod": "DELETE", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait", - "path": "v1/{+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": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } } @@ -25883,1342 +27499,756 @@ } } } - } - } - }, - "studies": { - "methods": { - "create": { - "id": "aiplatform.projects.locations.studies.create", - "path": "v1/{+parent}/studies", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", - "httpMethod": "POST", - "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", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Study" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Study" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a Study. A resource name will be generated after creation of the Study." }, - "get": { - "id": "aiplatform.projects.locations.studies.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1Study" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a Study by name." - }, - "list": { - "id": "aiplatform.projects.locations.studies.list", - "path": "v1/{+parent}/studies", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "pageToken": { - "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.", - "location": "query", - "type": "integer", - "format": "int32" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListStudiesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists all the studies in a region for an associated project." - }, - "delete": { - "id": "aiplatform.projects.locations.studies.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a Study." - }, - "lookup": { - "id": "aiplatform.projects.locations.studies.lookup", - "path": "v1/{+parent}/studies:lookup", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies:lookup", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1LookupStudyRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Study" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name." - } - }, - "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.studies.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.studies.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", - "httpMethod": "GET", + "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": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.studies.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", - "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.studies.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "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`." + ] }, "wait": { - "id": "aiplatform.projects.locations.studies.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "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", - "format": "google-duration" + "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "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." + ] } } + } + } + }, + "trainingPipelines": { + "methods": { + "cancel": { + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.trainingPipelines.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelTrainingPipelineRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "trials": { + "create": { + "description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.trainingPipelines.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/trainingPipelines", + "request": { + "$ref": "GoogleCloudAiplatformV1TrainingPipeline" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1TrainingPipeline" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a TrainingPipeline.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.trainingPipelines.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a TrainingPipeline.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.trainingPipelines.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1TrainingPipeline" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists TrainingPipelines in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.trainingPipelines.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "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 `=`, `!=`,`<`, `<=`,`>`, `>=` 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>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/trainingPipelines", + "response": { + "$ref": "GoogleCloudAiplatformV1ListTrainingPipelinesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { "methods": { - "suggest": { - "id": "aiplatform.projects.locations.studies.trials.suggest", - "path": "v1/{+parent}/trials:suggest", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest", + "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": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", "httpMethod": "POST", + "id": "aiplatform.projects.locations.trainingPipelines.operations.cancel", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1SuggestTrialsRequest" - }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "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." + ] }, - "create": { - "id": "aiplatform.projects.locations.studies.trials.create", - "path": "v1/{+parent}/trials", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", - "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.trainingPipelines.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1Trial" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Trial" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Adds a user provided Trial to a Study." + ] }, "get": { - "id": "aiplatform.projects.locations.studies.trials.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", + "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": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.trainingPipelines.operations.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Trial" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a Trial." + ] }, "list": { - "id": "aiplatform.projects.locations.studies.trials.list", - "path": "v1/{+parent}/trials", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations", "httpMethod": "GET", + "id": "aiplatform.projects.locations.trainingPipelines.operations.list", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "required": true, "type": "string" }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, "pageToken": { - "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "pageSize": { - "description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.", + "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": "integer", - "format": "int32" + "type": "boolean" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1ListTrialsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists the Trials associated with a Study." + ] }, - "addTrialMeasurement": { - "id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement", - "path": "v1/{+trialName}:addTrialMeasurement", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement", + "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": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "parameters": { - "trialName": { - "description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "trialName" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1AddTrialMeasurementRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete." - }, - "complete": { - "id": "aiplatform.projects.locations.studies.trials.complete", - "path": "v1/{+name}:complete", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CompleteTrialRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Marks a Trial as complete." - }, - "delete": { - "id": "aiplatform.projects.locations.studies.trials.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", - "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.trainingPipelines.operations.wait", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "description": "The name of the operation resource to wait on.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a Trial." - }, - "checkTrialEarlyStoppingState": { - "id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState", - "path": "v1/{+trialName}:checkTrialEarlyStoppingState", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState", - "httpMethod": "POST", - "parameters": { - "trialName": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "location": "path", - "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.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "parameterOrder": [ - "trialName" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest" - }, + "path": "v1/{+name}:wait", "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." - }, - "stop": { - "id": "aiplatform.projects.locations.studies.trials.stop", - "path": "v1/{+name}:stop", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1StopTrialRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Stops a Trial." - }, - "listOptimalTrials": { - "id": "aiplatform.projects.locations.studies.trials.listOptimalTrials", - "path": "v1/{+parent}/trials:listOptimalTrials", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The name of the Study that the optimal Trial belongs to.", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ListOptimalTrialsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1ListOptimalTrialsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "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" - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.studies.trials.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.studies.trials.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.studies.trials.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.projects.locations.studies.trials.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.studies.trials.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } + ] } } } } }, - "ragCorpora": { + "tuningJobs": { "methods": { - "create": { - "id": "aiplatform.projects.locations.ragCorpora.create", - "path": "v1/{+parent}/ragCorpora", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora", + "cancel": { + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.cancel", + "parameterOrder": [ + "name" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "name": { + "description": "Required. The name of the tuning job to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+name}:cancel", "request": { - "$ref": "GoogleCloudAiplatformV1RagCorpus" + "$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a RagCorpus." + ] }, - "patch": { - "id": "aiplatform.projects.locations.ragCorpora.patch", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", - "httpMethod": "PATCH", + "create": { + "description": "Creates a tuning job. A created tuning job will be subsequently executed to start the model tuning process.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.create", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "Output only. The resource name of the RagCorpus.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "parent": { + "description": "Required. The resource name of the location to create the tuning job in. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/tuningJobs", "request": { - "$ref": "GoogleCloudAiplatformV1RagCorpus" + "$ref": "GoogleCloudAiplatformV1TuningJob" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1TuningJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a RagCorpus." + ] }, "get": { - "id": "aiplatform.projects.locations.ragCorpora.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", + "description": "Gets a tuning job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.get", + "parameterOrder": [ + "name" + ], "parameters": { "name": { - "description": "Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "description": "Required. The name of the tuning job to retrieve. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1RagCorpus" + "$ref": "GoogleCloudAiplatformV1TuningJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a RagCorpus." + ] }, "list": { - "id": "aiplatform.projects.locations.ragCorpora.list", - "path": "v1/{+parent}/ragCorpora", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora", + "description": "Lists tuning jobs in a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.list", + "parameterOrder": [ + "parent" + ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "required": true, + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.", + "description": "Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call.", "location": "query", "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" } }, - "parameterOrder": [ - "parent" - ], + "path": "v1/{+parent}/tuningJobs", "response": { - "$ref": "GoogleCloudAiplatformV1ListRagCorporaResponse" + "$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists RagCorpora in a Location." + ] }, - "delete": { - "id": "aiplatform.projects.locations.ragCorpora.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", - "httpMethod": "DELETE", + "rebaseTunedModel": { + "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", + "parameterOrder": [ + "parent" + ], "parameters": { - "name": { - "description": "Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "parent": { + "description": "Required. The resource name of the location in which to rebase the Model. Format: `projects/{project}/locations/{location}`", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - }, - "force": { - "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", - "type": "boolean" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+parent}/tuningJobs:rebaseTunedModel", + "request": { + "$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest" + }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a RagCorpus." + ] } }, "resources": { "operations": { "methods": { - "list": { - "id": "aiplatform.projects.locations.ragCorpora.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.operations.cancel", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.ragCorpora.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}", - "httpMethod": "GET", "parameters": { "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", + "description": "The name of the operation resource to be cancelled.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "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": { - "id": "aiplatform.projects.locations.ragCorpora.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tuningJobs.operations.delete", + "parameterOrder": [ + "name" + ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+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`." + ] }, - "cancel": { - "id": "aiplatform.projects.locations.ragCorpora.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.operations.get", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.ragCorpora.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", - "httpMethod": "POST", "parameters": { "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } - }, - "ragFiles": { - "methods": { - "import": { - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.import", - "path": "v1/{+parent}/ragFiles:import", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "description": "The name of the operation resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "parameterOrder": [ - "parent" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ImportRagFilesRequest" - }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Import files from Google Cloud Storage or Google Drive into a RagCorpus." + ] }, - "get": { - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations", "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, + "id": "aiplatform.projects.locations.tuningJobs.operations.list", "parameterOrder": [ "name" ], - "response": { - "$ref": "GoogleCloudAiplatformV1RagFile" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a RagFile." - }, - "list": { - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.list", - "path": "v1/{+parent}/ragFiles", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles", - "httpMethod": "GET", "parameters": { - "parent": { - "description": "Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "integer", - "format": "int32" + "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.", + "description": "The standard list page token.", "location": "query", "type": "string" - } - }, - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1ListRagFilesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists RagFiles in a RagCorpus." - }, - "delete": { - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "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/[^/]+$", - "location": "path", - "required": true, - "type": "string" }, - "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.", + "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" } }, - "parameterOrder": [ - "name" - ], + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a RagFile." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } + ] } } } @@ -27226,2199 +28256,8526 @@ } } } - } + } + }, + "publishers": { + "resources": { + "models": { + "methods": { + "computeTokens": { + "description": "Return a list of tokens based on the input text.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:computeTokens", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.computeTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:computeTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "countTokens": { + "description": "Perform a token counting.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:countTokens", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.countTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:countTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1CountTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CountTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchPredictOperation": { + "description": "Fetch an asynchronous online prediction operation.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.fetchPredictOperation", + "parameterOrder": [ + "endpoint" + ], + "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", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:fetchPredictOperation", + "request": { + "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "generateContent": { + "description": "Generate content with multimodal inputs.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:generateContent", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.generateContent", + "parameterOrder": [ + "model" + ], + "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", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:generateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "get": { + "description": "Gets a Model Garden publisher model.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}", + "httpMethod": "GET", + "id": "aiplatform.publishers.models.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "huggingFaceToken": { + "description": "Optional. Token used to access Hugging Face gated models.", + "location": "query", + "type": "string" + }, + "isHuggingFaceModel": { + "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", + "location": "query", + "type": "boolean" + }, + "languageCode": { + "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", + "type": "string" + }, + "name": { + "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. PublisherModel view specifying which fields to read.", + "enum": [ + "PUBLISHER_MODEL_VIEW_UNSPECIFIED", + "PUBLISHER_MODEL_VIEW_BASIC", + "PUBLISHER_MODEL_VIEW_FULL", + "PUBLISHER_MODEL_VERSION_VIEW_BASIC" + ], + "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." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1PublisherModel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "predict": { + "description": "", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predictLongRunning": { + "description": "", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predictLongRunning", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.predictLongRunning", + "parameterOrder": [ + "endpoint" + ], + "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", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predictLongRunning", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "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.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.streamGenerateContent", + "parameterOrder": [ + "model" + ], + "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", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:streamGenerateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } + }, + "ragCorpora": { + "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`.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.ragCorpora.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.ragCorpora.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.ragCorpora.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/operations", + "httpMethod": "GET", + "id": "aiplatform.ragCorpora.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^ragCorpora/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.ragCorpora.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "ragFiles": { + "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`.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.ragCorpora.ragFiles.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.ragCorpora.ragFiles.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.ragCorpora.ragFiles.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.ragCorpora.ragFiles.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.ragCorpora.ragFiles.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "ragEngineConfig": { + "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`.", + "flatPath": "v1/ragEngineConfig/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.ragEngineConfig.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/ragEngineConfig/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.ragEngineConfig.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/ragEngineConfig/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.ragEngineConfig.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/ragEngineConfig/operations", + "httpMethod": "GET", + "id": "aiplatform.ragEngineConfig.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^ragEngineConfig$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/ragEngineConfig/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.ragEngineConfig.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "reasoningEngines": { + "methods": { + "asyncQuery": { + "description": "Async query using a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:asyncQuery", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.asyncQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:asyncQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "cancelAsyncQuery": { + "description": "Cancels an AsyncQueryReasoningEngine operation.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:cancelAsyncQuery", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.cancelAsyncQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancelAsyncQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a reasoning engine.", + "flatPath": "v1/reasoningEngines", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.create", + "parameterOrder": [], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + } + }, + "path": "v1/reasoningEngines", + "request": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "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.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "executeCode": { + "description": "Executes code statelessly.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:executeCode", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.executeCode", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:executeCode", + "request": { + "$ref": "GoogleCloudAiplatformV1ExecuteCodeRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ExecuteCodeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists reasoning engines in a location.", + "flatPath": "v1/reasoningEngines", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.list", + "parameterOrder": [], + "parameters": { + "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.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + } + }, + "path": "v1/reasoningEngines", + "response": { + "$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "PATCH", + "id": "aiplatform.reasoningEngines.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "query": { + "description": "Queries using a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:query", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:query", + "request": { + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "streamQuery": { + "description": "Streams queries using a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:streamQuery", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.streamQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:streamQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "memories": { + "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`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.memories.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.memories.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.memories.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.memories.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.memories.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "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`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "runtimeRevisions": { + "methods": { + "query": { + "description": "Queries using a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.runtimeRevisions.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:query", + "request": { + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "streamQuery": { + "description": "Streams queries using a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.runtimeRevisions.streamQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:streamQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "sandboxEnvironmentSnapshots": { + "methods": { + "delete": { + "description": "Deletes the specific SandboxEnvironmentSnapshot.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specific SandboxEnvironmentSnapshot.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.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", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SandboxEnvironmentSnapshots in a given reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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 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.", + "format": "int32", + "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" + }, + "parent": { + "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sandboxEnvironmentSnapshots", + "response": { + "$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentSnapshotsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "sandboxEnvironmentTemplates": { + "methods": { + "create": { + "description": "Creates a SandboxEnvironmentTemplate in a given reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sandboxEnvironmentTemplates", + "request": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specific SandboxEnvironmentTemplate.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", + "httpMethod": "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", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specific SandboxEnvironmentTemplate.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SandboxEnvironmentTemplates in a given reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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 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", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` 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 environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sandboxEnvironmentTemplates", + "response": { + "$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentTemplatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "sandboxEnvironments": { + "methods": { + "create": { + "description": "Creates a SandboxEnvironment in a given reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sandboxEnvironments", + "request": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironment" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specific SandboxEnvironment.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "execute": { + "description": "Executes using a sandbox environment.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.execute", + "parameterOrder": [ + "name" + ], + "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/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:execute", + "request": { + "$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specific SandboxEnvironment.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "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/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SandboxEnvironments in a given reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "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 maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sandboxEnvironments", + "response": { + "$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "snapshot": { + "description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.snapshot", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:snapshot", + "request": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "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`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "sessions": { + "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`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sessions.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.sessions.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sessions.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sessions.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sessions.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "schedules": { + "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`.", + "flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.schedules.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/schedules/{schedulesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.schedules.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.schedules.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/schedules/{schedulesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.schedules.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^schedules/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.schedules.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^schedules/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "skills": { + "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`.", + "flatPath": "v1/skills/{skillsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.skills.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^skills/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/skills/{skillsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.skills.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^skills/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/skills/{skillsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.skills.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^skills/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/skills/{skillsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.skills.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^skills/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/skills/{skillsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.skills.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^skills/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "specialistPools": { + "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`.", + "flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.specialistPools.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.specialistPools.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.specialistPools.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/specialistPools/{specialistPoolsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.specialistPools.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^specialistPools/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.specialistPools.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "studies": { + "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`.", + "flatPath": "v1/studies/{studiesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.studies.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/studies/{studiesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.studies.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/studies/{studiesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.studies.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/studies/{studiesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.studies.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^studies/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/studies/{studiesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.studies.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^studies/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "trials": { + "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`.", + "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.studies.trials.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.studies.trials.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.studies.trials.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.studies.trials.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.studies.trials.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "tensorboards": { + "resources": { + "experiments": { + "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`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tensorboards.experiments.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.experiments.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.experiments.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "runs": { + "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`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.runs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tensorboards.experiments.runs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.experiments.runs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.experiments.runs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.runs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "timeSeries": { + "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`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + }, + "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`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tensorboards.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "trainingPipelines": { + "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`.", + "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.trainingPipelines.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.trainingPipelines.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.trainingPipelines.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.trainingPipelines.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^trainingPipelines/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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.", + "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.trainingPipelines.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", + "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" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "tuningJobs": { + "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`.", + "flatPath": "v1/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.tuningJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tuningJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "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.", + "flatPath": "v1/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.tuningJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "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`.", + "flatPath": "v1/tuningJobs/{tuningJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.tuningJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^tuningJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "v1": { + "methods": { + "evaluateDataset": { + "description": "Evaluates a dataset based on a set of given metrics.", + "flatPath": "v1:evaluateDataset", + "httpMethod": "POST", + "id": "aiplatform.evaluateDataset", + "parameterOrder": [], + "parameters": {}, + "path": "v1:evaluateDataset", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluateDatasetRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "evaluateInstances": { + "description": "Evaluates instances based on a given metric.", + "flatPath": "v1:evaluateInstances", + "httpMethod": "POST", + "id": "aiplatform.evaluateInstances", + "parameterOrder": [], + "parameters": {}, + "path": "v1:evaluateInstances", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluateInstancesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluateInstancesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateInstanceRubrics": { + "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.", + "flatPath": "v1:generateInstanceRubrics", + "httpMethod": "POST", + "id": "aiplatform.generateInstanceRubrics", + "parameterOrder": [], + "parameters": {}, + "path": "v1:generateInstanceRubrics", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + }, + "revision": "20260515", + "rootUrl": "https://aiplatform.googleapis.com/", + "schemas": { + "CloudAiLargeModelsVisionGenerateVideoExperiments": { + "description": "Experimental parameters for video generation.", + "id": "CloudAiLargeModelsVisionGenerateVideoExperiments", + "properties": { + "codec": { + "description": "Optional. Video codec to use for output.", + "enum": [ + "VIDEO_CODEC_UNSPECIFIED", + "VIDEO_CODEC_H264", + "VIDEO_CODEC_PRORES" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "conditioningFrames": { + "description": "Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest.", + "items": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame" + }, + "type": "array" + }, + "humanPose": { + "$ref": "CloudAiLargeModelsVisionHumanPose", + "description": "Human pose parameters for Pose Control" + }, + "modelName": { + "description": "Model names, as defined in: xyz ", + "type": "string" + }, + "numDiffusionSteps": { + "description": "Number of diffusion steps", + "format": "int32", + "type": "integer" + }, + "promptInputs": { + "$ref": "CloudAiLargeModelsVisionPromptInputs", + "description": "Prompt chunks for \"ProModel\" prompting. If set, the prompt will not be rewritten, and top-level prompt ignored." + }, + "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" + }, + "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" + }, + "videoTransformMaskGcsUri": { + "description": "GCS URI of the grayscale video mask for Differential Diffusion. Maps to sdedit_video_tmax_scale_map ", + "type": "string" + }, + "videoTransformStrength": { + "description": "SDEdit: Scalar noise level (0.0 to 1.0) Maps to sdedit_tmax ", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame": { + "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame", + "properties": { + "frameNum": { + "description": "The index of the frame, starts with zero and must be a multiple of 8.", + "format": "int32", + "type": "integer" + }, + "image": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoRequestImage", + "description": "The image data for this conditioning frame." + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoRequestImage": { + "description": "The image bytes or Cloud Storage URI to make the prediction on.", + "id": "CloudAiLargeModelsVisionGenerateVideoRequestImage", + "properties": { + "blobId": { + "description": "Blob ID of the image. This is used for storing the large images in the request.", + "type": "string" + }, + "bytesBase64Encoded": { + "description": "Base64 encoded bytes string representing the image.", + "type": "string" + }, + "gcsUri": { + "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/png", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoResponse": { + "description": "Generate video response.", + "id": "CloudAiLargeModelsVisionGenerateVideoResponse", + "properties": { + "generatedSamples": { + "description": "The generates samples.", + "items": { + "$ref": "CloudAiLargeModelsVisionMedia" + }, + "type": "array" + }, + "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 videos, used to align naming with the external response.", + "items": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoResponseVideo" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoResponseVideo": { + "id": "CloudAiLargeModelsVisionGenerateVideoResponseVideo", + "properties": { + "bytesBase64Encoded": { + "description": "Base64 encoded bytes string representing the video.", + "type": "string" + }, + "experimentsMetadata": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoExperiments", + "description": "Optional metadata returned from experimental requests. Likely only includes the rewritten prompt chunks." + }, + "gcsUri": { + "description": "Cloud Storage URI where the generated video is written.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of the content of the video. - video/mp4", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionHumanPose": { + "id": "CloudAiLargeModelsVisionHumanPose", + "properties": { + "bodyLandmarksGcsUri": { + "deprecated": true, + "description": "GCS URI of the human pose video to condition video generation.", + "type": "string" + }, + "faceLandmarksGcsUri": { + "deprecated": true, + "description": "GCS URI of the face landmarks video to condition video generation.", + "type": "string" + }, + "perfMeshGcsUri": { + "description": "GCS URI of the performance mesh to condition video generation.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionImage": { + "description": "Image.", + "id": "CloudAiLargeModelsVisionImage", + "properties": { + "encoding": { + "description": "Image encoding, encoded as \"image/png\" or \"image/jpg\".", + "type": "string" + }, + "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.", + "format": "int32", + "type": "integer" + }, + "image": { + "description": "Raw bytes.", + "format": "byte", + "type": "string" + }, + "imageRaiScores": { + "$ref": "CloudAiLargeModelsVisionImageRAIScores", + "description": "RAI scores for generated image." + }, + "imageSize": { + "$ref": "CloudAiLargeModelsVisionImageImageSize", + "description": "Image size. The size of the image. Can be self reported, or computed from the image bytes." + }, + "raiInfo": { + "$ref": "CloudAiLargeModelsVisionRaiInfo", + "description": "RAI info for image." + }, + "semanticFilterResponse": { + "$ref": "CloudAiLargeModelsVisionSemanticFilterResponse", + "description": "Semantic filter info for image." + }, + "text": { + "description": "Text/Expanded text input for imagen.", + "type": "string" + }, + "uri": { + "description": "Path to another storage (typically Google Cloud Storage).", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionImageImageSize": { + "description": "Image size.", + "id": "CloudAiLargeModelsVisionImageImageSize", + "properties": { + "channels": { + "format": "int32", + "type": "integer" + }, + "height": { + "format": "int32", + "type": "integer" + }, + "width": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionImageRAIScores": { + "description": "RAI scores for generated image returned.", + "id": "CloudAiLargeModelsVisionImageRAIScores", + "properties": { + "agileWatermarkDetectionScore": { + "description": "Agile watermark score for image.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionMedia": { + "description": "Media.", + "id": "CloudAiLargeModelsVisionMedia", + "properties": { + "image": { + "$ref": "CloudAiLargeModelsVisionImage", + "description": "Image." + }, + "video": { + "$ref": "CloudAiLargeModelsVisionVideo", + "description": "Video" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionNamedBoundingBox": { + "id": "CloudAiLargeModelsVisionNamedBoundingBox", + "properties": { + "classes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "entities": { + "items": { + "type": "string" + }, + "type": "array" + }, + "scores": { + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + }, + "x1": { + "format": "float", + "type": "number" + }, + "x2": { + "format": "float", + "type": "number" + }, + "y1": { + "format": "float", + "type": "number" + }, + "y2": { + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionPromptInputs": { + "description": "\"Direct\" prompting for Experimental Video Generation. These will be sent directly to the LDM without being rewritten.", + "id": "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" + }, + "negativePrompt": { + "description": "Single negative prompt for what not to generate.", + "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" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRaiInfo": { + "description": "Next ID: 6", + "id": "CloudAiLargeModelsVisionRaiInfo", + "properties": { + "blockedEntities": { + "description": "List of blocked entities from the blocklist if it is detected.", + "items": { + "type": "string" + }, + "type": "array" + }, + "detectedLabels": { + "description": "The list of detected labels for different rai categories.", + "items": { + "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabels" + }, + "type": "array" + }, + "modelName": { + "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.", + "type": "string" + }, + "raiCategories": { + "description": "List of rai categories' information to return", + "items": { + "type": "string" + }, + "type": "array" + }, + "scores": { + "description": "List of rai scores mapping to the rai categories. Rounded to 1 decimal place.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRaiInfoDetectedLabels": { + "description": "Filters returning list of deteceted labels, scores, and bounding boxes.", + "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabels", + "properties": { + "entities": { + "description": "The list of detected entities for the rai signal.", + "items": { + "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity" + }, + "type": "array" + }, + "raiCategory": { + "description": "The RAI category for the deteceted labels.", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox": { + "description": "An integer bounding box of original pixels of the image for the detected labels.", + "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox", + "properties": { + "x1": { + "description": "The X coordinate of the top-left corner, in pixels.", + "format": "int32", + "type": "integer" + }, + "x2": { + "description": "The X coordinate of the bottom-right corner, in pixels.", + "format": "int32", + "type": "integer" + }, + "y1": { + "description": "The Y coordinate of the top-left corner, in pixels.", + "format": "int32", + "type": "integer" + }, + "y2": { + "description": "The Y coordinate of the bottom-right corner, in pixels.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity": { + "description": "The properties for a detected entity from the rai signal.", + "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity", + "properties": { + "boundingBox": { + "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox", + "description": "Bounding box of the label" + }, + "description": { + "description": "Description of the label", + "type": "string" + }, + "iouScore": { + "description": "The intersection ratio between the detection bounding box and the mask.", + "format": "float", + "type": "number" + }, + "mid": { + "description": "MID of the label", + "type": "string" + }, + "score": { + "description": "Confidence score of the label", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionSemanticFilterResponse": { + "id": "CloudAiLargeModelsVisionSemanticFilterResponse", + "properties": { + "namedBoundingBoxes": { + "description": "Class labels of the bounding boxes that failed the semantic filtering. Bounding box coordinates.", + "items": { + "$ref": "CloudAiLargeModelsVisionNamedBoundingBox" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionVideo": { + "description": "Video", + "id": "CloudAiLargeModelsVisionVideo", + "properties": { + "encodedVideo": { + "description": "Base 64 encoded video bytes.", + "type": "string" + }, + "encoding": { + "description": "Video encoding, for example \"video/mp4\".", + "type": "string" + }, + "text": { + "description": "Text/Expanded text input for Help Me Write.", + "type": "string" + }, + "uri": { + "description": "Path to another storage (typically Google Cloud Storage).", + "type": "string" + }, + "video": { + "description": "Raw bytes.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail": { + "description": "Create API error message for Vertex Pipeline.", + "id": "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail", + "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" + ], + "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." + ], + "type": "string" + }, + "publicMessage": { + "description": "Public messages contains actionable items for the error cause.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiHttpBody": { + "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", + "properties": { + "contentType": { + "description": "The HTTP Content-Type header value specifying the content type of the body.", + "type": "string" + }, + "data": { + "description": "The HTTP request/response body as raw binary.", + "format": "byte", + "type": "string" + }, + "extensions": { + "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ActiveLearningConfig": { + "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": "GoogleCloudAiplatformV1ActiveLearningConfig", + "properties": { + "maxDataItemCount": { + "description": "Max number of human labeled DataItems.", + "format": "int64", + "type": "string" + }, + "maxDataItemPercentage": { + "description": "Max percent of total DataItems for human labeling.", + "format": "int32", + "type": "integer" + }, + "sampleConfig": { + "$ref": "GoogleCloudAiplatformV1SampleConfig", + "description": "Active learning data sampling config. For every active learning labeling iteration, it will select a batch of data based on the sampling strategy." + }, + "trainingConfig": { + "$ref": "GoogleCloudAiplatformV1TrainingConfig", + "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." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest": { + "description": "Request message for MetadataService.AddContextArtifactsAndExecutions.", + "id": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest", + "properties": { + "artifacts": { + "description": "The resource names of the Artifacts to attribute to the Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", + "items": { + "type": "string" + }, + "type": "array" + }, + "executions": { + "description": "The resource names of the Executions to associate with the Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse": { + "description": "Response message for MetadataService.AddContextArtifactsAndExecutions.", + "id": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1AddContextChildrenRequest": { + "description": "Request message for MetadataService.AddContextChildren.", + "id": "GoogleCloudAiplatformV1AddContextChildrenRequest", + "properties": { + "childContexts": { + "description": "The resource names of the child Contexts.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AddContextChildrenResponse": { + "description": "Response message for MetadataService.AddContextChildren.", + "id": "GoogleCloudAiplatformV1AddContextChildrenResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1AddExecutionEventsRequest": { + "description": "Request message for MetadataService.AddExecutionEvents.", + "id": "GoogleCloudAiplatformV1AddExecutionEventsRequest", + "properties": { + "events": { + "description": "The Events to create and add.", + "items": { + "$ref": "GoogleCloudAiplatformV1Event" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AddExecutionEventsResponse": { + "description": "Response message for MetadataService.AddExecutionEvents.", + "id": "GoogleCloudAiplatformV1AddExecutionEventsResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1AddTrialMeasurementRequest": { + "description": "Request message for VizierService.AddTrialMeasurement.", + "id": "GoogleCloudAiplatformV1AddTrialMeasurementRequest", + "properties": { + "measurement": { + "$ref": "GoogleCloudAiplatformV1Measurement", + "description": "Required. The measurement to be added to a Trial." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AggregationOutput": { + "description": "The aggregation result for the entire dataset and all metrics.", + "id": "GoogleCloudAiplatformV1AggregationOutput", + "properties": { + "aggregationResults": { + "description": "One AggregationResult per metric.", + "items": { + "$ref": "GoogleCloudAiplatformV1AggregationResult" + }, + "type": "array" + }, + "dataset": { + "$ref": "GoogleCloudAiplatformV1EvaluationDataset", + "description": "The dataset used for evaluation & aggregation." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AggregationResult": { + "description": "The aggregation result for a single metric.", + "id": "GoogleCloudAiplatformV1AggregationResult", + "properties": { + "aggregationMetric": { + "description": "Aggregation metric.", + "enum": [ + "AGGREGATION_METRIC_UNSPECIFIED", + "AVERAGE", + "MODE", + "STANDARD_DEVIATION", + "VARIANCE", + "MINIMUM", + "MAXIMUM", + "MEDIAN", + "PERCENTILE_P90", + "PERCENTILE_P95", + "PERCENTILE_P99" + ], + "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." + ], + "type": "string" + }, + "bleuMetricValue": { + "$ref": "GoogleCloudAiplatformV1BleuMetricValue", + "description": "Results for bleu metric." + }, + "customCodeExecutionResult": { + "$ref": "GoogleCloudAiplatformV1CustomCodeExecutionResult", + "description": "Result for code execution metric." + }, + "exactMatchMetricValue": { + "$ref": "GoogleCloudAiplatformV1ExactMatchMetricValue", + "description": "Results for exact match metric." + }, + "pairwiseMetricResult": { + "$ref": "GoogleCloudAiplatformV1PairwiseMetricResult", + "description": "Result for pairwise metric." + }, + "pointwiseMetricResult": { + "$ref": "GoogleCloudAiplatformV1PointwiseMetricResult", + "description": "Result for pointwise metric." + }, + "rougeMetricValue": { + "$ref": "GoogleCloudAiplatformV1RougeMetricValue", + "description": "Results for rouge metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Annotation": { + "description": "Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.", + "id": "GoogleCloudAiplatformV1Annotation", + "properties": { + "annotationSource": { + "$ref": "GoogleCloudAiplatformV1UserActionReference", + "description": "Output only. The source of the Annotation.", + "readOnly": true + }, + "createTime": { + "description": "Output only. Timestamp when this Annotation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" + }, + "name": { + "description": "Output only. Resource name of the Annotation.", + "readOnly": true, + "type": "string" + }, + "payload": { + "description": "Required. The schema of the payload can be found in payload_schema.", + "type": "any" + }, + "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" + }, + "updateTime": { + "description": "Output only. Timestamp when this Annotation was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AnnotationSpec": { + "description": "Identifies a concept with which DataItems may be annotated with.", + "id": "GoogleCloudAiplatformV1AnnotationSpec", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this AnnotationSpec was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "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" + }, + "etag": { + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of the AnnotationSpec.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when AnnotationSpec was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ApiAuth": { + "description": "The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead.", + "id": "GoogleCloudAiplatformV1ApiAuth", + "properties": { + "apiKeyConfig": { + "$ref": "GoogleCloudAiplatformV1ApiAuthApiKeyConfig", + "description": "The API secret." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ApiAuthApiKeyConfig": { + "description": "The API secret.", + "id": "GoogleCloudAiplatformV1ApiAuthApiKeyConfig", + "properties": { + "apiKeySecretVersion": { + "description": "Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}", + "type": "string" + }, + "apiKeyString": { + "description": "The API key string. Either this or `api_key_secret_version` must be set.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AppendEventResponse": { + "description": "Response message for SessionService.AppendEvent.", + "id": "GoogleCloudAiplatformV1AppendEventResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1Artifact": { + "description": "Instance of a general artifact.", + "id": "GoogleCloudAiplatformV1Artifact", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this Artifact was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of the Artifact", + "type": "string" + }, + "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" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "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).", + "type": "object" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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.", + "type": "object" + }, + "name": { + "description": "Output only. The resource name of the Artifact.", + "readOnly": true, + "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" + }, + "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" + }, + "state": { + "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." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this Artifact was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AskContextsRequest": { + "description": "Agentic Retrieval Ask API for RAG. Request message for VertexRagService.AskContexts.", + "id": "GoogleCloudAiplatformV1AskContextsRequest", + "properties": { + "query": { + "$ref": "GoogleCloudAiplatformV1RagQuery", + "description": "Required. Single RAG retrieve query." + }, + "tools": { + "description": "Optional. The tools to use for AskContexts.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AskContextsResponse": { + "description": "Response message for VertexRagService.AskContexts.", + "id": "GoogleCloudAiplatformV1AskContextsResponse", + "properties": { + "contexts": { + "$ref": "GoogleCloudAiplatformV1RagContexts", + "description": "The contexts of the query." + }, + "response": { + "description": "The Retrieval Response.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata": { + "description": "Metadata information for NotebookService.AssignNotebookRuntime.", + "id": "GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + }, + "progressMessage": { + "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AssignNotebookRuntimeRequest": { + "description": "Request message for NotebookService.AssignNotebookRuntime.", + "id": "GoogleCloudAiplatformV1AssignNotebookRuntimeRequest", + "properties": { + "notebookRuntime": { + "$ref": "GoogleCloudAiplatformV1NotebookRuntime", + "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": { + "description": "Required. The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be assigned (reuse or create a new one).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest": { + "description": "Request message for ReasoningEngineExecutionService.AsyncQueryReasoningEngine.", + "id": "GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest", + "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": { + "description": "Optional. Output Cloud Storage URI for the Async query. This contains the final response of the query.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AsyncRetrieveContextsRequest": { + "description": "Request message for VertexRagService.AsyncRetrieveContexts.", + "id": "GoogleCloudAiplatformV1AsyncRetrieveContextsRequest", + "properties": { + "query": { + "$ref": "GoogleCloudAiplatformV1RagQuery", + "description": "Required. Single RAG retrieve query." + }, + "tools": { + "description": "Optional. The tools to use for AskContexts.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Attribution": { + "description": "Attribution that explains a particular prediction output.", + "id": "GoogleCloudAiplatformV1Attribution", + "properties": { + "approximationError": { + "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.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "baselineOutputValue": { + "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 > 1), this is the value in the output located by output_index. If there are multiple baselines, their output values are averaged.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "featureAttributions": { + "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).", + "readOnly": true, + "type": "any" + }, + "instanceOutputValue": { + "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.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "outputDisplayName": { + "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.", + "readOnly": true, + "type": "string" + }, + "outputIndex": { + "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.", + "items": { + "format": "int32", + "type": "integer" + }, + "readOnly": true, + "type": "array" + }, + "outputName": { + "description": "Output only. Name of the explain output. Specified as the key in ExplanationMetadata.outputs.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AugmentPromptRequest": { + "description": "Request message for AugmentPrompt.", + "id": "GoogleCloudAiplatformV1AugmentPromptRequest", + "properties": { + "contents": { + "description": "Optional. Input content to augment, only text format is supported for now.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + }, + "model": { + "$ref": "GoogleCloudAiplatformV1AugmentPromptRequestModel", + "description": "Optional. Metadata of the backend deployed model." + }, + "vertexRagStore": { + "$ref": "GoogleCloudAiplatformV1VertexRagStore", + "description": "Optional. Retrieves contexts from the Vertex RagStore." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AugmentPromptRequestModel": { + "description": "Metadata of the backend deployed model.", + "id": "GoogleCloudAiplatformV1AugmentPromptRequestModel", + "properties": { + "model": { + "description": "Optional. The model that the user will send the augmented prompt for content generation.", + "type": "string" + }, + "modelVersion": { + "description": "Optional. The model version of the backend deployed model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AugmentPromptResponse": { + "description": "Response message for AugmentPrompt.", + "id": "GoogleCloudAiplatformV1AugmentPromptResponse", + "properties": { + "augmentedPrompt": { + "description": "Augmented prompt, only text format is supported for now.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + }, + "facts": { + "description": "Retrieved facts from RAG data sources.", + "items": { + "$ref": "GoogleCloudAiplatformV1Fact" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AuthConfig": { + "description": "Auth configuration to run the extension.", + "id": "GoogleCloudAiplatformV1AuthConfig", + "properties": { + "apiKeyConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfigApiKeyConfig", + "description": "Config for API key auth." + }, + "authType": { + "description": "Type of auth scheme.", + "enum": [ + "AUTH_TYPE_UNSPECIFIED", + "NO_AUTH", + "API_KEY_AUTH", + "HTTP_BASIC_AUTH", + "GOOGLE_SERVICE_ACCOUNT_AUTH", + "OAUTH", + "OIDC_AUTH" + ], + "enumDescriptions": [ + "", + "No Auth.", + "API Key Auth.", + "HTTP Basic Auth.", + "Google Service Account Auth.", + "OAuth auth.", + "OpenID Connect (OIDC) Auth." + ], + "type": "string" + }, + "googleServiceAccountConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig", + "description": "Config for Google Service Account auth." + }, + "httpBasicAuthConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig", + "description": "Config for HTTP Basic auth." + }, + "oauthConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfigOauthConfig", + "description": "Config for user oauth." + }, + "oidcConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfigOidcConfig", + "description": "Config for user OIDC auth." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AuthConfigApiKeyConfig": { + "description": "Config for authentication with API key.", + "id": "GoogleCloudAiplatformV1AuthConfigApiKeyConfig", + "properties": { + "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": { + "description": "Optional. The API key to be used in the request directly.", + "type": "string" + }, + "httpElementLocation": { + "description": "Optional. The location of the API key.", + "enum": [ + "HTTP_IN_UNSPECIFIED", + "HTTP_IN_QUERY", + "HTTP_IN_HEADER", + "HTTP_IN_PATH", + "HTTP_IN_BODY", + "HTTP_IN_COOKIE" + ], + "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." + ], + "type": "string" + }, + "name": { + "description": "Optional. The parameter name of the API key. E.g. If the API request is \"https://example.com/act?api_key=\", \"api_key\" would be the parameter name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig": { + "description": "Config for Google Service Account Authentication.", + "id": "GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig", + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig": { + "description": "Config for HTTP Basic Authentication.", + "id": "GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig", + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AuthConfigOauthConfig": { + "description": "Config for user oauth.", + "id": "GoogleCloudAiplatformV1AuthConfigOauthConfig", + "properties": { + "accessToken": { + "description": "Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.", + "type": "string" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AuthConfigOidcConfig": { + "description": "Config for user OIDC auth.", + "id": "GoogleCloudAiplatformV1AuthConfigOidcConfig", + "properties": { + "idToken": { + "description": "OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.", + "type": "string" + }, + "serviceAccount": { + "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).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AutomaticResources": { + "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.", + "id": "GoogleCloudAiplatformV1AutomaticResources", + "properties": { + "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 Vertex AI may be unable to scale beyond certain replica number.", + "format": "int32", + "type": "integer" + }, + "minReplicaCount": { + "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", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AutoraterConfig": { + "description": "The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset.", + "id": "GoogleCloudAiplatformV1AutoraterConfig", + "properties": { + "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" + }, + "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" + }, + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "Optional. Configuration options for model generation and outputs." + }, + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AutoscalingMetricSpec": { + "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.", + "id": "GoogleCloudAiplatformV1AutoscalingMetricSpec", + "properties": { + "metricName": { + "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": "string" + }, + "target": { + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AvroSource": { + "description": "The storage details for Avro input content.", + "id": "GoogleCloudAiplatformV1AvroSource", + "properties": { + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1GcsSource", + "description": "Required. Google Cloud Storage location." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest": { + "description": "Request message for PipelineService.BatchCancelPipelineJobs.", + "id": "GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest", + "properties": { + "names": { + "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}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata": { + "description": "Details of operations that perform batch create Features.", + "id": "GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Feature." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchCreateFeaturesRequest": { + "description": "Request message for FeaturestoreService.BatchCreateFeatures. Request message for FeatureRegistryService.BatchCreateFeatures.", + "id": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest", + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1CreateFeatureRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchCreateFeaturesResponse": { + "description": "Response message for FeaturestoreService.BatchCreateFeatures.", + "id": "GoogleCloudAiplatformV1BatchCreateFeaturesResponse", + "properties": { + "features": { + "description": "The Features created.", + "items": { + "$ref": "GoogleCloudAiplatformV1Feature" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest": { + "description": "Request message for TensorboardService.BatchCreateTensorboardRuns.", + "id": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest", + "properties": { + "requests": { + "description": "Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.", + "items": { + "$ref": "GoogleCloudAiplatformV1CreateTensorboardRunRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse": { + "description": "Response message for TensorboardService.BatchCreateTensorboardRuns.", + "id": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse", + "properties": { + "tensorboardRuns": { + "description": "The created TensorboardRuns.", + "items": { + "$ref": "GoogleCloudAiplatformV1TensorboardRun" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest": { + "description": "Request message for TensorboardService.BatchCreateTensorboardTimeSeries.", + "id": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest", + "properties": { + "requests": { + "description": "Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.", + "items": { + "$ref": "GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse": { + "description": "Response message for TensorboardService.BatchCreateTensorboardTimeSeries.", + "id": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse", + "properties": { + "tensorboardTimeSeries": { + "description": "The created TensorboardTimeSeries.", + "items": { + "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchDedicatedResources": { + "description": "A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration.", + "id": "GoogleCloudAiplatformV1BatchDedicatedResources", + "properties": { + "machineSpec": { + "$ref": "GoogleCloudAiplatformV1MachineSpec", + "description": "Required. Immutable. The specification of a single machine." + }, + "maxReplicaCount": { + "description": "Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.", + "format": "int32", + "type": "integer" + }, + "startingReplicaCount": { + "description": "Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest": { + "description": "Request message for PipelineService.BatchDeletePipelineJobs.", + "id": "GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest", + "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}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest": { + "description": "Request message for ModelService.BatchImportEvaluatedAnnotations", + "id": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest", + "properties": { + "evaluatedAnnotations": { + "description": "Required. Evaluated annotations resource to be imported.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluatedAnnotation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse": { + "description": "Response message for ModelService.BatchImportEvaluatedAnnotations", + "id": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse", + "properties": { + "importedEvaluatedAnnotationsCount": { + "description": "Output only. Number of EvaluatedAnnotations imported.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest": { + "description": "Request message for ModelService.BatchImportModelEvaluationSlices", + "id": "GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest", + "properties": { + "modelEvaluationSlices": { + "description": "Required. Model evaluation slice resource to be imported.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModelEvaluationSlice" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse": { + "description": "Response message for ModelService.BatchImportModelEvaluationSlices", + "id": "GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse", + "properties": { + "importedModelEvaluationSlices": { + "description": "Output only. List of imported ModelEvaluationSlice.name.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata": { + "description": "Runtime operation information for MigrationService.BatchMigrateResources.", + "id": "GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The common part of the operation metadata." + }, + "partialResults": { + "description": "Partial results that reflect the latest migration operation progress.", + "items": { + "$ref": "GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult": { + "description": "Represents a partial result in batch migration operation for one MigrateResourceRequest.", + "id": "GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult", + "properties": { + "dataset": { + "description": "Migrated dataset resource name.", + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the migration request in case of failure." + }, + "model": { + "description": "Migrated model resource name.", + "type": "string" + }, + "request": { + "$ref": "GoogleCloudAiplatformV1MigrateResourceRequest", + "description": "It's the same as the value in BatchMigrateResourcesRequest.migrate_resource_requests." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchMigrateResourcesRequest": { + "description": "Request message for MigrationService.BatchMigrateResources.", + "id": "GoogleCloudAiplatformV1BatchMigrateResourcesRequest", + "properties": { + "migrateResourceRequests": { + "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": "GoogleCloudAiplatformV1MigrateResourceRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchMigrateResourcesResponse": { + "description": "Response message for MigrationService.BatchMigrateResources.", + "id": "GoogleCloudAiplatformV1BatchMigrateResourcesResponse", + "properties": { + "migrateResourceResponses": { + "description": "Successfully migrated resources.", + "items": { + "$ref": "GoogleCloudAiplatformV1MigrateResourceResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchPredictionJob": { + "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": "GoogleCloudAiplatformV1BatchPredictionJob", + "properties": { + "completionStats": { + "$ref": "GoogleCloudAiplatformV1CompletionStats", + "description": "Output only. Statistics on completed and failed prediction instances.", + "readOnly": true + }, + "createTime": { + "description": "Output only. Time when the BatchPredictionJob was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dedicatedResources": { + "$ref": "GoogleCloudAiplatformV1BatchDedicatedResources", + "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." + }, + "disableContainerLogging": { + "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.", + "type": "boolean" + }, + "displayName": { + "description": "Required. The user-defined name of this BatchPredictionJob.", + "type": "string" + }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." + }, + "endTime": { + "description": "Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.", + "readOnly": true + }, + "explanationSpec": { + "$ref": "GoogleCloudAiplatformV1ExplanationSpec", + "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": { + "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.", + "type": "boolean" + }, + "inputConfig": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJobInputConfig", + "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." + }, + "instanceConfig": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig", + "description": "Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" + }, + "manualBatchTuningParameters": { + "$ref": "GoogleCloudAiplatformV1ManualBatchTuningParameters", + "description": "Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself)." + }, + "model": { + "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}`", + "type": "string" + }, + "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" + }, + "modelVersionId": { + "description": "Output only. The version ID of the Model that produces the predictions via this job.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Resource name of the BatchPredictionJob.", + "readOnly": true, + "type": "string" + }, + "outputConfig": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJobOutputConfig", + "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." + }, + "outputInfo": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJobOutputInfo", + "description": "Output only. Information further describing the output of this job.", + "readOnly": true + }, + "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.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "resourcesConsumed": { + "$ref": "GoogleCloudAiplatformV1ResourcesConsumed", + "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.", + "readOnly": true + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "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" + }, + "startTime": { + "description": "Output only. Time when the BatchPredictionJob for the first time entered the `JOB_STATE_RUNNING` state.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "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" + ], + "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, + "type": "string" + }, + "unmanagedContainerModel": { + "$ref": "GoogleCloudAiplatformV1UnmanagedContainerModel", + "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." + }, + "updateTime": { + "description": "Output only. Time when the BatchPredictionJob was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchPredictionJobInputConfig": { + "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.", + "id": "GoogleCloudAiplatformV1BatchPredictionJobInputConfig", + "properties": { + "bigquerySource": { + "$ref": "GoogleCloudAiplatformV1BigQuerySource", + "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." + }, + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1GcsSource", + "description": "The Cloud Storage location for the input instances." + }, + "instancesFormat": { + "description": "Required. The format in which instances are given, must be one of the Model's supported_input_storage_formats.", + "type": "string" + }, + "vertexMultimodalDatasetSource": { + "$ref": "GoogleCloudAiplatformV1VertexMultimodalDatasetSource", + "description": "A Vertex Managed Dataset. Currently, only datasets of type Multimodal are supported." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig": { + "description": "Configuration defining how to transform batch prediction input instances to the instances that the Model accepts.", + "id": "GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig", + "properties": { + "excludedFields": { + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedFields": { + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "instanceType": { + "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.", + "type": "string" + }, + "keyField": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchPredictionJobOutputConfig": { + "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.", + "id": "GoogleCloudAiplatformV1BatchPredictionJobOutputConfig", + "properties": { + "bigqueryDestination": { + "$ref": "GoogleCloudAiplatformV1BigQueryDestination", + "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`." + }, + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "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." + }, + "predictionsFormat": { + "description": "Required. The format in which Vertex AI gives the predictions, must be one of the Model's supported_output_storage_formats.", + "type": "string" + }, + "vertexMultimodalDatasetDestination": { + "$ref": "GoogleCloudAiplatformV1VertexMultimodalDatasetDestination", + "description": "The details for a Vertex Multimodal Dataset that will be created for the output." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchPredictionJobOutputInfo": { + "description": "Further describes this job's output. Supplements output_config.", + "id": "GoogleCloudAiplatformV1BatchPredictionJobOutputInfo", + "properties": { + "bigqueryOutputDataset": { + "description": "Output only. The path of the BigQuery dataset created, in `bq://projectId.bqDatasetId` format, 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.", + "readOnly": true, + "type": "string" + }, + "gcsOutputDirectory": { + "description": "Output only. The full path of the Cloud Storage directory created, into which the prediction output is written.", + "readOnly": true, + "type": "string" + }, + "vertexMultimodalDatasetName": { + "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}`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" }, - "batchPredictionJobs": { - "methods": { - "create": { - "id": "aiplatform.batchPredictionJobs.create", - "path": "v1/batchPredictionJobs", - "flatPath": "v1/batchPredictionJobs", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [], - "request": { - "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start." + "GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata": { + "description": "Details of operations that batch reads Feature values.", + "id": "GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Featurestore batch read Features values." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchReadFeatureValuesRequest": { + "description": "Request message for FeaturestoreService.BatchReadFeatureValues.", + "id": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequest", + "properties": { + "bigqueryReadInstances": { + "$ref": "GoogleCloudAiplatformV1BigQuerySource", + "description": "Similar to csv_read_instances, but from BigQuery source." }, - "get": { - "id": "aiplatform.batchPredictionJobs.get", - "path": "v1/{+name}", - "flatPath": "v1/batchPredictionJobs/{batchPredictionJobsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", - "pattern": "^batchPredictionJobs/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a BatchPredictionJob" + "csvReadInstances": { + "$ref": "GoogleCloudAiplatformV1CsvSource", + "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`." }, - "list": { - "id": "aiplatform.batchPredictionJobs.list", - "path": "v1/batchPredictionJobs", - "flatPath": "v1/batchPredictionJobs", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - }, - "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" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } + "destination": { + "$ref": "GoogleCloudAiplatformV1FeatureValueDestination", + "description": "Required. Specifies output location and format." + }, + "entityTypeSpecs": { + "description": "Required. Specifies EntityType grouping Features to read values of and settings.", + "items": { + "$ref": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec" }, - "parameterOrder": [], - "response": { - "$ref": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse" + "type": "array" + }, + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists BatchPredictionJobs in a Location." + "type": "array" + }, + "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" }, - "endpoints": { - "methods": { - "predict": { - "id": "aiplatform.endpoints.predict", - "path": "v1/{+endpoint}:predict", - "flatPath": "v1/endpoints/{endpointsId}:predict", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1PredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Perform an online prediction." + "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec": { + "description": "Selects Features of an EntityType to read values of and specifies read settings.", + "id": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec", + "properties": { + "entityTypeId": { + "description": "Required. ID of the EntityType to select Features. The EntityType id is the entity_type_id specified during EntityType creation.", + "type": "string" }, - "predictLongRunning": { - "id": "aiplatform.endpoints.predictLongRunning", - "path": "v1/{+endpoint}:predictLongRunning", - "flatPath": "v1/endpoints/{endpointsId}:predictLongRunning", - "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}`", - "pattern": "^endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "" + "featureSelector": { + "$ref": "GoogleCloudAiplatformV1FeatureSelector", + "description": "Required. Selectors choosing which Feature values to read from the EntityType." }, - "fetchPredictOperation": { - "id": "aiplatform.endpoints.fetchPredictOperation", - "path": "v1/{+endpoint}:fetchPredictOperation", - "flatPath": "v1/endpoints/{endpointsId}:fetchPredictOperation", - "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}`", - "pattern": "^endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } + "settings": { + "description": "Per-Feature settings for the batch read.", + "items": { + "$ref": "GoogleCloudAiplatformV1DestinationFeatureSetting" }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField": { + "description": "Describe pass-through fields in read_instance source.", + "id": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField", + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchReadFeatureValuesResponse": { + "description": "Response message for FeaturestoreService.BatchReadFeatureValues.", + "id": "GoogleCloudAiplatformV1BatchReadFeatureValuesResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse": { + "description": "Response message for TensorboardService.BatchReadTensorboardTimeSeriesData.", + "id": "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse", + "properties": { + "timeSeriesData": { + "description": "The returned time series data.", + "items": { + "$ref": "GoogleCloudAiplatformV1TimeSeriesData" }, - "response": { - "$ref": "GoogleLongrunningOperation" + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BigQueryDestination": { + "description": "The BigQuery location for the output content.", + "id": "GoogleCloudAiplatformV1BigQueryDestination", + "properties": { + "outputUri": { + "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`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BigQueryRequestSet": { + "description": "The request set for the evaluation run.", + "id": "GoogleCloudAiplatformV1BigQueryRequestSet", + "properties": { + "candidateResponseColumns": { + "additionalProperties": { + "type": "string" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Fetch an asynchronous online prediction operation." + "description": "Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format.", + "type": "object" }, - "generateContent": { - "id": "aiplatform.endpoints.generateContent", - "path": "v1/{+model}:generateContent", - "flatPath": "v1/endpoints/{endpointsId}:generateContent", - "httpMethod": "POST", - "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", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "model" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Generate content with multimodal inputs." + "promptColumn": { + "description": "Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format.", + "type": "string" }, - "streamGenerateContent": { - "id": "aiplatform.endpoints.streamGenerateContent", - "path": "v1/{+model}:streamGenerateContent", - "flatPath": "v1/endpoints/{endpointsId}:streamGenerateContent", - "httpMethod": "POST", - "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", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "model" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Generate content with multimodal inputs with streaming support." + "rubricsColumn": { + "description": "Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format.", + "type": "string" }, - "countTokens": { - "id": "aiplatform.endpoints.countTokens", - "path": "v1/{+endpoint}:countTokens", - "flatPath": "v1/endpoints/{endpointsId}:countTokens", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" + "samplingConfig": { + "$ref": "GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig", + "description": "Optional. The sampling config for the bigquery resource." + }, + "uri": { + "description": "Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig": { + "description": "The sampling config.", + "id": "GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig", + "properties": { + "samplingCount": { + "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.", + "format": "int32", + "type": "integer" + }, + "samplingDuration": { + "description": "Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0.", + "format": "google-duration", + "type": "string" + }, + "samplingMethod": { + "description": "Optional. The sampling method to use.", + "enum": [ + "SAMPLING_METHOD_UNSPECIFIED", + "RANDOM" ], - "request": { - "$ref": "GoogleCloudAiplatformV1CountTokensRequest" + "enumDescriptions": [ + "Unspecified sampling method.", + "Random sampling." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BigQuerySource": { + "description": "The BigQuery location for the input content.", + "id": "GoogleCloudAiplatformV1BigQuerySource", + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BleuInput": { + "description": "Input for bleu metric.", + "id": "GoogleCloudAiplatformV1BleuInput", + "properties": { + "instances": { + "description": "Required. Repeated bleu instances.", + "items": { + "$ref": "GoogleCloudAiplatformV1BleuInstance" }, - "response": { - "$ref": "GoogleCloudAiplatformV1CountTokensResponse" + "type": "array" + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1BleuSpec", + "description": "Required. Spec for bleu score metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BleuInstance": { + "description": "Spec for bleu instance.", + "id": "GoogleCloudAiplatformV1BleuInstance", + "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" + }, + "GoogleCloudAiplatformV1BleuMetricValue": { + "description": "Bleu metric value for an instance.", + "id": "GoogleCloudAiplatformV1BleuMetricValue", + "properties": { + "score": { + "description": "Output only. Bleu score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BleuResults": { + "description": "Results for bleu metric.", + "id": "GoogleCloudAiplatformV1BleuResults", + "properties": { + "bleuMetricValues": { + "description": "Output only. Bleu metric values.", + "items": { + "$ref": "GoogleCloudAiplatformV1BleuMetricValue" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Perform a token counting." + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BleuSpec": { + "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.", + "id": "GoogleCloudAiplatformV1BleuSpec", + "properties": { + "useEffectiveOrder": { + "description": "Optional. Whether to use_effective_order to compute bleu score.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Blob": { + "description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.", + "id": "GoogleCloudAiplatformV1Blob", + "properties": { + "data": { + "description": "Required. The raw bytes of the data.", + "format": "byte", + "type": "string" }, - "computeTokens": { - "id": "aiplatform.endpoints.computeTokens", - "path": "v1/{+endpoint}:computeTokens", - "flatPath": "v1/endpoints/{endpointsId}:computeTokens", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", - "pattern": "^endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } + "displayName": { + "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.", + "type": "string" + }, + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BlurBaselineConfig": { + "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", + "id": "GoogleCloudAiplatformV1BlurBaselineConfig", + "properties": { + "maxBlurSigma": { + "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.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1BoolArray": { + "description": "A list of boolean values.", + "id": "GoogleCloudAiplatformV1BoolArray", + "properties": { + "values": { + "description": "A list of bool values.", + "items": { + "type": "boolean" }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CacheConfig": { + "description": "Config of GenAI caching features. This is a singleton resource.", + "id": "GoogleCloudAiplatformV1CacheConfig", + "properties": { + "disableCache": { + "description": "If set to true, disables GenAI caching. Otherwise caching is enabled.", + "type": "boolean" + }, + "name": { + "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CachedContent": { + "description": "A resource used in LLM queries for users to explicitly specify what to cache and how to cache.", + "id": "GoogleCloudAiplatformV1CachedContent", + "properties": { + "contents": { + "description": "Optional. Input only. Immutable. The content to cache", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" }, - "response": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" + "type": "array" + }, + "createTime": { + "description": "Output only. Creation time of the cache entry.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Immutable. The user-generated meaningful display name of the cached content.", + "type": "string" + }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "description": "Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key." + }, + "expireTime": { + "description": "Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.", + "format": "google-datetime", + "type": "string" + }, + "model": { + "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}", + "type": "string" + }, + "name": { + "description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}", + "type": "string" + }, + "systemInstruction": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Optional. Input only. Immutable. Developer set system instruction. Currently, text only" + }, + "toolConfig": { + "$ref": "GoogleCloudAiplatformV1ToolConfig", + "description": "Optional. Input only. Immutable. Tool config. This config is shared for all tools" + }, + "tools": { + "description": "Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Return a list of tokens based on the input text." + "type": "array" + }, + "ttl": { + "description": "Input only. The TTL for this resource. The expiration time is computed: now + TTL.", + "format": "google-duration", + "type": "string" + }, + "updateTime": { + "description": "Output only. When the cache entry was last updated in UTC time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "usageMetadata": { + "$ref": "GoogleCloudAiplatformV1CachedContentUsageMetadata", + "description": "Output only. Metadata on the usage of the cached content.", + "readOnly": true } }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.endpoints.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/endpoints/{endpointsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.endpoints.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^endpoints/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.endpoints.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^endpoints/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.endpoints.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^endpoints/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.endpoints.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^endpoints/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } + "type": "object" + }, + "GoogleCloudAiplatformV1CachedContentUsageMetadata": { + "description": "Metadata on the usage of the cached content.", + "id": "GoogleCloudAiplatformV1CachedContentUsageMetadata", + "properties": { + "audioDurationSeconds": { + "description": "Duration of audio in seconds.", + "format": "int32", + "type": "integer" }, - "chat": { - "methods": { - "completions": { - "id": "aiplatform.endpoints.chat.completions", - "path": "v1/{+endpoint}/chat/completions", - "flatPath": "v1/endpoints/{endpointsId}/chat/completions", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^endpoints/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleApiHttpBody" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Exposes an OpenAI-compatible endpoint for chat completions." - } - } + "imageCount": { + "description": "Number of images.", + "format": "int32", + "type": "integer" + }, + "textCount": { + "description": "Number of text characters.", + "format": "int32", + "type": "integer" + }, + "totalTokenCount": { + "description": "Total number of tokens that the cached content consumes.", + "format": "int32", + "type": "integer" + }, + "videoDurationSeconds": { + "description": "Duration of video in seconds.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "publishers": { - "resources": { - "models": { - "methods": { - "predict": { - "id": "aiplatform.publishers.models.predict", - "path": "v1/{+endpoint}:predict", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predict", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1PredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Perform an online prediction." - }, - "predictLongRunning": { - "id": "aiplatform.publishers.models.predictLongRunning", - "path": "v1/{+endpoint}:predictLongRunning", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predictLongRunning", - "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}`", - "pattern": "^publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "" - }, - "fetchPredictOperation": { - "id": "aiplatform.publishers.models.fetchPredictOperation", - "path": "v1/{+endpoint}:fetchPredictOperation", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", - "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}`", - "pattern": "^publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Fetch an asynchronous online prediction operation." - }, - "generateContent": { - "id": "aiplatform.publishers.models.generateContent", - "path": "v1/{+model}:generateContent", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:generateContent", - "httpMethod": "POST", - "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": "^publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "model" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Generate content with multimodal inputs." - }, - "streamGenerateContent": { - "id": "aiplatform.publishers.models.streamGenerateContent", - "path": "v1/{+model}:streamGenerateContent", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", - "httpMethod": "POST", - "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": "^publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "model" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "description": "Generate content with multimodal inputs with streaming support." - }, - "countTokens": { - "id": "aiplatform.publishers.models.countTokens", - "path": "v1/{+endpoint}:countTokens", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:countTokens", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "pattern": "^publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1CountTokensRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1CountTokensResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Perform a token counting." - }, - "computeTokens": { - "id": "aiplatform.publishers.models.computeTokens", - "path": "v1/{+endpoint}:computeTokens", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:computeTokens", - "httpMethod": "POST", - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", - "pattern": "^publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "endpoint" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Return a list of tokens based on the input text." - }, - "get": { - "id": "aiplatform.publishers.models.get", - "path": "v1/{+name}", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", - "pattern": "^publishers/[^/]+/models/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "languageCode": { - "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", - "type": "string" - }, - "view": { - "description": "Optional. PublisherModel view specifying which fields to read.", - "location": "query", - "type": "string", - "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" - ] - }, - "isHuggingFaceModel": { - "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", - "location": "query", - "type": "boolean" - }, - "huggingFaceToken": { - "description": "Optional. Token used to access Hugging Face gated models.", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudAiplatformV1PublisherModel" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Gets a Model Garden publisher model." - } - } + "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest": { + "description": "Request message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine.", + "id": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest", + "properties": { + "operationName": { + "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse": { + "description": "Response message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine.", + "id": "GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest": { + "description": "Request message for JobService.CancelBatchPredictionJob.", + "id": "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1CancelCustomJobRequest": { + "description": "Request message for JobService.CancelCustomJob.", + "id": "GoogleCloudAiplatformV1CancelCustomJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1CancelDataLabelingJobRequest": { + "description": "Request message for JobService.CancelDataLabelingJob.", + "id": "GoogleCloudAiplatformV1CancelDataLabelingJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1CancelEvaluationRunRequest": { + "description": "Request message for EvaluationManagementService.CancelEvaluationRun.", + "id": "GoogleCloudAiplatformV1CancelEvaluationRunRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest": { + "description": "Request message for JobService.CancelHyperparameterTuningJob.", + "id": "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1CancelNasJobRequest": { + "description": "Request message for JobService.CancelNasJob.", + "id": "GoogleCloudAiplatformV1CancelNasJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1CancelPipelineJobRequest": { + "description": "Request message for PipelineService.CancelPipelineJob.", + "id": "GoogleCloudAiplatformV1CancelPipelineJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1CancelTrainingPipelineRequest": { + "description": "Request message for PipelineService.CancelTrainingPipeline.", + "id": "GoogleCloudAiplatformV1CancelTrainingPipelineRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1CancelTuningJobRequest": { + "description": "Request message for GenAiTuningService.CancelTuningJob.", + "id": "GoogleCloudAiplatformV1CancelTuningJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1Candidate": { + "description": "A response candidate generated from the model.", + "id": "GoogleCloudAiplatformV1Candidate", + "properties": { + "avgLogprobs": { + "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.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "citationMetadata": { + "$ref": "GoogleCloudAiplatformV1CitationMetadata", + "description": "Output only. A collection of citations that apply to the generated content.", + "readOnly": true + }, + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Output only. The content of the candidate.", + "readOnly": true + }, + "finishMessage": { + "description": "Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.", + "readOnly": true, + "type": "string" + }, + "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." + ], + "readOnly": true, + "type": "string" + }, + "groundingMetadata": { + "$ref": "GoogleCloudAiplatformV1GroundingMetadata", + "description": "Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.", + "readOnly": true + }, + "index": { + "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` > 1.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "logprobsResult": { + "$ref": "GoogleCloudAiplatformV1LogprobsResult", + "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 + }, + "safetyRatings": { + "description": "Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.", + "items": { + "$ref": "GoogleCloudAiplatformV1SafetyRating" + }, + "readOnly": true, + "type": "array" + }, + "urlContextMetadata": { + "$ref": "GoogleCloudAiplatformV1UrlContextMetadata", + "description": "Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", + "readOnly": true } - } + }, + "type": "object" }, - "reasoningEngines": { - "methods": { - "query": { - "id": "aiplatform.reasoningEngines.query", - "path": "v1/{+name}:query", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:query", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "pattern": "^reasoningEngines/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } + "GoogleCloudAiplatformV1CandidateResponse": { + "description": "Responses from model or agent.", + "id": "GoogleCloudAiplatformV1CandidateResponse", + "properties": { + "candidate": { + "description": "Required. The name of the candidate that produced the response.", + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Error while scraping model or agent.", + "readOnly": true + }, + "text": { + "description": "Text response.", + "type": "string" + }, + "value": { + "description": "Fields and values that can be used to populate the response template.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CandidateResult": { + "description": "Result for a single candidate.", + "id": "GoogleCloudAiplatformV1CandidateResult", + "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" + }, + "explanation": { + "description": "Optional. The explanation for the metric.", + "type": "string" + }, + "metric": { + "description": "Required. The metric that was evaluated.", + "type": "string" + }, + "rubricVerdicts": { + "description": "Optional. The rubric verdicts for the metric.", + "items": { + "$ref": "GoogleCloudAiplatformV1RubricVerdict" }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" + "type": "array" + }, + "score": { + "description": "Optional. The score for the metric.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata": { + "description": "This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.", + "id": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for suggesting Trials." + }, + "study": { + "description": "The name of the Study that the Trial belongs to.", + "type": "string" + }, + "trial": { + "description": "The Trial name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest": { + "description": "Request message for VizierService.CheckTrialEarlyStoppingState.", + "id": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse": { + "description": "Response message for VizierService.CheckTrialEarlyStoppingState.", + "id": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse", + "properties": { + "shouldStop": { + "description": "True if the Trial should stop.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Checkpoint": { + "description": "Describes the machine learning model version checkpoint.", + "id": "GoogleCloudAiplatformV1Checkpoint", + "properties": { + "checkpointId": { + "description": "The ID of the checkpoint.", + "type": "string" + }, + "epoch": { + "description": "The epoch of the checkpoint.", + "format": "int64", + "type": "string" + }, + "step": { + "description": "The step of the checkpoint.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Chunk": { + "description": "Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.", + "id": "GoogleCloudAiplatformV1Chunk", + "properties": { + "data": { + "description": "Required. The data in the chunk.", + "format": "byte", + "type": "string" + }, + "metadata": { + "$ref": "GoogleCloudAiplatformV1Metadata", + "description": "Optional. Metadata that is associated with the data in the payload." + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Citation": { + "description": "A citation for a piece of generatedcontent.", + "id": "GoogleCloudAiplatformV1Citation", + "properties": { + "endIndex": { + "description": "Output only. The end index of the citation in the content.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "license": { + "description": "Output only. The license of the source of the citation.", + "readOnly": true, + "type": "string" + }, + "publicationDate": { + "$ref": "GoogleTypeDate", + "description": "Output only. The publication date of the source of the citation.", + "readOnly": true + }, + "startIndex": { + "description": "Output only. The start index of the citation in the content.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "title": { + "description": "Output only. The title of the source of the citation.", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Output only. The URI of the source of the citation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CitationMetadata": { + "description": "A collection of citations that apply to a piece of generated content.", + "id": "GoogleCloudAiplatformV1CitationMetadata", + "properties": { + "citations": { + "description": "Output only. A list of citations for the content.", + "items": { + "$ref": "GoogleCloudAiplatformV1Citation" }, - "response": { - "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Claim": { + "description": "Claim that is extracted from the input text and facts that support it.", + "id": "GoogleCloudAiplatformV1Claim", + "properties": { + "endIndex": { + "description": "Index in the input text where the claim ends (exclusive).", + "format": "int32", + "type": "integer" + }, + "factIndexes": { + "description": "Indexes of the facts supporting this claim.", + "items": { + "format": "int32", + "type": "integer" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "type": "array" + }, + "score": { + "description": "Confidence score of this corroboration.", + "format": "float", + "type": "number" + }, + "startIndex": { + "description": "Index in the input text where the claim starts (inclusive).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ClientConnectionConfig": { + "description": "Configurations (e.g. inference timeout) that are applied on your endpoints.", + "id": "GoogleCloudAiplatformV1ClientConnectionConfig", + "properties": { + "inferenceTimeout": { + "description": "Customizable online prediction request timeout.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CodeExecutionResult": { + "description": "Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.", + "id": "GoogleCloudAiplatformV1CodeExecutionResult", + "properties": { + "outcome": { + "description": "Required. Outcome of the code execution.", + "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." ], - "description": "Queries using a reasoning engine." + "type": "string" }, - "streamQuery": { - "id": "aiplatform.reasoningEngines.streamQuery", - "path": "v1/{+name}:streamQuery", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:streamQuery", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "pattern": "^reasoningEngines/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" + "output": { + "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CoherenceInput": { + "description": "Input for coherence metric.", + "id": "GoogleCloudAiplatformV1CoherenceInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1CoherenceInstance", + "description": "Required. Coherence instance." + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1CoherenceSpec", + "description": "Required. Spec for coherence score metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CoherenceInstance": { + "description": "Spec for coherence instance.", + "id": "GoogleCloudAiplatformV1CoherenceInstance", + "properties": { + "prediction": { + "description": "Required. Output of the evaluated model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CoherenceResult": { + "description": "Spec for coherence result.", + "id": "GoogleCloudAiplatformV1CoherenceResult", + "properties": { + "confidence": { + "description": "Output only. Confidence for coherence score.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "explanation": { + "description": "Output only. Explanation for coherence score.", + "readOnly": true, + "type": "string" + }, + "score": { + "description": "Output only. Coherence score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CoherenceSpec": { + "description": "Spec for coherence score metric.", + "id": "GoogleCloudAiplatformV1CoherenceSpec", + "properties": { + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ColabImage": { + "description": "Colab image of the runtime.", + "id": "GoogleCloudAiplatformV1ColabImage", + "properties": { + "description": { + "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\"", + "readOnly": true, + "type": "string" + }, + "releaseName": { + "description": "Optional. The release name of the NotebookRuntime Colab image, e.g. \"py310\". If not specified, detault to the latest release.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CometInput": { + "description": "Input for Comet metric.", + "id": "GoogleCloudAiplatformV1CometInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1CometInstance", + "description": "Required. Comet instance." + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1CometSpec", + "description": "Required. Spec for comet metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CometInstance": { + "description": "Spec for Comet instance - The fields used for evaluation are dependent on the comet version.", + "id": "GoogleCloudAiplatformV1CometInstance", + "properties": { + "prediction": { + "description": "Required. Output of the evaluated model.", + "type": "string" + }, + "reference": { + "description": "Optional. Ground truth used to compare against the prediction.", + "type": "string" + }, + "source": { + "description": "Optional. Source text in original language.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CometResult": { + "description": "Spec for Comet result - calculates the comet score for the given instance using the version specified in the spec.", + "id": "GoogleCloudAiplatformV1CometResult", + "properties": { + "score": { + "description": "Output only. Comet score. Range depends on version.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CometSpec": { + "description": "Spec for Comet metric.", + "id": "GoogleCloudAiplatformV1CometSpec", + "properties": { + "sourceLanguage": { + "description": "Optional. Source language in BCP-47 format.", + "type": "string" + }, + "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.", + "enum": [ + "COMET_VERSION_UNSPECIFIED", + "COMET_22_SRC_REF" ], - "request": { - "$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "enumDescriptions": [ + "Comet version unspecified.", + "Comet 22 for translation + source + reference (source-reference-combined)." ], - "description": "Streams queries using a reasoning engine." + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CompleteTrialRequest": { + "description": "Request message for VizierService.CompleteTrial.", + "id": "GoogleCloudAiplatformV1CompleteTrialRequest", + "properties": { + "finalMeasurement": { + "$ref": "GoogleCloudAiplatformV1Measurement", + "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" + }, + "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": { + "description": "Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CompletionStats": { + "description": "Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch.", + "id": "GoogleCloudAiplatformV1CompletionStats", + "properties": { + "failedCount": { + "description": "Output only. The number of entities for which any error was encountered.", + "format": "int64", + "readOnly": true, + "type": "string" }, - "create": { - "id": "aiplatform.reasoningEngines.create", - "path": "v1/reasoningEngines", - "flatPath": "v1/reasoningEngines", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [], - "request": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Creates a reasoning engine." + "incompleteCount": { + "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", + "readOnly": true, + "type": "string" }, - "get": { - "id": "aiplatform.reasoningEngines.get", - "path": "v1/{+name}", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "pattern": "^reasoningEngines/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } + "successfulCount": { + "description": "Output only. The number of entities that had been processed successfully.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "successfulForecastPointCount": { + "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.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ComputationBasedMetricSpec": { + "description": "Specification for a computation based metric.", + "id": "GoogleCloudAiplatformV1ComputationBasedMetricSpec", + "properties": { + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "parameterOrder": [ - "name" + "description": "Optional. A map of parameters for the metric, e.g. {\"rouge_type\": \"rougeL\"}.", + "type": "object" + }, + "type": { + "description": "Required. The type of the computation based metric.", + "enum": [ + "COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED", + "EXACT_MATCH", + "BLEU", + "ROUGE" ], - "response": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "enumDescriptions": [ + "Unspecified computation based metric type.", + "Exact match metric.", + "BLEU metric.", + "ROUGE metric." ], - "description": "Gets a reasoning engine." - }, - "list": { - "id": "aiplatform.reasoningEngines.list", - "path": "v1/reasoningEngines", - "flatPath": "v1/reasoningEngines", - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - }, - "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.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "Optional. The standard list page token.", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [], - "response": { - "$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ComputeTokensRequest": { + "description": "Request message for ComputeTokens RPC call.", + "id": "GoogleCloudAiplatformV1ComputeTokensRequest", + "properties": { + "contents": { + "description": "Optional. Input content.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Lists reasoning engines in a location." + "type": "array" }, - "patch": { - "id": "aiplatform.reasoningEngines.patch", - "path": "v1/{+name}", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "pattern": "^reasoningEngines/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Mask specifying which fields to update.", - "location": "query", - "type": "string", - "format": "google-fieldmask" - } + "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" }, - "parameterOrder": [ - "name" - ], - "request": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ComputeTokensResponse": { + "description": "Response message for ComputeTokens RPC call.", + "id": "GoogleCloudAiplatformV1ComputeTokensResponse", + "properties": { + "tokensInfo": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1TokensInfo" }, - "response": { - "$ref": "GoogleLongrunningOperation" + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ContainerRegistryDestination": { + "description": "The Container Registry location for the container image.", + "id": "GoogleCloudAiplatformV1ContainerRegistryDestination", + "properties": { + "outputUri": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ContainerSpec": { + "description": "The spec of a Container.", + "id": "GoogleCloudAiplatformV1ContainerSpec", + "properties": { + "args": { + "description": "The arguments to be passed when starting the container.", + "items": { + "type": "string" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Updates a reasoning engine." + "type": "array" }, - "delete": { - "id": "aiplatform.reasoningEngines.delete", - "path": "v1/{+name}", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "pattern": "^reasoningEngines/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "force": { - "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.", - "location": "query", - "type": "boolean" - } + "command": { + "description": "The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.", + "items": { + "type": "string" }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" + "type": "array" + }, + "env": { + "description": "Environment variables to be passed to the container. Maximum limit is 100.", + "items": { + "$ref": "GoogleCloudAiplatformV1EnvVar" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Deletes a reasoning engine." + "type": "array" + }, + "imageUri": { + "description": "Required. The URI of a container image in the Container Registry that is to be run on each worker replica.", + "type": "string" } }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "aiplatform.reasoningEngines.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^reasoningEngines/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "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": { - "id": "aiplatform.reasoningEngines.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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": { - "id": "aiplatform.reasoningEngines.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "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`." - }, - "cancel": { - "id": "aiplatform.reasoningEngines.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "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`." - }, - "wait": { - "id": "aiplatform.reasoningEngines.operations.wait", - "path": "v1/{+name}:wait", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", - "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", - "type": "string", - "format": "google-duration" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "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." - } - } + "type": "object" + }, + "GoogleCloudAiplatformV1Content": { + "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": "GoogleCloudAiplatformV1Content", + "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": "GoogleCloudAiplatformV1Part" + }, + "type": "array" + }, + "role": { + "description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.", + "type": "string" } - } + }, + "type": "object" }, - "media": { - "methods": { - "upload": { - "id": "aiplatform.media.upload", - "path": "v1/{+parent}/ragFiles:upload", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload", - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } + "GoogleCloudAiplatformV1ContentMap": { + "description": "Map of placeholder in metric prompt template to contents of model input.", + "id": "GoogleCloudAiplatformV1ContentMap", + "properties": { + "values": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1ContentMapContents" }, - "parameterOrder": [ - "parent" - ], - "supportsMediaUpload": true, - "mediaUpload": { - "accept": [ - "*/*" - ], - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/v1/{+parent}/ragFiles:upload" - } - } + "description": "Optional. Map of placeholder to contents.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ContentMapContents": { + "description": "Repeated Content type.", + "id": "GoogleCloudAiplatformV1ContentMapContents", + "properties": { + "contents": { + "description": "Optional. Repeated contents.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" }, - "request": { - "$ref": "GoogleCloudAiplatformV1UploadRagFileRequest" + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Context": { + "description": "Instance of a general context.", + "id": "GoogleCloudAiplatformV1Context", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this Context was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of the Context", + "type": "string" + }, + "displayName": { + "description": "User provided display name of the Context. 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" + }, + "labels": { + "additionalProperties": { + "type": "string" }, - "response": { - "$ref": "GoogleCloudAiplatformV1UploadRagFileResponse" + "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" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "description": "Upload a file into a RagCorpus." - } - } - } - }, - "servicePath": "", - "documentationLink": "https://cloud.google.com/vertex-ai/", - "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." + "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" }, - "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" - } - } - } - }, - "revision": "20251114", - "title": "Vertex AI API", - "version": "v1", - "discoveryVersion": "v1", - "basePath": "", - "canonicalName": "Aiplatform", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "schemas": { - "GoogleCloudLocationListLocationsResponse": { - "id": "GoogleCloudLocationListLocationsResponse", - "description": "The response message for Locations.ListLocations.", - "type": "object", - "properties": { - "locations": { - "description": "A list of locations that matches the specified filter in the request.", - "type": "array", + "name": { + "description": "Immutable. The resource name of the Context.", + "type": "string" + }, + "parentContexts": { + "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.", "items": { - "$ref": "GoogleCloudLocationLocation" - } + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "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" }, - "nextPageToken": { - "description": "The standard List next-page token.", + "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" + }, + "updateTime": { + "description": "Output only. Timestamp when this Context was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudLocationLocation": { - "id": "GoogleCloudLocationLocation", - "description": "A resource that represents a Google Cloud location.", - "type": "object", + "GoogleCloudAiplatformV1CopyModelOperationMetadata": { + "description": "Details of ModelService.CopyModel operation.", + "id": "GoogleCloudAiplatformV1CopyModelOperationMetadata", "properties": { - "name": { - "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The common part of the operation metadata." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CopyModelRequest": { + "description": "Request message for ModelService.CopyModel.", + "id": "GoogleCloudAiplatformV1CopyModelRequest", + "properties": { + "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" }, - "locationId": { - "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "description": "Customer-managed encryption key options. If this is set, then the Model copy will be encrypted with the provided encryption key." + }, + "modelId": { + "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.", "type": "string" }, - "displayName": { - "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "parentModel": { + "description": "Optional. Specify this field to copy source_model into this existing Model as a new version. Format: `projects/{project}/locations/{location}/models/{model}`", "type": "string" }, - "labels": { - "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", - "type": "object", - "additionalProperties": { - "type": "string" - } + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CopyModelResponse": { + "description": "Response message of ModelService.CopyModel operation.", + "id": "GoogleCloudAiplatformV1CopyModelResponse", + "properties": { + "model": { + "description": "The name of the copied Model resource. Format: `projects/{project}/locations/{location}/models/{model}`", + "type": "string" }, - "metadata": { - "description": "Service-specific metadata. For example the available capacity at the given location.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - } + "modelVersionId": { + "description": "Output only. The version ID of the model that is copied.", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleIamV1SetIamPolicyRequest": { - "id": "GoogleIamV1SetIamPolicyRequest", - "description": "Request message for `SetIamPolicy` method.", - "type": "object", + "GoogleCloudAiplatformV1CorpusStatus": { + "description": "RagCorpus status.", + "id": "GoogleCloudAiplatformV1CorpusStatus", "properties": { - "policy": { - "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.", - "$ref": "GoogleIamV1Policy" + "errorStatus": { + "description": "Output only. Only when the `state` field is ERROR.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. RagCorpus life state.", + "enum": [ + "UNKNOWN", + "INITIALIZED", + "ACTIVE", + "ERROR" + ], + "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." + ], + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleIamV1Policy": { - "id": "GoogleIamV1Policy", - "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/).", - "type": "object", + "GoogleCloudAiplatformV1CorroborateContentRequest": { + "description": "Request message for CorroborateContent.", + "id": "GoogleCloudAiplatformV1CorroborateContentRequest", "properties": { - "version": { - "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", - "format": "int32" + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Optional. Input content to corroborate, only text format is supported for now." }, - "bindings": { - "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`.", - "type": "array", + "facts": { + "description": "Optional. Facts used to generate the text can also be used to corroborate the text.", "items": { - "$ref": "GoogleIamV1Binding" - } + "$ref": "GoogleCloudAiplatformV1Fact" + }, + "type": "array" }, - "etag": { - "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.", - "type": "string", - "format": "byte" + "parameters": { + "$ref": "GoogleCloudAiplatformV1CorroborateContentRequestParameters", + "description": "Optional. Parameters that can be set to override default settings per request." } - } + }, + "type": "object" }, - "GoogleIamV1Binding": { - "id": "GoogleIamV1Binding", - "description": "Associates `members`, or principals, with a `role`.", - "type": "object", + "GoogleCloudAiplatformV1CorroborateContentRequestParameters": { + "description": "Parameters that can be overrided per request.", + "id": "GoogleCloudAiplatformV1CorroborateContentRequestParameters", "properties": { - "role": { - "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).", - "type": "string" - }, - "members": { - "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", + "citationThreshold": { + "description": "Optional. Only return claims with citation score larger than the threshold.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CorroborateContentResponse": { + "description": "Response message for CorroborateContent.", + "id": "GoogleCloudAiplatformV1CorroborateContentResponse", + "properties": { + "claims": { + "description": "Claims that are extracted from the input content and facts that support the claims.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1Claim" + }, + "type": "array" }, - "condition": { - "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).", - "$ref": "GoogleTypeExpr" + "corroborationScore": { + "description": "Confidence score of corroborating content. Value is [0,1] with 1 is the most confidence.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleTypeExpr": { - "id": "GoogleTypeExpr", - "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.", - "type": "object", + "GoogleCloudAiplatformV1CountTokensRequest": { + "description": "Request message for PredictionService.CountTokens.", + "id": "GoogleCloudAiplatformV1CountTokensRequest", "properties": { - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" + "contents": { + "description": "Optional. Input content.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" }, - "title": { - "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.", - "type": "string" + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "Optional. Generation config that the model will use to generate the response." }, - "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" + "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" }, - "location": { - "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "model": { + "description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" + }, + "systemInstruction": { + "$ref": "GoogleCloudAiplatformV1Content", + "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." + }, + "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": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleIamV1TestIamPermissionsResponse": { - "id": "GoogleIamV1TestIamPermissionsResponse", - "description": "Response message for `TestIamPermissions` method.", - "type": "object", + "GoogleCloudAiplatformV1CountTokensResponse": { + "description": "Response message for PredictionService.CountTokens.", + "id": "GoogleCloudAiplatformV1CountTokensResponse", "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", - "type": "array", + "promptTokensDetails": { + "description": "Output only. List of modalities that were processed in the request input.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, + "totalBillableCharacters": { + "description": "The total number of billable characters counted across all instances from the request.", + "format": "int32", + "type": "integer" + }, + "totalTokens": { + "description": "The total number of tokens counted across all instances from the request.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleLongrunningListOperationsResponse": { - "id": "GoogleLongrunningListOperationsResponse", - "description": "The response message for Operations.ListOperations.", - "type": "object", + "GoogleCloudAiplatformV1CreateDatasetOperationMetadata": { + "description": "Runtime operation information for DatasetService.CreateDataset.", + "id": "GoogleCloudAiplatformV1CreateDatasetOperationMetadata", "properties": { - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "GoogleLongrunningOperation" - } + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata": { + "description": "Runtime operation information for DatasetService.CreateDatasetVersion.", + "id": "GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The common part of the operation metadata." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata": { + "description": "Runtime operation information for CreateDeploymentResourcePool method.", + "id": "GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest": { + "description": "Request message for CreateDeploymentResourcePool method.", + "id": "GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest", + "properties": { + "deploymentResourcePool": { + "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool", + "description": "Required. The DeploymentResourcePool to create." }, - "nextPageToken": { - "description": "The standard List next-page token.", + "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" - }, - "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", - "type": "array", - "items": { - "type": "string" - } } - } + }, + "type": "object" }, - "GoogleLongrunningOperation": { - "id": "GoogleLongrunningOperation", - "description": "This resource represents a long-running operation that is the result of a network API call.", - "type": "object", + "GoogleCloudAiplatformV1CreateEndpointOperationMetadata": { + "description": "Runtime operation information for EndpointService.CreateEndpoint.", + "id": "GoogleCloudAiplatformV1CreateEndpointOperationMetadata", "properties": { - "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}`.", + "deploymentStage": { + "description": "Output only. The deployment stage of the model. Only populated if this CreateEndpoint request deploys a model at the same time.", + "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" + ], + "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." + ], + "readOnly": true, "type": "string" }, - "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." - } + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata": { + "description": "Details of operations that perform create EntityType.", + "id": "GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for EntityType." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata": { + "description": "Details of operations that perform create FeatureGroup.", + "id": "GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for FeatureGroup." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata": { + "description": "Details of operations that perform create FeatureOnlineStore.", + "id": "GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for FeatureOnlineStore." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateFeatureOperationMetadata": { + "description": "Details of operations that perform create Feature.", + "id": "GoogleCloudAiplatformV1CreateFeatureOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Feature." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateFeatureRequest": { + "description": "Request message for FeaturestoreService.CreateFeature. Request message for FeatureRegistryService.CreateFeature.", + "id": "GoogleCloudAiplatformV1CreateFeatureRequest", + "properties": { + "feature": { + "$ref": "GoogleCloudAiplatformV1Feature", + "description": "Required. The Feature to create." }, - "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" + "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" }, - "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "GoogleRpcStatus" + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata": { + "description": "Details of operations that perform create FeatureView.", + "id": "GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for FeatureView Create." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata": { + "description": "Details of operations that perform create Featurestore.", + "id": "GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Featurestore." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata": { + "description": "Runtime operation information for IndexEndpointService.CreateIndexEndpoint.", + "id": "GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateIndexOperationMetadata": { + "description": "Runtime operation information for IndexService.CreateIndex.", + "id": "GoogleCloudAiplatformV1CreateIndexOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." }, - "response": { - "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`.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - } + "nearestNeighborSearchOperationMetadata": { + "$ref": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata", + "description": "The operation metadata with regard to Matching Engine Index operation." } - } + }, + "type": "object" }, - "GoogleRpcStatus": { - "id": "GoogleRpcStatus", - "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).", - "type": "object", + "GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata": { + "description": "Details of operations that perform MetadataService.CreateMetadataStore.", + "id": "GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata", "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "type": "integer", - "format": "int32" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for creating a MetadataStore." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata": { + "description": "Metadata information for NotebookService.CreateNotebookExecutionJob.", + "id": "GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." }, - "message": { - "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.", + "progressMessage": { + "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest": { + "description": "Request message for [NotebookService.CreateNotebookExecutionJob]", + "id": "GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest", + "properties": { + "notebookExecutionJob": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob", + "description": "Required. The NotebookExecutionJob to create." + }, + "notebookExecutionJobId": { + "description": "Optional. User specified ID for the NotebookExecutionJob.", "type": "string" }, - "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": { - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - } - } + "parent": { + "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", + "type": "string" } - } + }, + "type": "object" }, - "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": {} + "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata": { + "description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate.", + "id": "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerateSyntheticDataRequest": { - "id": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest", - "description": "Request message for DataFoundryService.GenerateSyntheticData.", - "type": "object", + "GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata": { + "description": "Details of operations that perform create PersistentResource.", + "id": "GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata", "properties": { - "taskDescription": { - "description": "Generate data from a high-level task description.", - "$ref": "GoogleCloudAiplatformV1TaskDescriptionStrategy" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for PersistentResource." }, - "count": { - "description": "Required. The number of synthetic examples to generate. For this stateless API, the count is limited to a small number.", - "type": "integer", - "format": "int32" + "progressMessage": { + "description": "Progress Message for Create LRO", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreatePipelineJobRequest": { + "description": "Request message for PipelineService.CreatePipelineJob.", + "id": "GoogleCloudAiplatformV1CreatePipelineJobRequest", + "properties": { + "parent": { + "description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`", + "type": "string" }, - "outputFieldSpecs": { - "description": "Required. The schema of the desired output, defined by a list of fields.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1OutputFieldSpec" - } + "pipelineJob": { + "$ref": "GoogleCloudAiplatformV1PipelineJob", + "description": "Required. The PipelineJob to create." }, - "examples": { - "description": "Optional. A list of few-shot examples to guide the model's output style and format.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SyntheticExample" - } + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TaskDescriptionStrategy": { - "id": "GoogleCloudAiplatformV1TaskDescriptionStrategy", - "description": "Defines a generation strategy based on a high-level task description.", - "type": "object", + "GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata": { + "description": "Details of operations that perform create FeatureGroup.", + "id": "GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata", "properties": { - "taskDescription": { - "description": "Required. A high-level description of the synthetic data to be generated.", + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Feature." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata": { + "description": "Runtime operation information for SpecialistPoolService.CreateSpecialistPool.", + "id": "GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateTensorboardOperationMetadata": { + "description": "Details of operations that perform create Tensorboard.", + "id": "GoogleCloudAiplatformV1CreateTensorboardOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Tensorboard." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CreateTensorboardRunRequest": { + "description": "Request message for TensorboardService.CreateTensorboardRun.", + "id": "GoogleCloudAiplatformV1CreateTensorboardRunRequest", + "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": "GoogleCloudAiplatformV1TensorboardRun", + "description": "Required. The TensorboardRun to create." + }, + "tensorboardRunId": { + "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-/`.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1OutputFieldSpec": { - "id": "GoogleCloudAiplatformV1OutputFieldSpec", - "description": "Defines a specification for a single output field.", - "type": "object", + "GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest": { + "description": "Request message for TensorboardService.CreateTensorboardTimeSeries.", + "id": "GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest", "properties": { - "fieldName": { - "description": "Required. The name of the output field.", + "parent": { + "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" }, - "guidance": { - "description": "Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.", - "type": "string" + "tensorboardTimeSeries": { + "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries", + "description": "Required. The TensorboardTimeSeries to create." }, - "fieldType": { - "description": "Optional. The data type of the field. Defaults to CONTENT if not set.", - "type": "string", - "enumDescriptions": [ - "Field type is unspecified.", - "Arbitrary content field type.", - "Text field type.", - "Image field type.", - "Audio field type." - ], - "enum": [ - "FIELD_TYPE_UNSPECIFIED", - "CONTENT", - "TEXT", - "IMAGE", - "AUDIO" - ] + "tensorboardTimeSeriesId": { + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SyntheticExample": { - "id": "GoogleCloudAiplatformV1SyntheticExample", - "description": "Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response.", - "type": "object", + "GoogleCloudAiplatformV1CsvDestination": { + "description": "The storage details for CSV output content.", + "id": "GoogleCloudAiplatformV1CsvDestination", "properties": { - "fields": { - "description": "Required. A list of fields that constitute an example.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SyntheticField" - } + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "Required. Google Cloud Storage location." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SyntheticField": { - "id": "GoogleCloudAiplatformV1SyntheticField", - "description": "Represents a single named field within a SyntheticExample.", - "type": "object", + "GoogleCloudAiplatformV1CsvSource": { + "description": "The storage details for CSV input content.", + "id": "GoogleCloudAiplatformV1CsvSource", "properties": { - "fieldName": { - "description": "Optional. The name of the field.", - "type": "string" - }, - "content": { - "description": "Required. The content of the field.", - "$ref": "GoogleCloudAiplatformV1Content" + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1GcsSource", + "description": "Required. Google Cloud Storage location." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Content": { - "id": "GoogleCloudAiplatformV1Content", - "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.", - "type": "object", + "GoogleCloudAiplatformV1CustomCodeExecutionResult": { + "description": "Result for custom code execution metric.", + "id": "GoogleCloudAiplatformV1CustomCodeExecutionResult", "properties": { - "role": { - "description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.", + "score": { + "description": "Output only. Custom code execution score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CustomCodeExecutionSpec": { + "description": "Specificies a metric that is populated by evaluating user-defined Python code.", + "id": "GoogleCloudAiplatformV1CustomCodeExecutionSpec", + "properties": { + "evaluationFunction": { + "description": "Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> 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]) -> 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.", "type": "string" - }, - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Part" - } } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Part": { - "id": "GoogleCloudAiplatformV1Part", - "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.", - "type": "object", + "GoogleCloudAiplatformV1CustomJob": { + "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).", + "id": "GoogleCloudAiplatformV1CustomJob", "properties": { - "text": { - "description": "Optional. The text content of the part.", + "createTime": { + "description": "Output only. Time when the CustomJob was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "inlineData": { - "description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.", - "$ref": "GoogleCloudAiplatformV1Blob" + "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" }, - "fileData": { - "description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.", - "$ref": "GoogleCloudAiplatformV1FileData" + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "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": "GoogleCloudAiplatformV1FunctionCall" + "endTime": { + "description": "Output only. Time when the CustomJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "functionResponse": { - "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.", - "$ref": "GoogleCloudAiplatformV1FunctionResponse" + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", + "readOnly": true }, - "executableCode": { - "description": "Optional. Code generated by the model that is intended to be executed.", - "$ref": "GoogleCloudAiplatformV1ExecutableCode" + "jobSpec": { + "$ref": "GoogleCloudAiplatformV1CustomJobSpec", + "description": "Required. Job spec." }, - "codeExecutionResult": { - "description": "Optional. The result of executing the ExecutableCode.", - "$ref": "GoogleCloudAiplatformV1CodeExecutionResult" + "labels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" }, - "videoMetadata": { - "description": "Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.", - "$ref": "GoogleCloudAiplatformV1VideoMetadata" + "name": { + "description": "Output only. Resource name of a CustomJob.", + "readOnly": true, + "type": "string" }, - "thought": { - "description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning.", + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, "type": "boolean" }, - "thoughtSignature": { - "description": "Optional. An opaque signature for the thought so it can be reused in subsequent requests.", - "type": "string", - "format": "byte" - } - } - }, - "GoogleCloudAiplatformV1Blob": { - "id": "GoogleCloudAiplatformV1Blob", - "description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.", - "type": "object", - "properties": { - "mimeType": { - "description": "Required. The IANA standard MIME type of the source data.", + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "startTime": { + "description": "Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "data": { - "description": "Required. The raw bytes of the data.", - "type": "string", - "format": "byte" + "state": { + "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" + ], + "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, + "type": "string" }, - "displayName": { - "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.", + "updateTime": { + "description": "Output only. Time when the CustomJob was most recently updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" + }, + "webAccessUris": { + "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, + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FileData": { - "id": "GoogleCloudAiplatformV1FileData", - "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.", - "type": "object", + "GoogleCloudAiplatformV1CustomJobSpec": { + "description": "Represents the spec of a CustomJob.", + "id": "GoogleCloudAiplatformV1CustomJobSpec", "properties": { - "mimeType": { - "description": "Required. The IANA standard MIME type of the source data.", + "baseOutputDirectory": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "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/`" + }, + "enableDashboardAccess": { + "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).", + "type": "boolean" + }, + "enableWebAccess": { + "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).", + "type": "boolean" + }, + "experiment": { + "description": "Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`", "type": "string" }, - "fileUri": { - "description": "Required. The URI of the file in Google Cloud Storage.", + "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" }, - "displayName": { - "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.", + "models": { + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "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" - } - } - }, - "GoogleCloudAiplatformV1FunctionCall": { - "id": "GoogleCloudAiplatformV1FunctionCall", - "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", - "properties": { - "name": { - "description": "Optional. The name of the function to call. Matches [FunctionDeclaration.name].", + }, + "persistentResourceId": { + "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.", "type": "string" }, - "args": { - "description": "Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } - } - } - }, - "GoogleCloudAiplatformV1FunctionResponse": { - "id": "GoogleCloudAiplatformV1FunctionResponse", - "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.", - "type": "object", - "properties": { - "name": { - "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].", + "protectedArtifactLocationId": { + "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", "type": "string" }, - "response": { - "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.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } + "pscInterfaceConfig": { + "$ref": "GoogleCloudAiplatformV1PscInterfaceConfig", + "description": "Optional. Configuration for PSC-I for CustomJob." }, - "parts": { - "description": "Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.", - "type": "array", + "reservedIpRanges": { + "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'].", "items": { - "$ref": "GoogleCloudAiplatformV1FunctionResponsePart" - } + "type": "string" + }, + "type": "array" + }, + "scheduling": { + "$ref": "GoogleCloudAiplatformV1Scheduling", + "description": "Scheduling options for a CustomJob." + }, + "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" + }, + "tensorboard": { + "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}`", + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1WorkerPoolSpec" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FunctionResponsePart": { - "id": "GoogleCloudAiplatformV1FunctionResponsePart", - "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.", - "type": "object", + "GoogleCloudAiplatformV1CustomOutput": { + "description": "Spec for custom output.", + "id": "GoogleCloudAiplatformV1CustomOutput", "properties": { - "inlineData": { - "description": "Inline media bytes.", - "$ref": "GoogleCloudAiplatformV1FunctionResponseBlob" - }, - "fileData": { - "description": "URI based data.", - "$ref": "GoogleCloudAiplatformV1FunctionResponseFileData" + "rawOutputs": { + "$ref": "GoogleCloudAiplatformV1RawOutput", + "description": "Output only. List of raw output strings.", + "readOnly": true } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FunctionResponseBlob": { - "id": "GoogleCloudAiplatformV1FunctionResponseBlob", - "description": "Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field.", - "type": "object", + "GoogleCloudAiplatformV1CustomOutputFormatConfig": { + "description": "Spec for custom output format configuration.", + "id": "GoogleCloudAiplatformV1CustomOutputFormatConfig", "properties": { - "mimeType": { - "description": "Required. The IANA standard MIME type of the source data.", - "type": "string" - }, - "data": { - "description": "Required. Raw bytes.", - "type": "string", - "format": "byte" - }, - "displayName": { - "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": "string" + "returnRawOutput": { + "description": "Optional. Whether to return raw output.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FunctionResponseFileData": { - "id": "GoogleCloudAiplatformV1FunctionResponseFileData", - "description": "URI based data for function response.", - "type": "object", + "GoogleCloudAiplatformV1DataItem": { + "description": "A piece of data in a Dataset. Could be an image, a video, a document or plain text.", + "id": "GoogleCloudAiplatformV1DataItem", "properties": { - "mimeType": { - "description": "Required. The IANA standard MIME type of the source data.", + "createTime": { + "description": "Output only. Timestamp when this DataItem was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "fileUri": { - "description": "Required. URI.", + "etag": { + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "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" - } - } - }, - "GoogleCloudAiplatformV1ExecutableCode": { - "id": "GoogleCloudAiplatformV1ExecutableCode", - "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.", - "type": "object", - "properties": { - "language": { - "description": "Required. Programming language of the `code`.", - "type": "string", - "enumDescriptions": [ - "Unspecified language. This value should not be used.", - "Python \u003e= 3.10, with numpy and simpy available." - ], - "enum": [ - "LANGUAGE_UNSPECIFIED", - "PYTHON" - ] + "labels": { + "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.", + "type": "object" }, - "code": { - "description": "Required. The code to be executed.", + "name": { + "description": "Output only. The resource name of the DataItem.", + "readOnly": true, "type": "string" - } - } - }, - "GoogleCloudAiplatformV1CodeExecutionResult": { - "id": "GoogleCloudAiplatformV1CodeExecutionResult", - "description": "Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode].", - "type": "object", - "properties": { - "outcome": { - "description": "Required. Outcome of the code execution.", - "type": "string", - "enumDescriptions": [ - "Unspecified status. This value should not be used.", - "Code execution completed successfully.", - "Code execution finished but with a failure. `stderr` should contain the reason.", - "Code execution ran for too long, and was cancelled. There may or may not be a partial output present." - ], - "enum": [ - "OUTCOME_UNSPECIFIED", - "OUTCOME_OK", - "OUTCOME_FAILED", - "OUTCOME_DEADLINE_EXCEEDED" - ] }, - "output": { - "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", + "payload": { + "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.", + "type": "any" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "updateTime": { + "description": "Output only. Timestamp when this DataItem was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1VideoMetadata": { - "id": "GoogleCloudAiplatformV1VideoMetadata", - "description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.", - "type": "object", + "GoogleCloudAiplatformV1DataItemView": { + "description": "A container for a single DataItem and Annotations on it.", + "id": "GoogleCloudAiplatformV1DataItemView", "properties": { - "startOffset": { - "description": "Optional. The start offset of the video.", - "type": "string", - "format": "google-duration" + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1Annotation" + }, + "type": "array" }, - "endOffset": { - "description": "Optional. The end offset of the video.", - "type": "string", - "format": "google-duration" + "dataItem": { + "$ref": "GoogleCloudAiplatformV1DataItem", + "description": "The DataItem." }, - "fps": { - "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].", - "type": "number", - "format": "double" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerateSyntheticDataResponse": { - "id": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse", - "description": "The response containing the generated data.", - "type": "object", + "GoogleCloudAiplatformV1DataLabelingJob": { + "description": "DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset:", + "id": "GoogleCloudAiplatformV1DataLabelingJob", "properties": { - "syntheticExamples": { - "description": "A list of generated synthetic examples.", - "type": "array", + "activeLearningConfig": { + "$ref": "GoogleCloudAiplatformV1ActiveLearningConfig", + "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." + }, + "annotationLabels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" + }, + "createTime": { + "description": "Output only. Timestamp when this DataLabelingJob was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "currentSpend": { + "$ref": "GoogleTypeMoney", + "description": "Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.", + "readOnly": true + }, + "datasets": { + "description": "Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "items": { - "$ref": "GoogleCloudAiplatformV1SyntheticExample" - } + "type": "string" + }, + "type": "array" + }, + "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" + }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. DataLabelingJob errors. It is only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", + "readOnly": true + }, + "inputs": { + "description": "Required. Input config parameters for the DataLabelingJob.", + "type": "any" + }, + "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" + }, + "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" + }, + "labelerCount": { + "description": "Required. Number of labelers to work on each DataItem.", + "format": "int32", + "type": "integer" + }, + "labelingProgress": { + "description": "Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" + }, + "name": { + "description": "Output only. Resource name of the DataLabelingJob.", + "readOnly": true, + "type": "string" + }, + "specialistPools": { + "description": "The SpecialistPools' resource names associated with this job.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "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" + ], + "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, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this DataLabelingJob was updated most recently.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1Dataset": { - "id": "GoogleCloudAiplatformV1Dataset", "description": "A collection of DataItems and Annotations on them.", - "type": "object", + "id": "GoogleCloudAiplatformV1Dataset", "properties": { - "name": { - "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "createTime": { + "description": "Output only. Timestamp when this Dataset was created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "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.", + "dataItemCount": { + "description": "Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.", + "format": "int64", + "readOnly": true, "type": "string" }, "description": { "description": "The description of the Dataset.", "type": "string" }, - "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/.", + "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" }, - "metadata": { - "description": "Required. Additional information about the Dataset.", - "type": "any" - }, - "dataItemCount": { - "description": "Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "createTime": { - "description": "Output only. Timestamp when this Dataset was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this Dataset was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, "etag": { "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "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" - } - }, - "savedQueries": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SavedQuery" - } + }, + "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" }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" + "metadata": { + "description": "Required. Additional information about the Dataset.", + "type": "any" }, "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}`.", "readOnly": true, "type": "string" }, + "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" + }, "modelReference": { "description": "Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.", "type": "string" }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", + "name": { + "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "readOnly": true, - "type": "boolean" + "type": "string" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1SavedQuery": { - "id": "GoogleCloudAiplatformV1SavedQuery", - "description": "A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.", - "type": "object", - "properties": { - "name": { - "description": "Output only. Resource name of the SavedQuery.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "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.", - "type": "string" - }, - "metadata": { - "description": "Some additional information about the SavedQuery.", - "type": "any" - }, - "createTime": { - "description": "Output only. Timestamp when this SavedQuery was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when SavedQuery was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "annotationFilter": { - "description": "Output only. Filters on the Annotations in the dataset.", - "readOnly": true, - "type": "string" }, - "problemType": { - "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", - "type": "string" - }, - "annotationSpecCount": { - "description": "Output only. Number of AnnotationSpecs in the context of the SavedQuery.", + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", "readOnly": true, - "type": "integer", - "format": "int32" + "type": "boolean" }, - "etag": { - "description": "Used to perform a consistent read-modify-write update. If not set, a blind \"overwrite\" update happens.", - "type": "string" + "savedQueries": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1SavedQuery" + }, + "type": "array" }, - "supportAutomlTraining": { - "description": "Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.", + "updateTime": { + "description": "Output only. Timestamp when this Dataset was last updated.", + "format": "google-datetime", "readOnly": true, - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1EncryptionSpec": { - "id": "GoogleCloudAiplatformV1EncryptionSpec", - "description": "Represents a customer-managed encryption key spec that can be applied to a top-level resource.", - "type": "object", - "properties": { - "kmsKeyName": { - "description": "Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListDatasetsResponse": { - "id": "GoogleCloudAiplatformV1ListDatasetsResponse", - "description": "Response message for DatasetService.ListDatasets.", - "type": "object", + "GoogleCloudAiplatformV1DatasetCustomMetric": { + "description": "Defines a custom dataset-level aggregation.", + "id": "GoogleCloudAiplatformV1DatasetCustomMetric", "properties": { - "datasets": { - "description": "A list of Datasets that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Dataset" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", + "aggregationFunction": { + "description": "Required. The Python code string containing the aggregation function. Expected function signature: `def aggregate(instances: list[dict[str, Any]]) -> 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} ] }", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1ImportDataRequest": { - "id": "GoogleCloudAiplatformV1ImportDataRequest", - "description": "Request message for DatasetService.ImportData.", - "type": "object", - "properties": { - "importConfigs": { - "description": "Required. The desired input locations. The contents of all input locations will be imported in one batch.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ImportDataConfig" - } - } - } - }, - "GoogleCloudAiplatformV1ImportDataConfig": { - "id": "GoogleCloudAiplatformV1ImportDataConfig", - "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": { - "description": "The Google Cloud Storage location for the input content.", - "$ref": "GoogleCloudAiplatformV1GcsSource" - }, - "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" - } - }, - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } }, - "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).", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GcsSource": { - "id": "GoogleCloudAiplatformV1GcsSource", - "description": "The Google Cloud Storage location for the input content.", - "type": "object", + "GoogleCloudAiplatformV1DatasetDistribution": { + "description": "Distribution computed over a tuning dataset.", + "id": "GoogleCloudAiplatformV1DatasetDistribution", "properties": { - "uris": { - "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.", - "type": "array", + "buckets": { + "description": "Output only. Defines the histogram bucket.", "items": { - "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1ExportDataRequest": { - "id": "GoogleCloudAiplatformV1ExportDataRequest", - "description": "Request message for DatasetService.ExportData.", - "type": "object", - "properties": { - "exportConfig": { - "description": "Required. The desired output location.", - "$ref": "GoogleCloudAiplatformV1ExportDataConfig" - } - } - }, - "GoogleCloudAiplatformV1ExportDataConfig": { - "id": "GoogleCloudAiplatformV1ExportDataConfig", - "description": "Describes what part of the Dataset is to be exported, the destination of the export and how to export.", - "type": "object", - "properties": { - "gcsDestination": { - "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.", - "$ref": "GoogleCloudAiplatformV1GcsDestination" - }, - "fractionSplit": { - "description": "Split based on fractions defining the size of each set.", - "$ref": "GoogleCloudAiplatformV1ExportFractionSplit" + "$ref": "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket" + }, + "readOnly": true, + "type": "array" }, - "filterSplit": { - "description": "Split based on the provided filters for each set.", - "$ref": "GoogleCloudAiplatformV1ExportFilterSplit" + "max": { + "description": "Output only. The maximum of the population values.", + "format": "double", + "readOnly": true, + "type": "number" }, - "annotationsFilter": { - "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.", - "type": "string" + "mean": { + "description": "Output only. The arithmetic mean of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" }, - "savedQueryId": { - "description": "The ID of a SavedQuery (annotation set) under the Dataset specified by ExportDataRequest.name used for filtering Annotations for training. Only used for custom training data export use cases. Only applicable to Datasets that have SavedQueries. 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" + "median": { + "description": "Output only. The median of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" }, - "annotationSchemaUri": { - "description": "The 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 ExportDataRequest.name. Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations. 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.", - "type": "string" + "min": { + "description": "Output only. The minimum of the population values.", + "format": "double", + "readOnly": true, + "type": "number" }, - "exportUse": { - "description": "Indicates the usage of the exported files.", - "type": "string", - "enumDescriptions": [ - "Regular user export.", - "Export for custom code training." - ], - "enum": [ - "EXPORT_USE_UNSPECIFIED", - "CUSTOM_CODE_TRAINING" - ] - } - } - }, - "GoogleCloudAiplatformV1GcsDestination": { - "id": "GoogleCloudAiplatformV1GcsDestination", - "description": "The Google Cloud Storage location where the output is to be written to.", - "type": "object", - "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" - } - } - }, - "GoogleCloudAiplatformV1ExportFractionSplit": { - "id": "GoogleCloudAiplatformV1ExportFractionSplit", - "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", - "properties": { - "trainingFraction": { - "description": "The fraction of the input data that is to be used to train the Model.", - "type": "number", - "format": "double" + "p5": { + "description": "Output only. The 5th percentile of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" }, - "validationFraction": { - "description": "The fraction of the input data that is to be used to validate the Model.", - "type": "number", - "format": "double" + "p95": { + "description": "Output only. The 95th percentile of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" }, - "testFraction": { - "description": "The fraction of the input data that is to be used to evaluate the Model.", - "type": "number", - "format": "double" + "sum": { + "description": "Output only. Sum of a given population of values.", + "format": "double", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExportFilterSplit": { - "id": "GoogleCloudAiplatformV1ExportFilterSplit", - "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.", - "type": "object", + "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket": { + "description": "Dataset bucket used to create a histogram for the distribution given a population of values.", + "id": "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket", "properties": { - "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.", + "count": { + "description": "Output only. Number of values in the bucket.", + "format": "int64", + "readOnly": true, "type": "string" }, - "validationFilter": { - "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.", - "type": "string" + "left": { + "description": "Output only. Left bound of the bucket.", + "format": "double", + "readOnly": true, + "type": "number" }, - "testFilter": { - "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.", - "type": "string" + "right": { + "description": "Output only. Right bound of the bucket.", + "format": "double", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1DatasetVersion": { - "id": "GoogleCloudAiplatformV1DatasetVersion", "description": "Describes the dataset version.", - "type": "object", + "id": "GoogleCloudAiplatformV1DatasetVersion", "properties": { - "name": { - "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "bigQueryDatasetName": { + "description": "Output only. Name of the associated BigQuery dataset.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. Timestamp when this DatasetVersion was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this DatasetVersion was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "etag": { - "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", - "type": "string" - }, - "bigQueryDatasetName": { - "description": "Output only. Name of the associated BigQuery dataset.", + "format": "google-datetime", "readOnly": true, "type": "string" }, @@ -29426,6 +36783,10 @@ "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.", "type": "string" }, + "etag": { + "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" + }, "metadata": { "description": "Required. Output only. Additional information about the DatasetVersion.", "readOnly": true, @@ -29436,7748 +36797,7742 @@ "readOnly": true, "type": "string" }, - "satisfiesPzs": { + "name": { + "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "readOnly": true, + "type": "string" + }, + "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, - "satisfiesPzi": { + "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1ListDatasetVersionsResponse": { - "id": "GoogleCloudAiplatformV1ListDatasetVersionsResponse", - "description": "Response message for DatasetService.ListDatasetVersions.", - "type": "object", - "properties": { - "datasetVersions": { - "description": "A list of DatasetVersions that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" - } }, - "nextPageToken": { - "description": "The standard List next-page token.", + "updateTime": { + "description": "Output only. Timestamp when this DatasetVersion was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListDataItemsResponse": { - "id": "GoogleCloudAiplatformV1ListDataItemsResponse", - "description": "Response message for DatasetService.ListDataItems.", - "type": "object", + "GoogleCloudAiplatformV1DedicatedResources": { + "description": "A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration.", + "id": "GoogleCloudAiplatformV1DedicatedResources", "properties": { - "dataItems": { - "description": "A list of DataItems that matches the specified filter in the request.", - "type": "array", + "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`.", "items": { - "$ref": "GoogleCloudAiplatformV1DataItem" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1DataItem": { - "id": "GoogleCloudAiplatformV1DataItem", - "description": "A piece of data in a Dataset. Could be an image, a video, a document or plain text.", - "type": "object", - "properties": { - "name": { - "description": "Output only. The resource name of the DataItem.", - "readOnly": true, - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp when this DataItem was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this DataItem was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "$ref": "GoogleCloudAiplatformV1AutoscalingMetricSpec" + }, + "type": "array" }, - "labels": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "machineSpec": { + "$ref": "GoogleCloudAiplatformV1MachineSpec", + "description": "Required. Immutable. The specification of a single machine being used." }, - "payload": { - "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.", - "type": "any" + "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, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", + "format": "int32", + "type": "integer" }, - "etag": { - "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", - "type": "string" + "minReplicaCount": { + "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.", + "format": "int32", + "type": "integer" }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "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" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, + "spot": { + "description": "Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).", "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SearchDataItemsResponse": { - "id": "GoogleCloudAiplatformV1SearchDataItemsResponse", - "description": "Response message for DatasetService.SearchDataItems.", - "type": "object", + "GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata": { + "description": "Details of operations that delete Feature values.", + "id": "GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata", "properties": { - "dataItemViews": { - "description": "The DataItemViews read.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DataItemView" - } - }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass to SearchDataItemsRequest.page_token to obtain that page.", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Featurestore delete Features values." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DataItemView": { - "id": "GoogleCloudAiplatformV1DataItemView", - "description": "A container for a single DataItem and Annotations on it.", - "type": "object", + "GoogleCloudAiplatformV1DeleteFeatureValuesRequest": { + "description": "Request message for FeaturestoreService.DeleteFeatureValues.", + "id": "GoogleCloudAiplatformV1DeleteFeatureValuesRequest", "properties": { - "dataItem": { - "description": "The DataItem.", - "$ref": "GoogleCloudAiplatformV1DataItem" - }, - "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": "GoogleCloudAiplatformV1Annotation" - } + "selectEntity": { + "$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity", + "description": "Select feature values to be deleted by specifying entities." }, - "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" + "selectTimeRangeAndFeature": { + "$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature", + "description": "Select feature values to be deleted by specifying time range and features." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Annotation": { - "id": "GoogleCloudAiplatformV1Annotation", - "description": "Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.", - "type": "object", + "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity": { + "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": "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity", "properties": { - "name": { - "description": "Output only. Resource name of the Annotation.", - "readOnly": true, - "type": "string" - }, - "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" - }, - "payload": { - "description": "Required. The schema of the payload can be found in payload_schema.", - "type": "any" - }, - "createTime": { - "description": "Output only. Timestamp when this Annotation was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this Annotation was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "etag": { - "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", - "type": "string" + "entityIdSelector": { + "$ref": "GoogleCloudAiplatformV1EntityIdSelector", + "description": "Required. Selectors choosing feature values of which entity id to be deleted from the EntityType." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature": { + "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.", + "id": "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature", + "properties": { + "featureSelector": { + "$ref": "GoogleCloudAiplatformV1FeatureSelector", + "description": "Required. Selectors choosing which feature values to be deleted from the EntityType." }, - "annotationSource": { - "description": "Output only. The source of the Annotation.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1UserActionReference" + "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" }, - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "timeRange": { + "$ref": "GoogleTypeInterval", + "description": "Required. Select feature generated within a half-inclusive time range. The time range is lower inclusive and upper exclusive." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UserActionReference": { - "id": "GoogleCloudAiplatformV1UserActionReference", - "description": "References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.", - "type": "object", + "GoogleCloudAiplatformV1DeleteFeatureValuesResponse": { + "description": "Response message for FeaturestoreService.DeleteFeatureValues.", + "id": "GoogleCloudAiplatformV1DeleteFeatureValuesResponse", "properties": { - "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" - }, - "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" + "selectEntity": { + "$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity", + "description": "Response for request specifying the entities to delete" }, - "method": { - "description": "The method name of the API RPC call. For example, \"/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset\"", - "type": "string" + "selectTimeRangeAndFeature": { + "$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature", + "description": "Response for request specifying time range and feature" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListSavedQueriesResponse": { - "id": "GoogleCloudAiplatformV1ListSavedQueriesResponse", - "description": "Response message for DatasetService.ListSavedQueries.", - "type": "object", + "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity": { + "description": "Response message if the request uses the SelectEntity option.", + "id": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity", "properties": { - "savedQueries": { - "description": "A list of SavedQueries that match the specified filter in the request.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SavedQuery" - } + "offlineStorageDeletedEntityRowCount": { + "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.", + "format": "int64", + "type": "string" }, - "nextPageToken": { - "description": "The standard List next-page token.", + "onlineStorageDeletedEntityCount": { + "description": "The count of deleted entities in the online storage. Each entity ID corresponds to one entity.", + "format": "int64", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AnnotationSpec": { - "id": "GoogleCloudAiplatformV1AnnotationSpec", - "description": "Identifies a concept with which DataItems may be annotated with.", - "type": "object", + "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature": { + "description": "Response message if the request uses the SelectTimeRangeAndFeature option.", + "id": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature", "properties": { - "name": { - "description": "Output only. Resource name of the AnnotationSpec.", - "readOnly": true, + "impactedFeatureCount": { + "description": "The count of the features or columns impacted. This is the same as the feature count in the request.", + "format": "int64", "type": "string" }, - "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.", + "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.", + "format": "int64", "type": "string" }, - "createTime": { - "description": "Output only. Timestamp when this AnnotationSpec was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when AnnotationSpec was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "etag": { - "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "onlineStorageModifiedEntityCount": { + "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.", + "format": "int64", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListAnnotationsResponse": { - "id": "GoogleCloudAiplatformV1ListAnnotationsResponse", - "description": "Response message for DatasetService.ListAnnotations.", - "type": "object", + "GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata": { + "description": "Details of operations that perform MetadataService.DeleteMetadataStore.", + "id": "GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata", "properties": { - "annotations": { - "description": "A list of Annotations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Annotation" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for deleting a MetadataStore." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest": { - "id": "GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest", - "description": "Request message for CreateDeploymentResourcePool method.", - "type": "object", + "GoogleCloudAiplatformV1DeleteOperationMetadata": { + "description": "Details of operations that perform deletes of any entities.", + "id": "GoogleCloudAiplatformV1DeleteOperationMetadata", "properties": { - "deploymentResourcePool": { - "description": "Required. The DeploymentResourcePool to create.", - "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" - }, - "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" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The common part of the operation metadata." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeploymentResourcePool": { - "id": "GoogleCloudAiplatformV1DeploymentResourcePool", - "description": "A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources.", - "type": "object", + "GoogleCloudAiplatformV1DeployIndexOperationMetadata": { + "description": "Runtime operation information for IndexEndpointService.DeployIndex.", + "id": "GoogleCloudAiplatformV1DeployIndexOperationMetadata", "properties": { - "name": { - "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "deployedIndexId": { + "description": "The unique index id specified by user", "type": "string" }, - "dedicatedResources": { - "description": "Required. The underlying DedicatedResources that the DeploymentResourcePool uses.", - "$ref": "GoogleCloudAiplatformV1DedicatedResources" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DeployIndexRequest": { + "description": "Request message for IndexEndpointService.DeployIndex.", + "id": "GoogleCloudAiplatformV1DeployIndexRequest", + "properties": { + "deployedIndex": { + "$ref": "GoogleCloudAiplatformV1DeployedIndex", + "description": "Required. The DeployedIndex to be created within the IndexEndpoint." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DeployIndexResponse": { + "description": "Response message for IndexEndpointService.DeployIndex.", + "id": "GoogleCloudAiplatformV1DeployIndexResponse", + "properties": { + "deployedIndex": { + "$ref": "GoogleCloudAiplatformV1DeployedIndex", + "description": "The DeployedIndex that had been deployed in the IndexEndpoint." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DeployModelOperationMetadata": { + "description": "Runtime operation information for EndpointService.DeployModel.", + "id": "GoogleCloudAiplatformV1DeployModelOperationMetadata", + "properties": { + "deploymentStage": { + "description": "Output only. The deployment stage of the model.", + "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" + ], + "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." + ], + "readOnly": true, + "type": "string" }, - "encryptionSpec": { - "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.", - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DeployModelRequest": { + "description": "Request message for EndpointService.DeployModel.", + "id": "GoogleCloudAiplatformV1DeployModelRequest", + "properties": { + "deployedModel": { + "$ref": "GoogleCloudAiplatformV1DeployedModel", + "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." }, - "serviceAccount": { - "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.", + "trafficSplit": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "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.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DeployModelResponse": { + "description": "Response message for EndpointService.DeployModel.", + "id": "GoogleCloudAiplatformV1DeployModelResponse", + "properties": { + "deployedModel": { + "$ref": "GoogleCloudAiplatformV1DeployedModel", + "description": "The DeployedModel that had been deployed in the Endpoint." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DeployOperationMetadata": { + "description": "Runtime operation information for ModelGardenService.Deploy.", + "id": "GoogleCloudAiplatformV1DeployOperationMetadata", + "properties": { + "destination": { + "description": "Output only. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", + "readOnly": true, "type": "string" }, - "disableContainerLogging": { - "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.", - "type": "boolean" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." }, - "createTime": { - "description": "Output only. Timestamp when this DeploymentResourcePool was created.", + "modelId": { + "description": "Output only. The model id to be used at query time.", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "string" }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", + "projectNumber": { + "description": "Output only. The project number where the deploy model request is sent.", + "format": "int64", "readOnly": true, - "type": "boolean" + "type": "string" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", + "publisherModel": { + "description": "Output only. The name of the model resource.", "readOnly": true, - "type": "boolean" + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DedicatedResources": { - "id": "GoogleCloudAiplatformV1DedicatedResources", - "description": "A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration.", - "type": "object", + "GoogleCloudAiplatformV1DeployRequest": { + "description": "Request message for ModelGardenService.Deploy.", + "id": "GoogleCloudAiplatformV1DeployRequest", "properties": { - "machineSpec": { - "description": "Required. Immutable. The specification of a single machine being used.", - "$ref": "GoogleCloudAiplatformV1MachineSpec" - }, - "minReplicaCount": { - "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", - "format": "int32" + "deployConfig": { + "$ref": "GoogleCloudAiplatformV1DeployRequestDeployConfig", + "description": "Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used." }, - "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, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", - "type": "integer", - "format": "int32" + "endpointConfig": { + "$ref": "GoogleCloudAiplatformV1DeployRequestEndpointConfig", + "description": "Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used." }, - "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.", - "type": "integer", - "format": "int32" + "huggingFaceModelId": { + "description": "The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`.", + "type": "string" }, - "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": "GoogleCloudAiplatformV1AutoscalingMetricSpec" - } + "modelConfig": { + "$ref": "GoogleCloudAiplatformV1DeployRequestModelConfig", + "description": "Optional. The model config to use for the deployment. If not specified, the default model config will be used." }, - "spot": { - "description": "Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).", - "type": "boolean" + "publisherModelName": { + "description": "The Model Garden model to deploy. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MachineSpec": { - "id": "GoogleCloudAiplatformV1MachineSpec", - "description": "Specification of a single machine.", - "type": "object", + "GoogleCloudAiplatformV1DeployRequestDeployConfig": { + "description": "The deploy config to use for the deployment.", + "id": "GoogleCloudAiplatformV1DeployRequestDeployConfig", "properties": { - "machineType": { - "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", - "type": "string" - }, - "acceleratorType": { - "description": "Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.", - "type": "string", - "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." - ], - "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.", - "type": "integer", - "format": "int32" + "dedicatedResources": { + "$ref": "GoogleCloudAiplatformV1DedicatedResources", + "description": "Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used." }, - "tpuTopology": { - "description": "Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: \"2x2x1\").", - "type": "string" + "fastTryoutEnabled": { + "description": "Optional. If true, enable the QMT fast tryout feature for this model if possible.", + "type": "boolean" }, - "reservationAffinity": { - "description": "Optional. Immutable. Configuration controlling how this resource pool consumes reservation.", - "$ref": "GoogleCloudAiplatformV1ReservationAffinity" + "systemLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. System labels for Model Garden deployments. These labels are managed by Google and for tracking purposes only.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReservationAffinity": { - "id": "GoogleCloudAiplatformV1ReservationAffinity", - "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.", - "type": "object", + "GoogleCloudAiplatformV1DeployRequestEndpointConfig": { + "description": "The endpoint config to use for the deployment.", + "id": "GoogleCloudAiplatformV1DeployRequestEndpointConfig", "properties": { - "reservationAffinityType": { - "description": "Required. Specifies the reservation affinity type.", - "type": "string", - "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." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "NO_RESERVATION", - "ANY_RESERVATION", - "SPECIFIC_RESERVATION" - ] + "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" }, - "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.", + "dedicatedEndpointEnabled": { + "deprecated": true, + "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.", + "type": "boolean" + }, + "endpointDisplayName": { + "description": "Optional. The user-specified display name of the endpoint. If not set, a default name will be used.", "type": "string" }, - "values": { - "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.", - "type": "array", - "items": { + "endpointUserId": { + "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.", + "type": "string" + }, + "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" + }, + "privateServiceConnectConfig": { + "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", + "description": "Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AutoscalingMetricSpec": { - "id": "GoogleCloudAiplatformV1AutoscalingMetricSpec", - "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.", - "type": "object", + "GoogleCloudAiplatformV1DeployRequestModelConfig": { + "description": "The model config to use for the deployment.", + "id": "GoogleCloudAiplatformV1DeployRequestModelConfig", "properties": { - "metricName": { - "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`", + "acceptEula": { + "description": "Optional. Whether the user accepts the End User License Agreement (EULA) for the model.", + "type": "boolean" + }, + "containerSpec": { + "$ref": "GoogleCloudAiplatformV1ModelContainerSpec", + "description": "Optional. The specification of the container that is to be used when deploying. If not set, the default container spec will be used." + }, + "huggingFaceAccessToken": { + "description": "Optional. The Hugging Face read access token used to access the model artifacts of gated models.", "type": "string" }, - "target": { - "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.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse": { - "id": "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse", - "description": "Response message for ListDeploymentResourcePools method.", - "type": "object", - "properties": { - "deploymentResourcePools": { - "description": "The DeploymentResourcePools from the specified location.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" - } + "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" }, - "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.", + "modelDisplayName": { + "description": "Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.", + "type": "string" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QueryDeployedModelsResponse": { - "id": "GoogleCloudAiplatformV1QueryDeployedModelsResponse", - "description": "Response message for QueryDeployedModels method.", - "type": "object", + "GoogleCloudAiplatformV1DeployResponse": { + "description": "Response message for ModelGardenService.Deploy.", + "id": "GoogleCloudAiplatformV1DeployResponse", "properties": { - "deployedModels": { - "description": "DEPRECATED Use deployed_model_refs instead.", - "deprecated": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DeployedModel" - } - }, - "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.", + "endpoint": { + "description": "Output only. The name of the Endpoint created. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "readOnly": true, "type": "string" }, - "deployedModelRefs": { - "description": "References to the DeployedModels that share the specified deploymentResourcePool.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DeployedModelRef" - } - }, - "totalDeployedModelCount": { - "description": "The total number of DeployedModels on this DeploymentResourcePool.", - "type": "integer", - "format": "int32" + "model": { + "description": "Output only. The name of the Model created. Format: `projects/{project}/locations/{location}/models/{model}`", + "readOnly": true, + "type": "string" }, - "totalEndpointCount": { - "description": "The total number of Endpoints that have DeployedModels on this DeploymentResourcePool.", - "type": "integer", - "format": "int32" + "publisherModel": { + "description": "Output only. 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`", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployedModel": { - "id": "GoogleCloudAiplatformV1DeployedModel", - "description": "A deployment of a Model. Endpoints contain one or more DeployedModels.", - "type": "object", + "GoogleCloudAiplatformV1DeployedIndex": { + "description": "A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.", + "id": "GoogleCloudAiplatformV1DeployedIndex", "properties": { - "dedicatedResources": { - "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.", - "$ref": "GoogleCloudAiplatformV1DedicatedResources" - }, "automaticResources": { - "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.", - "$ref": "GoogleCloudAiplatformV1AutomaticResources" + "$ref": "GoogleCloudAiplatformV1AutomaticResources", + "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." }, - "sharedResources": { - "description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "createTime": { + "description": "Output only. Timestamp when the DeployedIndex was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "id": { - "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]/`.", - "type": "string" + "dedicatedResources": { + "$ref": "GoogleCloudAiplatformV1DedicatedResources", + "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." }, - "model": { - "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.", - "type": "string" + "deployedIndexAuthConfig": { + "$ref": "GoogleCloudAiplatformV1DeployedIndexAuthConfig", + "description": "Optional. If set, the authentication is enabled for the private endpoint." }, - "gdcConnectedModel": { - "description": "GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.", + "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" }, - "modelVersionId": { - "description": "Output only. The version ID of the model that is deployed.", - "readOnly": true, + "deploymentTier": { + "description": "Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.", + "enum": [ + "DEPLOYMENT_TIER_UNSPECIFIED", + "STORAGE" + ], + "enumDescriptions": [ + "Default deployment tier.", + "Optimized for costs." + ], "type": "string" }, "displayName": { - "description": "The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used.", + "description": "The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.", "type": "string" }, - "createTime": { - "description": "Output only. Timestamp when the DeployedModel was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "explanationSpec": { - "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.", - "$ref": "GoogleCloudAiplatformV1ExplanationSpec" + "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" }, - "disableExplanations": { - "description": "If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec.", + "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" }, - "serviceAccount": { - "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.", + "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" }, - "disableContainerLogging": { - "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.", - "type": "boolean" - }, - "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" + "index": { + "description": "Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's \"original\" Index.", + "type": "string" }, - "privateEndpoints": { - "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.", + "indexSyncTime": { + "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.", + "format": "google-datetime", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1PrivateEndpoints" + "type": "string" }, - "fasterDeploymentConfig": { - "description": "Configuration for faster model deployment.", - "$ref": "GoogleCloudAiplatformV1FasterDeploymentConfig" + "privateEndpoints": { + "$ref": "GoogleCloudAiplatformV1IndexPrivateEndpoints", + "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.", + "readOnly": true }, - "status": { - "description": "Output only. Runtime status of the deployed model.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1DeployedModelStatus" + "pscAutomationConfigs": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1PSCAutomationConfig" + }, + "type": "array" }, - "systemLabels": { - "description": "System labels to apply to Model Garden deployments. System labels are managed by Google for internal use only.", - "type": "object", - "additionalProperties": { + "reservedIpRanges": { + "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.", + "items": { "type": "string" - } - }, - "checkpointId": { - "description": "The checkpoint id of the model.", - "type": "string" - }, - "speculativeDecodingSpec": { - "description": "Optional. Spec for configuring speculative decoding.", - "$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpec" - } - } - }, - "GoogleCloudAiplatformV1AutomaticResources": { - "id": "GoogleCloudAiplatformV1AutomaticResources", - "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.", - "type": "object", - "properties": { - "minReplicaCount": { - "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.", - "type": "integer", - "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 Vertex AI may be unable to scale beyond certain replica number.", - "type": "integer", - "format": "int32" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExplanationSpec": { - "id": "GoogleCloudAiplatformV1ExplanationSpec", - "description": "Specification of Model explanation.", - "type": "object", + "GoogleCloudAiplatformV1DeployedIndexAuthConfig": { + "description": "Used to set up the auth on the DeployedIndex's private endpoint.", + "id": "GoogleCloudAiplatformV1DeployedIndexAuthConfig", "properties": { - "parameters": { - "description": "Required. Parameters that configure explaining of the Model's predictions.", - "$ref": "GoogleCloudAiplatformV1ExplanationParameters" - }, - "metadata": { - "description": "Optional. Metadata describing the Model's input and output for explanation.", - "$ref": "GoogleCloudAiplatformV1ExplanationMetadata" + "authProvider": { + "$ref": "GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider", + "description": "Defines the authentication provider that the DeployedIndex uses." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExplanationParameters": { - "id": "GoogleCloudAiplatformV1ExplanationParameters", - "description": "Parameters to configure explaining for Model's predictions.", - "type": "object", + "GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider": { + "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).", + "id": "GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider", "properties": { - "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": "GoogleCloudAiplatformV1SampledShapleyAttribution" - }, - "integratedGradientsAttribution": { - "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", - "$ref": "GoogleCloudAiplatformV1IntegratedGradientsAttribution" - }, - "xraiAttribution": { - "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.", - "$ref": "GoogleCloudAiplatformV1XraiAttribution" - }, - "examples": { - "description": "Example-based explanations that returns the nearest neighbors from the provided dataset.", - "$ref": "GoogleCloudAiplatformV1Examples" - }, - "topK": { - "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.", - "type": "integer", - "format": "int32" + "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" }, - "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).", - "type": "array", + "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": "any" - } - } - } - }, - "GoogleCloudAiplatformV1SampledShapleyAttribution": { - "id": "GoogleCloudAiplatformV1SampledShapleyAttribution", - "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.", - "type": "object", - "properties": { - "pathCount": { - "description": "Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.", - "type": "integer", - "format": "int32" + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1IntegratedGradientsAttribution": { - "id": "GoogleCloudAiplatformV1IntegratedGradientsAttribution", - "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", - "type": "object", + "GoogleCloudAiplatformV1DeployedIndexRef": { + "description": "Points to a DeployedIndex.", + "id": "GoogleCloudAiplatformV1DeployedIndexRef", "properties": { - "stepCount": { - "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": "integer", - "format": "int32" + "deployedIndexId": { + "description": "Immutable. The ID of the DeployedIndex in the above IndexEndpoint.", + "type": "string" }, - "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": "GoogleCloudAiplatformV1SmoothGradConfig" + "displayName": { + "description": "Output only. The display name of the DeployedIndex.", + "readOnly": true, + "type": "string" }, - "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": "GoogleCloudAiplatformV1BlurBaselineConfig" + "indexEndpoint": { + "description": "Immutable. A resource name of the IndexEndpoint.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SmoothGradConfig": { - "id": "GoogleCloudAiplatformV1SmoothGradConfig", - "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", - "type": "object", + "GoogleCloudAiplatformV1DeployedModel": { + "description": "A deployment of a Model. Endpoints contain one or more DeployedModels.", + "id": "GoogleCloudAiplatformV1DeployedModel", "properties": { - "noiseSigma": { - "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", - "format": "float" - }, - "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": "GoogleCloudAiplatformV1FeatureNoiseSigma" + "automaticResources": { + "$ref": "GoogleCloudAiplatformV1AutomaticResources", + "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration." }, - "noisySampleCount": { - "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", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1FeatureNoiseSigma": { - "id": "GoogleCloudAiplatformV1FeatureNoiseSigma", - "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.", - "type": "object", - "properties": { - "noiseSigma": { - "description": "Noise sigma per feature. No noise is added to features that are not set.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature" - } - } - } - }, - "GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature": { - "id": "GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature", - "description": "Noise sigma for a single feature.", - "type": "object", - "properties": { - "name": { - "description": "The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.", + "checkpointId": { + "description": "The checkpoint id of the model.", "type": "string" }, - "sigma": { - "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.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudAiplatformV1BlurBaselineConfig": { - "id": "GoogleCloudAiplatformV1BlurBaselineConfig", - "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", - "type": "object", - "properties": { - "maxBlurSigma": { - "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": "number", - "format": "float" - } - } - }, - "GoogleCloudAiplatformV1XraiAttribution": { - "id": "GoogleCloudAiplatformV1XraiAttribution", - "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.", - "type": "object", - "properties": { - "stepCount": { - "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": "integer", - "format": "int32" - }, - "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": "GoogleCloudAiplatformV1SmoothGradConfig" + "createTime": { + "description": "Output only. Timestamp when the DeployedModel was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "blurBaselineConfig": { - "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", - "$ref": "GoogleCloudAiplatformV1BlurBaselineConfig" - } - } - }, - "GoogleCloudAiplatformV1Examples": { - "id": "GoogleCloudAiplatformV1Examples", - "description": "Example-based explainability that returns the nearest neighbors from the provided dataset.", - "type": "object", - "properties": { - "exampleGcsSource": { - "description": "The Cloud Storage input instances.", - "$ref": "GoogleCloudAiplatformV1ExamplesExampleGcsSource" + "dedicatedResources": { + "$ref": "GoogleCloudAiplatformV1DedicatedResources", + "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration." }, - "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" + "disableContainerLogging": { + "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.", + "type": "boolean" }, - "presets": { - "description": "Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.", - "$ref": "GoogleCloudAiplatformV1Presets" + "disableExplanations": { + "description": "If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec.", + "type": "boolean" }, - "neighborCount": { - "description": "The number of neighbors to return when querying for examples.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1ExamplesExampleGcsSource": { - "id": "GoogleCloudAiplatformV1ExamplesExampleGcsSource", - "description": "The Cloud Storage input instances.", - "type": "object", - "properties": { - "dataFormat": { - "description": "The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.", - "type": "string", - "enumDescriptions": [ - "Format unspecified, used when unset.", - "Examples are stored in JSONL files." - ], - "enum": [ - "DATA_FORMAT_UNSPECIFIED", - "JSONL" - ] + "displayName": { + "description": "The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used.", + "type": "string" }, - "gcsSource": { - "description": "The Cloud Storage location for the input instances.", - "$ref": "GoogleCloudAiplatformV1GcsSource" - } - } - }, - "GoogleCloudAiplatformV1Presets": { - "id": "GoogleCloudAiplatformV1Presets", - "description": "Preset configuration for example-based explanations", - "type": "object", - "properties": { - "query": { - "description": "Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.", - "type": "string", - "enumDescriptions": [ - "More precise neighbors as a trade-off against slower response.", - "Faster response as a trade-off against less precise neighbors." - ], - "enum": [ - "PRECISE", - "FAST" - ] + "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" }, - "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.", - "type": "string", - "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" - ] - } - } - }, - "GoogleCloudAiplatformV1ExplanationMetadata": { - "id": "GoogleCloudAiplatformV1ExplanationMetadata", - "description": "Metadata describing the Model's input and output for explanation.", - "type": "object", - "properties": { - "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.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadata" - } + "explanationSpec": { + "$ref": "GoogleCloudAiplatformV1ExplanationSpec", + "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." }, - "outputs": { - "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.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata" - } + "fasterDeploymentConfig": { + "$ref": "GoogleCloudAiplatformV1FasterDeploymentConfig", + "description": "Configuration for faster model deployment." }, - "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.", + "gdcConnectedModel": { + "description": "GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.", "type": "string" }, - "latentSpaceSource": { - "description": "Name of the source to generate embeddings for example based explanations.", + "id": { + "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]/`.", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1ExplanationMetadataInputMetadata": { - "id": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadata", - "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.", - "type": "object", - "properties": { - "inputBaselines": { - "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.", - "type": "array", - "items": { - "type": "any" - } }, - "inputTensorName": { - "description": "Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.", + "model": { + "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.", "type": "string" }, - "encoding": { - "description": "Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.", - "type": "string", - "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]] ```" - ], - "enum": [ - "ENCODING_UNSPECIFIED", - "IDENTITY", - "BAG_OF_FEATURES", - "BAG_OF_FEATURES_SPARSE", - "INDICATOR", - "COMBINED_EMBEDDING", - "CONCAT_EMBEDDING" - ] - }, - "modality": { - "description": "Modality of the feature. Valid values are: numeric, image. Defaults to numeric.", + "modelVersionId": { + "description": "Output only. The version ID of the model that is deployed.", + "readOnly": true, "type": "string" }, - "featureValueDomain": { - "description": "The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.", - "$ref": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain" + "privateEndpoints": { + "$ref": "GoogleCloudAiplatformV1PrivateEndpoints", + "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.", + "readOnly": true }, - "indicesTensorName": { - "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.", + "serviceAccount": { + "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.", "type": "string" }, - "denseShapeTensorName": { - "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.", + "sharedResources": { + "description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "type": "string" }, - "indexFeatureMapping": { - "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.", - "type": "array", - "items": { - "type": "string" - } + "speculativeDecodingSpec": { + "$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpec", + "description": "Optional. Spec for configuring speculative decoding." }, - "encodedTensorName": { - "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.", - "type": "string" + "status": { + "$ref": "GoogleCloudAiplatformV1DeployedModelStatus", + "description": "Output only. Runtime status of the deployed model.", + "readOnly": true }, - "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" - } + "systemLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "System labels to apply to Model Garden deployments. System labels are managed by Google for internal use only.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DeployedModelRef": { + "description": "Points to a DeployedModel.", + "id": "GoogleCloudAiplatformV1DeployedModelRef", + "properties": { + "checkpointId": { + "description": "Immutable. The ID of the Checkpoint deployed in the DeployedModel.", + "type": "string" }, - "visualization": { - "description": "Visualization configurations for image explanation.", - "$ref": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization" + "deployedModelId": { + "description": "Immutable. An ID of a DeployedModel in the above Endpoint.", + "type": "string" }, - "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.", + "endpoint": { + "description": "Immutable. A resource name of an Endpoint.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain": { - "id": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain", - "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", + "GoogleCloudAiplatformV1DeployedModelStatus": { + "description": "Runtime status of the deployed model.", + "id": "GoogleCloudAiplatformV1DeployedModelStatus", "properties": { - "minValue": { - "description": "The minimum permissible value for this feature.", - "type": "number", - "format": "float" - }, - "maxValue": { - "description": "The maximum permissible value for this feature.", - "type": "number", - "format": "float" + "availableReplicaCount": { + "description": "Output only. The number of available replicas of the deployed model.", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "originalMean": { - "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.", - "type": "number", - "format": "float" + "lastUpdateTime": { + "description": "Output only. The time at which the status was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "originalStddev": { - "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.", - "type": "number", - "format": "float" + "message": { + "description": "Output only. The latest deployed model's status message (if any).", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization": { - "id": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization", - "description": "Visualization configurations for image explanation.", - "type": "object", + "GoogleCloudAiplatformV1DeploymentResourcePool": { + "description": "A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources.", + "id": "GoogleCloudAiplatformV1DeploymentResourcePool", "properties": { - "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.", - "type": "string", - "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" - ] + "createTime": { + "description": "Output only. Timestamp when this DeploymentResourcePool was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "polarity": { - "description": "Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.", - "type": "string", - "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." - ], - "enum": [ - "POLARITY_UNSPECIFIED", - "POSITIVE", - "NEGATIVE", - "BOTH" - ] + "dedicatedResources": { + "$ref": "GoogleCloudAiplatformV1DedicatedResources", + "description": "Required. The underlying DedicatedResources that the DeploymentResourcePool uses." }, - "colorMap": { - "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.", - "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" - ] + "disableContainerLogging": { + "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.", + "type": "boolean" + }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." + }, + "name": { + "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "type": "string" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" }, - "clipPercentUpperbound": { - "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.", - "type": "number", - "format": "float" + "serviceAccount": { + "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": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DestinationFeatureSetting": { + "id": "GoogleCloudAiplatformV1DestinationFeatureSetting", + "properties": { + "destinationField": { + "description": "Specify the field name in the export destination. If not specified, Feature ID is used.", + "type": "string" }, - "clipPercentLowerbound": { - "description": "Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.", - "type": "number", - "format": "float" + "featureId": { + "description": "Required. The ID of the Feature to apply the setting to.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DirectPredictRequest": { + "description": "Request message for PredictionService.DirectPredict.", + "id": "GoogleCloudAiplatformV1DirectPredictRequest", + "properties": { + "inputs": { + "description": "The prediction input.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tensor" + }, + "type": "array" }, - "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" - ] + "parameters": { + "$ref": "GoogleCloudAiplatformV1Tensor", + "description": "The parameters that govern the prediction." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata": { - "id": "GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata", - "description": "Metadata of the prediction output to be explained.", - "type": "object", + "GoogleCloudAiplatformV1DirectPredictResponse": { + "description": "Response message for PredictionService.DirectPredict.", + "id": "GoogleCloudAiplatformV1DirectPredictResponse", "properties": { - "indexDisplayNameMapping": { - "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.", - "type": "any" + "outputs": { + "description": "The prediction output.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tensor" + }, + "type": "array" }, - "displayNameMappingKey": { - "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.", + "parameters": { + "$ref": "GoogleCloudAiplatformV1Tensor", + "description": "The parameters that govern the prediction." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DirectRawPredictRequest": { + "description": "Request message for PredictionService.DirectRawPredict.", + "id": "GoogleCloudAiplatformV1DirectRawPredictRequest", + "properties": { + "input": { + "description": "The prediction input.", + "format": "byte", "type": "string" }, - "outputTensorName": { - "description": "Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PrivateEndpoints": { - "id": "GoogleCloudAiplatformV1PrivateEndpoints", - "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.", - "type": "object", + "GoogleCloudAiplatformV1DirectRawPredictResponse": { + "description": "Response message for PredictionService.DirectRawPredict.", + "id": "GoogleCloudAiplatformV1DirectRawPredictResponse", "properties": { - "predictHttpUri": { - "description": "Output only. Http(s) path to send prediction requests.", - "readOnly": true, + "output": { + "description": "The prediction output.", + "format": "byte", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DirectUploadSource": { + "description": "The input content is encapsulated and uploaded in the request.", + "id": "GoogleCloudAiplatformV1DirectUploadSource", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1DiskSpec": { + "description": "Represents the spec of disk options.", + "id": "GoogleCloudAiplatformV1DiskSpec", + "properties": { + "bootDiskSizeGb": { + "description": "Size in GB of the boot disk (default is 100GB).", + "format": "int32", + "type": "integer" }, - "explainHttpUri": { - "description": "Output only. Http(s) path to send explain requests.", - "readOnly": true, + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1DnsPeeringConfig": { + "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": "GoogleCloudAiplatformV1DnsPeeringConfig", + "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" }, - "healthHttpUri": { - "description": "Output only. Http(s) path to send health check requests.", - "readOnly": true, + "targetNetwork": { + "description": "Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.", "type": "string" }, - "serviceAttachment": { - "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled.", - "readOnly": true, + "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" }, - "GoogleCloudAiplatformV1FasterDeploymentConfig": { - "id": "GoogleCloudAiplatformV1FasterDeploymentConfig", - "description": "Configuration for faster model deployment.", - "type": "object", + "GoogleCloudAiplatformV1DoubleArray": { + "description": "A list of double values.", + "id": "GoogleCloudAiplatformV1DoubleArray", "properties": { - "fastTryoutEnabled": { - "description": "If true, enable fast tryout feature for this deployed model.", - "type": "boolean" + "values": { + "description": "A list of double values.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployedModelStatus": { - "id": "GoogleCloudAiplatformV1DeployedModelStatus", - "description": "Runtime status of the deployed model.", - "type": "object", + "GoogleCloudAiplatformV1DynamicRetrievalConfig": { + "description": "Describes the options to customize dynamic retrieval.", + "id": "GoogleCloudAiplatformV1DynamicRetrievalConfig", "properties": { - "message": { - "description": "Output only. The latest deployed model's status message (if any).", - "readOnly": true, + "dynamicThreshold": { + "description": "Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.", + "format": "float", + "type": "number" + }, + "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" + }, + "GoogleCloudAiplatformV1EmbedContentRequest": { + "description": "Request message for PredictionService.EmbedContent.", + "id": "GoogleCloudAiplatformV1EmbedContentRequest", + "properties": { + "autoTruncate": { + "deprecated": true, + "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.", + "type": "boolean" }, - "lastUpdateTime": { - "description": "Output only. The time at which the status was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Required. The content to be embedded." }, - "availableReplicaCount": { - "description": "Output only. The number of available replicas of the deployed model.", - "readOnly": true, - "type": "integer", - "format": "int32" + "embedContentConfig": { + "$ref": "GoogleCloudAiplatformV1EmbedContentRequestEmbedContentConfig", + "description": "Optional. Configuration for the EmbedContent request." + }, + "outputDimensionality": { + "deprecated": true, + "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", + "type": "integer" + }, + "taskType": { + "deprecated": true, + "description": "Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.", + "enum": [ + "UNSPECIFIED", + "RETRIEVAL_QUERY", + "RETRIEVAL_DOCUMENT", + "SEMANTIC_SIMILARITY", + "CLASSIFICATION", + "CLUSTERING", + "QUESTION_ANSWERING", + "FACT_VERIFICATION", + "CODE_RETRIEVAL_QUERY" + ], + "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." + ], + "type": "string" + }, + "title": { + "deprecated": true, + "description": "Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SpeculativeDecodingSpec": { - "id": "GoogleCloudAiplatformV1SpeculativeDecodingSpec", - "description": "Configuration for Speculative Decoding.", - "type": "object", + "GoogleCloudAiplatformV1EmbedContentRequestEmbedContentConfig": { + "description": "Configurations for the EmbedContent API.", + "id": "GoogleCloudAiplatformV1EmbedContentRequestEmbedContentConfig", "properties": { - "draftModelSpeculation": { - "description": "draft model speculation.", - "$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation" + "audioTrackExtraction": { + "description": "Optional. Whether to extract audio from video content.", + "type": "boolean" }, - "ngramSpeculation": { - "description": "N-Gram speculation.", - "$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation" + "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" }, - "speculativeTokenCount": { - "description": "The number of speculative tokens to generate at each step.", - "type": "integer", - "format": "int32" + "documentOcr": { + "description": "Optional. Whether to enable OCR for document content.", + "type": "boolean" + }, + "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" + }, + "taskType": { + "description": "Optional. The task type of the embedding. Only applicable to text-only embedding models.", + "enum": [ + "UNSPECIFIED", + "RETRIEVAL_QUERY", + "RETRIEVAL_DOCUMENT", + "SEMANTIC_SIMILARITY", + "CLASSIFICATION", + "CLUSTERING", + "QUESTION_ANSWERING", + "FACT_VERIFICATION", + "CODE_RETRIEVAL_QUERY" + ], + "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." + ], + "type": "string" + }, + "title": { + "description": "Optional. The title for the text. Only applicable to text-only embedding models.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation": { - "id": "GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation", - "description": "Draft model speculation works by using the smaller model to generate candidate tokens for speculative decoding.", - "type": "object", + "GoogleCloudAiplatformV1EmbedContentResponse": { + "description": "Response message for PredictionService.EmbedContent.", + "id": "GoogleCloudAiplatformV1EmbedContentResponse", "properties": { - "draftModel": { - "description": "Required. The resource name of the draft model.", - "type": "string" + "embedding": { + "$ref": "GoogleCloudAiplatformV1EmbedContentResponseEmbedding", + "description": "The embedding generated from the input content." + }, + "truncated": { + "description": "Whether the input content was truncated before generating the embedding.", + "type": "boolean" + }, + "usageMetadata": { + "$ref": "GoogleCloudAiplatformV1UsageMetadata", + "description": "Usage metadata about the response(s)." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation": { - "id": "GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation", - "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.", - "type": "object", + "GoogleCloudAiplatformV1EmbedContentResponseEmbedding": { + "description": "A list of floats representing an embedding.", + "id": "GoogleCloudAiplatformV1EmbedContentResponseEmbedding", "properties": { - "ngramSize": { - "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.", - "type": "integer", - "format": "int32" + "values": { + "description": "Embedding vector values.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployedModelRef": { - "id": "GoogleCloudAiplatformV1DeployedModelRef", - "description": "Points to a DeployedModel.", - "type": "object", + "GoogleCloudAiplatformV1EncryptionSpec": { + "description": "Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource.", + "id": "GoogleCloudAiplatformV1EncryptionSpec", "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.", + "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" } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1Endpoint": { - "id": "GoogleCloudAiplatformV1Endpoint", "description": "Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.", - "type": "object", + "id": "GoogleCloudAiplatformV1Endpoint", "properties": { - "name": { - "description": "Output only. The resource name of the Endpoint.", + "clientConnectionConfig": { + "$ref": "GoogleCloudAiplatformV1ClientConnectionConfig", + "description": "Configurations that are applied to the endpoint for online prediction." + }, + "createTime": { + "description": "Output only. Timestamp when this Endpoint was created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "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.", + "dedicatedEndpointDns": { + "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`.", + "readOnly": true, "type": "string" }, - "description": { - "description": "The description of the Endpoint.", - "type": "string" + "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, - "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1DeployedModel" - } - }, - "trafficSplit": { - "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.", - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } + }, + "readOnly": true, + "type": "array" }, - "etag": { - "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "description": { + "description": "The description of the Endpoint.", "type": "string" }, - "labels": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "createTime": { - "description": "Output only. Timestamp when this Endpoint was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "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" }, - "updateTime": { - "description": "Output only. Timestamp when this Endpoint was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "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" }, "encryptionSpec": { - "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.", - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "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.", + "etag": { + "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, - "enablePrivateServiceConnect": { - "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.", - "deprecated": true, - "type": "boolean" + "gdcConfig": { + "$ref": "GoogleCloudAiplatformV1GdcConfig", + "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." }, - "privateServiceConnectConfig": { - "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.", - "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig" + "genAiAdvancedFeaturesConfig": { + "$ref": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig", + "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." + }, + "labels": { + "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.", + "type": "object" }, "modelDeploymentMonitoringJob": { "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}`", "readOnly": true, "type": "string" }, - "predictRequestResponseLoggingConfig": { - "description": "Configures the request-response logging for online prediction.", - "$ref": "GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig" - }, - "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" + "name": { + "description": "Identifier. The resource name of the Endpoint.", + "type": "string" }, - "dedicatedEndpointDns": { - "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`.", - "readOnly": true, + "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" }, - "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": "GoogleCloudAiplatformV1GdcConfig" + "predictRequestResponseLoggingConfig": { + "$ref": "GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig", + "description": "Configures the request-response logging for online prediction." }, - "clientConnectionConfig": { - "description": "Configurations that are applied to the endpoint for online prediction.", - "$ref": "GoogleCloudAiplatformV1ClientConnectionConfig" + "privateServiceConnectConfig": { + "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", + "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." }, - "satisfiesPzs": { + "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, - "satisfiesPzi": { + "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, - "genAiAdvancedFeaturesConfig": { - "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.", - "$ref": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig" + "trafficSplit": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "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.", + "type": "object" + }, + "updateTime": { + "description": "Output only. Timestamp when this Endpoint was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PrivateServiceConnectConfig": { - "id": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", - "description": "Represents configuration for private service connect.", - "type": "object", + "GoogleCloudAiplatformV1EnterpriseWebSearch": { + "description": "Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.", + "id": "GoogleCloudAiplatformV1EnterpriseWebSearch", "properties": { - "enablePrivateServiceConnect": { - "description": "Required. If true, expose the IndexEndpoint via private service connect.", - "type": "boolean" + "blockingConfidence": { + "description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", + "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" + ], + "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." + ], + "type": "string" }, - "projectAllowlist": { - "description": "A list of Projects from which the forwarding rule will target the service attachment.", - "type": "array", + "excludeDomains": { + "description": "Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.", "items": { "type": "string" - } - }, - "pscAutomationConfigs": { - "description": "Optional. List of projects and networks where the PSC endpoints will be created. This field is used by Online Inference(Prediction) only.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1PSCAutomationConfig" - } + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EntityIdSelector": { + "description": "Selector for entityId. Getting ids from the given source.", + "id": "GoogleCloudAiplatformV1EntityIdSelector", + "properties": { + "csvSource": { + "$ref": "GoogleCloudAiplatformV1CsvSource", + "description": "Source of Csv" }, - "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, + "entityIdField": { + "description": "Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PSCAutomationConfig": { - "id": "GoogleCloudAiplatformV1PSCAutomationConfig", - "description": "PSC config that is used to automatically create PSC endpoints in the user projects.", - "type": "object", + "GoogleCloudAiplatformV1EntityType": { + "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.", + "id": "GoogleCloudAiplatformV1EntityType", "properties": { - "projectId": { - "description": "Required. Project id used to create forwarding rule.", + "createTime": { + "description": "Output only. Timestamp when this EntityType was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "network": { - "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}`.", + "description": { + "description": "Optional. Description of the EntityType.", "type": "string" }, - "ipAddress": { - "description": "Output only. IP address rule created by the PSC service automation.", - "readOnly": true, + "etag": { + "description": "Optional. Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, - "forwardingRule": { - "description": "Output only. Forwarding rule created by the PSC service automation.", + "labels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" + }, + "monitoringConfig": { + "$ref": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfig", + "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." + }, + "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" + }, + "offlineStorageTtlDays": { + "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.", + "format": "int32", + "type": "integer" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", "readOnly": true, - "type": "string" + "type": "boolean" }, - "state": { - "description": "Output only. The state of the PSC service automation.", + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", "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" - ] + "type": "boolean" }, - "errorMessage": { - "description": "Output only. Error message if the PSC service automation failed.", + "updateTime": { + "description": "Output only. Timestamp when this EntityType was most recently updated.", + "format": "google-datetime", "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig": { - "id": "GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig", - "description": "Configuration for logging request-response to a BigQuery table.", - "type": "object", + "GoogleCloudAiplatformV1EnvVar": { + "description": "Represents an environment variable present in a Container or Python Module.", + "id": "GoogleCloudAiplatformV1EnvVar", "properties": { - "enabled": { - "description": "If logging is enabled or not.", - "type": "boolean" - }, - "samplingRate": { - "description": "Percentage of requests to be logged, expressed as a fraction in range(0,1].", - "type": "number", - "format": "double" + "name": { + "description": "Required. Name of the environment variable. Must be a valid C identifier.", + "type": "string" }, - "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": "GoogleCloudAiplatformV1BigQueryDestination" - } - } - }, - "GoogleCloudAiplatformV1BigQueryDestination": { - "id": "GoogleCloudAiplatformV1BigQueryDestination", - "description": "The BigQuery location for the output content.", - "type": "object", - "properties": { - "outputUri": { - "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`.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GdcConfig": { - "id": "GoogleCloudAiplatformV1GdcConfig", - "description": "Google Distributed Cloud (GDC) config.", - "type": "object", + "GoogleCloudAiplatformV1ErrorAnalysisAnnotation": { + "description": "Model error analysis for each annotation.", + "id": "GoogleCloudAiplatformV1ErrorAnalysisAnnotation", "properties": { - "zone": { - "description": "GDC zone. A cluster will be designated for the Vertex AI workload in this zone.", + "attributedItems": { + "description": "Attributed items for a given annotation, typically representing neighbors from the training sets constrained by the query type.", + "items": { + "$ref": "GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem" + }, + "type": "array" + }, + "outlierScore": { + "description": "The outlier score of this annotated item. Usually defined as the min of all distances from attributed items.", + "format": "double", + "type": "number" + }, + "outlierThreshold": { + "description": "The threshold used to determine if this annotation is an outlier or not.", + "format": "double", + "type": "number" + }, + "queryType": { + "description": "The query type used for finding the attributed items.", + "enum": [ + "QUERY_TYPE_UNSPECIFIED", + "ALL_SIMILAR", + "SAME_CLASS_SIMILAR", + "SAME_CLASS_DISSIMILAR" + ], + "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." + ], "type": "string" } - } - }, - "GoogleCloudAiplatformV1ClientConnectionConfig": { - "id": "GoogleCloudAiplatformV1ClientConnectionConfig", - "description": "Configurations (e.g. inference timeout) that are applied on your endpoints.", - "type": "object", - "properties": { - "inferenceTimeout": { - "description": "Customizable online prediction request timeout.", - "type": "string", - "format": "google-duration" - } - } - }, - "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig": { - "id": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig", - "description": "Configuration for GenAiAdvancedFeatures.", - "type": "object", - "properties": { - "ragConfig": { - "description": "Configuration for Retrieval Augmented Generation feature.", - "$ref": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig" - } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig": { - "id": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig", - "description": "Configuration for Retrieval Augmented Generation feature.", - "type": "object", + "GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem": { + "description": "Attributed items for a given annotation, typically representing neighbors from the training sets constrained by the query type.", + "id": "GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem", "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" + "annotationResourceName": { + "description": "The unique ID for each annotation. Used by FE to allocate the annotation in DB.", + "type": "string" + }, + "distance": { + "description": "The distance of this item to the annotation.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListEndpointsResponse": { - "id": "GoogleCloudAiplatformV1ListEndpointsResponse", - "description": "Response message for EndpointService.ListEndpoints.", - "type": "object", + "GoogleCloudAiplatformV1EvaluateDatasetRequest": { + "description": "Request message for EvaluationService.EvaluateDataset.", + "id": "GoogleCloudAiplatformV1EvaluateDatasetRequest", "properties": { - "endpoints": { - "description": "List of Endpoints in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Endpoint" - } + "autoraterConfig": { + "$ref": "GoogleCloudAiplatformV1AutoraterConfig", + "description": "Optional. Autorater config used for evaluation. Currently only publisher Gemini models are supported. Format: `projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}.`" }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListEndpointsRequest.page_token to obtain that page.", + "dataset": { + "$ref": "GoogleCloudAiplatformV1EvaluationDataset", + "description": "Required. The dataset used for evaluation." + }, + "location": { + "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", "type": "string" + }, + "metrics": { + "description": "Required. The metrics used for evaluation.", + "items": { + "$ref": "GoogleCloudAiplatformV1Metric" + }, + "type": "array" + }, + "outputConfig": { + "$ref": "GoogleCloudAiplatformV1OutputConfig", + "description": "Required. Config for evaluation output." } - } - }, - "GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest": { - "id": "GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest", - "description": "Request message for EndpointService.UpdateEndpointLongRunning.", - "type": "object", - "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": "GoogleCloudAiplatformV1Endpoint" - } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployModelRequest": { - "id": "GoogleCloudAiplatformV1DeployModelRequest", - "description": "Request message for EndpointService.DeployModel.", - "type": "object", + "GoogleCloudAiplatformV1EvaluateDatasetResponse": { + "description": "The results from an evaluation run performed by the EvaluationService.", + "id": "GoogleCloudAiplatformV1EvaluateDatasetResponse", "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": "GoogleCloudAiplatformV1DeployedModel" + "aggregationOutput": { + "$ref": "GoogleCloudAiplatformV1AggregationOutput", + "description": "Output only. Aggregation statistics derived from results of EvaluationService.", + "readOnly": true }, - "trafficSplit": { - "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.", - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } + "outputInfo": { + "$ref": "GoogleCloudAiplatformV1OutputInfo", + "description": "Output only. Output info for EvaluationService.", + "readOnly": true } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UndeployModelRequest": { - "id": "GoogleCloudAiplatformV1UndeployModelRequest", - "description": "Request message for EndpointService.UndeployModel.", - "type": "object", + "GoogleCloudAiplatformV1EvaluateDatasetRun": { + "description": "Evaluate Dataset Run Result for Tuning Job.", + "id": "GoogleCloudAiplatformV1EvaluateDatasetRun", "properties": { - "deployedModelId": { - "description": "Required. The ID of the DeployedModel to be undeployed from the Endpoint.", + "checkpointId": { + "description": "Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints.", + "readOnly": true, "type": "string" }, - "trafficSplit": { - "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.", - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - } - } - }, - "GoogleCloudAiplatformV1MutateDeployedModelRequest": { - "id": "GoogleCloudAiplatformV1MutateDeployedModelRequest", - "description": "Request message for EndpointService.MutateDeployedModel.", - "type": "object", - "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": "GoogleCloudAiplatformV1DeployedModel" + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error of the evaluation run if any.", + "readOnly": true }, - "updateMask": { - "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", - "type": "string", - "format": "google-fieldmask" + "evaluateDatasetResponse": { + "$ref": "GoogleCloudAiplatformV1EvaluateDatasetResponse", + "description": "Output only. Results for EvaluationService.", + "readOnly": true + }, + "evaluationRun": { + "description": "Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`.", + "readOnly": true, + "type": "string" + }, + "operationName": { + "deprecated": true, + "description": "Output only. Deprecated: The updated architecture uses evaluation_run instead.", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1EvaluateInstancesRequest": { - "id": "GoogleCloudAiplatformV1EvaluateInstancesRequest", "description": "Request message for EvaluationService.EvaluateInstances.", - "type": "object", + "id": "GoogleCloudAiplatformV1EvaluateInstancesRequest", "properties": { - "exactMatchInput": { - "description": "Auto metric instances. Instances and metric spec for exact match metric.", - "$ref": "GoogleCloudAiplatformV1ExactMatchInput" + "autoraterConfig": { + "$ref": "GoogleCloudAiplatformV1AutoraterConfig", + "description": "Optional. Autorater config used for evaluation." }, "bleuInput": { - "description": "Instances and metric spec for bleu metric.", - "$ref": "GoogleCloudAiplatformV1BleuInput" + "$ref": "GoogleCloudAiplatformV1BleuInput", + "description": "Instances and metric spec for bleu metric." }, - "rougeInput": { - "description": "Instances and metric spec for rouge metric.", - "$ref": "GoogleCloudAiplatformV1RougeInput" + "coherenceInput": { + "$ref": "GoogleCloudAiplatformV1CoherenceInput", + "description": "Input for coherence metric." }, - "fluencyInput": { - "description": "LLM-based metric instance. General text generation metrics, applicable to other categories. Input for fluency metric.", - "$ref": "GoogleCloudAiplatformV1FluencyInput" + "cometInput": { + "$ref": "GoogleCloudAiplatformV1CometInput", + "description": "Translation metrics. Input for Comet metric." }, - "coherenceInput": { - "description": "Input for coherence metric.", - "$ref": "GoogleCloudAiplatformV1CoherenceInput" + "exactMatchInput": { + "$ref": "GoogleCloudAiplatformV1ExactMatchInput", + "description": "Auto metric instances. Instances and metric spec for exact match metric." }, - "safetyInput": { - "description": "Input for safety metric.", - "$ref": "GoogleCloudAiplatformV1SafetyInput" + "fluencyInput": { + "$ref": "GoogleCloudAiplatformV1FluencyInput", + "description": "LLM-based metric instance. General text generation metrics, applicable to other categories. Input for fluency metric." + }, + "fulfillmentInput": { + "$ref": "GoogleCloudAiplatformV1FulfillmentInput", + "description": "Input for fulfillment metric." }, "groundednessInput": { - "description": "Input for groundedness metric.", - "$ref": "GoogleCloudAiplatformV1GroundednessInput" + "$ref": "GoogleCloudAiplatformV1GroundednessInput", + "description": "Input for groundedness metric." }, - "fulfillmentInput": { - "description": "Input for fulfillment metric.", - "$ref": "GoogleCloudAiplatformV1FulfillmentInput" + "instance": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstance", + "description": "The instance to be evaluated." }, - "summarizationQualityInput": { - "description": "Input for summarization quality metric.", - "$ref": "GoogleCloudAiplatformV1SummarizationQualityInput" + "location": { + "description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`", + "type": "string" }, - "pairwiseSummarizationQualityInput": { - "description": "Input for pairwise summarization quality metric.", - "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInput" + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1MetricSource" + }, + "type": "array" }, - "summarizationHelpfulnessInput": { - "description": "Input for summarization helpfulness metric.", - "$ref": "GoogleCloudAiplatformV1SummarizationHelpfulnessInput" + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1Metric" + }, + "type": "array" }, - "summarizationVerbosityInput": { - "description": "Input for summarization verbosity metric.", - "$ref": "GoogleCloudAiplatformV1SummarizationVerbosityInput" + "metricxInput": { + "$ref": "GoogleCloudAiplatformV1MetricxInput", + "description": "Input for Metricx metric." }, - "questionAnsweringQualityInput": { - "description": "Input for question answering quality metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringQualityInput" + "pairwiseMetricInput": { + "$ref": "GoogleCloudAiplatformV1PairwiseMetricInput", + "description": "Input for pairwise metric." }, "pairwiseQuestionAnsweringQualityInput": { - "description": "Input for pairwise question answering quality metric.", - "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput" + "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput", + "description": "Input for pairwise question answering quality metric." }, - "questionAnsweringRelevanceInput": { - "description": "Input for question answering relevance metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput" + "pairwiseSummarizationQualityInput": { + "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInput", + "description": "Input for pairwise summarization quality metric." }, - "questionAnsweringHelpfulnessInput": { - "description": "Input for question answering helpfulness metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput" + "pointwiseMetricInput": { + "$ref": "GoogleCloudAiplatformV1PointwiseMetricInput", + "description": "Input for pointwise metric." }, "questionAnsweringCorrectnessInput": { - "description": "Input for question answering correctness metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput" + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput", + "description": "Input for question answering correctness metric." }, - "pointwiseMetricInput": { - "description": "Input for pointwise metric.", - "$ref": "GoogleCloudAiplatformV1PointwiseMetricInput" + "questionAnsweringHelpfulnessInput": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput", + "description": "Input for question answering helpfulness metric." }, - "pairwiseMetricInput": { - "description": "Input for pairwise metric.", - "$ref": "GoogleCloudAiplatformV1PairwiseMetricInput" + "questionAnsweringQualityInput": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringQualityInput", + "description": "Input for question answering quality metric." + }, + "questionAnsweringRelevanceInput": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput", + "description": "Input for question answering relevance metric." + }, + "rougeInput": { + "$ref": "GoogleCloudAiplatformV1RougeInput", + "description": "Instances and metric spec for rouge metric." + }, + "rubricBasedInstructionFollowingInput": { + "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput", + "description": "Rubric Based Instruction Following metric." + }, + "safetyInput": { + "$ref": "GoogleCloudAiplatformV1SafetyInput", + "description": "Input for safety metric." + }, + "summarizationHelpfulnessInput": { + "$ref": "GoogleCloudAiplatformV1SummarizationHelpfulnessInput", + "description": "Input for summarization helpfulness metric." + }, + "summarizationQualityInput": { + "$ref": "GoogleCloudAiplatformV1SummarizationQualityInput", + "description": "Input for summarization quality metric." + }, + "summarizationVerbosityInput": { + "$ref": "GoogleCloudAiplatformV1SummarizationVerbosityInput", + "description": "Input for summarization verbosity metric." }, "toolCallValidInput": { - "description": "Tool call metric instances. Input for tool call valid metric.", - "$ref": "GoogleCloudAiplatformV1ToolCallValidInput" + "$ref": "GoogleCloudAiplatformV1ToolCallValidInput", + "description": "Tool call metric instances. Input for tool call valid metric." }, "toolNameMatchInput": { - "description": "Input for tool name match metric.", - "$ref": "GoogleCloudAiplatformV1ToolNameMatchInput" + "$ref": "GoogleCloudAiplatformV1ToolNameMatchInput", + "description": "Input for tool name match metric." }, "toolParameterKeyMatchInput": { - "description": "Input for tool parameter key match metric.", - "$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchInput" + "$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchInput", + "description": "Input for tool parameter key match metric." }, "toolParameterKvMatchInput": { - "description": "Input for tool parameter key value match metric.", - "$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchInput" - }, - "cometInput": { - "description": "Translation metrics. Input for Comet metric.", - "$ref": "GoogleCloudAiplatformV1CometInput" + "$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchInput", + "description": "Input for tool parameter key value match metric." }, - "metricxInput": { - "description": "Input for Metricx metric.", - "$ref": "GoogleCloudAiplatformV1MetricxInput" + "trajectoryAnyOrderMatchInput": { + "$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput", + "description": "Input for trajectory match any order metric." }, "trajectoryExactMatchInput": { - "description": "Input for trajectory exact match metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchInput" + "$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchInput", + "description": "Input for trajectory exact match metric." }, "trajectoryInOrderMatchInput": { - "description": "Input for trajectory in order match metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchInput" - }, - "trajectoryAnyOrderMatchInput": { - "description": "Input for trajectory match any order metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput" + "$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchInput", + "description": "Input for trajectory in order match metric." }, "trajectoryPrecisionInput": { - "description": "Input for trajectory precision metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionInput" + "$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionInput", + "description": "Input for trajectory precision metric." }, "trajectoryRecallInput": { - "description": "Input for trajectory recall metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryRecallInput" + "$ref": "GoogleCloudAiplatformV1TrajectoryRecallInput", + "description": "Input for trajectory recall metric." }, "trajectorySingleToolUseInput": { - "description": "Input for trajectory single tool use metric.", - "$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseInput" + "$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseInput", + "description": "Input for trajectory single tool use metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluateInstancesResponse": { + "description": "Response message for EvaluationService.EvaluateInstances.", + "id": "GoogleCloudAiplatformV1EvaluateInstancesResponse", + "properties": { + "bleuResults": { + "$ref": "GoogleCloudAiplatformV1BleuResults", + "description": "Results for bleu metric." }, - "rubricBasedInstructionFollowingInput": { - "description": "Rubric Based Instruction Following metric.", - "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput" + "coherenceResult": { + "$ref": "GoogleCloudAiplatformV1CoherenceResult", + "description": "Result for coherence 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": "GoogleCloudAiplatformV1Metric" - } + "cometResult": { + "$ref": "GoogleCloudAiplatformV1CometResult", + "description": "Translation metrics. Result for Comet metric." }, - "instance": { - "description": "The instance to be evaluated.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstance" + "exactMatchResults": { + "$ref": "GoogleCloudAiplatformV1ExactMatchResults", + "description": "Auto metric evaluation results. Results for exact match metric." }, - "autoraterConfig": { - "description": "Optional. Autorater config used for evaluation.", - "$ref": "GoogleCloudAiplatformV1AutoraterConfig" - } - } - }, - "GoogleCloudAiplatformV1ExactMatchInput": { - "id": "GoogleCloudAiplatformV1ExactMatchInput", - "description": "Input for exact match metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for exact match metric.", - "$ref": "GoogleCloudAiplatformV1ExactMatchSpec" + "fluencyResult": { + "$ref": "GoogleCloudAiplatformV1FluencyResult", + "description": "LLM-based metric evaluation result. General text generation metrics, applicable to other categories. Result for fluency metric." }, - "instances": { - "description": "Required. Repeated exact match instances.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ExactMatchInstance" - } - } - } - }, - "GoogleCloudAiplatformV1ExactMatchSpec": { - "id": "GoogleCloudAiplatformV1ExactMatchSpec", - "description": "Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1ExactMatchInstance": { - "id": "GoogleCloudAiplatformV1ExactMatchInstance", - "description": "Spec for exact match instance.", - "type": "object", - "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" + "fulfillmentResult": { + "$ref": "GoogleCloudAiplatformV1FulfillmentResult", + "description": "Result for fulfillment metric." }, - "reference": { - "description": "Required. Ground truth used to compare against the prediction.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1BleuInput": { - "id": "GoogleCloudAiplatformV1BleuInput", - "description": "Input for bleu metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for bleu score metric.", - "$ref": "GoogleCloudAiplatformV1BleuSpec" + "groundednessResult": { + "$ref": "GoogleCloudAiplatformV1GroundednessResult", + "description": "Result for groundedness metric." }, - "instances": { - "description": "Required. Repeated bleu instances.", - "type": "array", + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1BleuInstance" - } - } - } - }, - "GoogleCloudAiplatformV1BleuSpec": { - "id": "GoogleCloudAiplatformV1BleuSpec", - "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" - } - } - }, - "GoogleCloudAiplatformV1BleuInstance": { - "id": "GoogleCloudAiplatformV1BleuInstance", - "description": "Spec for bleu instance.", - "type": "object", - "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" + "$ref": "GoogleCloudAiplatformV1MetricResult" + }, + "type": "array" }, - "reference": { - "description": "Required. Ground truth used to compare against the prediction.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1RougeInput": { - "id": "GoogleCloudAiplatformV1RougeInput", - "description": "Input for rouge metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for rouge score metric.", - "$ref": "GoogleCloudAiplatformV1RougeSpec" + "metricxResult": { + "$ref": "GoogleCloudAiplatformV1MetricxResult", + "description": "Result for Metricx metric." }, - "instances": { - "description": "Required. Repeated rouge instances.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1RougeInstance" - } - } - } - }, - "GoogleCloudAiplatformV1RougeSpec": { - "id": "GoogleCloudAiplatformV1RougeSpec", - "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.", - "type": "object", - "properties": { - "rougeType": { - "description": "Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.", - "type": "string" + "pairwiseMetricResult": { + "$ref": "GoogleCloudAiplatformV1PairwiseMetricResult", + "description": "Result for pairwise metric." }, - "useStemmer": { - "description": "Optional. Whether to use stemmer to compute rouge score.", - "type": "boolean" + "pairwiseQuestionAnsweringQualityResult": { + "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult", + "description": "Result for pairwise question answering quality metric." }, - "splitSummaries": { - "description": "Optional. Whether to split summaries while using rougeLsum.", - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1RougeInstance": { - "id": "GoogleCloudAiplatformV1RougeInstance", - "description": "Spec for rouge instance.", - "type": "object", - "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" + "pairwiseSummarizationQualityResult": { + "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityResult", + "description": "Result for pairwise summarization quality metric." }, - "reference": { - "description": "Required. Ground truth used to compare against the prediction.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1FluencyInput": { - "id": "GoogleCloudAiplatformV1FluencyInput", - "description": "Input for fluency metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for fluency score metric.", - "$ref": "GoogleCloudAiplatformV1FluencySpec" + "pointwiseMetricResult": { + "$ref": "GoogleCloudAiplatformV1PointwiseMetricResult", + "description": "Generic metrics. Result for pointwise metric." }, - "instance": { - "description": "Required. Fluency instance.", - "$ref": "GoogleCloudAiplatformV1FluencyInstance" - } - } - }, - "GoogleCloudAiplatformV1FluencySpec": { - "id": "GoogleCloudAiplatformV1FluencySpec", - "description": "Spec for fluency score metric.", - "type": "object", - "properties": { - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1FluencyInstance": { - "id": "GoogleCloudAiplatformV1FluencyInstance", - "description": "Spec for fluency instance.", - "type": "object", - "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1CoherenceInput": { - "id": "GoogleCloudAiplatformV1CoherenceInput", - "description": "Input for coherence metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for coherence score metric.", - "$ref": "GoogleCloudAiplatformV1CoherenceSpec" + "questionAnsweringCorrectnessResult": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult", + "description": "Result for question answering correctness metric." }, - "instance": { - "description": "Required. Coherence instance.", - "$ref": "GoogleCloudAiplatformV1CoherenceInstance" - } - } - }, - "GoogleCloudAiplatformV1CoherenceSpec": { - "id": "GoogleCloudAiplatformV1CoherenceSpec", - "description": "Spec for coherence score metric.", - "type": "object", - "properties": { - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1CoherenceInstance": { - "id": "GoogleCloudAiplatformV1CoherenceInstance", - "description": "Spec for coherence instance.", - "type": "object", - "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1SafetyInput": { - "id": "GoogleCloudAiplatformV1SafetyInput", - "description": "Input for safety metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for safety metric.", - "$ref": "GoogleCloudAiplatformV1SafetySpec" + "questionAnsweringHelpfulnessResult": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult", + "description": "Result for question answering helpfulness metric." }, - "instance": { - "description": "Required. Safety instance.", - "$ref": "GoogleCloudAiplatformV1SafetyInstance" - } - } - }, - "GoogleCloudAiplatformV1SafetySpec": { - "id": "GoogleCloudAiplatformV1SafetySpec", - "description": "Spec for safety metric.", - "type": "object", - "properties": { - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1SafetyInstance": { - "id": "GoogleCloudAiplatformV1SafetyInstance", - "description": "Spec for safety instance.", - "type": "object", - "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1GroundednessInput": { - "id": "GoogleCloudAiplatformV1GroundednessInput", - "description": "Input for groundedness metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for groundedness metric.", - "$ref": "GoogleCloudAiplatformV1GroundednessSpec" + "questionAnsweringQualityResult": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringQualityResult", + "description": "Question answering only metrics. Result for question answering quality metric." + }, + "questionAnsweringRelevanceResult": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult", + "description": "Result for question answering relevance metric." + }, + "rougeResults": { + "$ref": "GoogleCloudAiplatformV1RougeResults", + "description": "Results for rouge metric." + }, + "rubricBasedInstructionFollowingResult": { + "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult", + "description": "Result for rubric based instruction following metric." + }, + "safetyResult": { + "$ref": "GoogleCloudAiplatformV1SafetyResult", + "description": "Result for safety metric." + }, + "summarizationHelpfulnessResult": { + "$ref": "GoogleCloudAiplatformV1SummarizationHelpfulnessResult", + "description": "Result for summarization helpfulness metric." + }, + "summarizationQualityResult": { + "$ref": "GoogleCloudAiplatformV1SummarizationQualityResult", + "description": "Summarization only metrics. Result for summarization quality metric." + }, + "summarizationVerbosityResult": { + "$ref": "GoogleCloudAiplatformV1SummarizationVerbosityResult", + "description": "Result for summarization verbosity metric." + }, + "toolCallValidResults": { + "$ref": "GoogleCloudAiplatformV1ToolCallValidResults", + "description": "Tool call metrics. Results for tool call valid metric." + }, + "toolNameMatchResults": { + "$ref": "GoogleCloudAiplatformV1ToolNameMatchResults", + "description": "Results for tool name match metric." }, - "instance": { - "description": "Required. Groundedness instance.", - "$ref": "GoogleCloudAiplatformV1GroundednessInstance" - } - } - }, - "GoogleCloudAiplatformV1GroundednessSpec": { - "id": "GoogleCloudAiplatformV1GroundednessSpec", - "description": "Spec for groundedness metric.", - "type": "object", - "properties": { - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1GroundednessInstance": { - "id": "GoogleCloudAiplatformV1GroundednessInstance", - "description": "Spec for groundedness instance.", - "type": "object", - "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" + "toolParameterKeyMatchResults": { + "$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchResults", + "description": "Results for tool parameter key match metric." }, - "context": { - "description": "Required. Background information provided in context used to compare against the prediction.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1FulfillmentInput": { - "id": "GoogleCloudAiplatformV1FulfillmentInput", - "description": "Input for fulfillment metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for fulfillment score metric.", - "$ref": "GoogleCloudAiplatformV1FulfillmentSpec" + "toolParameterKvMatchResults": { + "$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchResults", + "description": "Results for tool parameter key value match metric." }, - "instance": { - "description": "Required. Fulfillment instance.", - "$ref": "GoogleCloudAiplatformV1FulfillmentInstance" - } - } - }, - "GoogleCloudAiplatformV1FulfillmentSpec": { - "id": "GoogleCloudAiplatformV1FulfillmentSpec", - "description": "Spec for fulfillment metric.", - "type": "object", - "properties": { - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" + "trajectoryAnyOrderMatchResults": { + "$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchResults", + "description": "Result for trajectory any order match metric." + }, + "trajectoryExactMatchResults": { + "$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchResults", + "description": "Result for trajectory exact match metric." + }, + "trajectoryInOrderMatchResults": { + "$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchResults", + "description": "Result for trajectory in order match metric." + }, + "trajectoryPrecisionResults": { + "$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionResults", + "description": "Result for trajectory precision metric." + }, + "trajectoryRecallResults": { + "$ref": "GoogleCloudAiplatformV1TrajectoryRecallResults", + "description": "Results for trajectory recall metric." + }, + "trajectorySingleToolUseResults": { + "$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseResults", + "description": "Results for trajectory single tool use metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FulfillmentInstance": { - "id": "GoogleCloudAiplatformV1FulfillmentInstance", - "description": "Spec for fulfillment instance.", - "type": "object", + "GoogleCloudAiplatformV1EvaluatedAnnotation": { + "description": "True positive, false positive, or false negative. EvaluatedAnnotation is only available under ModelEvaluationSlice with slice of `annotationSpec` dimension.", + "id": "GoogleCloudAiplatformV1EvaluatedAnnotation", "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", + "dataItemPayload": { + "description": "Output only. The data item payload that the Model predicted this EvaluatedAnnotation on.", + "readOnly": true, + "type": "any" + }, + "errorAnalysisAnnotations": { + "description": "Annotations of model error analysis results.", + "items": { + "$ref": "GoogleCloudAiplatformV1ErrorAnalysisAnnotation" + }, + "type": "array" + }, + "evaluatedDataItemViewId": { + "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.", + "readOnly": true, "type": "string" }, - "instruction": { - "description": "Required. Inference instruction prompt to compare prediction with.", + "explanations": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluatedAnnotationExplanation" + }, + "type": "array" + }, + "groundTruths": { + "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" + }, + "readOnly": true, + "type": "array" + }, + "predictions": { + "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" + }, + "readOnly": true, + "type": "array" + }, + "type": { + "description": "Output only. Type of the EvaluatedAnnotation.", + "enum": [ + "EVALUATED_ANNOTATION_TYPE_UNSPECIFIED", + "TRUE_POSITIVE", + "FALSE_POSITIVE", + "FALSE_NEGATIVE" + ], + "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." + ], + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SummarizationQualityInput": { - "id": "GoogleCloudAiplatformV1SummarizationQualityInput", - "description": "Input for summarization quality metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluatedAnnotationExplanation": { + "description": "Explanation result of the prediction produced by the Model.", + "id": "GoogleCloudAiplatformV1EvaluatedAnnotationExplanation", "properties": { - "metricSpec": { - "description": "Required. Spec for summarization quality score metric.", - "$ref": "GoogleCloudAiplatformV1SummarizationQualitySpec" + "explanation": { + "$ref": "GoogleCloudAiplatformV1Explanation", + "description": "Explanation attribution response details." }, - "instance": { - "description": "Required. Summarization quality instance.", - "$ref": "GoogleCloudAiplatformV1SummarizationQualityInstance" + "explanationType": { + "description": "Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai`", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SummarizationQualitySpec": { - "id": "GoogleCloudAiplatformV1SummarizationQualitySpec", - "description": "Spec for summarization quality score metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationConfig": { + "description": "Evaluation Config for Tuning Job.", + "id": "GoogleCloudAiplatformV1EvaluationConfig", "properties": { - "useReference": { - "description": "Optional. Whether to use instance.reference to compute summarization quality.", - "type": "boolean" + "autoraterConfig": { + "$ref": "GoogleCloudAiplatformV1AutoraterConfig", + "description": "Optional. Autorater config for evaluation." }, - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1SummarizationQualityInstance": { - "id": "GoogleCloudAiplatformV1SummarizationQualityInstance", - "description": "Spec for summarization quality instance.", - "type": "object", - "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" + "datasetCustomMetrics": { + "description": "Optional. Specifications for custom dataset-level aggregations.", + "items": { + "$ref": "GoogleCloudAiplatformV1DatasetCustomMetric" + }, + "type": "array" }, - "reference": { - "description": "Optional. Ground truth used to compare against the prediction.", - "type": "string" + "inferenceGenerationConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used." }, - "context": { - "description": "Required. Text to be summarized.", - "type": "string" + "metrics": { + "description": "Required. The metrics used for evaluation.", + "items": { + "$ref": "GoogleCloudAiplatformV1Metric" + }, + "type": "array" }, - "instruction": { - "description": "Required. Summarization prompt for LLM.", - "type": "string" + "outputConfig": { + "$ref": "GoogleCloudAiplatformV1OutputConfig", + "description": "Required. Config for evaluation output." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseSummarizationQualityInput": { - "id": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInput", - "description": "Input for pairwise summarization quality metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationDataset": { + "description": "The dataset used for evaluation.", + "id": "GoogleCloudAiplatformV1EvaluationDataset", "properties": { - "metricSpec": { - "description": "Required. Spec for pairwise summarization quality score metric.", - "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec" + "bigquerySource": { + "$ref": "GoogleCloudAiplatformV1BigQuerySource", + "description": "BigQuery source holds the dataset." }, - "instance": { - "description": "Required. Pairwise summarization quality instance.", - "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance" + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1GcsSource", + "description": "Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec": { - "id": "GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec", - "description": "Spec for pairwise summarization quality score metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationInstance": { + "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", + "id": "GoogleCloudAiplatformV1EvaluationInstance", "properties": { - "useReference": { - "description": "Optional. Whether to use instance.reference to compute pairwise summarization quality.", - "type": "boolean" + "agentData": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentData", + "deprecated": true, + "description": "Optional. Deprecated: Use `agent_eval_data` instead. Data used for agent evaluation." }, - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" + "otherData": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceMapInstance", + "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." + }, + "prompt": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "description": "Optional. Data used to populate placeholder `prompt` in a metric prompt template." + }, + "reference": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "description": "Optional. Data used to populate placeholder `reference` in a metric prompt template." + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "description": "Optional. Data used to populate placeholder `response` in a metric prompt template." + }, + "rubricGroups": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1RubricGroup" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance": { - "id": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance", - "description": "Spec for pairwise summarization quality instance.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfig": { + "deprecated": true, + "description": "Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfig", "properties": { - "prediction": { - "description": "Required. Output of the candidate model.", + "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" }, - "baselinePrediction": { - "description": "Required. Output of the baseline model.", + "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" }, - "reference": { - "description": "Optional. Ground truth used to compare against the prediction.", + "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" }, - "context": { - "description": "Required. Text to be summarized.", - "type": "string" + "developerInstruction": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "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." }, - "instruction": { - "description": "Required. Summarization prompt for LLM.", + "subAgents": { + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tools": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfigTools", + "description": "List of tools." + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SummarizationHelpfulnessInput": { - "id": "GoogleCloudAiplatformV1SummarizationHelpfulnessInput", - "description": "Input for summarization helpfulness metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfigTools": { + "description": "Represents a list of tools for an agent.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfigTools", "properties": { - "metricSpec": { - "description": "Required. Spec for summarization helpfulness score metric.", - "$ref": "GoogleCloudAiplatformV1SummarizationHelpfulnessSpec" - }, - "instance": { - "description": "Required. Summarization helpfulness instance.", - "$ref": "GoogleCloudAiplatformV1SummarizationHelpfulnessInstance" + "tool": { + "description": "Optional. List of tools: each tool can have multiple function declarations.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SummarizationHelpfulnessSpec": { - "id": "GoogleCloudAiplatformV1SummarizationHelpfulnessSpec", - "description": "Spec for summarization helpfulness score metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentData": { + "deprecated": true, + "description": "Deprecated: Use `agent_eval_data` instead. Contains data specific to agent evaluations.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentData", "properties": { - "useReference": { - "description": "Optional. Whether to use instance.reference to compute summarization helpfulness.", - "type": "boolean" + "agentConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfig", + "description": "Optional. Deprecated: Use `agent_eval_data` instead. Agent configuration." }, - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1SummarizationHelpfulnessInstance": { - "id": "GoogleCloudAiplatformV1SummarizationHelpfulnessInstance", - "description": "Spec for summarization helpfulness instance.", - "type": "object", - "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" + "agents": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfig" + }, + "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" }, - "reference": { - "description": "Optional. Ground truth used to compare against the prediction.", - "type": "string" + "developerInstruction": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "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." }, - "context": { - "description": "Required. Text to be summarized.", - "type": "string" + "events": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataEvents", + "description": "A list of events." }, - "instruction": { - "description": "Optional. Summarization prompt for LLM.", + "tools": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataTools", + "deprecated": true, + "description": "List of tools." + }, + "toolsText": { + "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.", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1SummarizationVerbosityInput": { - "id": "GoogleCloudAiplatformV1SummarizationVerbosityInput", - "description": "Input for summarization verbosity metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for summarization verbosity score metric.", - "$ref": "GoogleCloudAiplatformV1SummarizationVerbositySpec" }, - "instance": { - "description": "Required. Summarization verbosity instance.", - "$ref": "GoogleCloudAiplatformV1SummarizationVerbosityInstance" + "turns": { + "description": "Optional. The chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response).", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataConversationTurn" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SummarizationVerbositySpec": { - "id": "GoogleCloudAiplatformV1SummarizationVerbositySpec", - "description": "Spec for summarization verbosity score metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataAgentEvent": { + "description": "A single event in the execution trace.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataAgentEvent", "properties": { - "useReference": { - "description": "Optional. Whether to use instance.reference to compute summarization verbosity.", - "type": "boolean" + "activeTools": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" }, - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1SummarizationVerbosityInstance": { - "id": "GoogleCloudAiplatformV1SummarizationVerbosityInstance", - "description": "Spec for summarization verbosity instance.", - "type": "object", - "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", + "author": { + "description": "Required. The ID of the agent or entity that generated this event.", "type": "string" }, - "reference": { - "description": "Optional. Ground truth used to compare against the prediction.", - "type": "string" + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Required. The content of the event (e.g., text response, tool call, tool response)." }, - "context": { - "description": "Required. Text to be summarized.", + "eventTime": { + "description": "Optional. The timestamp when the event occurred.", + "format": "google-datetime", "type": "string" }, - "instruction": { - "description": "Optional. Summarization prompt for LLM.", - "type": "string" + "stateDelta": { + "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.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringQualityInput": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringQualityInput", - "description": "Input for question answering quality metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataConversationTurn": { + "description": "Represents a single turn/invocation in the conversation.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataConversationTurn", "properties": { - "metricSpec": { - "description": "Required. Spec for question answering quality score metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringQualitySpec" + "events": { + "description": "Optional. The list of events that occurred during this turn.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataAgentEvent" + }, + "type": "array" }, - "instance": { - "description": "Required. Question answering quality instance.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringQualityInstance" + "turnId": { + "description": "Optional. A unique identifier for the turn. Useful for referencing specific turns across systems.", + "type": "string" + }, + "turnIndex": { + "description": "Required. The 0-based index of the turn in the conversation sequence.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringQualitySpec": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringQualitySpec", - "description": "Spec for question answering quality score metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataEvents": { + "description": "Represents a list of events for an agent.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataEvents", "properties": { - "useReference": { - "description": "Optional. Whether to use instance.reference to compute question answering quality.", - "type": "boolean" - }, - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" + "event": { + "description": "Optional. A list of events.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringQualityInstance": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringQualityInstance", - "description": "Spec for question answering quality instance.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataTools": { + "description": "Deprecated: Use `agent_eval_data` instead. Represents a list of tools for an agent.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentDataTools", "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" - }, - "reference": { - "description": "Optional. Ground truth used to compare against the prediction.", - "type": "string" - }, - "context": { - "description": "Required. Text to answer the question.", - "type": "string" + "tool": { + "deprecated": true, + "description": "Optional. List of tools: each tool can have multiple function declarations.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationInstanceInstanceData": { + "description": "Instance data used to populate placeholders in a metric prompt template.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "properties": { + "contents": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents", + "description": "List of Gemini content data." }, - "instruction": { - "description": "Required. Question Answering prompt for LLM.", + "text": { + "description": "Text data.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput": { - "id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput", - "description": "Input for pairwise question answering quality metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents": { + "description": "List of standard Content messages from Gemini API.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents", "properties": { - "metricSpec": { - "description": "Required. Spec for pairwise question answering quality score metric.", - "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec" - }, - "instance": { - "description": "Required. Pairwise question answering quality instance.", - "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance" + "contents": { + "description": "Optional. Repeated contents.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec": { - "id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec", - "description": "Spec for pairwise question answering quality score metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationInstanceMapInstance": { + "description": "Instance data specified as a map.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceMapInstance", "properties": { - "useReference": { - "description": "Optional. Whether to use instance.reference to compute question answering quality.", - "type": "boolean" - }, - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" + "mapInstance": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData" + }, + "description": "Optional. Map of instance data.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance": { - "id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance", - "description": "Spec for pairwise question answering quality instance.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationItem": { + "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.", + "id": "GoogleCloudAiplatformV1EvaluationItem", "properties": { - "prediction": { - "description": "Required. Output of the candidate model.", + "createTime": { + "description": "Output only. Timestamp when this item was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "baselinePrediction": { - "description": "Required. Output of the baseline model.", + "displayName": { + "description": "Required. The display name of the EvaluationItem.", "type": "string" }, - "reference": { - "description": "Optional. Ground truth used to compare against the prediction.", - "type": "string" + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Error for the evaluation item.", + "readOnly": true }, - "context": { - "description": "Required. Text to answer the question.", + "evaluationItemType": { + "description": "Required. The type of the EvaluationItem.", + "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" }, - "instruction": { - "description": "Required. Question Answering prompt for LLM.", + "evaluationRequest": { + "$ref": "GoogleCloudAiplatformV1EvaluationRequest", + "description": "The request to evaluate." + }, + "evaluationResponse": { + "$ref": "GoogleCloudAiplatformV1EvaluationResult", + "description": "Output only. The response from evaluation.", + "readOnly": true + }, + "gcsUri": { + "description": "The Cloud Storage object where the request or response is stored.", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput", - "description": "Input for question answering relevance metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for question answering relevance score metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec" }, - "instance": { - "description": "Required. Question answering relevance instance.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance" - } - } - }, - "GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec", - "description": "Spec for question answering relevance metric.", - "type": "object", - "properties": { - "useReference": { - "description": "Optional. Whether to use instance.reference to compute question answering relevance.", - "type": "boolean" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the EvaluationItem.", + "type": "object" }, - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" + "metadata": { + "description": "Optional. Metadata for the EvaluationItem.", + "type": "any" + }, + "name": { + "description": "Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationParserConfig": { + "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.", + "id": "GoogleCloudAiplatformV1EvaluationParserConfig", + "properties": { + "customCodeParserConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationParserConfigCustomCodeParserConfig", + "description": "Optional. Use custom code to parse the LLM response." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance", - "description": "Spec for question answering relevance instance.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationParserConfigCustomCodeParserConfig": { + "description": "Configuration for parsing the LLM response using custom code.", + "id": "GoogleCloudAiplatformV1EvaluationParserConfigCustomCodeParserConfig", "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" - }, - "reference": { - "description": "Optional. Ground truth used to compare against the prediction.", + "parsingFunction": { + "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]) -> 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", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationPrompt": { + "description": "Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations.", + "id": "GoogleCloudAiplatformV1EvaluationPrompt", + "properties": { + "promptTemplateData": { + "$ref": "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData", + "description": "Prompt template data." }, - "context": { - "description": "Optional. Text provided as context to answer the question.", + "text": { + "description": "Text prompt.", "type": "string" }, - "instruction": { - "description": "Required. The question asked and other instruction in the inference prompt.", - "type": "string" + "value": { + "description": "Fields and values that can be used to populate the prompt template.", + "type": "any" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput", - "description": "Input for question answering helpfulness metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData": { + "description": "Message to hold a prompt template and the values to populate the template.", + "id": "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData", "properties": { - "metricSpec": { - "description": "Required. Spec for question answering helpfulness score metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec" - }, - "instance": { - "description": "Required. Question answering helpfulness instance.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance" + "values": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "description": "The values for fields in the prompt template.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec", - "description": "Spec for question answering helpfulness metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRequest": { + "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": "GoogleCloudAiplatformV1EvaluationRequest", "properties": { - "useReference": { - "description": "Optional. Whether to use instance.reference to compute question answering helpfulness.", - "type": "boolean" + "candidateResponses": { + "description": "Optional. Responses from model under test and other baseline models for comparison.", + "items": { + "$ref": "GoogleCloudAiplatformV1CandidateResponse" + }, + "type": "array" }, - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" + "goldenResponse": { + "$ref": "GoogleCloudAiplatformV1CandidateResponse", + "description": "Optional. The Ideal response or ground truth." + }, + "prompt": { + "$ref": "GoogleCloudAiplatformV1EvaluationPrompt", + "description": "Optional. The request/prompt to evaluate." + }, + "rubrics": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1RubricGroup" + }, + "description": "Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance", - "description": "Spec for question answering helpfulness instance.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationResult": { + "description": "Evaluation result.", + "id": "GoogleCloudAiplatformV1EvaluationResult", "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" + "candidateResults": { + "description": "Optional. The results for the metric.", + "items": { + "$ref": "GoogleCloudAiplatformV1CandidateResult" + }, + "type": "array" }, - "reference": { - "description": "Optional. Ground truth used to compare against the prediction.", + "evaluationRequest": { + "description": "Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}", "type": "string" }, - "context": { - "description": "Optional. Text provided as context to answer the question.", + "evaluationRun": { + "description": "Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}", "type": "string" }, - "instruction": { - "description": "Required. The question asked and other instruction in the inference prompt.", + "metadata": { + "description": "Optional. Metadata about the evaluation result.", + "type": "any" + }, + "metric": { + "description": "Required. The metric that was evaluated.", "type": "string" + }, + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationRequest", + "description": "Required. The request that was evaluated." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput", - "description": "Input for question answering correctness metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationResults": { + "description": "The results of the evaluation run.", + "id": "GoogleCloudAiplatformV1EvaluationResults", "properties": { - "metricSpec": { - "description": "Required. Spec for question answering correctness score metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec" + "evaluationSet": { + "description": "The evaluation set where item level results are stored.", + "type": "string" }, - "instance": { - "description": "Required. Question answering correctness instance.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance" + "summaryMetrics": { + "$ref": "GoogleCloudAiplatformV1SummaryMetrics", + "description": "Optional. The summary metrics for the evaluation run." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec", - "description": "Spec for question answering correctness metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRubricConfig": { + "description": "Configuration for a rubric group to be generated/saved for evaluation.", + "id": "GoogleCloudAiplatformV1EvaluationRubricConfig", "properties": { - "useReference": { - "description": "Optional. Whether to use instance.reference to compute question answering correctness.", - "type": "boolean" + "predefinedRubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", + "description": "Dynamically generate rubrics using a predefined spec." }, - "version": { - "description": "Optional. Which version to use for evaluation.", - "type": "integer", - "format": "int32" + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", + "description": "Dynamically generate rubrics using this specification." + }, + "rubricGroupKey": { + "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.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance", - "description": "Spec for question answering correctness instance.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRun": { + "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.", + "id": "GoogleCloudAiplatformV1EvaluationRun", "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", + "completionTime": { + "description": "Output only. Time when the evaluation run was completed.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "reference": { - "description": "Optional. Ground truth used to compare against the prediction.", + "createTime": { + "description": "Output only. Time when the evaluation run was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "context": { - "description": "Optional. Text provided as context to answer the question.", - "type": "string" + "dataSource": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunDataSource", + "description": "Required. The data source for the evaluation run." }, - "instruction": { - "description": "Required. The question asked and other instruction in the inference prompt.", + "displayName": { + "description": "Required. The display name of the Evaluation Run.", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1PointwiseMetricInput": { - "id": "GoogleCloudAiplatformV1PointwiseMetricInput", - "description": "Input for pointwise metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for pointwise metric.", - "$ref": "GoogleCloudAiplatformV1PointwiseMetricSpec" }, - "instance": { - "description": "Required. Pointwise metric instance.", - "$ref": "GoogleCloudAiplatformV1PointwiseMetricInstance" - } - } - }, - "GoogleCloudAiplatformV1PointwiseMetricSpec": { - "id": "GoogleCloudAiplatformV1PointwiseMetricSpec", - "description": "Spec for pointwise metric.", - "type": "object", - "properties": { - "metricPromptTemplate": { - "description": "Required. Metric prompt template for pointwise metric.", + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when the evaluation run's state is FAILED or CANCELLED.", + "readOnly": true + }, + "evaluationConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfig", + "description": "Optional. The configuration used for the evaluation. Optional when analysis_configs is provided." + }, + "evaluationResults": { + "$ref": "GoogleCloudAiplatformV1EvaluationResults", + "description": "Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED.", + "readOnly": true + }, + "evaluationSetSnapshot": { + "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.", + "readOnly": true, "type": "string" }, - "systemInstruction": { - "description": "Optional. System instructions for pointwise metric.", + "inferenceConfigs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunInferenceConfig" + }, + "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.", + "type": "object" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the evaluation run.", + "type": "object" + }, + "metadata": { + "description": "Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run.", + "type": "any" + }, + "name": { + "description": "Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", "type": "string" }, - "customOutputFormatConfig": { - "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.", - "$ref": "GoogleCloudAiplatformV1CustomOutputFormatConfig" - } - } - }, - "GoogleCloudAiplatformV1CustomOutputFormatConfig": { - "id": "GoogleCloudAiplatformV1CustomOutputFormatConfig", - "description": "Spec for custom output format configuration.", - "type": "object", - "properties": { - "returnRawOutput": { - "description": "Optional. Whether to return raw output.", - "type": "boolean" + "state": { + "description": "Output only. The state of the evaluation run.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED", + "INFERENCE", + "GENERATING_RUBRICS", + "GENERATING_LOSS_CLUSTERS" + ], + "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." + ], + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PointwiseMetricInstance": { - "id": "GoogleCloudAiplatformV1PointwiseMetricInstance", - "description": "Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunDataSource": { + "description": "The data source for the evaluation run.", + "id": "GoogleCloudAiplatformV1EvaluationRunDataSource", "properties": { - "jsonInstance": { - "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template.", - "type": "string" + "bigqueryRequestSet": { + "$ref": "GoogleCloudAiplatformV1BigQueryRequestSet", + "description": "Evaluation data in bigquery." }, - "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": "GoogleCloudAiplatformV1ContentMap" + "evaluationSet": { + "description": "The EvaluationSet resource name. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ContentMap": { - "id": "GoogleCloudAiplatformV1ContentMap", - "description": "Map of placeholder in metric prompt template to contents of model input.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunEvaluationConfig": { + "description": "The Evalution configuration used for the evaluation run.", + "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfig", "properties": { - "values": { - "description": "Optional. Map of placeholder to contents.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1ContentMapContents" - } + "autoraterConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", + "description": "Optional. The autorater config for the evaluation run." + }, + "datasetCustomMetrics": { + "description": "Optional. Specifications for custom dataset-level aggregations.", + "items": { + "$ref": "GoogleCloudAiplatformV1DatasetCustomMetric" + }, + "type": "array" + }, + "metrics": { + "description": "Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetric" + }, + "type": "array" + }, + "outputConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig", + "description": "Optional. The output config for the evaluation run." + }, + "promptTemplate": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate", + "description": "The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values." + }, + "rubricConfigs": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationRubricConfig" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ContentMapContents": { - "id": "GoogleCloudAiplatformV1ContentMapContents", - "description": "Repeated Content type.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig": { + "description": "The autorater config used for the evaluation run.", + "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", "properties": { - "contents": { - "description": "Optional. Repeated contents.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Content" - } + "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": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "Optional. Configuration options for model generation and outputs." + }, + "sampleCount": { + "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", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseMetricInput": { - "id": "GoogleCloudAiplatformV1PairwiseMetricInput", - "description": "Input for pairwise metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig": { + "description": "The output config for the evaluation run.", + "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig", "properties": { - "metricSpec": { - "description": "Required. Spec for pairwise metric.", - "$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec" + "bigqueryDestination": { + "$ref": "GoogleCloudAiplatformV1BigQueryDestination", + "description": "BigQuery destination for evaluation output." }, - "instance": { - "description": "Required. Pairwise metric instance.", - "$ref": "GoogleCloudAiplatformV1PairwiseMetricInstance" + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "Cloud Storage destination for evaluation output." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseMetricSpec": { - "id": "GoogleCloudAiplatformV1PairwiseMetricSpec", - "description": "Spec for pairwise metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate": { + "description": "Prompt template used for inference.", + "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate", "properties": { - "metricPromptTemplate": { - "description": "Required. Metric prompt template for pairwise metric.", + "gcsUri": { + "description": "Prompt template stored in Cloud Storage. Format: \"gs://my-bucket/file-name.txt\".", "type": "string" }, - "candidateResponseFieldName": { - "description": "Optional. The field name of the candidate response.", + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationRunInferenceConfig": { + "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.", + "id": "GoogleCloudAiplatformV1EvaluationRunInferenceConfig", + "properties": { + "agentRunConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunInferenceConfigAgentRunConfig", + "description": "Optional. Agent run config." }, - "baselineResponseFieldName": { - "description": "Optional. The field name of the baseline response.", - "type": "string" + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "Optional. Generation config." }, - "systemInstruction": { - "description": "Optional. System instructions for pairwise metric.", + "model": { + "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}`", "type": "string" }, - "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": "GoogleCloudAiplatformV1CustomOutputFormatConfig" + "parallelism": { + "description": "Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseMetricInstance": { - "id": "GoogleCloudAiplatformV1PairwiseMetricInstance", - "description": "Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunInferenceConfigAgentRunConfig": { + "description": "Configuration for Agent Run.", + "id": "GoogleCloudAiplatformV1EvaluationRunInferenceConfigAgentRunConfig", "properties": { - "jsonInstance": { - "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template.", + "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" }, - "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": "GoogleCloudAiplatformV1ContentMap" - } - } - }, - "GoogleCloudAiplatformV1ToolCallValidInput": { - "id": "GoogleCloudAiplatformV1ToolCallValidInput", - "description": "Input for tool call valid metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for tool call valid metric.", - "$ref": "GoogleCloudAiplatformV1ToolCallValidSpec" + "sessionInput": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunInferenceConfigSessionInput", + "description": "Optional. The session input to get agent running results." }, - "instances": { - "description": "Required. Repeated tool call valid instances.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ToolCallValidInstance" - } + "userSimulatorConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunInferenceConfigAgentRunConfigUserSimulatorConfig", + "description": "The configuration for a user simulator that uses an LLM to generate messages on behalf of the user." } - } - }, - "GoogleCloudAiplatformV1ToolCallValidSpec": { - "id": "GoogleCloudAiplatformV1ToolCallValidSpec", - "description": "Spec for tool call valid metric.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolCallValidInstance": { - "id": "GoogleCloudAiplatformV1ToolCallValidInstance", - "description": "Spec for tool call valid instance.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunInferenceConfigAgentRunConfigUserSimulatorConfig": { + "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.", + "id": "GoogleCloudAiplatformV1EvaluationRunInferenceConfigAgentRunConfigUserSimulatorConfig", "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", - "type": "string" + "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" }, - "reference": { - "description": "Required. Ground truth used to compare against the prediction.", + "modelConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "The configuration for the model." + }, + "modelName": { + "description": "The model name to use for multi-turn agent scraping to get next user message, e.g. \"gemini-3-flash-preview\".", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolNameMatchInput": { - "id": "GoogleCloudAiplatformV1ToolNameMatchInput", - "description": "Input for tool name match metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunInferenceConfigSessionInput": { + "description": "Session input to run an Agent.", + "id": "GoogleCloudAiplatformV1EvaluationRunInferenceConfigSessionInput", "properties": { - "metricSpec": { - "description": "Required. Spec for tool name match metric.", - "$ref": "GoogleCloudAiplatformV1ToolNameMatchSpec" + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Additional parameters for the session, like app_name, etc. For example, {\"app_name\": \"my-app\"}.", + "type": "object" }, - "instances": { - "description": "Required. Repeated tool name match instances.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ToolNameMatchInstance" - } + "sessionState": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Session specific memory which stores key conversation points.", + "type": "object" + }, + "userId": { + "description": "Optional. The user id for the agent session. The ID can be up to 128 characters long.", + "type": "string" } - } - }, - "GoogleCloudAiplatformV1ToolNameMatchSpec": { - "id": "GoogleCloudAiplatformV1ToolNameMatchSpec", - "description": "Spec for tool name match metric.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolNameMatchInstance": { - "id": "GoogleCloudAiplatformV1ToolNameMatchInstance", - "description": "Spec for tool name match instance.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunMetric": { + "description": "The metric used for evaluation runs.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetric", "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", + "computationBasedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec", + "description": "Spec for a computation based metric." + }, + "llmBasedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec", + "description": "Spec for an LLM based metric." + }, + "metric": { + "description": "Required. The name of the metric.", "type": "string" }, - "reference": { - "description": "Required. Ground truth used to compare against the prediction.", + "metricConfig": { + "$ref": "GoogleCloudAiplatformV1Metric", + "description": "The metric config." + }, + "metricResourceName": { + "description": "Optional. The resource name of the metric definition.", "type": "string" + }, + "predefinedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", + "description": "Spec for a pre-defined metric." + }, + "rubricBasedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec", + "description": "Spec for rubric based metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolParameterKeyMatchInput": { - "id": "GoogleCloudAiplatformV1ToolParameterKeyMatchInput", - "description": "Input for tool parameter key match metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec": { + "description": "Specification for a computation based metric.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec", "properties": { - "metricSpec": { - "description": "Required. Spec for tool parameter key match metric.", - "$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchSpec" + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. A map of parameters for the metric, e.g. {\"rouge_type\": \"rougeL\"}.", + "type": "object" }, - "instances": { - "description": "Required. Repeated tool parameter key match instances.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchInstance" - } + "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" } - } - }, - "GoogleCloudAiplatformV1ToolParameterKeyMatchSpec": { - "id": "GoogleCloudAiplatformV1ToolParameterKeyMatchSpec", - "description": "Spec for tool parameter key match metric.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolParameterKeyMatchInstance": { - "id": "GoogleCloudAiplatformV1ToolParameterKeyMatchInstance", - "description": "Spec for tool parameter key match instance.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec": { + "description": "Specification for an LLM based metric.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec", "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", + "additionalConfig": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Optional additional configuration for the metric.", + "type": "object" + }, + "judgeAutoraterConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", + "description": "Optional. Optional configuration for the judge LLM (Autorater)." + }, + "metricPromptTemplate": { + "description": "Required. Template for the prompt sent to the judge model.", "type": "string" }, - "reference": { - "description": "Required. Ground truth used to compare against the prediction.", + "predefinedRubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", + "description": "Dynamically generate rubrics using a predefined spec." + }, + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", + "description": "Dynamically generate rubrics using this specification." + }, + "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" - } - } - }, - "GoogleCloudAiplatformV1ToolParameterKVMatchInput": { - "id": "GoogleCloudAiplatformV1ToolParameterKVMatchInput", - "description": "Input for tool parameter key value match metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for tool parameter key value match metric.", - "$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchSpec" }, - "instances": { - "description": "Required. Repeated tool parameter key value match instances.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchInstance" - } + "systemInstruction": { + "description": "Optional. System instructions for the judge model.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolParameterKVMatchSpec": { - "id": "GoogleCloudAiplatformV1ToolParameterKVMatchSpec", - "description": "Spec for tool parameter key value match metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec": { + "description": "Specification for a pre-defined metric.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", "properties": { - "useStrictStringMatch": { - "description": "Optional. Whether to use STRICT string match on parameter values.", - "type": "boolean" + "metricSpecName": { + "description": "Required. The name of a pre-defined metric, such as \"instruction_following_v1\" or \"text_quality_v1\".", + "type": "string" + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The parameters needed to run the pre-defined metric.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolParameterKVMatchInstance": { - "id": "GoogleCloudAiplatformV1ToolParameterKVMatchInstance", - "description": "Spec for tool parameter key value match instance.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec": { + "description": "Specification for a metric that is based on rubrics.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec", "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", + "inlineRubrics": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics", + "description": "Use rubrics provided directly in the spec." + }, + "judgeAutoraterConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", + "description": "Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided." + }, + "metricPromptTemplate": { + "description": "Optional. Template for the prompt used by the judge model to evaluate against rubrics.", "type": "string" }, - "reference": { - "description": "Required. Ground truth used to compare against the prediction.", + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", + "description": "Dynamically generate rubrics for evaluation using this specification." + }, + "rubricGroupKey": { + "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`.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CometInput": { - "id": "GoogleCloudAiplatformV1CometInput", - "description": "Input for Comet metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics": { + "description": "Defines a list of rubrics, used when providing rubrics inline.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics", "properties": { - "metricSpec": { - "description": "Required. Spec for comet metric.", - "$ref": "GoogleCloudAiplatformV1CometSpec" - }, - "instance": { - "description": "Required. Comet instance.", - "$ref": "GoogleCloudAiplatformV1CometInstance" + "rubrics": { + "description": "The list of rubrics.", + "items": { + "$ref": "GoogleCloudAiplatformV1Rubric" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CometSpec": { - "id": "GoogleCloudAiplatformV1CometSpec", - "description": "Spec for Comet metric.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec": { + "description": "Specification for how rubrics should be generated.", + "id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", "properties": { - "version": { - "description": "Required. Which version to use for evaluation.", - "type": "string", - "enumDescriptions": [ - "Comet version unspecified.", - "Comet 22 for translation + source + reference (source-reference-combined)." - ], - "enum": [ - "COMET_VERSION_UNSPECIFIED", - "COMET_22_SRC_REF" - ] + "metricResourceName": { + "description": "Optional. Resource name of the metric definition.", + "type": "string" }, - "sourceLanguage": { - "description": "Optional. Source language in BCP-47 format.", + "modelConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", + "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": { + "description": "Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.", "type": "string" }, - "targetLanguage": { - "description": "Optional. Target language in BCP-47 format. Covers both prediction and reference.", + "rubricContentType": { + "description": "Optional. The type of rubric content to be generated.", + "enum": [ + "RUBRIC_CONTENT_TYPE_UNSPECIFIED", + "PROPERTY", + "NL_QUESTION_ANSWER", + "PYTHON_CODE_ASSERTION" + ], + "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" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CometInstance": { - "id": "GoogleCloudAiplatformV1CometInstance", - "description": "Spec for Comet instance - The fields used for evaluation are dependent on the comet version.", - "type": "object", + "GoogleCloudAiplatformV1EvaluationSet": { + "description": "EvaluationSet is a collection of related EvaluationItems that are evaluated together.", + "id": "GoogleCloudAiplatformV1EvaluationSet", "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", + "createTime": { + "description": "Output only. Timestamp when this item was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "reference": { - "description": "Optional. Ground truth used to compare against the prediction.", + "displayName": { + "description": "Required. The display name of the EvaluationSet.", "type": "string" }, - "source": { - "description": "Optional. Source text in original language.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1MetricxInput": { - "id": "GoogleCloudAiplatformV1MetricxInput", - "description": "Input for MetricX metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for Metricx metric.", - "$ref": "GoogleCloudAiplatformV1MetricxSpec" + "evaluationItems": { + "description": "Required. The EvaluationItems that are part of this dataset.", + "items": { + "type": "string" + }, + "type": "array" }, - "instance": { - "description": "Required. Metricx instance.", - "$ref": "GoogleCloudAiplatformV1MetricxInstance" - } - } - }, - "GoogleCloudAiplatformV1MetricxSpec": { - "id": "GoogleCloudAiplatformV1MetricxSpec", - "description": "Spec for MetricX metric.", - "type": "object", - "properties": { - "version": { - "description": "Required. Which version to use for evaluation.", - "type": "string", - "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)." - ], - "enum": [ - "METRICX_VERSION_UNSPECIFIED", - "METRICX_24_REF", - "METRICX_24_SRC", - "METRICX_24_SRC_REF" - ] + "metadata": { + "description": "Optional. Metadata for the EvaluationSet.", + "type": "any" }, - "sourceLanguage": { - "description": "Optional. Source language in BCP-47 format.", + "name": { + "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", "type": "string" }, - "targetLanguage": { - "description": "Optional. Target language in BCP-47 format. Covers both prediction and reference.", + "updateTime": { + "description": "Output only. Timestamp when this item was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MetricxInstance": { - "id": "GoogleCloudAiplatformV1MetricxInstance", - "description": "Spec for MetricX instance - The fields used for evaluation are dependent on the MetricX version.", - "type": "object", + "GoogleCloudAiplatformV1Event": { + "description": "An edge describing the relationship between an Artifact and an Execution in a lineage graph.", + "id": "GoogleCloudAiplatformV1Event", "properties": { - "prediction": { - "description": "Required. Output of the evaluated model.", + "artifact": { + "description": "Required. The relative resource name of the Artifact in the Event.", "type": "string" }, - "reference": { - "description": "Optional. Ground truth used to compare against the prediction.", + "eventTime": { + "description": "Output only. Time the Event occurred.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "source": { - "description": "Optional. Source text in original language.", + "execution": { + "description": "Output only. The relative resource name of the Execution in the Event.", + "readOnly": true, + "type": "string" + }, + "labels": { + "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": "object" + }, + "type": { + "description": "Required. The type of the Event.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryExactMatchInput": { - "id": "GoogleCloudAiplatformV1TrajectoryExactMatchInput", - "description": "Instances and metric spec for TrajectoryExactMatch metric.", - "type": "object", + "GoogleCloudAiplatformV1EventActions": { + "description": "Actions are parts of events that are executed by the agent.", + "id": "GoogleCloudAiplatformV1EventActions", "properties": { - "metricSpec": { - "description": "Required. Spec for TrajectoryExactMatch metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchSpec" + "artifactDelta": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "description": "Optional. Indicates that the event is updating an artifact. key is the filename, value is the version.", + "type": "object" }, - "instances": { - "description": "Required. Repeated TrajectoryExactMatch instance.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchInstance" - } + "escalate": { + "description": "Optional. The agent is escalating to a higher level agent.", + "type": "boolean" + }, + "requestedAuthConfigs": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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.", + "type": "object" + }, + "skipSummarization": { + "description": "Optional. If true, it won't call model to summarize function response. Only used for function_response event.", + "type": "boolean" + }, + "stateDelta": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Indicates that the event is updating the state with the given delta.", + "type": "object" + }, + "transferAgent": { + "description": "Optional. If set, the event transfers to the specified agent.", + "type": "string" } - } - }, - "GoogleCloudAiplatformV1TrajectoryExactMatchSpec": { - "id": "GoogleCloudAiplatformV1TrajectoryExactMatchSpec", - "description": "Spec for TrajectoryExactMatch metric - returns 1 if tool calls in the reference trajectory exactly match the predicted trajectory, else 0.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryExactMatchInstance": { - "id": "GoogleCloudAiplatformV1TrajectoryExactMatchInstance", - "description": "Spec for TrajectoryExactMatch instance.", - "type": "object", + "GoogleCloudAiplatformV1EventMetadata": { + "description": "Metadata relating to a LLM response event.", + "id": "GoogleCloudAiplatformV1EventMetadata", "properties": { - "predictedTrajectory": { - "description": "Required. Spec for predicted tool call trajectory.", - "$ref": "GoogleCloudAiplatformV1Trajectory" + "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" }, - "referenceTrajectory": { - "description": "Required. Spec for reference tool call trajectory.", - "$ref": "GoogleCloudAiplatformV1Trajectory" + "customMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The custom metadata of the LlmResponse.", + "type": "object" + }, + "groundingMetadata": { + "$ref": "GoogleCloudAiplatformV1GroundingMetadata", + "description": "Optional. Metadata returned to client when grounding is enabled." + }, + "inputTranscription": { + "$ref": "GoogleCloudAiplatformV1Transcription", + "description": "Optional. Audio transcription of user input." + }, + "interrupted": { + "description": "Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.", + "type": "boolean" + }, + "longRunningToolIds": { + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "outputTranscription": { + "$ref": "GoogleCloudAiplatformV1Transcription", + "description": "Optional. Audio transcription of model output." + }, + "partial": { + "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.", + "type": "boolean" + }, + "turnComplete": { + "description": "Optional. Indicates whether the response from the model is complete. Only used for streaming mode.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Trajectory": { - "id": "GoogleCloudAiplatformV1Trajectory", - "description": "Spec for trajectory.", - "type": "object", + "GoogleCloudAiplatformV1ExactMatchInput": { + "description": "Input for exact match metric.", + "id": "GoogleCloudAiplatformV1ExactMatchInput", "properties": { - "toolCalls": { - "description": "Required. Tool calls in the trajectory.", - "type": "array", + "instances": { + "description": "Required. Repeated exact match instances.", "items": { - "$ref": "GoogleCloudAiplatformV1ToolCall" - } + "$ref": "GoogleCloudAiplatformV1ExactMatchInstance" + }, + "type": "array" + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1ExactMatchSpec", + "description": "Required. Spec for exact match metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolCall": { - "id": "GoogleCloudAiplatformV1ToolCall", - "description": "Spec for tool call.", - "type": "object", + "GoogleCloudAiplatformV1ExactMatchInstance": { + "description": "Spec for exact match instance.", + "id": "GoogleCloudAiplatformV1ExactMatchInstance", "properties": { - "toolName": { - "description": "Required. Spec for tool name", + "prediction": { + "description": "Required. Output of the evaluated model.", "type": "string" }, - "toolInput": { - "description": "Optional. Spec for tool input", + "reference": { + "description": "Required. Ground truth used to compare against the prediction.", "type": "string" } - } - }, - "GoogleCloudAiplatformV1TrajectoryInOrderMatchInput": { - "id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchInput", - "description": "Instances and metric spec for TrajectoryInOrderMatch metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for TrajectoryInOrderMatch metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchSpec" - }, - "instances": { - "description": "Required. Repeated TrajectoryInOrderMatch instance.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance" - } - } - } - }, - "GoogleCloudAiplatformV1TrajectoryInOrderMatchSpec": { - "id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchSpec", - "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": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance": { - "id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance", - "description": "Spec for TrajectoryInOrderMatch instance.", - "type": "object", + "GoogleCloudAiplatformV1ExactMatchMetricValue": { + "description": "Exact match metric value for an instance.", + "id": "GoogleCloudAiplatformV1ExactMatchMetricValue", "properties": { - "predictedTrajectory": { - "description": "Required. Spec for predicted tool call trajectory.", - "$ref": "GoogleCloudAiplatformV1Trajectory" - }, - "referenceTrajectory": { - "description": "Required. Spec for reference tool call trajectory.", - "$ref": "GoogleCloudAiplatformV1Trajectory" + "score": { + "description": "Output only. Exact match score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput": { - "id": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput", - "description": "Instances and metric spec for TrajectoryAnyOrderMatch metric.", - "type": "object", + "GoogleCloudAiplatformV1ExactMatchResults": { + "description": "Results for exact match metric.", + "id": "GoogleCloudAiplatformV1ExactMatchResults", "properties": { - "metricSpec": { - "description": "Required. Spec for TrajectoryAnyOrderMatch metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchSpec" - }, - "instances": { - "description": "Required. Repeated TrajectoryAnyOrderMatch instance.", - "type": "array", + "exactMatchMetricValues": { + "description": "Output only. Exact match metric values.", "items": { - "$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInstance" - } + "$ref": "GoogleCloudAiplatformV1ExactMatchMetricValue" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchSpec": { - "id": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchSpec", - "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.", - "type": "object", - "properties": {} + "GoogleCloudAiplatformV1ExactMatchSpec": { + "description": "Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0.", + "id": "GoogleCloudAiplatformV1ExactMatchSpec", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInstance": { - "id": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInstance", - "description": "Spec for TrajectoryAnyOrderMatch instance.", - "type": "object", + "GoogleCloudAiplatformV1Examples": { + "description": "Example-based explainability that returns the nearest neighbors from the provided dataset.", + "id": "GoogleCloudAiplatformV1Examples", "properties": { - "predictedTrajectory": { - "description": "Required. Spec for predicted tool call trajectory.", - "$ref": "GoogleCloudAiplatformV1Trajectory" + "exampleGcsSource": { + "$ref": "GoogleCloudAiplatformV1ExamplesExampleGcsSource", + "description": "The Cloud Storage input instances." }, - "referenceTrajectory": { - "description": "Required. Spec for reference tool call trajectory.", - "$ref": "GoogleCloudAiplatformV1Trajectory" - } - } - }, - "GoogleCloudAiplatformV1TrajectoryPrecisionInput": { - "id": "GoogleCloudAiplatformV1TrajectoryPrecisionInput", - "description": "Instances and metric spec for TrajectoryPrecision metric.", - "type": "object", - "properties": { - "metricSpec": { - "description": "Required. Spec for TrajectoryPrecision metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionSpec" + "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" }, - "instances": { - "description": "Required. Repeated TrajectoryPrecision instance.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionInstance" - } + "neighborCount": { + "description": "The number of neighbors to return when querying for examples.", + "format": "int32", + "type": "integer" + }, + "presets": { + "$ref": "GoogleCloudAiplatformV1Presets", + "description": "Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality." } - } - }, - "GoogleCloudAiplatformV1TrajectoryPrecisionSpec": { - "id": "GoogleCloudAiplatformV1TrajectoryPrecisionSpec", - "description": "Spec for TrajectoryPrecision metric - returns a float score based on average precision of individual tool calls.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryPrecisionInstance": { - "id": "GoogleCloudAiplatformV1TrajectoryPrecisionInstance", - "description": "Spec for TrajectoryPrecision instance.", - "type": "object", + "GoogleCloudAiplatformV1ExamplesExampleGcsSource": { + "description": "The Cloud Storage input instances.", + "id": "GoogleCloudAiplatformV1ExamplesExampleGcsSource", "properties": { - "predictedTrajectory": { - "description": "Required. Spec for predicted tool call trajectory.", - "$ref": "GoogleCloudAiplatformV1Trajectory" + "dataFormat": { + "description": "The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.", + "enum": [ + "DATA_FORMAT_UNSPECIFIED", + "JSONL" + ], + "enumDescriptions": [ + "Format unspecified, used when unset.", + "Examples are stored in JSONL files." + ], + "type": "string" }, - "referenceTrajectory": { - "description": "Required. Spec for reference tool call trajectory.", - "$ref": "GoogleCloudAiplatformV1Trajectory" + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1GcsSource", + "description": "The Cloud Storage location for the input instances." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryRecallInput": { - "id": "GoogleCloudAiplatformV1TrajectoryRecallInput", - "description": "Instances and metric spec for TrajectoryRecall metric.", - "type": "object", + "GoogleCloudAiplatformV1ExamplesOverride": { + "description": "Overrides for example-based explanations.", + "id": "GoogleCloudAiplatformV1ExamplesOverride", "properties": { - "metricSpec": { - "description": "Required. Spec for TrajectoryRecall metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryRecallSpec" + "crowdingCount": { + "description": "The number of neighbors to return that have the same crowding tag.", + "format": "int32", + "type": "integer" }, - "instances": { - "description": "Required. Repeated TrajectoryRecall instance.", - "type": "array", + "dataFormat": { + "description": "The format of the data being provided with each call.", + "enum": [ + "DATA_FORMAT_UNSPECIFIED", + "INSTANCES", + "EMBEDDINGS" + ], + "enumDescriptions": [ + "Unspecified format. Must not be used.", + "Provided data is a set of model inputs.", + "Provided data is a set of embeddings." + ], + "type": "string" + }, + "neighborCount": { + "description": "The number of neighbors to return.", + "format": "int32", + "type": "integer" + }, + "restrictions": { + "description": "Restrict the resulting nearest neighbors to respect these constraints.", "items": { - "$ref": "GoogleCloudAiplatformV1TrajectoryRecallInstance" - } + "$ref": "GoogleCloudAiplatformV1ExamplesRestrictionsNamespace" + }, + "type": "array" + }, + "returnEmbeddings": { + "description": "If true, return the embeddings instead of neighbors.", + "type": "boolean" } - } - }, - "GoogleCloudAiplatformV1TrajectoryRecallSpec": { - "id": "GoogleCloudAiplatformV1TrajectoryRecallSpec", - "description": "Spec for TrajectoryRecall metric - returns a float score based on average recall of individual tool calls.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryRecallInstance": { - "id": "GoogleCloudAiplatformV1TrajectoryRecallInstance", - "description": "Spec for TrajectoryRecall instance.", - "type": "object", + "GoogleCloudAiplatformV1ExamplesRestrictionsNamespace": { + "description": "Restrictions namespace for example-based explanations overrides.", + "id": "GoogleCloudAiplatformV1ExamplesRestrictionsNamespace", "properties": { - "predictedTrajectory": { - "description": "Required. Spec for predicted tool call trajectory.", - "$ref": "GoogleCloudAiplatformV1Trajectory" + "allow": { + "description": "The list of allowed tags.", + "items": { + "type": "string" + }, + "type": "array" }, - "referenceTrajectory": { - "description": "Required. Spec for reference tool call trajectory.", - "$ref": "GoogleCloudAiplatformV1Trajectory" + "deny": { + "description": "The list of deny tags.", + "items": { + "type": "string" + }, + "type": "array" + }, + "namespaceName": { + "description": "The namespace name.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectorySingleToolUseInput": { - "id": "GoogleCloudAiplatformV1TrajectorySingleToolUseInput", - "description": "Instances and metric spec for TrajectorySingleToolUse metric.", - "type": "object", + "GoogleCloudAiplatformV1ExecutableCode": { + "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.", + "id": "GoogleCloudAiplatformV1ExecutableCode", "properties": { - "metricSpec": { - "description": "Required. Spec for TrajectorySingleToolUse metric.", - "$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseSpec" + "code": { + "description": "Required. The code to be executed.", + "type": "string" }, - "instances": { - "description": "Required. Repeated TrajectorySingleToolUse instance.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseInstance" - } + "language": { + "description": "Required. Programming language of the `code`.", + "enum": [ + "LANGUAGE_UNSPECIFIED", + "PYTHON" + ], + "enumDescriptions": [ + "Unspecified language. This value should not be used.", + "Python >= 3.10, with numpy and simpy available." + ], + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectorySingleToolUseSpec": { - "id": "GoogleCloudAiplatformV1TrajectorySingleToolUseSpec", - "description": "Spec for TrajectorySingleToolUse metric - returns 1 if tool is present in the predicted trajectory, else 0.", - "type": "object", + "GoogleCloudAiplatformV1ExecuteCodeRequest": { + "description": "Request message for SandboxEnvironmentExecutionService.ExecuteCode.", + "id": "GoogleCloudAiplatformV1ExecuteCodeRequest", "properties": { - "toolName": { - "description": "Required. Spec for tool name to be checked for in the predicted trajectory.", - "type": "string" + "inputs": { + "description": "Required. The inputs used for the stateless code execution.", + "items": { + "$ref": "GoogleCloudAiplatformV1Chunk" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectorySingleToolUseInstance": { - "id": "GoogleCloudAiplatformV1TrajectorySingleToolUseInstance", - "description": "Spec for TrajectorySingleToolUse instance.", - "type": "object", + "GoogleCloudAiplatformV1ExecuteCodeResponse": { + "description": "Response message for SandboxEnvironmentExecutionService.ExecuteCode.", + "id": "GoogleCloudAiplatformV1ExecuteCodeResponse", "properties": { - "predictedTrajectory": { - "description": "Required. Spec for predicted tool call trajectory.", - "$ref": "GoogleCloudAiplatformV1Trajectory" + "outputs": { + "description": "The outputs from the sandbox environment.", + "items": { + "$ref": "GoogleCloudAiplatformV1Chunk" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput": { - "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput", - "description": "Instance and metric spec for RubricBasedInstructionFollowing metric.", - "type": "object", + "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest": { + "description": "Request message for SandboxEnvironmentExecutionService.Execute.", + "id": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest", "properties": { - "metricSpec": { - "description": "Required. Spec for RubricBasedInstructionFollowing metric.", - "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec" - }, - "instance": { - "description": "Required. Instance for RubricBasedInstructionFollowing metric.", - "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance" + "inputs": { + "description": "Required. The inputs to the sandbox environment.", + "items": { + "$ref": "GoogleCloudAiplatformV1Chunk" + }, + "type": "array" } - } - }, - "GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec": { - "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec", - "description": "Spec for RubricBasedInstructionFollowing metric - returns rubrics and verdicts corresponding to rubrics along with overall score.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance": { - "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance", - "description": "Instance for RubricBasedInstructionFollowing metric - one instance corresponds to one row in an evaluation dataset.", - "type": "object", + "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentResponse": { + "description": "Response message for SandboxEnvironmentExecutionService.Execute.", + "id": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentResponse", "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" + "outputs": { + "description": "The outputs from the sandbox environment.", + "items": { + "$ref": "GoogleCloudAiplatformV1Chunk" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Metric": { - "id": "GoogleCloudAiplatformV1Metric", - "description": "The metric used for running evaluations.", - "type": "object", + "GoogleCloudAiplatformV1Execution": { + "description": "Instance of a general execution.", + "id": "GoogleCloudAiplatformV1Execution", "properties": { - "predefinedMetricSpec": { - "description": "The spec for a pre-defined metric.", - "$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec" + "createTime": { + "description": "Output only. Timestamp when this Execution was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "llmBasedMetricSpec": { - "description": "Spec for an LLM based metric.", - "$ref": "GoogleCloudAiplatformV1LLMBasedMetricSpec" + "description": { + "description": "Description of the Execution", + "type": "string" }, - "customCodeExecutionSpec": { - "description": "Spec for Custom Code Execution metric.", - "$ref": "GoogleCloudAiplatformV1CustomCodeExecutionSpec" + "displayName": { + "description": "User provided display name of the Execution. May be up to 128 Unicode characters.", + "type": "string" }, - "pointwiseMetricSpec": { - "description": "Spec for pointwise metric.", - "$ref": "GoogleCloudAiplatformV1PointwiseMetricSpec" + "etag": { + "description": "An eTag used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" }, - "pairwiseMetricSpec": { - "description": "Spec for pairwise metric.", - "$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec" + "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" }, - "exactMatchSpec": { - "description": "Spec for exact match metric.", - "$ref": "GoogleCloudAiplatformV1ExactMatchSpec" + "metadata": { + "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.", + "type": "object" }, - "bleuSpec": { - "description": "Spec for bleu metric.", - "$ref": "GoogleCloudAiplatformV1BleuSpec" + "name": { + "description": "Output only. The resource name of the Execution.", + "readOnly": true, + "type": "string" }, - "rougeSpec": { - "description": "Spec for rouge metric.", - "$ref": "GoogleCloudAiplatformV1RougeSpec" + "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" }, - "aggregationMetrics": { - "description": "Optional. The aggregation metrics to use.", - "type": "array", - "items": { - "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." - ], - "enum": [ - "AGGREGATION_METRIC_UNSPECIFIED", - "AVERAGE", - "MODE", - "STANDARD_DEVIATION", - "VARIANCE", - "MINIMUM", - "MAXIMUM", - "MEDIAN", - "PERCENTILE_P90", - "PERCENTILE_P95", - "PERCENTILE_P99" - ] - } - } - } - }, - "GoogleCloudAiplatformV1PredefinedMetricSpec": { - "id": "GoogleCloudAiplatformV1PredefinedMetricSpec", - "description": "The spec for a pre-defined metric.", - "type": "object", - "properties": { - "metricSpecName": { - "description": "Required. The name of a pre-defined metric, such as \"instruction_following_v1\" or \"text_quality_v1\".", + "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" }, - "metricSpecParameters": { - "description": "Optional. The parameters needed to run the pre-defined metric.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } + "state": { + "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.", + "enum": [ + "STATE_UNSPECIFIED", + "NEW", + "RUNNING", + "COMPLETE", + "FAILED", + "CACHED", + "CANCELLED" + ], + "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" + }, + "updateTime": { + "description": "Output only. Timestamp when this Execution was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1LLMBasedMetricSpec": { - "id": "GoogleCloudAiplatformV1LLMBasedMetricSpec", - "description": "Specification for an LLM based metric.", - "type": "object", + "GoogleCloudAiplatformV1ExplainRequest": { + "description": "Request message for PredictionService.Explain.", + "id": "GoogleCloudAiplatformV1ExplainRequest", "properties": { - "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" - }, - "rubricGenerationSpec": { - "description": "Dynamically generate rubrics using this specification.", - "$ref": "GoogleCloudAiplatformV1RubricGenerationSpec" - }, - "predefinedRubricGenerationSpec": { - "description": "Dynamically generate rubrics using a predefined spec.", - "$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec" - }, - "metricPromptTemplate": { - "description": "Required. Template for the prompt sent to the judge model.", + "deployedModelId": { + "description": "If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split.", "type": "string" }, - "systemInstruction": { - "description": "Optional. System instructions for the judge model.", - "type": "string" + "explanationSpecOverride": { + "$ref": "GoogleCloudAiplatformV1ExplanationSpecOverride", + "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." }, - "judgeAutoraterConfig": { - "description": "Optional. Optional configuration for the judge LLM (Autorater).", - "$ref": "GoogleCloudAiplatformV1AutoraterConfig" + "instances": { + "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.", + "items": { + "type": "any" + }, + "type": "array" }, - "additionalConfig": { - "description": "Optional. Optional additional configuration for the metric.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RubricGenerationSpec": { - "id": "GoogleCloudAiplatformV1RubricGenerationSpec", - "description": "Specification for how rubrics should be generated.", - "type": "object", + "GoogleCloudAiplatformV1ExplainResponse": { + "description": "Response message for PredictionService.Explain.", + "id": "GoogleCloudAiplatformV1ExplainResponse", "properties": { - "promptTemplate": { - "description": "Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.", + "deployedModelId": { + "description": "ID of the Endpoint's DeployedModel that served this explanation.", "type": "string" }, - "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": "GoogleCloudAiplatformV1AutoraterConfig" + "explanations": { + "description": "The explanations of the Model's PredictResponse.predictions. It has the same number of elements as instances to be explained.", + "items": { + "$ref": "GoogleCloudAiplatformV1Explanation" + }, + "type": "array" }, - "rubricContentType": { - "description": "The type of rubric content to be generated.", - "type": "string", - "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." - ], - "enum": [ - "RUBRIC_CONTENT_TYPE_UNSPECIFIED", - "PROPERTY", - "NL_QUESTION_ANSWER", - "PYTHON_CODE_ASSERTION" - ] + "predictions": { + "description": "The predictions that are the output of the predictions call. Same as PredictResponse.predictions.", + "items": { + "type": "any" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Explanation": { + "description": "Explanation of a prediction (provided in PredictResponse.predictions) produced by the Model on a given instance.", + "id": "GoogleCloudAiplatformV1Explanation", + "properties": { + "attributions": { + "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 > 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.", + "items": { + "$ref": "GoogleCloudAiplatformV1Attribution" + }, + "readOnly": true, + "type": "array" }, - "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", + "neighbors": { + "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.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1Neighbor" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AutoraterConfig": { - "id": "GoogleCloudAiplatformV1AutoraterConfig", - "description": "The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset.", - "type": "object", + "GoogleCloudAiplatformV1ExplanationMetadata": { + "description": "Metadata describing the Model's input and output for explanation.", + "id": "GoogleCloudAiplatformV1ExplanationMetadata", "properties": { - "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" + "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" }, - "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" + "inputs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadata" + }, + "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.", + "type": "object" }, - "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}`", + "latentSpaceSource": { + "description": "Name of the source to generate embeddings for example based explanations.", "type": "string" }, - "generationConfig": { - "description": "Optional. Configuration options for model generation and outputs.", - "$ref": "GoogleCloudAiplatformV1GenerationConfig" + "outputs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata" + }, + "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.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerationConfig": { - "id": "GoogleCloudAiplatformV1GenerationConfig", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ExplanationMetadataInputMetadata": { + "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": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadata", "properties": { - "temperature": { - "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].", - "type": "number", - "format": "float" + "denseShapeTensorName": { + "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.", + "type": "string" }, - "topP": { - "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", - "format": "float" + "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.", + "items": { + "type": "any" + }, + "type": "array" }, - "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.", - "type": "number", - "format": "float" + "encodedTensorName": { + "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.", + "type": "string" }, - "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" + "encoding": { + "description": "Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.", + "enum": [ + "ENCODING_UNSPECIFIED", + "IDENTITY", + "BAG_OF_FEATURES", + "BAG_OF_FEATURES_SPARSE", + "INDICATOR", + "COMBINED_EMBEDDING", + "CONCAT_EMBEDDING" + ], + "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]] ```" + ], + "type": "string" }, - "maxOutputTokens": { - "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.", - "type": "integer", - "format": "int32" + "featureValueDomain": { + "$ref": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain", + "description": "The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized." }, - "stopSequences": { - "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.", - "type": "array", + "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" + }, + "indexFeatureMapping": { + "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" - } - }, - "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" - }, - "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" + }, + "type": "array" }, - "presencePenalty": { - "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].", - "type": "number", - "format": "float" + "indicesTensorName": { + "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.", + "type": "string" }, - "frequencyPenalty": { - "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].", - "type": "number", - "format": "float" + "inputBaselines": { + "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" + }, + "type": "array" }, - "seed": { - "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.", - "type": "integer", - "format": "int32" + "inputTensorName": { + "description": "Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.", + "type": "string" }, - "responseMimeType": { - "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. This is a preview feature.", + "modality": { + "description": "Modality of the feature. Valid values are: numeric, image. Defaults to numeric.", "type": "string" }, - "responseSchema": { - "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`.", - "$ref": "GoogleCloudAiplatformV1Schema" + "visualization": { + "$ref": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization", + "description": "Visualization configurations for image explanation." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain": { + "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.", + "id": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain", + "properties": { + "maxValue": { + "description": "The maximum permissible value for this feature.", + "format": "float", + "type": "number" }, - "responseJsonSchema": { - "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.", - "type": "any" + "minValue": { + "description": "The minimum permissible value for this feature.", + "format": "float", + "type": "number" }, - "routingConfig": { - "description": "Optional. Routing configuration.", - "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig" + "originalMean": { + "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.", + "format": "float", + "type": "number" }, - "audioTimestamp": { - "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.", - "type": "boolean" + "originalStddev": { + "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.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization": { + "description": "Visualization configurations for image explanation.", + "id": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization", + "properties": { + "clipPercentLowerbound": { + "description": "Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.", + "format": "float", + "type": "number" }, - "responseModalities": { - "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.", - "type": "array", - "items": { - "type": "string", - "enumDescriptions": [ - "Unspecified modality. Will be processed as text.", - "Text modality.", - "Image modality.", - "Audio modality." - ], - "enum": [ - "MODALITY_UNSPECIFIED", - "TEXT", - "IMAGE", - "AUDIO" - ] - } + "clipPercentUpperbound": { + "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", + "type": "number" }, - "mediaResolution": { - "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.", - "type": "string", + "colorMap": { + "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.", + "enum": [ + "COLOR_MAP_UNSPECIFIED", + "PINK_GREEN", + "VIRIDIS", + "RED", + "GREEN", + "RED_GREEN", + "PINK_WHITE_GREEN" + ], "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)." + "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": [ - "MEDIA_RESOLUTION_UNSPECIFIED", - "MEDIA_RESOLUTION_LOW", - "MEDIA_RESOLUTION_MEDIUM", - "MEDIA_RESOLUTION_HIGH" - ] - }, - "speechConfig": { - "description": "Optional. The speech generation config.", - "$ref": "GoogleCloudAiplatformV1SpeechConfig" - }, - "thinkingConfig": { - "description": "Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.", - "$ref": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig" - }, - "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" + "type": "string" }, - "imageConfig": { - "description": "Optional. Config for image generation features.", - "$ref": "GoogleCloudAiplatformV1ImageConfig" - } - } - }, - "GoogleCloudAiplatformV1Schema": { - "id": "GoogleCloudAiplatformV1Schema", - "description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed.", - "type": "object", - "properties": { - "type": { - "description": "Optional. The type of the data.", - "type": "string", + "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.", + "enum": [ + "OVERLAY_TYPE_UNSPECIFIED", + "NONE", + "ORIGINAL", + "GRAYSCALE", + "MASK_BLACK" + ], "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" + "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": [ - "TYPE_UNSPECIFIED", - "STRING", - "NUMBER", - "INTEGER", - "BOOLEAN", - "ARRAY", - "OBJECT", - "NULL" - ] + "type": "string" }, - "format": { - "description": "Optional. The format of the data. Supported formats: for NUMBER type: \"float\", \"double\" for INTEGER type: \"int32\", \"int64\" for STRING type: \"email\", \"byte\", etc", + "polarity": { + "description": "Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.", + "enum": [ + "POLARITY_UNSPECIFIED", + "POSITIVE", + "NEGATIVE", + "BOTH" + ], + "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" }, - "title": { - "description": "Optional. The title of the Schema.", + "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.", + "enum": [ + "TYPE_UNSPECIFIED", + "PIXELS", + "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." + ], "type": "string" - }, - "description": { - "description": "Optional. The description of the data.", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata": { + "description": "Metadata of the prediction output to be explained.", + "id": "GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata", + "properties": { + "displayNameMappingKey": { + "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.", "type": "string" }, - "nullable": { - "description": "Optional. Indicates if the value may be null.", - "type": "boolean" - }, - "default": { - "description": "Optional. Default value of the data.", + "indexDisplayNameMapping": { + "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.", "type": "any" }, - "items": { - "description": "Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.", - "$ref": "GoogleCloudAiplatformV1Schema" - }, - "minItems": { - "description": "Optional. Minimum number of the elements for Type.ARRAY.", - "type": "string", - "format": "int64" - }, - "maxItems": { - "description": "Optional. Maximum number of the elements for Type.ARRAY.", - "type": "string", - "format": "int64" - }, - "enum": { - "description": "Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}", - "type": "array", + "outputTensorName": { + "description": "Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExplanationMetadataOverride": { + "description": "The ExplanationMetadata entries that can be overridden at online explanation time.", + "id": "GoogleCloudAiplatformV1ExplanationMetadataOverride", + "properties": { + "inputs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride": { + "description": "The input metadata entries to be overridden.", + "id": "GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride", + "properties": { + "inputBaselines": { + "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.", "items": { - "type": "string" - } + "type": "any" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExplanationParameters": { + "description": "Parameters to configure explaining for Model's predictions.", + "id": "GoogleCloudAiplatformV1ExplanationParameters", + "properties": { + "examples": { + "$ref": "GoogleCloudAiplatformV1Examples", + "description": "Example-based explanations that returns the nearest neighbors from the provided dataset." }, - "properties": { - "description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1Schema" - } + "integratedGradientsAttribution": { + "$ref": "GoogleCloudAiplatformV1IntegratedGradientsAttribution", + "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" }, - "propertyOrdering": { - "description": "Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.", - "type": "array", + "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": "string" - } + "type": "any" + }, + "type": "array" }, - "required": { - "description": "Optional. Required properties of Type.OBJECT.", - "type": "array", - "items": { - "type": "string" - } + "sampledShapleyAttribution": { + "$ref": "GoogleCloudAiplatformV1SampledShapleyAttribution", + "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." }, - "minProperties": { - "description": "Optional. Minimum number of the properties for Type.OBJECT.", - "type": "string", - "format": "int64" + "topK": { + "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.", + "format": "int32", + "type": "integer" }, - "maxProperties": { - "description": "Optional. Maximum number of the properties for Type.OBJECT.", - "type": "string", - "format": "int64" + "xraiAttribution": { + "$ref": "GoogleCloudAiplatformV1XraiAttribution", + "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." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExplanationSpec": { + "description": "Specification of Model explanation.", + "id": "GoogleCloudAiplatformV1ExplanationSpec", + "properties": { + "metadata": { + "$ref": "GoogleCloudAiplatformV1ExplanationMetadata", + "description": "Optional. Metadata describing the Model's input and output for explanation." }, - "minimum": { - "description": "Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER", - "type": "number", - "format": "double" + "parameters": { + "$ref": "GoogleCloudAiplatformV1ExplanationParameters", + "description": "Required. Parameters that configure explaining of the Model's predictions." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExplanationSpecOverride": { + "description": "The ExplanationSpec entries that can be overridden at online explanation time.", + "id": "GoogleCloudAiplatformV1ExplanationSpecOverride", + "properties": { + "examplesOverride": { + "$ref": "GoogleCloudAiplatformV1ExamplesOverride", + "description": "The example-based explanations parameter overrides." }, - "maximum": { - "description": "Optional. Maximum value of the Type.INTEGER and Type.NUMBER", - "type": "number", - "format": "double" + "metadata": { + "$ref": "GoogleCloudAiplatformV1ExplanationMetadataOverride", + "description": "The metadata to be overridden. If not specified, no metadata is overridden." }, - "minLength": { - "description": "Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING", - "type": "string", - "format": "int64" + "parameters": { + "$ref": "GoogleCloudAiplatformV1ExplanationParameters", + "description": "The parameters to be overridden. Note that the attribution method cannot be changed. If not specified, no parameter is overridden." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExportDataConfig": { + "description": "Describes what part of the Dataset is to be exported, the destination of the export and how to export.", + "id": "GoogleCloudAiplatformV1ExportDataConfig", + "properties": { + "annotationSchemaUri": { + "description": "The 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 ExportDataRequest.name. Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations. 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.", + "type": "string" }, - "maxLength": { - "description": "Optional. Maximum length of the Type.STRING", - "type": "string", - "format": "int64" + "annotationsFilter": { + "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.", + "type": "string" }, - "pattern": { - "description": "Optional. Pattern of the Type.STRING to restrict a string to a regular expression.", + "exportUse": { + "description": "Indicates the usage of the exported files.", + "enum": [ + "EXPORT_USE_UNSPECIFIED", + "CUSTOM_CODE_TRAINING" + ], + "enumDescriptions": [ + "Regular user export.", + "Export for custom code training." + ], "type": "string" }, - "example": { - "description": "Optional. Example of the object. Will only populated when the object is the root.", - "type": "any" + "filterSplit": { + "$ref": "GoogleCloudAiplatformV1ExportFilterSplit", + "description": "Split based on the provided filters for each set." }, - "anyOf": { - "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Schema" - } + "fractionSplit": { + "$ref": "GoogleCloudAiplatformV1ExportFractionSplit", + "description": "Split based on fractions defining the size of each set." }, - "additionalProperties": { - "description": "Optional. Can either be a boolean or an object; controls the presence of additional properties.", - "type": "any" + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "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." }, - "ref": { - "description": "Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named \"Pet\": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the \"pet\" property is a reference to the schema node named \"Pet\". See details in https://json-schema.org/understanding-json-schema/structuring", + "savedQueryId": { + "description": "The ID of a SavedQuery (annotation set) under the Dataset specified by ExportDataRequest.name used for filtering Annotations for training. Only used for custom training data export use cases. Only applicable to Datasets that have SavedQueries. 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" - }, - "defs": { - "description": "Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1Schema" - } } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerationConfigRoutingConfig": { - "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ExportDataOperationMetadata": { + "description": "Runtime operation information for DatasetService.ExportData.", + "id": "GoogleCloudAiplatformV1ExportDataOperationMetadata", "properties": { - "autoMode": { - "description": "In this mode, the model is selected automatically based on the content of the request.", - "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode" + "gcsOutputDirectory": { + "description": "A Google Cloud Storage directory which path ends with '/'. The exported data is stored in the directory.", + "type": "string" }, - "manualMode": { - "description": "In this mode, the model is specified manually.", - "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The common part of the operation metadata." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode": { - "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ExportDataRequest": { + "description": "Request message for DatasetService.ExportData.", + "id": "GoogleCloudAiplatformV1ExportDataRequest", "properties": { - "modelRoutingPreference": { - "description": "The model routing preference.", - "type": "string", - "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" - ] + "exportConfig": { + "$ref": "GoogleCloudAiplatformV1ExportDataConfig", + "description": "Required. The desired output location." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode": { - "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode", - "description": "The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.", - "type": "object", + "GoogleCloudAiplatformV1ExportDataResponse": { + "description": "Response message for DatasetService.ExportData.", + "id": "GoogleCloudAiplatformV1ExportDataResponse", "properties": { - "modelName": { - "description": "The name of the model to use. Only public LLM models are accepted.", - "type": "string" + "dataStats": { + "$ref": "GoogleCloudAiplatformV1ModelDataStats", + "description": "Only present for custom code training export use case. Records data stats, i.e., train/validation/test item/annotation counts calculated during the export operation." + }, + "exportedFiles": { + "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-*).", + "items": { + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SpeechConfig": { - "id": "GoogleCloudAiplatformV1SpeechConfig", - "description": "Configuration for speech generation.", - "type": "object", + "GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata": { + "description": "Details of operations that exports Features values.", + "id": "GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata", "properties": { - "voiceConfig": { - "description": "The configuration for the voice to use.", - "$ref": "GoogleCloudAiplatformV1VoiceConfig" - }, - "languageCode": { - "description": "Optional. The language code (ISO 639-1) for the speech synthesis.", - "type": "string" - }, - "multiSpeakerVoiceConfig": { - "description": "The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.", - "$ref": "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Featurestore export Feature values." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1VoiceConfig": { - "id": "GoogleCloudAiplatformV1VoiceConfig", - "description": "Configuration for a voice.", - "type": "object", + "GoogleCloudAiplatformV1ExportFeatureValuesRequest": { + "description": "Request message for FeaturestoreService.ExportFeatureValues.", + "id": "GoogleCloudAiplatformV1ExportFeatureValuesRequest", "properties": { - "prebuiltVoiceConfig": { - "description": "The configuration for a prebuilt voice.", - "$ref": "GoogleCloudAiplatformV1PrebuiltVoiceConfig" + "destination": { + "$ref": "GoogleCloudAiplatformV1FeatureValueDestination", + "description": "Required. Specifies destination location and format." + }, + "featureSelector": { + "$ref": "GoogleCloudAiplatformV1FeatureSelector", + "description": "Required. Selects Features to export values of." + }, + "fullExport": { + "$ref": "GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport", + "description": "Exports all historical values of all entities of the EntityType within a time range" + }, + "settings": { + "description": "Per-Feature export settings.", + "items": { + "$ref": "GoogleCloudAiplatformV1DestinationFeatureSetting" + }, + "type": "array" + }, + "snapshotExport": { + "$ref": "GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport", + "description": "Exports the latest Feature values of all entities of the EntityType within a time range." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PrebuiltVoiceConfig": { - "id": "GoogleCloudAiplatformV1PrebuiltVoiceConfig", - "description": "Configuration for a prebuilt voice.", - "type": "object", + "GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport": { + "description": "Describes exporting all historical Feature values of all entities of the EntityType between [start_time, end_time].", + "id": "GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport", "properties": { - "voiceName": { - "description": "The name of the prebuilt voice to use.", + "endTime": { + "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.", + "format": "google-datetime", + "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.", + "format": "google-datetime", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig": { - "id": "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig", - "description": "Configuration for a multi-speaker text-to-speech request.", - "type": "object", + "GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport": { + "description": "Describes exporting the latest Feature values of all entities of the EntityType between [start_time, snapshot_time].", + "id": "GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport", "properties": { - "speakerVoiceConfigs": { - "description": "Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SpeakerVoiceConfig" - } + "snapshotTime": { + "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.", + "format": "google-datetime", + "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.", + "format": "google-datetime", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SpeakerVoiceConfig": { - "id": "GoogleCloudAiplatformV1SpeakerVoiceConfig", - "description": "Configuration for a single speaker in a multi-speaker setup.", - "type": "object", + "GoogleCloudAiplatformV1ExportFeatureValuesResponse": { + "description": "Response message for FeaturestoreService.ExportFeatureValues.", + "id": "GoogleCloudAiplatformV1ExportFeatureValuesResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1ExportFilterSplit": { + "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.", + "id": "GoogleCloudAiplatformV1ExportFilterSplit", "properties": { - "speaker": { - "description": "Required. The name of the speaker. This should be the same as the speaker name used in the prompt.", + "testFilter": { + "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.", "type": "string" }, - "voiceConfig": { - "description": "Required. The configuration for the voice of this speaker.", - "$ref": "GoogleCloudAiplatformV1VoiceConfig" + "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" + }, + "validationFilter": { + "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.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerationConfigThinkingConfig": { - "id": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig", - "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", + "GoogleCloudAiplatformV1ExportFractionSplit": { + "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": "GoogleCloudAiplatformV1ExportFractionSplit", "properties": { - "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" + "testFraction": { + "description": "The fraction of the input data that is to be used to evaluate the Model.", + "format": "double", + "type": "number" }, - "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.", - "type": "integer", - "format": "int32" + "trainingFraction": { + "description": "The fraction of the input data that is to be used to train the Model.", + "format": "double", + "type": "number" + }, + "validationFraction": { + "description": "The fraction of the input data that is to be used to validate the Model.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ImageConfig": { - "id": "GoogleCloudAiplatformV1ImageConfig", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ExportModelOperationMetadata": { + "description": "Details of ModelService.ExportModel operation.", + "id": "GoogleCloudAiplatformV1ExportModelOperationMetadata", "properties": { - "imageOutputOptions": { - "description": "Optional. The image output format for generated images.", - "$ref": "GoogleCloudAiplatformV1ImageConfigImageOutputOptions" - }, - "aspectRatio": { - "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\"", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The common part of the operation metadata." }, - "personGeneration": { - "description": "Optional. Controls whether the model can generate people.", - "type": "string", - "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." - ], - "enum": [ - "PERSON_GENERATION_UNSPECIFIED", - "ALLOW_ALL", - "ALLOW_ADULT", - "ALLOW_NONE" - ] + "outputInfo": { + "$ref": "GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo", + "description": "Output only. Information further describing the output of this Model export.", + "readOnly": true } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ImageConfigImageOutputOptions": { - "id": "GoogleCloudAiplatformV1ImageConfigImageOutputOptions", - "description": "The image output format for generated images.", - "type": "object", + "GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo": { + "description": "Further describes the output of the ExportModel. Supplements ExportModelRequest.OutputConfig.", + "id": "GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo", "properties": { - "mimeType": { - "description": "Optional. The image format that the output should be saved as.", + "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.", + "readOnly": true, "type": "string" }, - "compressionQuality": { - "description": "Optional. The compression quality of the output image.", - "type": "integer", - "format": "int32" + "imageOutputUri": { + "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.", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CustomCodeExecutionSpec": { - "id": "GoogleCloudAiplatformV1CustomCodeExecutionSpec", - "description": "Specificies a metric that is populated by evaluating user-defined Python code.", - "type": "object", + "GoogleCloudAiplatformV1ExportModelRequest": { + "description": "Request message for ModelService.ExportModel.", + "id": "GoogleCloudAiplatformV1ExportModelRequest", "properties": { - "evaluationFunction": { - "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.", - "type": "string" + "outputConfig": { + "$ref": "GoogleCloudAiplatformV1ExportModelRequestOutputConfig", + "description": "Required. The desired output location and configuration." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationInstance": { - "id": "GoogleCloudAiplatformV1EvaluationInstance", - "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", + "GoogleCloudAiplatformV1ExportModelRequestOutputConfig": { + "description": "Output configuration for the Model export.", + "id": "GoogleCloudAiplatformV1ExportModelRequestOutputConfig", "properties": { - "prompt": { - "description": "Optional. Data used to populate placeholder `prompt` in a metric prompt template.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData" - }, - "rubricGroups": { - "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", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1RubricGroup" - } - }, - "response": { - "description": "Optional. Data used to populate placeholder `response` in a metric prompt template.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData" - }, - "reference": { - "description": "Optional. Data used to populate placeholder `reference` in a metric prompt template.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData" + "artifactDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "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`." }, - "otherData": { - "description": "Optional. Other data used to populate placeholders based on their key.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceMapInstance" + "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" }, - "agentData": { - "description": "Optional. Data used for agent evaluation.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentData" + "imageDestination": { + "$ref": "GoogleCloudAiplatformV1ContainerRegistryDestination", + "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`." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationInstanceInstanceData": { - "id": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", - "description": "Instance data used to populate placeholders in a metric prompt template.", - "type": "object", + "GoogleCloudAiplatformV1ExportModelResponse": { + "description": "Response message of ModelService.ExportModel operation.", + "id": "GoogleCloudAiplatformV1ExportModelResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest": { + "description": "Request message for TensorboardService.ExportTensorboardTimeSeriesData.", + "id": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest", "properties": { - "text": { - "description": "Text data.", + "filter": { + "description": "Exports the TensorboardTimeSeries' data that match the filter expression.", "type": "string" }, - "contents": { - "description": "List of Gemini content data.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents" - } - } - }, - "GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents": { - "id": "GoogleCloudAiplatformV1EvaluationInstanceInstanceDataContents", - "description": "List of standard Content messages from Gemini API.", - "type": "object", - "properties": { - "contents": { - "description": "Optional. Repeated contents.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Content" - } + "orderBy": { + "description": "Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data is returned in a pseudo random order.", + "type": "string" + }, + "pageSize": { + "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.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "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.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RubricGroup": { - "id": "GoogleCloudAiplatformV1RubricGroup", - "description": "A group of rubrics, used for grouping rubrics based on a metric or a version.", - "type": "object", + "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse": { + "description": "Response message for TensorboardService.ExportTensorboardTimeSeriesData.", + "id": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse", "properties": { - "groupId": { - "description": "Unique identifier for the group.", - "type": "string" - }, - "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\".", + "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" }, - "rubrics": { - "description": "Rubrics that are part of this group.", - "type": "array", + "timeSeriesDataPoints": { + "description": "The returned time series data points.", "items": { - "$ref": "GoogleCloudAiplatformV1Rubric" - } + "$ref": "GoogleCloudAiplatformV1TimeSeriesDataPoint" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Rubric": { - "id": "GoogleCloudAiplatformV1Rubric", - "description": "Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.", - "type": "object", + "GoogleCloudAiplatformV1ExternalApi": { + "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.", + "id": "GoogleCloudAiplatformV1ExternalApi", "properties": { - "rubricId": { - "description": "Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.", + "apiAuth": { + "$ref": "GoogleCloudAiplatformV1ApiAuth", + "deprecated": true, + "description": "The authentication config to access the API. Deprecated. Please use auth_config instead." + }, + "apiSpec": { + "description": "The API spec that the external API implements.", + "enum": [ + "API_SPEC_UNSPECIFIED", + "SIMPLE_SEARCH", + "ELASTIC_SEARCH" + ], + "enumDescriptions": [ + "Unspecified API spec. This value should not be used.", + "Simple search API spec.", + "Elastic search API spec." + ], "type": "string" }, - "content": { - "description": "Required. The actual testable criteria for the rubric.", - "$ref": "GoogleCloudAiplatformV1RubricContent" + "authConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfig", + "description": "The authentication config to access the API." }, - "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\".", + "elasticSearchParams": { + "$ref": "GoogleCloudAiplatformV1ExternalApiElasticSearchParams", + "description": "Parameters for the elastic search 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" }, - "importance": { - "description": "Optional. The relative importance of this rubric.", - "type": "string", - "enumDescriptions": [ - "Importance is not specified.", - "High importance.", - "Medium importance.", - "Low importance." - ], - "enum": [ - "IMPORTANCE_UNSPECIFIED", - "HIGH", - "MEDIUM", - "LOW" - ] - } - } - }, - "GoogleCloudAiplatformV1RubricContent": { - "id": "GoogleCloudAiplatformV1RubricContent", - "description": "Content of the rubric, defining the testable criteria.", - "type": "object", - "properties": { - "property": { - "description": "Evaluation criteria based on a specific property.", - "$ref": "GoogleCloudAiplatformV1RubricContentProperty" + "simpleSearchParams": { + "$ref": "GoogleCloudAiplatformV1ExternalApiSimpleSearchParams", + "description": "Parameters for the simple search API." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RubricContentProperty": { - "id": "GoogleCloudAiplatformV1RubricContentProperty", - "description": "Defines criteria based on a specific property.", - "type": "object", + "GoogleCloudAiplatformV1ExternalApiElasticSearchParams": { + "description": "The search parameters to use for the ELASTIC_SEARCH spec.", + "id": "GoogleCloudAiplatformV1ExternalApiElasticSearchParams", "properties": { - "description": { - "description": "Description of the property being evaluated. Example: \"The model's response is grammatically correct.\"", + "index": { + "description": "The ElasticSearch index to use.", + "type": "string" + }, + "numHits": { + "description": "Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.", + "format": "int32", + "type": "integer" + }, + "searchTemplate": { + "description": "The ElasticSearch search template to use.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationInstanceMapInstance": { - "id": "GoogleCloudAiplatformV1EvaluationInstanceMapInstance", - "description": "Instance data specified as a map.", - "type": "object", - "properties": { - "mapInstance": { - "description": "Optional. Map of instance data.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData" - } - } - } + "GoogleCloudAiplatformV1ExternalApiSimpleSearchParams": { + "description": "The search parameters to use for SIMPLE_SEARCH spec.", + "id": "GoogleCloudAiplatformV1ExternalApiSimpleSearchParams", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationInstanceAgentData": { - "id": "GoogleCloudAiplatformV1EvaluationInstanceAgentData", - "description": "Contains data specific to agent evaluations.", - "type": "object", + "GoogleCloudAiplatformV1Fact": { + "description": "The fact used in grounding.", + "id": "GoogleCloudAiplatformV1Fact", "properties": { - "toolsText": { - "description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. Example: [ { \"name\": \"search_actors\", \"description\": \"Search for actors in a movie. Returns a list of actors, their roles, their birthdate, and their place of birth.\", \"parameters\": [ { \"name\": \"movie_name\", \"description\": \"The name of the movie.\" }, { \"name\": \"character_name\", \"description\": \"The name of the character.\" } ], \"required\": [\"movie_name\", \"character_name\"] } ]", - "deprecated": true, + "chunk": { + "$ref": "GoogleCloudAiplatformV1RagChunk", + "description": "If present, chunk properties." + }, + "query": { + "description": "Query that is used to retrieve this fact.", "type": "string" }, - "tools": { - "description": "List of tools.", - "deprecated": true, - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools" + "score": { + "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.", + "format": "double", + "type": "number" }, - "events": { - "description": "A list of events.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents" + "summary": { + "description": "If present, the summary/snippet of the fact.", + "type": "string" }, - "developerInstruction": { - "description": "Optional. A field containing instructions from the developer for the agent.", - "deprecated": true, - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData" + "title": { + "description": "If present, it refers to the title of this fact.", + "type": "string" }, - "agentConfig": { - "description": "Optional. Agent configuration.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig" + "uri": { + "description": "If present, this uri links to the source of the fact.", + "type": "string" + }, + "vectorDistance": { + "deprecated": true, + "description": "If present, the distance between the query vector and this fact vector.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools": { - "id": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools", - "description": "Represents a list of tools for an agent.", - "type": "object", + "GoogleCloudAiplatformV1FasterDeploymentConfig": { + "description": "Configuration for faster model deployment.", + "id": "GoogleCloudAiplatformV1FasterDeploymentConfig", "properties": { - "tool": { - "description": "Optional. List of tools: each tool can have multiple function declarations.", - "deprecated": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Tool" - } + "fastTryoutEnabled": { + "description": "If true, enable fast tryout feature for this deployed model.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Tool": { - "id": "GoogleCloudAiplatformV1Tool", - "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).", - "type": "object", + "GoogleCloudAiplatformV1Feature": { + "description": "Feature Metadata information. For example, color is a feature that describes an apple.", + "id": "GoogleCloudAiplatformV1Feature", "properties": { - "functionDeclarations": { - "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1FunctionDeclaration" - } + "createTime": { + "description": "Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "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": "GoogleCloudAiplatformV1Retrieval" + "description": { + "description": "Description of the Feature.", + "type": "string" }, - "googleSearch": { - "description": "Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", - "$ref": "GoogleCloudAiplatformV1ToolGoogleSearch" + "disableMonitoring": { + "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.", + "type": "boolean" }, - "googleSearchRetrieval": { - "description": "Optional. Specialized retrieval tool that is powered by Google Search.", - "deprecated": true, - "$ref": "GoogleCloudAiplatformV1GoogleSearchRetrieval" + "etag": { + "description": "Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" }, - "googleMaps": { - "description": "Optional. GoogleMaps tool type. Tool to support Google Maps in Model.", - "$ref": "GoogleCloudAiplatformV1GoogleMaps" + "labels": { + "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.", + "type": "object" }, - "enterpriseWebSearch": { - "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.", - "$ref": "GoogleCloudAiplatformV1EnterpriseWebSearch" + "monitoringStatsAnomalies": { + "description": "Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.", + "items": { + "$ref": "GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly" + }, + "readOnly": true, + "type": "array" }, - "codeExecution": { - "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation.", - "$ref": "GoogleCloudAiplatformV1ToolCodeExecution" + "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" }, - "urlContext": { - "description": "Optional. Tool to support URL context retrieval.", - "$ref": "GoogleCloudAiplatformV1UrlContext" + "pointOfContact": { + "description": "Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.", + "type": "string" }, - "computerUse": { - "description": "Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.", - "$ref": "GoogleCloudAiplatformV1ToolComputerUse" + "updateTime": { + "description": "Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "valueType": { + "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" + ], + "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." + ], + "type": "string" + }, + "versionColumnName": { + "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.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FunctionDeclaration": { - "id": "GoogleCloudAiplatformV1FunctionDeclaration", - "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.", - "type": "object", + "GoogleCloudAiplatformV1FeatureGroup": { + "description": "Vertex AI Feature Group.", + "id": "GoogleCloudAiplatformV1FeatureGroup", "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 and dashes, with a maximum length of 64.", + "bigQuery": { + "$ref": "GoogleCloudAiplatformV1FeatureGroupBigQuery", + "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`." + }, + "createTime": { + "description": "Output only. Timestamp when this FeatureGroup was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, "description": { - "description": "Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.", + "description": "Optional. Description of the FeatureGroup.", "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": "GoogleCloudAiplatformV1Schema" + "etag": { + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" }, - "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" + "labels": { + "additionalProperties": { + "type": "string" + }, + "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" }, - "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": "GoogleCloudAiplatformV1Schema" + "name": { + "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", + "type": "string" }, - "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" + "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.", + "readOnly": true, + "type": "string" + }, + "serviceAgentType": { + "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.", + "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." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this FeatureGroup was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Retrieval": { - "id": "GoogleCloudAiplatformV1Retrieval", - "description": "Defines a retrieval tool that model can call to access external knowledge.", - "type": "object", + "GoogleCloudAiplatformV1FeatureGroupBigQuery": { + "description": "Input source type for BigQuery Tables and Views.", + "id": "GoogleCloudAiplatformV1FeatureGroupBigQuery", "properties": { - "vertexAiSearch": { - "description": "Set to use data source powered by Vertex AI Search.", - "$ref": "GoogleCloudAiplatformV1VertexAISearch" + "bigQuerySource": { + "$ref": "GoogleCloudAiplatformV1BigQuerySource", + "description": "Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View." }, - "vertexRagStore": { - "description": "Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.", - "$ref": "GoogleCloudAiplatformV1VertexRagStore" + "dense": { + "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.", + "type": "boolean" }, - "externalApi": { - "description": "Use data source powered by external API for grounding.", - "$ref": "GoogleCloudAiplatformV1ExternalApi" + "entityIdColumns": { + "description": "Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`.", + "items": { + "type": "string" + }, + "type": "array" }, - "disableAttribution": { - "description": "Optional. Deprecated. This option is no longer supported.", - "deprecated": true, + "staticDataSource": { + "description": "Optional. Set if the data source is not a time-series.", "type": "boolean" + }, + "timeSeries": { + "$ref": "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries", + "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." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1VertexAISearch": { - "id": "GoogleCloudAiplatformV1VertexAISearch", - "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", - "type": "object", + "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries": { + "id": "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries", "properties": { - "datastore": { - "description": "Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", + "timestampColumn": { + "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": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly": { + "description": "A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.", + "id": "GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly", + "properties": { + "featureStatsAnomaly": { + "$ref": "GoogleCloudAiplatformV1FeatureStatsAnomaly", + "description": "Output only. The stats and anomalies generated at specific timestamp.", + "readOnly": true }, - "engine": { - "description": "Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", + "objective": { + "description": "Output only. The objective for each stats.", + "enum": [ + "OBJECTIVE_UNSPECIFIED", + "IMPORT_FEATURE_ANALYSIS", + "SNAPSHOT_ANALYSIS" + ], + "enumDescriptions": [ + "If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty.", + "Stats are generated by Import Feature Analysis.", + "Stats are generated by Snapshot Analysis." + ], + "readOnly": true, "type": "string" - }, - "maxResults": { - "description": "Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.", - "type": "integer", - "format": "int32" - }, - "filter": { - "description": "Optional. Filter strings to be passed to the search API.", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FeatureNoiseSigma": { + "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.", + "id": "GoogleCloudAiplatformV1FeatureNoiseSigma", + "properties": { + "noiseSigma": { + "description": "Noise sigma per feature. No noise is added to features that are not set.", + "items": { + "$ref": "GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature": { + "description": "Noise sigma for a single feature.", + "id": "GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature", + "properties": { + "name": { + "description": "The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.", "type": "string" }, - "dataStoreSpecs": { - "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", - "items": { - "$ref": "GoogleCloudAiplatformV1VertexAISearchDataStoreSpec" - } + "sigma": { + "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", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1VertexAISearchDataStoreSpec": { - "id": "GoogleCloudAiplatformV1VertexAISearchDataStoreSpec", - "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", - "type": "object", + "GoogleCloudAiplatformV1FeatureOnlineStore": { + "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.", + "id": "GoogleCloudAiplatformV1FeatureOnlineStore", "properties": { - "dataStore": { - "description": "Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", + "bigtable": { + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtable", + "description": "Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore." + }, + "createTime": { + "description": "Output only. Timestamp when this FeatureOnlineStore was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "filter": { - "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)", + "dedicatedServingEndpoint": { + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint", + "description": "Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint." + }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "description": "Optional. Customer-managed encryption key spec for data storage. If set, online store will be secured by this key." + }, + "etag": { + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "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" + }, + "name": { + "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", + "type": "string" + }, + "optimized": { + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreOptimized", + "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." + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. State of the featureOnlineStore.", + "enum": [ + "STATE_UNSPECIFIED", + "STABLE", + "UPDATING" + ], + "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." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this FeatureOnlineStore was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1VertexRagStore": { - "id": "GoogleCloudAiplatformV1VertexRagStore", - "description": "Retrieve from Vertex RAG Store for grounding.", - "type": "object", + "GoogleCloudAiplatformV1FeatureOnlineStoreBigtable": { + "id": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtable", "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": "GoogleCloudAiplatformV1VertexRagStoreRagResource" - } + "autoScaling": { + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling", + "description": "Required. Autoscaling config applied to Bigtable Instance." }, - "similarityTopK": { - "description": "Optional. Number of top k results to return from the selected corpora.", - "deprecated": true, - "type": "integer", - "format": "int32" + "bigtableMetadata": { + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableBigtableMetadata", + "description": "Output only. Metadata of the Bigtable instance. Output only.", + "readOnly": true }, - "vectorDistanceThreshold": { - "description": "Optional. Only return results with vector distance smaller than the threshold.", - "deprecated": true, - "type": "number", - "format": "double" + "enableDirectBigtableAccess": { + "description": "Optional. It true, enable direct access to the Bigtable instance.", + "type": "boolean" }, - "ragRetrievalConfig": { - "description": "Optional. The retrieval config for the Rag query.", - "$ref": "GoogleCloudAiplatformV1RagRetrievalConfig" + "zone": { + "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": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1VertexRagStoreRagResource": { - "id": "GoogleCloudAiplatformV1VertexRagStoreRagResource", - "description": "The definition of the Rag resource.", - "type": "object", + "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling": { + "id": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling", "properties": { - "ragCorpus": { - "description": "Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", - "type": "string" + "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%.", + "format": "int32", + "type": "integer" }, - "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" - } + "maxNodeCount": { + "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'.", + "format": "int32", + "type": "integer" + }, + "minNodeCount": { + "description": "Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagRetrievalConfig": { - "id": "GoogleCloudAiplatformV1RagRetrievalConfig", - "description": "Specifies the context retrieval config.", - "type": "object", + "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableBigtableMetadata": { + "description": "Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project.", + "id": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableBigtableMetadata", "properties": { - "topK": { - "description": "Optional. The number of contexts to retrieve.", - "type": "integer", - "format": "int32" + "instanceId": { + "description": "The Cloud Bigtable instance id.", + "type": "string" }, - "filter": { - "description": "Optional. Config for filters.", - "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigFilter" + "tableId": { + "description": "The Cloud Bigtable table id.", + "type": "string" }, - "ranking": { - "description": "Optional. Config for ranking and reranking.", - "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigRanking" + "tenantProjectId": { + "description": "Tenant project ID.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagRetrievalConfigFilter": { - "id": "GoogleCloudAiplatformV1RagRetrievalConfigFilter", - "description": "Config for filters.", - "type": "object", + "GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint": { + "description": "The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default.", + "id": "GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint", "properties": { - "vectorDistanceThreshold": { - "description": "Optional. Only returns contexts with vector distance smaller than the threshold.", - "type": "number", - "format": "double" + "privateServiceConnectConfig": { + "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", + "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." }, - "vectorSimilarityThreshold": { - "description": "Optional. Only returns contexts with vector similarity larger than the threshold.", - "type": "number", - "format": "double" + "publicEndpointDomainName": { + "description": "Output only. This field will be populated with the domain name to use for this FeatureOnlineStore", + "readOnly": true, + "type": "string" }, - "metadataFilter": { - "description": "Optional. String for metadata filtering.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagRetrievalConfigRanking": { - "id": "GoogleCloudAiplatformV1RagRetrievalConfigRanking", - "description": "Config for ranking and reranking.", - "type": "object", - "properties": { - "rankService": { - "description": "Optional. Config for Rank Service.", - "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService" - }, - "llmRanker": { - "description": "Optional. Config for LlmRanker.", - "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker" - } - } + "GoogleCloudAiplatformV1FeatureOnlineStoreOptimized": { + "description": "Optimized storage type", + "id": "GoogleCloudAiplatformV1FeatureOnlineStoreOptimized", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService": { - "id": "GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService", - "description": "Config for Rank Service.", - "type": "object", + "GoogleCloudAiplatformV1FeatureSelector": { + "description": "Selector for Features of an EntityType.", + "id": "GoogleCloudAiplatformV1FeatureSelector", "properties": { - "modelName": { - "description": "Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`", - "type": "string" + "idMatcher": { + "$ref": "GoogleCloudAiplatformV1IdMatcher", + "description": "Required. Matches Features based on ID." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker": { - "id": "GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker", - "description": "Config for LlmRanker.", - "type": "object", + "GoogleCloudAiplatformV1FeatureStatsAnomaly": { + "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.", + "id": "GoogleCloudAiplatformV1FeatureStatsAnomaly", "properties": { - "modelName": { - "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).", + "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.", + "format": "double", + "type": "number" + }, + "anomalyUri": { + "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).", + "type": "string" + }, + "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.", + "format": "double", + "type": "number" + }, + "startTime": { + "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", + "type": "string" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExternalApi": { - "id": "GoogleCloudAiplatformV1ExternalApi", - "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.", - "type": "object", + "GoogleCloudAiplatformV1FeatureValue": { + "description": "Value for a feature.", + "id": "GoogleCloudAiplatformV1FeatureValue", "properties": { - "simpleSearchParams": { - "description": "Parameters for the simple search API.", - "$ref": "GoogleCloudAiplatformV1ExternalApiSimpleSearchParams" + "boolArrayValue": { + "$ref": "GoogleCloudAiplatformV1BoolArray", + "description": "A list of bool type feature value." }, - "elasticSearchParams": { - "description": "Parameters for the elastic search API.", - "$ref": "GoogleCloudAiplatformV1ExternalApiElasticSearchParams" + "boolValue": { + "description": "Bool type feature value.", + "type": "boolean" }, - "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" - ] + "bytesValue": { + "description": "Bytes feature value.", + "format": "byte", + "type": "string" }, - "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", + "doubleArrayValue": { + "$ref": "GoogleCloudAiplatformV1DoubleArray", + "description": "A list of double type feature value." + }, + "doubleValue": { + "description": "Double type feature value.", + "format": "double", + "type": "number" + }, + "int64ArrayValue": { + "$ref": "GoogleCloudAiplatformV1Int64Array", + "description": "A list of int64 type feature value." + }, + "int64Value": { + "description": "Int64 feature value.", + "format": "int64", "type": "string" }, - "apiAuth": { - "description": "The authentication config to access the API. Deprecated. Please use auth_config instead.", - "deprecated": true, - "$ref": "GoogleCloudAiplatformV1ApiAuth" + "metadata": { + "$ref": "GoogleCloudAiplatformV1FeatureValueMetadata", + "description": "Metadata of feature value." }, - "authConfig": { - "description": "The authentication config to access the API.", - "$ref": "GoogleCloudAiplatformV1AuthConfig" + "stringArrayValue": { + "$ref": "GoogleCloudAiplatformV1StringArray", + "description": "A list of string type feature value." + }, + "stringValue": { + "description": "String feature value.", + "type": "string" + }, + "structValue": { + "$ref": "GoogleCloudAiplatformV1StructValue", + "description": "A struct type feature value." } - } - }, - "GoogleCloudAiplatformV1ExternalApiSimpleSearchParams": { - "id": "GoogleCloudAiplatformV1ExternalApiSimpleSearchParams", - "description": "The search parameters to use for SIMPLE_SEARCH spec.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExternalApiElasticSearchParams": { - "id": "GoogleCloudAiplatformV1ExternalApiElasticSearchParams", - "description": "The search parameters to use for the ELASTIC_SEARCH spec.", - "type": "object", + "GoogleCloudAiplatformV1FeatureValueDestination": { + "description": "A destination location for Feature values and format.", + "id": "GoogleCloudAiplatformV1FeatureValueDestination", "properties": { - "index": { - "description": "The ElasticSearch index to use.", - "type": "string" + "bigqueryDestination": { + "$ref": "GoogleCloudAiplatformV1BigQueryDestination", + "description": "Output in BigQuery format. BigQueryDestination.output_uri in FeatureValueDestination.bigquery_destination must refer to a table." }, - "searchTemplate": { - "description": "The ElasticSearch search template to use.", - "type": "string" + "csvDestination": { + "$ref": "GoogleCloudAiplatformV1CsvDestination", + "description": "Output in CSV format. Array Feature value types are not allowed in CSV format." }, - "numHits": { - "description": "Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.", - "type": "integer", - "format": "int32" + "tfrecordDestination": { + "$ref": "GoogleCloudAiplatformV1TFRecordDestination", + "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 -> byte_string(\"true\"), false -> byte_string(\"false\") BOOL, BOOL_ARRAY (true, false) | BYTES_LIST" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ApiAuth": { - "id": "GoogleCloudAiplatformV1ApiAuth", - "description": "The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead.", - "type": "object", + "GoogleCloudAiplatformV1FeatureValueList": { + "description": "Container for list of values.", + "id": "GoogleCloudAiplatformV1FeatureValueList", "properties": { - "apiKeyConfig": { - "description": "The API secret.", - "$ref": "GoogleCloudAiplatformV1ApiAuthApiKeyConfig" + "values": { + "description": "A list of feature values. All of them should be the same data type.", + "items": { + "$ref": "GoogleCloudAiplatformV1FeatureValue" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ApiAuthApiKeyConfig": { - "id": "GoogleCloudAiplatformV1ApiAuthApiKeyConfig", - "description": "The API secret.", - "type": "object", + "GoogleCloudAiplatformV1FeatureValueMetadata": { + "description": "Metadata of feature value.", + "id": "GoogleCloudAiplatformV1FeatureValueMetadata", "properties": { - "apiKeySecretVersion": { - "description": "Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}", - "type": "string" - }, - "apiKeyString": { - "description": "The API key string. Either this or `api_key_secret_version` must be set.", + "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" }, - "GoogleCloudAiplatformV1AuthConfig": { - "id": "GoogleCloudAiplatformV1AuthConfig", - "description": "Auth configuration to run the extension.", - "type": "object", + "GoogleCloudAiplatformV1FeatureView": { + "description": "FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.", + "id": "GoogleCloudAiplatformV1FeatureView", "properties": { - "apiKeyConfig": { - "description": "Config for API key auth.", - "$ref": "GoogleCloudAiplatformV1AuthConfigApiKeyConfig" + "bigQuerySource": { + "$ref": "GoogleCloudAiplatformV1FeatureViewBigQuerySource", + "description": "Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore." }, - "httpBasicAuthConfig": { - "description": "Config for HTTP Basic auth.", - "$ref": "GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig" + "bigtableMetadata": { + "$ref": "GoogleCloudAiplatformV1FeatureViewBigtableMetadata", + "description": "Output only. Metadata containing information about the Cloud Bigtable.", + "readOnly": true }, - "googleServiceAccountConfig": { - "description": "Config for Google Service Account auth.", - "$ref": "GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig" + "createTime": { + "description": "Output only. Timestamp when this FeatureView was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "oauthConfig": { - "description": "Config for user oauth.", - "$ref": "GoogleCloudAiplatformV1AuthConfigOauthConfig" + "etag": { + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" }, - "oidcConfig": { - "description": "Config for user OIDC auth.", - "$ref": "GoogleCloudAiplatformV1AuthConfigOidcConfig" + "featureRegistrySource": { + "$ref": "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource", + "description": "Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore." + }, + "indexConfig": { + "$ref": "GoogleCloudAiplatformV1FeatureViewIndexConfig", + "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." + }, + "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" }, - "authType": { - "description": "Type of auth scheme.", - "type": "string", - "enumDescriptions": [ - "", - "No Auth.", - "API Key Auth.", - "HTTP Basic Auth.", - "Google Service Account Auth.", - "OAuth auth.", - "OpenID Connect (OIDC) Auth." - ], - "enum": [ - "AUTH_TYPE_UNSPECIFIED", - "NO_AUTH", - "API_KEY_AUTH", - "HTTP_BASIC_AUTH", - "GOOGLE_SERVICE_ACCOUNT_AUTH", - "OAUTH", - "OIDC_AUTH" - ] - } - } - }, - "GoogleCloudAiplatformV1AuthConfigApiKeyConfig": { - "id": "GoogleCloudAiplatformV1AuthConfigApiKeyConfig", - "description": "Config for authentication with API key.", - "type": "object", - "properties": { "name": { - "description": "Optional. The parameter name of the API key. E.g. If the API request is \"https://example.com/act?api_key=\", \"api_key\" would be the parameter name.", + "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "type": "string" }, - "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" + "optimizedConfig": { + "$ref": "GoogleCloudAiplatformV1FeatureViewOptimizedConfig", + "description": "Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore." }, - "apiKeyString": { - "description": "Optional. The API key to be used in the request directly.", + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "serviceAccountEmail": { + "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.", + "readOnly": true, "type": "string" }, - "httpElementLocation": { - "description": "Optional. The location of the API key.", - "type": "string", + "serviceAgentType": { + "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.", + "enum": [ + "SERVICE_AGENT_TYPE_UNSPECIFIED", + "SERVICE_AGENT_TYPE_PROJECT", + "SERVICE_AGENT_TYPE_FEATURE_VIEW" + ], "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." + "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." ], - "enum": [ - "HTTP_IN_UNSPECIFIED", - "HTTP_IN_QUERY", - "HTTP_IN_HEADER", - "HTTP_IN_PATH", - "HTTP_IN_BODY", - "HTTP_IN_COOKIE" - ] + "type": "string" + }, + "syncConfig": { + "$ref": "GoogleCloudAiplatformV1FeatureViewSyncConfig", + "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." + }, + "updateTime": { + "description": "Output only. Timestamp when this FeatureView was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "vertexRagSource": { + "$ref": "GoogleCloudAiplatformV1FeatureViewVertexRagSource", + "description": "Optional. The Vertex RAG Source that the FeatureView is linked to." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig": { - "id": "GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig", - "description": "Config for HTTP Basic Authentication.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewBigQuerySource": { + "id": "GoogleCloudAiplatformV1FeatureViewBigQuerySource", "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.", + "entityIdColumns": { + "description": "Required. Columns to construct entity_id / row keys.", + "items": { + "type": "string" + }, + "type": "array" + }, + "uri": { + "description": "Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig": { - "id": "GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig", - "description": "Config for Google Service Account Authentication.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewBigtableMetadata": { + "description": "Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances.", + "id": "GoogleCloudAiplatformV1FeatureViewBigtableMetadata", "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.", + "readAppProfile": { + "description": "Output only. The Bigtable App Profile to use for reading from Bigtable.", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AuthConfigOauthConfig": { - "id": "GoogleCloudAiplatformV1AuthConfigOauthConfig", - "description": "Config for user oauth.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewDataKey": { + "description": "Lookup key for a feature view.", + "id": "GoogleCloudAiplatformV1FeatureViewDataKey", "properties": { - "accessToken": { - "description": "Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.", - "type": "string" + "compositeKey": { + "$ref": "GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey", + "description": "The actual Entity ID will be composed from this struct. This should match with the way ID is defined in the FeatureView spec." }, - "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.", + "key": { + "description": "String key to use for lookup.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AuthConfigOidcConfig": { - "id": "GoogleCloudAiplatformV1AuthConfigOidcConfig", - "description": "Config for user OIDC auth.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey": { + "description": "ID that is comprised from several parts (columns).", + "id": "GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey", "properties": { - "idToken": { - "description": "OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.", - "type": "string" - }, - "serviceAccount": { - "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).", - "type": "string" + "parts": { + "description": "Parts to construct Entity ID. Should match with the same ID columns as defined in FeatureView in the same order.", + "items": { + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolGoogleSearch": { - "id": "GoogleCloudAiplatformV1ToolGoogleSearch", - "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewDirectWriteRequest": { + "description": "Request message for FeatureOnlineStoreService.FeatureViewDirectWrite.", + "id": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequest", "properties": { - "excludeDomains": { - "description": "Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: [\"amazon.com\", \"facebook.com\"].", - "type": "array", + "dataKeyAndFeatureValues": { + "description": "Required. The data keys and associated feature values.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValues" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValues": { + "description": "A data key and associated feature values to write to the feature view.", + "id": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValues", + "properties": { + "dataKey": { + "$ref": "GoogleCloudAiplatformV1FeatureViewDataKey", + "description": "The data key." }, - "blockingConfidence": { - "description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", - "type": "string", - "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" - ] + "features": { + "description": "List of features to write.", + "items": { + "$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GoogleSearchRetrieval": { - "id": "GoogleCloudAiplatformV1GoogleSearchRetrieval", - "description": "Tool to retrieve public web data for grounding, powered by Google.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature": { + "description": "Feature name & value pair.", + "id": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature", "properties": { - "dynamicRetrievalConfig": { - "description": "Specifies the dynamic retrieval configuration for the given source.", - "$ref": "GoogleCloudAiplatformV1DynamicRetrievalConfig" + "name": { + "description": "Feature short name.", + "type": "string" + }, + "value": { + "$ref": "GoogleCloudAiplatformV1FeatureValue", + "description": "Feature value. A user provided timestamp may be set in the `FeatureValue.metadata.generate_time` field." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DynamicRetrievalConfig": { - "id": "GoogleCloudAiplatformV1DynamicRetrievalConfig", - "description": "Describes the options to customize dynamic retrieval.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewDirectWriteResponse": { + "description": "Response message for FeatureOnlineStoreService.FeatureViewDirectWrite.", + "id": "GoogleCloudAiplatformV1FeatureViewDirectWriteResponse", "properties": { - "mode": { - "description": "The mode of the predictor to be used in dynamic retrieval.", - "type": "string", - "enumDescriptions": [ - "Always trigger retrieval.", - "Run retrieval only when system decides it is necessary." - ], - "enum": [ - "MODE_UNSPECIFIED", - "MODE_DYNAMIC" - ] + "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." }, - "dynamicThreshold": { - "description": "Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.", - "type": "number", - "format": "float" + "writeResponses": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteResponseWriteResponse" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GoogleMaps": { - "id": "GoogleCloudAiplatformV1GoogleMaps", - "description": "Tool to retrieve public maps data for grounding, powered by Google.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewDirectWriteResponseWriteResponse": { + "description": "Details about the write for each key.", + "id": "GoogleCloudAiplatformV1FeatureViewDirectWriteResponseWriteResponse", "properties": { - "enableWidget": { - "description": "Optional. If true, include the widget context token in the response.", - "type": "boolean" + "dataKey": { + "$ref": "GoogleCloudAiplatformV1FeatureViewDataKey", + "description": "What key is this write response associated with." + }, + "onlineStoreWriteTime": { + "description": "When the feature values were written to the online store. If FeatureViewDirectWriteResponse.status is not OK, this field is not populated.", + "format": "google-datetime", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EnterpriseWebSearch": { - "id": "GoogleCloudAiplatformV1EnterpriseWebSearch", - "description": "Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource": { + "description": "A Feature Registry source for features that need to be synced to Online Store.", + "id": "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource", "properties": { - "excludeDomains": { - "description": "Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.", - "type": "array", + "featureGroups": { + "description": "Required. List of features that need to be synced to Online Store.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup" + }, + "type": "array" }, - "blockingConfidence": { - "description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", - "type": "string", - "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" - ] + "projectNumber": { + "description": "Optional. The project number of the parent project of the Feature Groups.", + "format": "int64", + "type": "string" } - } - }, - "GoogleCloudAiplatformV1ToolCodeExecution": { - "id": "GoogleCloudAiplatformV1ToolCodeExecution", - "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.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1UrlContext": { - "id": "GoogleCloudAiplatformV1UrlContext", - "description": "Tool to support URL context.", - "type": "object", - "properties": {} + "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup": { + "description": "Features belonging to a single feature group that will be synced to Online Store.", + "id": "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup", + "properties": { + "featureGroupId": { + "description": "Required. Identifier of the feature group.", + "type": "string" + }, + "featureIds": { + "description": "Required. Identifiers of features under the feature group.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolComputerUse": { - "id": "GoogleCloudAiplatformV1ToolComputerUse", - "description": "Tool to support computer use.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewIndexConfig": { + "description": "Configuration for vector indexing.", + "id": "GoogleCloudAiplatformV1FeatureViewIndexConfig", "properties": { - "environment": { - "description": "Required. The environment being operated.", - "type": "string", + "bruteForceConfig": { + "$ref": "GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig", + "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." + }, + "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" + }, + "distanceMeasureType": { + "description": "Optional. The distance measure used in nearest neighbor search.", + "enum": [ + "DISTANCE_MEASURE_TYPE_UNSPECIFIED", + "SQUARED_L2_DISTANCE", + "COSINE_DISTANCE", + "DOT_PRODUCT_DISTANCE" + ], "enumDescriptions": [ - "Defaults to browser.", - "Operates in a web browser." + "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." ], - "enum": [ - "ENVIRONMENT_UNSPECIFIED", - "ENVIRONMENT_BROWSER" - ] + "type": "string" }, - "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", + "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" + }, + "embeddingDimension": { + "description": "Optional. The number of dimensions of the input embedding.", + "format": "int32", + "type": "integer" + }, + "filterColumns": { + "description": "Optional. Columns of features that're used to filter vector search results.", "items": { "type": "string" - } + }, + "type": "array" + }, + "treeAhConfig": { + "$ref": "GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents": { - "id": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents", - "description": "Represents a list of events for an agent.", - "type": "object", - "properties": { - "event": { - "description": "Optional. A list of events.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Content" - } - } - } + "GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig": { + "description": "Configuration options for using brute force search.", + "id": "GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig": { - "id": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig", - "description": "Configuration for an Agent.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig": { + "description": "Configuration options for the tree-AH algorithm.", + "id": "GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig", "properties": { - "toolsText": { - "description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters.", + "leafNodeEmbeddingCount": { + "description": "Optional. Number of embeddings on each leaf node. The default value is 1000 if not set.", + "format": "int64", "type": "string" - }, - "tools": { - "description": "List of tools.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools" - }, - "developerInstruction": { - "description": "Optional. A field containing instructions from the developer for the agent.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools": { - "id": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools", - "description": "Represents a list of tools for an agent.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewOptimizedConfig": { + "description": "Configuration for FeatureViews created in Optimized FeatureOnlineStore.", + "id": "GoogleCloudAiplatformV1FeatureViewOptimizedConfig", "properties": { - "tool": { - "description": "Optional. List of tools: each tool can have multiple function declarations.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Tool" - } + "automaticResources": { + "$ref": "GoogleCloudAiplatformV1AutomaticResources", + "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." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluateInstancesResponse": { - "id": "GoogleCloudAiplatformV1EvaluateInstancesResponse", - "description": "Response message for EvaluationService.EvaluateInstances.", - "type": "object", + "GoogleCloudAiplatformV1FeatureViewSync": { + "description": "FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store.", + "id": "GoogleCloudAiplatformV1FeatureViewSync", "properties": { - "exactMatchResults": { - "description": "Auto metric evaluation results. Results for exact match metric.", - "$ref": "GoogleCloudAiplatformV1ExactMatchResults" - }, - "bleuResults": { - "description": "Results for bleu metric.", - "$ref": "GoogleCloudAiplatformV1BleuResults" - }, - "rougeResults": { - "description": "Results for rouge metric.", - "$ref": "GoogleCloudAiplatformV1RougeResults" - }, - "fluencyResult": { - "description": "LLM-based metric evaluation result. General text generation metrics, applicable to other categories. Result for fluency metric.", - "$ref": "GoogleCloudAiplatformV1FluencyResult" - }, - "coherenceResult": { - "description": "Result for coherence metric.", - "$ref": "GoogleCloudAiplatformV1CoherenceResult" - }, - "safetyResult": { - "description": "Result for safety metric.", - "$ref": "GoogleCloudAiplatformV1SafetyResult" - }, - "groundednessResult": { - "description": "Result for groundedness metric.", - "$ref": "GoogleCloudAiplatformV1GroundednessResult" - }, - "fulfillmentResult": { - "description": "Result for fulfillment metric.", - "$ref": "GoogleCloudAiplatformV1FulfillmentResult" - }, - "summarizationQualityResult": { - "description": "Summarization only metrics. Result for summarization quality metric.", - "$ref": "GoogleCloudAiplatformV1SummarizationQualityResult" - }, - "pairwiseSummarizationQualityResult": { - "description": "Result for pairwise summarization quality metric.", - "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityResult" - }, - "summarizationHelpfulnessResult": { - "description": "Result for summarization helpfulness metric.", - "$ref": "GoogleCloudAiplatformV1SummarizationHelpfulnessResult" - }, - "summarizationVerbosityResult": { - "description": "Result for summarization verbosity metric.", - "$ref": "GoogleCloudAiplatformV1SummarizationVerbosityResult" - }, - "questionAnsweringQualityResult": { - "description": "Question answering only metrics. Result for question answering quality metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringQualityResult" + "createTime": { + "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": "string" }, - "pairwiseQuestionAnsweringQualityResult": { - "description": "Result for pairwise question answering quality metric.", - "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult" + "finalStatus": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Final status of the FeatureViewSync.", + "readOnly": true }, - "questionAnsweringRelevanceResult": { - "description": "Result for question answering relevance metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult" + "name": { + "description": "Identifier. Name of the FeatureViewSync. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", + "type": "string" }, - "questionAnsweringHelpfulnessResult": { - "description": "Result for question answering helpfulness metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult" + "runTime": { + "$ref": "GoogleTypeInterval", + "description": "Output only. Time when this FeatureViewSync is finished.", + "readOnly": true }, - "questionAnsweringCorrectnessResult": { - "description": "Result for question answering correctness metric.", - "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult" + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" }, - "pointwiseMetricResult": { - "description": "Generic metrics. Result for pointwise metric.", - "$ref": "GoogleCloudAiplatformV1PointwiseMetricResult" + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" }, - "pairwiseMetricResult": { - "description": "Result for pairwise metric.", - "$ref": "GoogleCloudAiplatformV1PairwiseMetricResult" + "syncSummary": { + "$ref": "GoogleCloudAiplatformV1FeatureViewSyncSyncSummary", + "description": "Output only. Summary of the sync job.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FeatureViewSyncConfig": { + "description": "Configuration for Sync. Only one option is set.", + "id": "GoogleCloudAiplatformV1FeatureViewSyncConfig", + "properties": { + "continuous": { + "description": "Optional. If true, syncs the FeatureView in a continuous manner to Online Store.", + "type": "boolean" }, - "toolCallValidResults": { - "description": "Tool call metrics. Results for tool call valid metric.", - "$ref": "GoogleCloudAiplatformV1ToolCallValidResults" + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FeatureViewSyncSyncSummary": { + "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": "GoogleCloudAiplatformV1FeatureViewSyncSyncSummary", + "properties": { + "rowSynced": { + "description": "Output only. Total number of rows synced.", + "format": "int64", + "readOnly": true, + "type": "string" }, - "toolNameMatchResults": { - "description": "Results for tool name match metric.", - "$ref": "GoogleCloudAiplatformV1ToolNameMatchResults" + "systemWatermarkTime": { + "description": "Lower bound of the system time watermark for the sync job. This is only set for continuously syncing feature views.", + "format": "google-datetime", + "type": "string" }, - "toolParameterKeyMatchResults": { - "description": "Results for tool parameter key match metric.", - "$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchResults" + "totalSlot": { + "description": "Output only. BigQuery slot milliseconds consumed for the sync job.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FeatureViewVertexRagSource": { + "description": "A Vertex Rag source for features that need to be synced to Online Store.", + "id": "GoogleCloudAiplatformV1FeatureViewVertexRagSource", + "properties": { + "ragCorpusId": { + "description": "Optional. The RAG corpus id corresponding to this FeatureView.", + "format": "int64", + "type": "string" }, - "toolParameterKvMatchResults": { - "description": "Results for tool parameter key value match metric.", - "$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchResults" + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Featurestore": { + "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": "GoogleCloudAiplatformV1Featurestore", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this Featurestore was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "cometResult": { - "description": "Translation metrics. Result for Comet metric.", - "$ref": "GoogleCloudAiplatformV1CometResult" + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "metricxResult": { - "description": "Result for Metricx metric.", - "$ref": "GoogleCloudAiplatformV1MetricxResult" + "etag": { + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" }, - "trajectoryExactMatchResults": { - "description": "Result for trajectory exact match metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchResults" + "labels": { + "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.", + "type": "object" }, - "trajectoryInOrderMatchResults": { - "description": "Result for trajectory in order match metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchResults" + "name": { + "description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", + "readOnly": true, + "type": "string" }, - "trajectoryAnyOrderMatchResults": { - "description": "Result for trajectory any order match metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchResults" + "onlineServingConfig": { + "$ref": "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig", + "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." }, - "trajectoryPrecisionResults": { - "description": "Result for trajectory precision metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionResults" + "onlineStorageTtlDays": { + "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", + "type": "integer" }, - "trajectoryRecallResults": { - "description": "Results for trajectory recall metric.", - "$ref": "GoogleCloudAiplatformV1TrajectoryRecallResults" + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" }, - "trajectorySingleToolUseResults": { - "description": "Results for trajectory single tool use metric.", - "$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseResults" + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" }, - "rubricBasedInstructionFollowingResult": { - "description": "Result for rubric based instruction following metric.", - "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult" + "state": { + "description": "Output only. State of the featurestore.", + "enum": [ + "STATE_UNSPECIFIED", + "STABLE", + "UPDATING" + ], + "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." + ], + "readOnly": true, + "type": "string" }, - "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": "GoogleCloudAiplatformV1MetricResult" - } - } - } - }, - "GoogleCloudAiplatformV1ExactMatchResults": { - "id": "GoogleCloudAiplatformV1ExactMatchResults", - "description": "Results for exact match metric.", - "type": "object", - "properties": { - "exactMatchMetricValues": { - "description": "Output only. Exact match metric values.", + "updateTime": { + "description": "Output only. Timestamp when this Featurestore was last updated.", + "format": "google-datetime", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ExactMatchMetricValue" - } + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExactMatchMetricValue": { - "id": "GoogleCloudAiplatformV1ExactMatchMetricValue", - "description": "Exact match metric value for an instance.", - "type": "object", + "GoogleCloudAiplatformV1FeaturestoreMonitoringConfig": { + "description": "Configuration of how features in Featurestore are monitored.", + "id": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfig", "properties": { - "score": { - "description": "Output only. Exact match score.", - "readOnly": true, - "type": "number", - "format": "float" + "categoricalThresholdConfig": { + "$ref": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig", + "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": { + "$ref": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis", + "description": "The config for ImportFeatures Analysis Based Feature Monitoring." + }, + "numericalThresholdConfig": { + "$ref": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig", + "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)." + }, + "snapshotAnalysis": { + "$ref": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis", + "description": "The config for Snapshot Analysis Based Feature Monitoring." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BleuResults": { - "id": "GoogleCloudAiplatformV1BleuResults", - "description": "Results for bleu metric.", - "type": "object", + "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis": { + "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.", + "id": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis", "properties": { - "bleuMetricValues": { - "description": "Output only. Bleu metric values.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1BleuMetricValue" - } + "anomalyDetectionBaseline": { + "description": "The baseline used to do anomaly detection for the statistics generated by import features analysis.", + "enum": [ + "BASELINE_UNSPECIFIED", + "LATEST_STATS", + "MOST_RECENT_SNAPSHOT_STATS", + "PREVIOUS_IMPORT_FEATURES_STATS" + ], + "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": "string" + }, + "state": { + "description": "Whether to enable / disable / inherite default hebavior for import features analysis.", + "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." + ], + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BleuMetricValue": { - "id": "GoogleCloudAiplatformV1BleuMetricValue", - "description": "Bleu metric value for an instance.", - "type": "object", + "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis": { + "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.", + "id": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis", "properties": { - "score": { - "description": "Output only. Bleu score.", - "readOnly": true, - "type": "number", - "format": "float" + "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" + }, + "monitoringIntervalDays": { + "description": "Configuration of the snapshot analysis based monitoring pipeline running interval. The value indicates number of days.", + "format": "int32", + "type": "integer" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RougeResults": { - "id": "GoogleCloudAiplatformV1RougeResults", - "description": "Results for rouge metric.", - "type": "object", + "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig": { + "description": "The config for Featurestore Monitoring threshold.", + "id": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig", "properties": { - "rougeMetricValues": { - "description": "Output only. Rouge metric values.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1RougeMetricValue" - } + "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.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RougeMetricValue": { - "id": "GoogleCloudAiplatformV1RougeMetricValue", - "description": "Rouge metric value for an instance.", - "type": "object", + "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig": { + "description": "OnlineServingConfig specifies the details for provisioning online serving resources.", + "id": "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig", "properties": { - "score": { - "description": "Output only. Rouge score.", - "readOnly": true, - "type": "number", - "format": "float" + "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" + }, + "scaling": { + "$ref": "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling", + "description": "Online serving scaling configuration. Only one of `fixed_node_count` and `scaling` can be set. Setting one will reset the other." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FluencyResult": { - "id": "GoogleCloudAiplatformV1FluencyResult", - "description": "Spec for fluency result.", - "type": "object", + "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling": { + "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).", + "id": "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling", "properties": { - "score": { - "description": "Output only. Fluency score.", - "readOnly": true, - "type": "number", - "format": "float" + "cpuUtilizationTarget": { + "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": "integer" }, - "explanation": { - "description": "Output only. Explanation for fluency score.", - "readOnly": true, - "type": "string" + "maxNodeCount": { + "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'.", + "format": "int32", + "type": "integer" }, - "confidence": { - "description": "Output only. Confidence for fluency score.", - "readOnly": true, - "type": "number", - "format": "float" + "minNodeCount": { + "description": "Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CoherenceResult": { - "id": "GoogleCloudAiplatformV1CoherenceResult", - "description": "Spec for coherence result.", - "type": "object", + "GoogleCloudAiplatformV1FetchFeatureValuesRequest": { + "description": "Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned.", + "id": "GoogleCloudAiplatformV1FetchFeatureValuesRequest", "properties": { - "score": { - "description": "Output only. Coherence score.", - "readOnly": true, - "type": "number", - "format": "float" - }, - "explanation": { - "description": "Output only. Explanation for coherence score.", - "readOnly": true, + "dataFormat": { + "description": "Optional. Response data format. If not set, FeatureViewDataFormat.KEY_VALUE will be used.", + "enum": [ + "FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED", + "KEY_VALUE", + "PROTO_STRUCT" + ], + "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" }, - "confidence": { - "description": "Output only. Confidence for coherence score.", - "readOnly": true, - "type": "number", - "format": "float" + "dataKey": { + "$ref": "GoogleCloudAiplatformV1FeatureViewDataKey", + "description": "Optional. The request key to fetch feature values for." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SafetyResult": { - "id": "GoogleCloudAiplatformV1SafetyResult", - "description": "Spec for safety result.", - "type": "object", + "GoogleCloudAiplatformV1FetchFeatureValuesResponse": { + "description": "Response message for FeatureOnlineStoreService.FetchFeatureValues", + "id": "GoogleCloudAiplatformV1FetchFeatureValuesResponse", "properties": { - "score": { - "description": "Output only. Safety score.", - "readOnly": true, - "type": "number", - "format": "float" + "dataKey": { + "$ref": "GoogleCloudAiplatformV1FeatureViewDataKey", + "description": "The data key associated with this response. Will only be populated for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs." }, - "explanation": { - "description": "Output only. Explanation for safety score.", - "readOnly": true, - "type": "string" + "keyValues": { + "$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList", + "description": "Feature values in KeyValue format." }, - "confidence": { - "description": "Output only. Confidence for safety score.", - "readOnly": true, - "type": "number", - "format": "float" + "protoStruct": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Feature values in proto Struct format.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GroundednessResult": { - "id": "GoogleCloudAiplatformV1GroundednessResult", - "description": "Spec for groundedness result.", - "type": "object", + "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList": { + "description": "Response structure in the format of key (feature name) and (feature) value pair.", + "id": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList", "properties": { - "score": { - "description": "Output only. Groundedness score.", - "readOnly": true, - "type": "number", - "format": "float" - }, - "explanation": { - "description": "Output only. Explanation for groundedness score.", - "readOnly": true, - "type": "string" - }, - "confidence": { - "description": "Output only. Confidence for groundedness score.", - "readOnly": true, - "type": "number", - "format": "float" + "features": { + "description": "List of feature names and values.", + "items": { + "$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FulfillmentResult": { - "id": "GoogleCloudAiplatformV1FulfillmentResult", - "description": "Spec for fulfillment result.", - "type": "object", + "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair": { + "description": "Feature name & value pair.", + "id": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair", "properties": { - "score": { - "description": "Output only. Fulfillment score.", - "readOnly": true, - "type": "number", - "format": "float" + "name": { + "description": "Feature short name.", + "type": "string" }, - "explanation": { - "description": "Output only. Explanation for fulfillment score.", - "readOnly": true, + "value": { + "$ref": "GoogleCloudAiplatformV1FeatureValue", + "description": "Feature value." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FetchPredictOperationRequest": { + "description": "Request message for PredictionService.FetchPredictOperation.", + "id": "GoogleCloudAiplatformV1FetchPredictOperationRequest", + "properties": { + "operationName": { + "description": "Required. The server-assigned name for the operation.", "type": "string" - }, - "confidence": { - "description": "Output only. Confidence for fulfillment score.", - "readOnly": true, - "type": "number", - "format": "float" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SummarizationQualityResult": { - "id": "GoogleCloudAiplatformV1SummarizationQualityResult", - "description": "Spec for summarization quality result.", - "type": "object", + "GoogleCloudAiplatformV1FileData": { + "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.", + "id": "GoogleCloudAiplatformV1FileData", "properties": { - "score": { - "description": "Output only. Summarization Quality score.", - "readOnly": true, - "type": "number", - "format": "float" + "displayName": { + "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.", + "type": "string" }, - "explanation": { - "description": "Output only. Explanation for summarization quality score.", - "readOnly": true, + "fileUri": { + "description": "Required. The URI of the file in Google Cloud Storage.", "type": "string" }, - "confidence": { - "description": "Output only. Confidence for summarization quality score.", - "readOnly": true, - "type": "number", - "format": "float" + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseSummarizationQualityResult": { - "id": "GoogleCloudAiplatformV1PairwiseSummarizationQualityResult", - "description": "Spec for pairwise summarization quality result.", - "type": "object", + "GoogleCloudAiplatformV1FileStatus": { + "description": "RagFile status.", + "id": "GoogleCloudAiplatformV1FileStatus", "properties": { - "pairwiseChoice": { - "description": "Output only. Pairwise summarization prediction choice.", + "errorStatus": { + "description": "Output only. Only when the `state` field is ERROR.", "readOnly": true, - "type": "string", + "type": "string" + }, + "state": { + "description": "Output only. RagFile state.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "ERROR" + ], "enumDescriptions": [ - "Unspecified prediction choice.", - "Baseline prediction wins", - "Candidate prediction wins", - "Winner cannot be determined" + "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": [ - "PAIRWISE_CHOICE_UNSPECIFIED", - "BASELINE", - "CANDIDATE", - "TIE" - ] - }, - "explanation": { - "description": "Output only. Explanation for summarization quality score.", "readOnly": true, "type": "string" - }, - "confidence": { - "description": "Output only. Confidence for summarization quality score.", - "readOnly": true, - "type": "number", - "format": "float" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SummarizationHelpfulnessResult": { - "id": "GoogleCloudAiplatformV1SummarizationHelpfulnessResult", - "description": "Spec for summarization helpfulness result.", - "type": "object", + "GoogleCloudAiplatformV1FilterSplit": { + "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. ", + "id": "GoogleCloudAiplatformV1FilterSplit", "properties": { - "score": { - "description": "Output only. Summarization Helpfulness score.", - "readOnly": true, - "type": "number", - "format": "float" + "testFilter": { + "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.", + "type": "string" }, - "explanation": { - "description": "Output only. Explanation for summarization helpfulness score.", - "readOnly": true, + "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" }, - "confidence": { - "description": "Output only. Confidence for summarization helpfulness score.", - "readOnly": true, - "type": "number", - "format": "float" + "validationFilter": { + "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.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SummarizationVerbosityResult": { - "id": "GoogleCloudAiplatformV1SummarizationVerbosityResult", - "description": "Spec for summarization verbosity result.", - "type": "object", + "GoogleCloudAiplatformV1FindNeighborsRequest": { + "description": "The request message for MatchService.FindNeighbors.", + "id": "GoogleCloudAiplatformV1FindNeighborsRequest", "properties": { - "score": { - "description": "Output only. Summarization Verbosity score.", - "readOnly": true, - "type": "number", - "format": "float" - }, - "explanation": { - "description": "Output only. Explanation for summarization verbosity score.", - "readOnly": true, + "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" }, - "confidence": { - "description": "Output only. Confidence for summarization verbosity score.", - "readOnly": true, - "type": "number", - "format": "float" + "queries": { + "description": "The list of queries.", + "items": { + "$ref": "GoogleCloudAiplatformV1FindNeighborsRequestQuery" + }, + "type": "array" + }, + "returnFullDatapoint": { + "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.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringQualityResult": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringQualityResult", - "description": "Spec for question answering quality result.", - "type": "object", + "GoogleCloudAiplatformV1FindNeighborsRequestQuery": { + "description": "A query to find a number of the nearest neighbors (most similar vectors) of a vector.", + "id": "GoogleCloudAiplatformV1FindNeighborsRequestQuery", "properties": { - "score": { - "description": "Output only. Question Answering Quality score.", - "readOnly": true, - "type": "number", - "format": "float" + "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 > 0.", + "format": "int32", + "type": "integer" }, - "explanation": { - "description": "Output only. Explanation for question answering quality score.", - "readOnly": true, - "type": "string" + "datapoint": { + "$ref": "GoogleCloudAiplatformV1IndexDatapoint", + "description": "Required. The datapoint/vector whose nearest neighbors should be searched for." }, - "confidence": { - "description": "Output only. Confidence for question answering quality score.", - "readOnly": true, - "type": "number", - "format": "float" + "fractionLeafNodesToSearchOverride": { + "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": "number" + }, + "neighborCount": { + "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).", + "format": "int32", + "type": "integer" + }, + "perCrowdingAttributeNeighborCount": { + "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", + "type": "integer" + }, + "rrf": { + "$ref": "GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF", + "description": "Optional. Represents RRF algorithm that combines search results." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult": { - "id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult", - "description": "Spec for pairwise question answering quality result.", - "type": "object", + "GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF": { + "description": "Parameters for RRF algorithm that combines search results.", + "id": "GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF", "properties": { - "pairwiseChoice": { - "description": "Output only. Pairwise question answering prediction choice.", - "readOnly": true, - "type": "string", - "enumDescriptions": [ - "Unspecified prediction choice.", - "Baseline prediction wins", - "Candidate prediction wins", - "Winner cannot be determined" - ], - "enum": [ - "PAIRWISE_CHOICE_UNSPECIFIED", - "BASELINE", - "CANDIDATE", - "TIE" - ] - }, - "explanation": { - "description": "Output only. Explanation for question answering quality score.", - "readOnly": true, + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FindNeighborsResponse": { + "description": "The response message for MatchService.FindNeighbors.", + "id": "GoogleCloudAiplatformV1FindNeighborsResponse", + "properties": { + "nearestNeighbors": { + "description": "The nearest neighbors of the query datapoints.", + "items": { + "$ref": "GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors": { + "description": "Nearest neighbors for one query.", + "id": "GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors", + "properties": { + "id": { + "description": "The ID of the query datapoint.", "type": "string" }, - "confidence": { - "description": "Output only. Confidence for question answering quality score.", - "readOnly": true, - "type": "number", - "format": "float" + "neighbors": { + "description": "All its neighbors.", + "items": { + "$ref": "GoogleCloudAiplatformV1FindNeighborsResponseNeighbor" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult", - "description": "Spec for question answering relevance result.", - "type": "object", + "GoogleCloudAiplatformV1FindNeighborsResponseNeighbor": { + "description": "A neighbor of the query vector.", + "id": "GoogleCloudAiplatformV1FindNeighborsResponseNeighbor", "properties": { - "score": { - "description": "Output only. Question Answering Relevance score.", - "readOnly": true, - "type": "number", - "format": "float" + "datapoint": { + "$ref": "GoogleCloudAiplatformV1IndexDatapoint", + "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." }, - "explanation": { - "description": "Output only. Explanation for question answering relevance score.", - "readOnly": true, - "type": "string" + "distance": { + "description": "The distance between the neighbor and the dense embedding query.", + "format": "double", + "type": "number" }, - "confidence": { - "description": "Output only. Confidence for question answering relevance score.", - "readOnly": true, - "type": "number", - "format": "float" + "sparseDistance": { + "description": "The distance between the neighbor and the query sparse_embedding.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult", - "description": "Spec for question answering helpfulness result.", - "type": "object", + "GoogleCloudAiplatformV1FluencyInput": { + "description": "Input for fluency metric.", + "id": "GoogleCloudAiplatformV1FluencyInput", "properties": { - "score": { - "description": "Output only. Question Answering Helpfulness score.", - "readOnly": true, - "type": "number", - "format": "float" + "instance": { + "$ref": "GoogleCloudAiplatformV1FluencyInstance", + "description": "Required. Fluency instance." }, - "explanation": { - "description": "Output only. Explanation for question answering helpfulness score.", - "readOnly": true, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1FluencySpec", + "description": "Required. Spec for fluency score metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FluencyInstance": { + "description": "Spec for fluency instance.", + "id": "GoogleCloudAiplatformV1FluencyInstance", + "properties": { + "prediction": { + "description": "Required. Output of the evaluated model.", "type": "string" - }, - "confidence": { - "description": "Output only. Confidence for question answering helpfulness score.", - "readOnly": true, - "type": "number", - "format": "float" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult": { - "id": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult", - "description": "Spec for question answering correctness result.", - "type": "object", + "GoogleCloudAiplatformV1FluencyResult": { + "description": "Spec for fluency result.", + "id": "GoogleCloudAiplatformV1FluencyResult", "properties": { - "score": { - "description": "Output only. Question Answering Correctness score.", + "confidence": { + "description": "Output only. Confidence for fluency score.", + "format": "float", "readOnly": true, - "type": "number", - "format": "float" + "type": "number" }, "explanation": { - "description": "Output only. Explanation for question answering correctness score.", + "description": "Output only. Explanation for fluency score.", "readOnly": true, "type": "string" }, - "confidence": { - "description": "Output only. Confidence for question answering correctness score.", + "score": { + "description": "Output only. Fluency score.", + "format": "float", "readOnly": true, - "type": "number", - "format": "float" + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PointwiseMetricResult": { - "id": "GoogleCloudAiplatformV1PointwiseMetricResult", - "description": "Spec for pointwise metric result.", - "type": "object", + "GoogleCloudAiplatformV1FluencySpec": { + "description": "Spec for fluency score metric.", + "id": "GoogleCloudAiplatformV1FluencySpec", "properties": { - "score": { - "description": "Output only. Pointwise metric score.", - "readOnly": true, - "type": "number", - "format": "float" + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FractionSplit": { + "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": "GoogleCloudAiplatformV1FractionSplit", + "properties": { + "testFraction": { + "description": "The fraction of the input data that is to be used to evaluate the Model.", + "format": "double", + "type": "number" }, - "explanation": { - "description": "Output only. Explanation for pointwise metric score.", - "readOnly": true, - "type": "string" + "trainingFraction": { + "description": "The fraction of the input data that is to be used to train the Model.", + "format": "double", + "type": "number" }, - "customOutput": { - "description": "Output only. Spec for custom output.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1CustomOutput" + "validationFraction": { + "description": "The fraction of the input data that is to be used to validate the Model.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CustomOutput": { - "id": "GoogleCloudAiplatformV1CustomOutput", - "description": "Spec for custom output.", - "type": "object", + "GoogleCloudAiplatformV1FulfillmentInput": { + "description": "Input for fulfillment metric.", + "id": "GoogleCloudAiplatformV1FulfillmentInput", "properties": { - "rawOutputs": { - "description": "Output only. List of raw output strings.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1RawOutput" + "instance": { + "$ref": "GoogleCloudAiplatformV1FulfillmentInstance", + "description": "Required. Fulfillment instance." + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1FulfillmentSpec", + "description": "Required. Spec for fulfillment score metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RawOutput": { - "id": "GoogleCloudAiplatformV1RawOutput", - "description": "Raw output.", - "type": "object", + "GoogleCloudAiplatformV1FulfillmentInstance": { + "description": "Spec for fulfillment instance.", + "id": "GoogleCloudAiplatformV1FulfillmentInstance", "properties": { - "rawOutput": { - "description": "Output only. Raw output string.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } + "instruction": { + "description": "Required. Inference instruction prompt to compare prediction with.", + "type": "string" + }, + "prediction": { + "description": "Required. Output of the evaluated model.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PairwiseMetricResult": { - "id": "GoogleCloudAiplatformV1PairwiseMetricResult", - "description": "Spec for pairwise metric result.", - "type": "object", + "GoogleCloudAiplatformV1FulfillmentResult": { + "description": "Spec for fulfillment result.", + "id": "GoogleCloudAiplatformV1FulfillmentResult", "properties": { - "pairwiseChoice": { - "description": "Output only. Pairwise metric choice.", + "confidence": { + "description": "Output only. Confidence for fulfillment score.", + "format": "float", "readOnly": true, - "type": "string", - "enumDescriptions": [ - "Unspecified prediction choice.", - "Baseline prediction wins", - "Candidate prediction wins", - "Winner cannot be determined" - ], - "enum": [ - "PAIRWISE_CHOICE_UNSPECIFIED", - "BASELINE", - "CANDIDATE", - "TIE" - ] + "type": "number" }, "explanation": { - "description": "Output only. Explanation for pairwise metric score.", + "description": "Output only. Explanation for fulfillment score.", "readOnly": true, "type": "string" }, - "customOutput": { - "description": "Output only. Spec for custom output.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1CustomOutput" - } - } - }, - "GoogleCloudAiplatformV1ToolCallValidResults": { - "id": "GoogleCloudAiplatformV1ToolCallValidResults", - "description": "Results for tool call valid metric.", - "type": "object", - "properties": { - "toolCallValidMetricValues": { - "description": "Output only. Tool call valid metric values.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ToolCallValidMetricValue" - } - } - } - }, - "GoogleCloudAiplatformV1ToolCallValidMetricValue": { - "id": "GoogleCloudAiplatformV1ToolCallValidMetricValue", - "description": "Tool call valid metric value for an instance.", - "type": "object", - "properties": { "score": { - "description": "Output only. Tool call valid score.", + "description": "Output only. Fulfillment score.", + "format": "float", "readOnly": true, - "type": "number", - "format": "float" + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolNameMatchResults": { - "id": "GoogleCloudAiplatformV1ToolNameMatchResults", - "description": "Results for tool name match metric.", - "type": "object", + "GoogleCloudAiplatformV1FulfillmentSpec": { + "description": "Spec for fulfillment metric.", + "id": "GoogleCloudAiplatformV1FulfillmentSpec", "properties": { - "toolNameMatchMetricValues": { - "description": "Output only. Tool name match metric values.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ToolNameMatchMetricValue" - } + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolNameMatchMetricValue": { - "id": "GoogleCloudAiplatformV1ToolNameMatchMetricValue", - "description": "Tool name match metric value for an instance.", - "type": "object", + "GoogleCloudAiplatformV1FunctionCall": { + "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.", + "id": "GoogleCloudAiplatformV1FunctionCall", "properties": { - "score": { - "description": "Output only. Tool name match score.", - "readOnly": true, - "type": "number", - "format": "float" + "args": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.", + "type": "object" + }, + "name": { + "description": "Optional. The name of the function to call. Matches FunctionDeclaration.name.", + "type": "string" + }, + "partialArgs": { + "description": "Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.", + "items": { + "$ref": "GoogleCloudAiplatformV1PartialArg" + }, + "type": "array" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolParameterKeyMatchResults": { - "id": "GoogleCloudAiplatformV1ToolParameterKeyMatchResults", - "description": "Results for tool parameter key match metric.", - "type": "object", + "GoogleCloudAiplatformV1FunctionCallingConfig": { + "description": "Function calling config.", + "id": "GoogleCloudAiplatformV1FunctionCallingConfig", "properties": { - "toolParameterKeyMatchMetricValues": { - "description": "Output only. Tool parameter key match metric values.", - "readOnly": true, - "type": "array", + "allowedFunctionNames": { + "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": { - "$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue" - } + "type": "string" + }, + "type": "array" + }, + "mode": { + "description": "Optional. Function calling mode.", + "enum": [ + "MODE_UNSPECIFIED", + "AUTO", + "ANY", + "NONE", + "VALIDATED" + ], + "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\"." + ], + "type": "string" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue": { - "id": "GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue", - "description": "Tool parameter key match metric value for an instance.", - "type": "object", + "GoogleCloudAiplatformV1FunctionDeclaration": { + "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.", + "id": "GoogleCloudAiplatformV1FunctionDeclaration", "properties": { - "score": { - "description": "Output only. Tool parameter key match score.", - "readOnly": true, - "type": "number", - "format": "float" + "behavior": { + "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.", + "enum": [ + "UNSPECIFIED", + "BLOCKING", + "NON_BLOCKING" + ], + "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." + ], + "type": "string" + }, + "description": { + "description": "Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.", + "type": "string" + }, + "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": { + "$ref": "GoogleCloudAiplatformV1Schema", + "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" + }, + "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" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Schema", + "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." + }, + "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" }, - "GoogleCloudAiplatformV1ToolParameterKVMatchResults": { - "id": "GoogleCloudAiplatformV1ToolParameterKVMatchResults", - "description": "Results for tool parameter key value match metric.", - "type": "object", + "GoogleCloudAiplatformV1FunctionResponse": { + "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.", + "id": "GoogleCloudAiplatformV1FunctionResponse", "properties": { - "toolParameterKvMatchMetricValues": { - "description": "Output only. Tool parameter key value match metric values.", - "readOnly": true, - "type": "array", + "name": { + "description": "Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.", + "type": "string" + }, + "parts": { + "description": "Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.", "items": { - "$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue" - } - } - } - }, - "GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue": { - "id": "GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue", - "description": "Tool parameter key value match metric value for an instance.", - "type": "object", - "properties": { - "score": { - "description": "Output only. Tool parameter key value match score.", - "readOnly": true, - "type": "number", - "format": "float" + "$ref": "GoogleCloudAiplatformV1FunctionResponsePart" + }, + "type": "array" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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.", + "type": "object" + }, + "scheduling": { + "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.", + "enum": [ + "SCHEDULING_UNSPECIFIED", + "SILENT", + "WHEN_IDLE", + "INTERRUPT" + ], + "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": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CometResult": { - "id": "GoogleCloudAiplatformV1CometResult", - "description": "Spec for Comet result - calculates the comet score for the given instance using the version specified in the spec.", - "type": "object", + "GoogleCloudAiplatformV1FunctionResponseBlob": { + "description": "Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field.", + "id": "GoogleCloudAiplatformV1FunctionResponseBlob", "properties": { - "score": { - "description": "Output only. Comet score. Range depends on version.", - "readOnly": true, - "type": "number", - "format": "float" + "data": { + "description": "Required. Raw bytes.", + "format": "byte", + "type": "string" + }, + "displayName": { + "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": "string" + }, + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MetricxResult": { - "id": "GoogleCloudAiplatformV1MetricxResult", - "description": "Spec for MetricX result - calculates the MetricX score for the given instance using the version specified in the spec.", - "type": "object", + "GoogleCloudAiplatformV1FunctionResponseFileData": { + "description": "URI based data for function response.", + "id": "GoogleCloudAiplatformV1FunctionResponseFileData", "properties": { - "score": { - "description": "Output only. MetricX score. Range depends on version.", - "readOnly": true, - "type": "number", - "format": "float" + "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" + }, + "fileUri": { + "description": "Required. URI.", + "type": "string" + }, + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryExactMatchResults": { - "id": "GoogleCloudAiplatformV1TrajectoryExactMatchResults", - "description": "Results for TrajectoryExactMatch metric.", - "type": "object", + "GoogleCloudAiplatformV1FunctionResponsePart": { + "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.", + "id": "GoogleCloudAiplatformV1FunctionResponsePart", "properties": { - "trajectoryExactMatchMetricValues": { - "description": "Output only. TrajectoryExactMatch metric values.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue" - } + "fileData": { + "$ref": "GoogleCloudAiplatformV1FunctionResponseFileData", + "description": "URI based data." + }, + "inlineData": { + "$ref": "GoogleCloudAiplatformV1FunctionResponseBlob", + "description": "Inline media bytes." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue": { - "id": "GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue", - "description": "TrajectoryExactMatch metric value for an instance.", - "type": "object", + "GoogleCloudAiplatformV1GcsDestination": { + "description": "The Google Cloud Storage location where the output is to be written to.", + "id": "GoogleCloudAiplatformV1GcsDestination", "properties": { - "score": { - "description": "Output only. TrajectoryExactMatch score.", - "readOnly": true, - "type": "number", - "format": "float" + "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" }, - "GoogleCloudAiplatformV1TrajectoryInOrderMatchResults": { - "id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchResults", - "description": "Results for TrajectoryInOrderMatch metric.", - "type": "object", + "GoogleCloudAiplatformV1GcsSource": { + "description": "The Google Cloud Storage location for the input content.", + "id": "GoogleCloudAiplatformV1GcsSource", "properties": { - "trajectoryInOrderMatchMetricValues": { - "description": "Output only. TrajectoryInOrderMatch metric values.", - "readOnly": true, - "type": "array", + "uris": { + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue" - } + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue": { - "id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue", - "description": "TrajectoryInOrderMatch metric value for an instance.", - "type": "object", + "GoogleCloudAiplatformV1GdcConfig": { + "description": "Google Distributed Cloud (GDC) config.", + "id": "GoogleCloudAiplatformV1GdcConfig", "properties": { - "score": { - "description": "Output only. TrajectoryInOrderMatch score.", - "readOnly": true, - "type": "number", - "format": "float" + "zone": { + "description": "GDC zone. A cluster will be designated for the Vertex AI workload in this zone.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchResults": { - "id": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchResults", - "description": "Results for TrajectoryAnyOrderMatch metric.", - "type": "object", + "GoogleCloudAiplatformV1GeminiPreferenceExample": { + "description": "Input example for preference optimization.", + "id": "GoogleCloudAiplatformV1GeminiPreferenceExample", "properties": { - "trajectoryAnyOrderMatchMetricValues": { - "description": "Output only. TrajectoryAnyOrderMatch metric values.", - "readOnly": true, - "type": "array", + "completions": { + "description": "List of completions for a given prompt.", "items": { - "$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchMetricValue" - } - } - } - }, - "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchMetricValue": { - "id": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchMetricValue", - "description": "TrajectoryAnyOrderMatch metric value for an instance.", - "type": "object", - "properties": { - "score": { - "description": "Output only. TrajectoryAnyOrderMatch score.", - "readOnly": true, - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudAiplatformV1TrajectoryPrecisionResults": { - "id": "GoogleCloudAiplatformV1TrajectoryPrecisionResults", - "description": "Results for TrajectoryPrecision metric.", - "type": "object", - "properties": { - "trajectoryPrecisionMetricValues": { - "description": "Output only. TrajectoryPrecision metric values.", - "readOnly": true, - "type": "array", + "$ref": "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion" + }, + "type": "array" + }, + "contents": { + "description": "Multi-turn contents that represents the Prompt.", "items": { - "$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue" - } + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue": { - "id": "GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue", - "description": "TrajectoryPrecision metric value for an instance.", - "type": "object", + "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion": { + "description": "Completion and its preference score.", + "id": "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion", "properties": { + "completion": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Single turn completion for the given prompt." + }, "score": { - "description": "Output only. TrajectoryPrecision score.", - "readOnly": true, - "type": "number", - "format": "float" + "description": "The score for the given completion.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryRecallResults": { - "id": "GoogleCloudAiplatformV1TrajectoryRecallResults", - "description": "Results for TrajectoryRecall metric.", - "type": "object", + "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig": { + "description": "Configuration for GenAiAdvancedFeatures.", + "id": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig", "properties": { - "trajectoryRecallMetricValues": { - "description": "Output only. TrajectoryRecall metric values.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TrajectoryRecallMetricValue" - } + "ragConfig": { + "$ref": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig", + "description": "Configuration for Retrieval Augmented Generation feature." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectoryRecallMetricValue": { - "id": "GoogleCloudAiplatformV1TrajectoryRecallMetricValue", - "description": "TrajectoryRecall metric value for an instance.", - "type": "object", + "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig": { + "description": "Configuration for Retrieval Augmented Generation feature.", + "id": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig", "properties": { - "score": { - "description": "Output only. TrajectoryRecall score.", - "readOnly": true, - "type": "number", - "format": "float" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectorySingleToolUseResults": { - "id": "GoogleCloudAiplatformV1TrajectorySingleToolUseResults", - "description": "Results for TrajectorySingleToolUse metric.", - "type": "object", + "GoogleCloudAiplatformV1GenerateContentRequest": { + "description": "Request message for [PredictionService.GenerateContent].", + "id": "GoogleCloudAiplatformV1GenerateContentRequest", "properties": { - "trajectorySingleToolUseMetricValues": { - "description": "Output only. TrajectorySingleToolUse metric values.", - "readOnly": true, - "type": "array", + "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" + }, + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue" - } + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + }, + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "Optional. Generation config." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" + }, + "modelArmorConfig": { + "$ref": "GoogleCloudAiplatformV1ModelArmorConfig", + "description": "Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied." + }, + "safetySettings": { + "description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", + "items": { + "$ref": "GoogleCloudAiplatformV1SafetySetting" + }, + "type": "array" + }, + "systemInstruction": { + "$ref": "GoogleCloudAiplatformV1Content", + "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." + }, + "toolConfig": { + "$ref": "GoogleCloudAiplatformV1ToolConfig", + "description": "Optional. Tool config. This config is shared for all tools provided in the request." + }, + "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": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue": { - "id": "GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue", - "description": "TrajectorySingleToolUse metric value for an instance.", - "type": "object", + "GoogleCloudAiplatformV1GenerateContentResponse": { + "description": "Response message for [PredictionService.GenerateContent].", + "id": "GoogleCloudAiplatformV1GenerateContentResponse", "properties": { - "score": { - "description": "Output only. TrajectorySingleToolUse score.", + "candidates": { + "description": "Output only. Generated candidates.", + "items": { + "$ref": "GoogleCloudAiplatformV1Candidate" + }, "readOnly": true, - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult": { - "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult", - "description": "Result for RubricBasedInstructionFollowing metric.", - "type": "object", - "properties": { - "score": { - "description": "Output only. Overall score for the instruction following.", + "type": "array" + }, + "createTime": { + "description": "Output only. Timestamp when the request is made to the server.", + "format": "google-datetime", "readOnly": true, - "type": "number", - "format": "float" + "type": "string" }, - "rubricCritiqueResults": { - "description": "Output only. List of per rubric critique results.", + "modelVersion": { + "description": "Output only. The model version used to generate the response.", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1RubricCritiqueResult" - } + "type": "string" + }, + "promptFeedback": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback", + "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 + }, + "responseId": { + "description": "Output only. response_id is used to identify each response. It is the encoding of the event_id.", + "readOnly": true, + "type": "string" + }, + "usageMetadata": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata", + "description": "Usage metadata about the response(s)." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RubricCritiqueResult": { - "id": "GoogleCloudAiplatformV1RubricCritiqueResult", - "description": "Rubric critique result.", - "type": "object", + "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback": { + "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.", + "id": "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback", "properties": { - "rubric": { - "description": "Output only. Rubric to be evaluated.", + "blockReason": { + "description": "Output only. The reason why the prompt was blocked.", + "enum": [ + "BLOCKED_REASON_UNSPECIFIED", + "SAFETY", + "OTHER", + "BLOCKLIST", + "PROHIBITED_CONTENT", + "MODEL_ARMOR", + "IMAGE_SAFETY", + "JAILBREAK" + ], + "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." + ], "readOnly": true, "type": "string" }, - "verdict": { - "description": "Output only. Verdict for the rubric - true if the rubric is met, false otherwise.", + "blockReasonMessage": { + "description": "Output only. A readable message that explains the reason why the prompt was blocked.", "readOnly": true, - "type": "boolean" + "type": "string" + }, + "safetyRatings": { + "description": "Output only. A list of safety ratings for the prompt. There is one rating per category.", + "items": { + "$ref": "GoogleCloudAiplatformV1SafetyRating" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MetricResult": { - "id": "GoogleCloudAiplatformV1MetricResult", - "description": "Result for a single metric on a single instance.", - "type": "object", + "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata": { + "description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", + "id": "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata", "properties": { - "score": { - "description": "Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score.", + "cacheTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, "readOnly": true, - "type": "number", - "format": "float" + "type": "array" }, - "rubricVerdicts": { - "description": "Output only. For rubric-based metrics, the verdicts for each rubric.", + "cachedContentTokenCount": { + "description": "Output only. The number of tokens in the cached content that was used for this request.", + "format": "int32", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1RubricVerdict" - } + "type": "integer" }, - "explanation": { - "description": "Output only. The explanation for the metric result.", + "candidatesTokenCount": { + "description": "The total number of tokens in the generated candidates.", + "format": "int32", + "type": "integer" + }, + "candidatesTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, "readOnly": true, - "type": "string" + "type": "array" }, - "error": { - "description": "Output only. The error status for the metric result.", + "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" + }, + "promptTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, "readOnly": true, - "$ref": "GoogleRpcStatus" - } - } - }, - "GoogleCloudAiplatformV1RubricVerdict": { - "id": "GoogleCloudAiplatformV1RubricVerdict", - "description": "Represents the verdict of an evaluation against a single rubric.", - "type": "object", - "properties": { - "evaluatedRubric": { - "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.", - "$ref": "GoogleCloudAiplatformV1Rubric" + "type": "array" }, - "verdict": { - "description": "Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a \"Pass\", `false` indicates a \"Fail\".", - "type": "boolean" + "thoughtsTokenCount": { + "description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "reasoning": { - "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.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1EvaluateDatasetRequest": { - "id": "GoogleCloudAiplatformV1EvaluateDatasetRequest", - "description": "Request message for EvaluationService.EvaluateDataset.", - "type": "object", - "properties": { - "dataset": { - "description": "Required. The dataset used for evaluation.", - "$ref": "GoogleCloudAiplatformV1EvaluationDataset" + "toolUsePromptTokenCount": { + "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", + "readOnly": true, + "type": "integer" }, - "metrics": { - "description": "Required. The metrics used for evaluation.", - "type": "array", + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1Metric" - } + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" }, - "outputConfig": { - "description": "Required. Config for evaluation output.", - "$ref": "GoogleCloudAiplatformV1OutputConfig" + "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" }, - "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": "GoogleCloudAiplatformV1AutoraterConfig" + "trafficType": { + "description": "Output only. The traffic type for this request.", + "enum": [ + "TRAFFIC_TYPE_UNSPECIFIED", + "ON_DEMAND", + "ON_DEMAND_PRIORITY", + "ON_DEMAND_FLEX", + "PROVISIONED_THROUGHPUT" + ], + "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 Provisioned Throughput traffic." + ], + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationDataset": { - "id": "GoogleCloudAiplatformV1EvaluationDataset", - "description": "The dataset used for evaluation.", - "type": "object", - "properties": { - "gcsSource": { - "description": "Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported.", - "$ref": "GoogleCloudAiplatformV1GcsSource" - }, - "bigquerySource": { - "description": "BigQuery source holds the dataset.", - "$ref": "GoogleCloudAiplatformV1BigQuerySource" - } - } + "GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest": { + "description": "Request message for FeatureOnlineStoreService.GenerateFetchAccessToken.", + "id": "GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1BigQuerySource": { - "id": "GoogleCloudAiplatformV1BigQuerySource", - "description": "The BigQuery location for the input content.", - "type": "object", + "GoogleCloudAiplatformV1GenerateFetchAccessTokenResponse": { + "description": "Response message for FeatureOnlineStoreService.GenerateFetchAccessToken.", + "id": "GoogleCloudAiplatformV1GenerateFetchAccessTokenResponse", "properties": { - "inputUri": { - "description": "Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.", + "accessToken": { + "description": "The OAuth 2.0 access token.", + "type": "string" + }, + "expireTime": { + "description": "Token expiration time. This is always set", + "format": "google-datetime", "type": "string" } - } - }, - "GoogleCloudAiplatformV1OutputConfig": { - "id": "GoogleCloudAiplatformV1OutputConfig", - "description": "Config for evaluation output.", - "type": "object", - "properties": { - "gcsDestination": { - "description": "Cloud storage destination for evaluation output.", - "$ref": "GoogleCloudAiplatformV1GcsDestination" - } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest": { - "id": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest", "description": "Request message for EvaluationService.GenerateInstanceRubrics.", - "type": "object", + "id": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest", "properties": { + "agentConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceDeprecatedAgentConfig", + "description": "Optional. Agent configuration, required for agent-based rubric generation." + }, "contents": { "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.", - "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1Content" - } + }, + "type": "array" + }, + "location": { + "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", + "type": "string" + }, + "metricResourceName": { + "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.", + "type": "string" }, "predefinedRubricGenerationSpec": { - "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.", - "$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec" + "$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec", + "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": "GoogleCloudAiplatformV1RubricGenerationSpec" - }, - "agentConfig": { - "description": "Optional. Agent configuration, required for agent-based rubric generation.", - "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig" + "$ref": "GoogleCloudAiplatformV1RubricGenerationSpec", + "description": "Optional. Specification for how the rubrics should be generated." } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse": { - "id": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse", "description": "Response message for EvaluationService.GenerateInstanceRubrics.", - "type": "object", + "id": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse", "properties": { "generatedRubrics": { "description": "Output only. A list of generated rubrics.", - "readOnly": true, - "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1Rubric" - } + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationRun": { - "id": "GoogleCloudAiplatformV1EvaluationRun", - "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", + "GoogleCloudAiplatformV1GenerateMemoriesRequest": { + "description": "Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB.", + "id": "GoogleCloudAiplatformV1GenerateMemoriesRequest", "properties": { - "name": { - "description": "Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", - "type": "string" + "allowedTopics": { + "description": "Optional. Restricts memory generation to a subset of memory topics.", + "items": { + "$ref": "GoogleCloudAiplatformV1MemoryTopicId" + }, + "type": "array" }, - "displayName": { - "description": "Required. The display name of the Evaluation Run.", - "type": "string" + "directContentsSource": { + "$ref": "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectContentsSource", + "description": "Defines a direct source of content as the source content from which to generate memories." }, - "metadata": { - "description": "Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run.", - "type": "any" + "directMemoriesSource": { + "$ref": "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectMemoriesSource", + "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." }, - "labels": { - "description": "Optional. Labels for the evaluation run.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "disableConsolidation": { + "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.", + "type": "boolean" }, - "dataSource": { - "description": "Required. The data source for the evaluation run.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunDataSource" + "disableMemoryRevisions": { + "description": "Optional. If true, no revisions will be created for this request.", + "type": "boolean" }, - "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.", - "type": "object", + "metadata": { "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1EvaluationRunInferenceConfig" - } - }, - "evaluationConfig": { - "description": "Required. The configuration used for the evaluation.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfig" + "$ref": "GoogleCloudAiplatformV1MemoryMetadataValue" + }, + "description": "Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.", + "type": "object" }, - "state": { - "description": "Output only. The state of the evaluation run.", - "readOnly": true, - "type": "string", + "metadataMergeStrategy": { + "description": "Optional. The strategy to use when applying metadata to existing memories.", + "enum": [ + "METADATA_MERGE_STRATEGY_UNSPECIFIED", + "OVERWRITE", + "MERGE", + "REQUIRE_EXACT_MATCH" + ], "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." + "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." ], - "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "SUCCEEDED", - "FAILED", - "CANCELLED", - "INFERENCE", - "GENERATING_RUBRICS" - ] - }, - "error": { - "description": "Output only. Only populated when the evaluation run's state is FAILED or CANCELLED.", - "readOnly": true, - "$ref": "GoogleRpcStatus" - }, - "evaluationResults": { - "description": "Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1EvaluationResults" - }, - "createTime": { - "description": "Output only. Time when the evaluation run was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "completionTime": { - "description": "Output only. Time when the evaluation run was completed.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "evaluationSetSnapshot": { - "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.", - "readOnly": true, - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1EvaluationRunDataSource": { - "id": "GoogleCloudAiplatformV1EvaluationRunDataSource", - "description": "The data source for the evaluation run.", - "type": "object", - "properties": { - "evaluationSet": { - "description": "The EvaluationSet resource name. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", "type": "string" }, - "bigqueryRequestSet": { - "description": "Evaluation data in bigquery.", - "$ref": "GoogleCloudAiplatformV1BigQueryRequestSet" - } - } - }, - "GoogleCloudAiplatformV1BigQueryRequestSet": { - "id": "GoogleCloudAiplatformV1BigQueryRequestSet", - "description": "The request set for the evaluation run.", - "type": "object", - "properties": { - "uri": { - "description": "Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId", + "revisionExpireTime": { + "description": "Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", + "format": "google-datetime", "type": "string" }, - "promptColumn": { - "description": "Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format.", - "type": "string" + "revisionLabels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" }, - "rubricsColumn": { - "description": "Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format.", + "revisionTtl": { + "description": "Optional. The TTL for the revision. The expiration time is computed: now + TTL.", + "format": "google-duration", "type": "string" }, - "candidateResponseColumns": { - "description": "Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format.", - "type": "object", + "scope": { "additionalProperties": { "type": "string" - } + }, + "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" }, - "samplingConfig": { - "description": "Optional. The sampling config for the bigquery resource.", - "$ref": "GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig" + "vertexSessionSource": { + "$ref": "GoogleCloudAiplatformV1GenerateMemoriesRequestVertexSessionSource", + "description": "Defines a Vertex Session as the source content from which to generate memories." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig": { - "id": "GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig", - "description": "The sampling config.", - "type": "object", + "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectContentsSource": { + "description": "Defines a direct source of content from which to generate the memories.", + "id": "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectContentsSource", "properties": { - "samplingCount": { - "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.", - "type": "integer", - "format": "int32" - }, - "samplingMethod": { - "description": "Optional. The sampling method to use.", - "type": "string", - "enumDescriptions": [ - "Unspecified sampling method.", - "Random sampling." - ], - "enum": [ - "SAMPLING_METHOD_UNSPECIFIED", - "RANDOM" - ] - }, - "samplingDuration": { - "description": "Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0.", - "type": "string", - "format": "google-duration" + "events": { + "description": "Required. The source content (i.e. chat history) to generate memories from.", + "items": { + "$ref": "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectContentsSourceEvent" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationRunInferenceConfig": { - "id": "GoogleCloudAiplatformV1EvaluationRunInferenceConfig", - "description": "An inference config used for model inference during the evaluation run.", - "type": "object", + "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectContentsSourceEvent": { + "description": "A single piece of conversation from which to generate memories.", + "id": "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectContentsSourceEvent", "properties": { - "generationConfig": { - "description": "Optional. Generation config.", - "$ref": "GoogleCloudAiplatformV1GenerationConfig" - }, - "model": { - "description": "Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "type": "string" + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Required. A single piece of content from which to generate memories." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationRunEvaluationConfig": { - "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfig", - "description": "The Evalution configuration used for the evaluation run.", - "type": "object", + "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectMemoriesSource": { + "description": "Defines a direct source of memories that should be uploaded to Memory Bank with consolidation.", + "id": "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectMemoriesSource", "properties": { - "metrics": { - "description": "Required. The metrics to be calculated in the evaluation run.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1EvaluationRunMetric" - } - }, - "rubricConfigs": { - "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.", - "type": "array", + "directMemories": { + "description": "Required. The direct memories to upload to Memory Bank. At most 5 direct memories are allowed per request.", "items": { - "$ref": "GoogleCloudAiplatformV1EvaluationRubricConfig" - } - }, - "outputConfig": { - "description": "Optional. The output config for the evaluation run.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig" - }, - "autoraterConfig": { - "description": "Optional. The autorater config for the evaluation run.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig" - }, - "promptTemplate": { - "description": "The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate" + "$ref": "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectMemoriesSourceDirectMemory" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationRunMetric": { - "id": "GoogleCloudAiplatformV1EvaluationRunMetric", - "description": "The metric used for evaluation runs.", - "type": "object", + "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectMemoriesSourceDirectMemory": { + "description": "A direct memory to upload to Memory Bank.", + "id": "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectMemoriesSourceDirectMemory", "properties": { - "rubricBasedMetricSpec": { - "description": "Spec for rubric based metric.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec" - }, - "predefinedMetricSpec": { - "description": "Spec for a pre-defined metric.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec" - }, - "llmBasedMetricSpec": { - "description": "Spec for an LLM based metric.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec" - }, - "metric": { - "description": "Required. The name of the metric.", + "fact": { + "description": "Required. The fact to consolidate with existing memories.", "type": "string" }, - "metricConfig": { - "description": "The metric config.", - "$ref": "GoogleCloudAiplatformV1Metric" + "topics": { + "description": "Optional. The topics that the consolidated memories should be associated with.", + "items": { + "$ref": "GoogleCloudAiplatformV1MemoryTopicId" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec": { - "id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec", - "description": "Specification for a metric that is based on rubrics.", - "type": "object", + "GoogleCloudAiplatformV1GenerateMemoriesRequestVertexSessionSource": { + "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}).", + "id": "GoogleCloudAiplatformV1GenerateMemoriesRequestVertexSessionSource", "properties": { - "inlineRubrics": { - "description": "Use rubrics provided directly in the spec.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics" - }, - "rubricGroupKey": { - "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`.", + "endTime": { + "description": "Optional. End time (exclusive) of the time range. If not set, the end time is unbounded.", + "format": "google-datetime", "type": "string" }, - "rubricGenerationSpec": { - "description": "Dynamically generate rubrics for evaluation using this specification.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec" - }, - "metricPromptTemplate": { - "description": "Optional. Template for the prompt used by the judge model to evaluate against rubrics.", + "session": { + "description": "Required. The resource name of the Session to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "type": "string" }, - "judgeAutoraterConfig": { - "description": "Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig" - } - } - }, - "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics": { - "id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics", - "description": "Defines a list of rubrics, used when providing rubrics inline.", - "type": "object", - "properties": { - "rubrics": { - "description": "The list of rubrics.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Rubric" - } - } - } - }, - "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec": { - "id": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec", - "description": "Specification for how rubrics should be generated.", - "type": "object", - "properties": { - "promptTemplate": { - "description": "Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.", + "startTime": { + "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.", + "format": "google-datetime", "type": "string" - }, - "modelConfig": { - "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.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig" - }, - "rubricContentType": { - "description": "Optional. The type of rubric content to be generated.", - "type": "string", - "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." - ], - "enum": [ - "RUBRIC_CONTENT_TYPE_UNSPECIFIED", - "PROPERTY", - "NL_QUESTION_ANSWER", - "PYTHON_CODE_ASSERTION" - ] - }, - "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" - } } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig": { - "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", - "description": "The autorater config used for the evaluation run.", - "type": "object", + "GoogleCloudAiplatformV1GenerateSyntheticDataRequest": { + "description": "Request message for DataFoundryService.GenerateSyntheticData. It contains the settings and information needed to generate synthetic data.", + "id": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest", "properties": { - "sampleCount": { - "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" + "count": { + "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", + "type": "integer" }, - "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" + "examples": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1SyntheticExample" + }, + "type": "array" }, - "generationConfig": { - "description": "Optional. Configuration options for model generation and outputs.", - "$ref": "GoogleCloudAiplatformV1GenerationConfig" - } - } - }, - "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec": { - "id": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", - "description": "Specification for a pre-defined metric.", - "type": "object", - "properties": { - "metricSpecName": { - "description": "Required. The name of a pre-defined metric, such as \"instruction_following_v1\" or \"text_quality_v1\".", - "type": "string" + "outputFieldSpecs": { + "description": "Required. Defines the schema of each synthetic example to be generated, defined by a list of fields.", + "items": { + "$ref": "GoogleCloudAiplatformV1OutputFieldSpec" + }, + "type": "array" }, - "parameters": { - "description": "Optional. The parameters needed to run the pre-defined metric.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } + "taskDescription": { + "$ref": "GoogleCloudAiplatformV1TaskDescriptionStrategy", + "description": "Generates synthetic data based on a high-level description of the task or data you want." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec": { - "id": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec", - "description": "Specification for an LLM based metric.", - "type": "object", + "GoogleCloudAiplatformV1GenerateSyntheticDataResponse": { + "description": "The response message for the `GenerateSyntheticData` method, containing the synthetic examples generated by the Gen AI evaluation service.", + "id": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse", "properties": { - "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" - }, - "rubricGenerationSpec": { - "description": "Dynamically generate rubrics using this specification.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec" - }, - "predefinedRubricGenerationSpec": { - "description": "Dynamically generate rubrics using a predefined spec.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec" - }, - "metricPromptTemplate": { - "description": "Required. Template for the prompt sent to the judge model.", - "type": "string" - }, - "systemInstruction": { - "description": "Optional. System instructions for the judge model.", - "type": "string" - }, - "judgeAutoraterConfig": { - "description": "Optional. Optional configuration for the judge LLM (Autorater).", - "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig" - }, - "additionalConfig": { - "description": "Optional. Optional additional configuration for the metric.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } + "syntheticExamples": { + "description": "A list of generated synthetic examples, each containing a complete synthetic data instance generated based on your request.", + "items": { + "$ref": "GoogleCloudAiplatformV1SyntheticExample" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationRubricConfig": { - "id": "GoogleCloudAiplatformV1EvaluationRubricConfig", - "description": "Configuration for a rubric group to be generated/saved for evaluation.", - "type": "object", + "GoogleCloudAiplatformV1GenerateVideoResponse": { + "description": "Generate video response.", + "id": "GoogleCloudAiplatformV1GenerateVideoResponse", "properties": { - "rubricGenerationSpec": { - "description": "Dynamically generate rubrics using this specification.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec" + "generatedSamples": { + "deprecated": true, + "description": "The cloud storage uris of the generated videos.", + "items": { + "type": "string" + }, + "type": "array" }, - "predefinedRubricGenerationSpec": { - "description": "Dynamically generate rubrics using a predefined spec.", - "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec" + "raiMediaFilteredCount": { + "description": "Returns if any videos were filtered due to RAI policies.", + "format": "int32", + "type": "integer" }, - "rubricGroupKey": { - "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.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig": { - "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig", - "description": "The output config for the evaluation run.", - "type": "object", - "properties": { - "bigqueryDestination": { - "description": "BigQuery destination for evaluation output.", - "$ref": "GoogleCloudAiplatformV1BigQueryDestination" + "raiMediaFilteredReasons": { + "description": "Returns rai failure reasons if any.", + "items": { + "type": "string" + }, + "type": "array" }, - "gcsDestination": { - "description": "Cloud Storage destination for evaluation output.", - "$ref": "GoogleCloudAiplatformV1GcsDestination" + "videos": { + "description": "List of video bytes or Cloud Storage URIs of the generated videos.", + "items": { + "$ref": "GoogleCloudAiplatformV1GenerateVideoResponseVideo" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate": { - "id": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate", - "description": "Prompt template used for inference.", - "type": "object", + "GoogleCloudAiplatformV1GenerateVideoResponseVideo": { + "description": "A generated video.", + "id": "GoogleCloudAiplatformV1GenerateVideoResponseVideo", "properties": { - "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}\"", + "bytesBase64Encoded": { + "description": "Base64 encoded bytes string representing the video.", "type": "string" }, "gcsUri": { - "description": "Prompt template stored in Cloud Storage. Format: \"gs://my-bucket/file-name.txt\".", + "description": "Cloud Storage URI where the generated video is written.", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1EvaluationResults": { - "id": "GoogleCloudAiplatformV1EvaluationResults", - "description": "The results of the evaluation run.", - "type": "object", - "properties": { - "summaryMetrics": { - "description": "Optional. The summary metrics for the evaluation run.", - "$ref": "GoogleCloudAiplatformV1SummaryMetrics" }, - "evaluationSet": { - "description": "The evaluation set where item level results are stored.", + "mimeType": { + "description": "The MIME type of the content of the video. - video/mp4", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SummaryMetrics": { - "id": "GoogleCloudAiplatformV1SummaryMetrics", - "description": "The summary metrics for the evaluation run.", - "type": "object", + "GoogleCloudAiplatformV1GenerationConfig": { + "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": "GoogleCloudAiplatformV1GenerationConfig", "properties": { - "metrics": { - "description": "Optional. Map of metric name to metric value.", - "type": "object", - "additionalProperties": { - "type": "any" - } + "audioTimestamp": { + "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.", + "type": "boolean" }, - "totalItems": { - "description": "Optional. The total number of items that were evaluated.", - "type": "integer", - "format": "int32" + "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.", + "format": "int32", + "type": "integer" }, - "failedItems": { - "description": "Optional. The number of items that failed to be evaluated.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1ListEvaluationRunsResponse": { - "id": "GoogleCloudAiplatformV1ListEvaluationRunsResponse", - "description": "Response message for EvaluationManagementService.ListEvaluationRuns.", - "type": "object", - "properties": { - "evaluationRuns": { - "description": "List of EvaluationRuns in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1EvaluationRun" - } + "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" }, - "nextPageToken": { - "description": "A token to retrieve the next page of results.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1CancelEvaluationRunRequest": { - "id": "GoogleCloudAiplatformV1CancelEvaluationRunRequest", - "description": "Request message for EvaluationManagementService.CancelEvaluationRun.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1EvaluationSet": { - "id": "GoogleCloudAiplatformV1EvaluationSet", - "description": "EvaluationSet is a collection of related EvaluationItems that are evaluated together.", - "type": "object", - "properties": { - "name": { - "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", - "type": "string" + "frequencyPenalty": { + "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].", + "format": "float", + "type": "number" }, - "displayName": { - "description": "Required. The display name of the EvaluationSet.", - "type": "string" + "imageConfig": { + "$ref": "GoogleCloudAiplatformV1ImageConfig", + "description": "Optional. Config for image generation features." }, - "evaluationItems": { - "description": "Required. The EvaluationItems that are part of this dataset.", - "type": "array", - "items": { - "type": "string" - } + "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.", + "format": "int32", + "type": "integer" }, - "createTime": { - "description": "Output only. Timestamp when this item was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "maxOutputTokens": { + "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.", + "format": "int32", + "type": "integer" }, - "updateTime": { - "description": "Output only. Timestamp when this item was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "mediaResolution": { + "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.", + "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)." + ], + "type": "string" }, - "metadata": { - "description": "Optional. Metadata for the EvaluationSet.", - "type": "any" - } - } - }, - "GoogleCloudAiplatformV1ListEvaluationSetsResponse": { - "id": "GoogleCloudAiplatformV1ListEvaluationSetsResponse", - "description": "Response message for EvaluationManagementService.ListEvaluationSets.", - "type": "object", - "properties": { - "evaluationSets": { - "description": "List of EvaluationSets in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1EvaluationSet" - } + "presencePenalty": { + "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", + "type": "number" }, - "nextPageToken": { - "description": "A token to retrieve the next page of results.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1EvaluationItem": { - "id": "GoogleCloudAiplatformV1EvaluationItem", - "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.", - "type": "object", - "properties": { - "evaluationRequest": { - "description": "The request to evaluate.", - "$ref": "GoogleCloudAiplatformV1EvaluationRequest" + "responseJsonSchema": { + "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.", + "type": "any" }, - "evaluationResponse": { - "description": "Output only. The response from evaluation.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1EvaluationResult" + "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" }, - "gcsUri": { - "description": "The Cloud Storage object where the request or response is stored.", + "responseMimeType": { + "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.", "type": "string" }, - "name": { - "description": "Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", - "type": "string" + "responseModalities": { + "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" + }, + "type": "array" }, - "displayName": { - "description": "Required. The display name of the EvaluationItem.", - "type": "string" + "responseSchema": { + "$ref": "GoogleCloudAiplatformV1Schema", + "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`." }, - "metadata": { - "description": "Optional. Metadata for the EvaluationItem.", - "type": "any" + "routingConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig", + "description": "Optional. Routing configuration." }, - "labels": { - "description": "Optional. Labels for the EvaluationItem.", - "type": "object", - "additionalProperties": { + "seed": { + "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.", + "format": "int32", + "type": "integer" + }, + "speechConfig": { + "$ref": "GoogleCloudAiplatformV1SpeechConfig", + "description": "Optional. The speech generation config." + }, + "stopSequences": { + "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.", + "items": { "type": "string" - } + }, + "type": "array" }, - "evaluationItemType": { - "description": "Required. The type of the EvaluationItem.", - "type": "string", - "enumDescriptions": [ - "The default value. This value is unused.", - "The EvaluationItem is a request to evaluate.", - "The EvaluationItem is the result of evaluation." - ], - "enum": [ - "EVALUATION_ITEM_TYPE_UNSPECIFIED", - "REQUEST", - "RESULT" - ] + "temperature": { + "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].", + "format": "float", + "type": "number" }, - "createTime": { - "description": "Output only. Timestamp when this item was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "thinkingConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig", + "description": "Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking." }, - "error": { - "description": "Output only. Error for the evaluation item.", - "readOnly": true, - "$ref": "GoogleRpcStatus" + "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" + }, + "topP": { + "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.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationRequest": { - "id": "GoogleCloudAiplatformV1EvaluationRequest", - "description": "Single evaluation request.", - "type": "object", + "GoogleCloudAiplatformV1GenerationConfigRoutingConfig": { + "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.", + "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig", "properties": { - "prompt": { - "description": "Required. The request/prompt to evaluate.", - "$ref": "GoogleCloudAiplatformV1EvaluationPrompt" - }, - "goldenResponse": { - "description": "Optional. The Ideal response or ground truth.", - "$ref": "GoogleCloudAiplatformV1CandidateResponse" - }, - "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": "GoogleCloudAiplatformV1RubricGroup" - } + "autoMode": { + "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode", + "description": "In this mode, the model is selected automatically based on the content of the request." }, - "candidateResponses": { - "description": "Optional. Responses from model under test and other baseline models for comparison.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1CandidateResponse" - } + "manualMode": { + "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode", + "description": "In this mode, the model is specified manually." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationPrompt": { - "id": "GoogleCloudAiplatformV1EvaluationPrompt", - "description": "Prompt to be evaluated.", - "type": "object", + "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode": { + "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.", + "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode", "properties": { - "text": { - "description": "Text prompt.", + "modelRoutingPreference": { + "description": "The model routing preference.", + "enum": [ + "UNKNOWN", + "PRIORITIZE_QUALITY", + "BALANCED", + "PRIORITIZE_COST" + ], + "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." + ], "type": "string" - }, - "value": { - "description": "Fields and values that can be used to populate the prompt template.", - "type": "any" - }, - "promptTemplateData": { - "description": "Prompt template data.", - "$ref": "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData": { - "id": "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData", - "description": "Message to hold a prompt template and the values to populate the template.", - "type": "object", + "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode": { + "description": "The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.", + "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode", "properties": { - "values": { - "description": "The values for fields in the prompt template.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1Content" - } + "modelName": { + "description": "The name of the model to use. Only public LLM models are accepted.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CandidateResponse": { - "id": "GoogleCloudAiplatformV1CandidateResponse", - "description": "Responses from model or agent.", - "type": "object", + "GoogleCloudAiplatformV1GenerationConfigThinkingConfig": { + "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.", + "id": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig", "properties": { - "text": { - "description": "Text response.", - "type": "string" + "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" }, - "value": { - "description": "Fields and values that can be used to populate the response template.", - "type": "any" + "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" }, - "candidate": { - "description": "Required. The name of the candidate that produced the response.", + "thinkingLevel": { + "description": "Optional. The number of thoughts tokens that the model should generate.", + "enum": [ + "THINKING_LEVEL_UNSPECIFIED", + "LOW", + "MEDIUM", + "HIGH", + "MINIMAL" + ], + "enumDescriptions": [ + "Unspecified thinking level.", + "Low thinking level.", + "Medium thinking level.", + "High thinking level.", + "MINIMAL thinking level." + ], "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluationResult": { - "id": "GoogleCloudAiplatformV1EvaluationResult", - "description": "Evaluation result.", - "type": "object", + "GoogleCloudAiplatformV1GenericOperationMetadata": { + "description": "Generic Metadata shared by all operations.", + "id": "GoogleCloudAiplatformV1GenericOperationMetadata", "properties": { - "evaluationRequest": { - "description": "Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}", - "type": "string" - }, - "evaluationRun": { - "description": "Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}", - "type": "string" - }, - "request": { - "description": "Required. The request that was evaluated.", - "$ref": "GoogleCloudAiplatformV1EvaluationRequest" - }, - "metric": { - "description": "Required. The metric that was evaluated.", + "createTime": { + "description": "Output only. Time when the operation was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "candidateResults": { - "description": "Optional. The results for the metric.", - "type": "array", + "partialFailures": { + "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": "GoogleCloudAiplatformV1CandidateResult" - } + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" }, - "metadata": { - "description": "Optional. Metadata about the evaluation result.", - "type": "any" + "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.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CandidateResult": { - "id": "GoogleCloudAiplatformV1CandidateResult", - "description": "Result for a single candidate.", - "type": "object", + "GoogleCloudAiplatformV1GenieSource": { + "description": "Contains information about the source of the models generated from Generative AI Studio.", + "id": "GoogleCloudAiplatformV1GenieSource", "properties": { - "score": { - "description": "Optional. The score for the metric.", - "type": "number", - "format": "float" - }, - "candidate": { - "description": "Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.", - "type": "string" - }, - "metric": { - "description": "Required. The metric that was evaluated.", - "type": "string" - }, - "explanation": { - "description": "Optional. The explanation for the metric.", + "baseModelUri": { + "description": "Required. The public base model URI.", "type": "string" - }, - "rubricVerdicts": { - "description": "Optional. The rubric verdicts for the metric.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1RubricVerdict" - } - }, - "additionalResults": { - "description": "Optional. Additional results for the metric.", - "type": "any" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListEvaluationItemsResponse": { - "id": "GoogleCloudAiplatformV1ListEvaluationItemsResponse", - "description": "Response message for EvaluationManagementService.ListEvaluationItems.", - "type": "object", + "GoogleCloudAiplatformV1GoogleDriveSource": { + "description": "The Google Drive location for the input content.", + "id": "GoogleCloudAiplatformV1GoogleDriveSource", "properties": { - "evaluationItems": { - "description": "List of EvaluationItems in the requested page.", - "type": "array", + "resourceIds": { + "description": "Required. Google Drive resource IDs.", "items": { - "$ref": "GoogleCloudAiplatformV1EvaluationItem" - } - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results.", - "type": "string" + "$ref": "GoogleCloudAiplatformV1GoogleDriveSourceResourceId" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReadFeatureValuesRequest": { - "id": "GoogleCloudAiplatformV1ReadFeatureValuesRequest", - "description": "Request message for FeaturestoreOnlineServingService.ReadFeatureValues.", - "type": "object", + "GoogleCloudAiplatformV1GoogleDriveSourceResourceId": { + "description": "The type and ID of the Google Drive resource.", + "id": "GoogleCloudAiplatformV1GoogleDriveSourceResourceId", "properties": { - "entityId": { - "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`.", + "resourceId": { + "description": "Required. The ID of the Google Drive resource.", "type": "string" }, - "featureSelector": { - "description": "Required. Selector choosing Features of the target EntityType.", - "$ref": "GoogleCloudAiplatformV1FeatureSelector" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureSelector": { - "id": "GoogleCloudAiplatformV1FeatureSelector", - "description": "Selector for Features of an EntityType.", - "type": "object", + "GoogleCloudAiplatformV1GoogleMaps": { + "description": "Tool to retrieve public maps data for grounding, powered by Google.", + "id": "GoogleCloudAiplatformV1GoogleMaps", "properties": { - "idMatcher": { - "description": "Required. Matches Features based on ID.", - "$ref": "GoogleCloudAiplatformV1IdMatcher" + "enableWidget": { + "description": "Optional. If true, include the widget context token in the response.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1IdMatcher": { - "id": "GoogleCloudAiplatformV1IdMatcher", - "description": "Matcher for Features of an EntityType by Feature ID.", - "type": "object", + "GoogleCloudAiplatformV1GoogleSearchRetrieval": { + "description": "Tool to retrieve public web data for grounding, powered by Google.", + "id": "GoogleCloudAiplatformV1GoogleSearchRetrieval", "properties": { - "ids": { - "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.", - "type": "array", - "items": { - "type": "string" - } + "dynamicRetrievalConfig": { + "$ref": "GoogleCloudAiplatformV1DynamicRetrievalConfig", + "description": "Specifies the dynamic retrieval configuration for the given source." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReadFeatureValuesResponse": { - "id": "GoogleCloudAiplatformV1ReadFeatureValuesResponse", - "description": "Response message for FeaturestoreOnlineServingService.ReadFeatureValues.", - "type": "object", + "GoogleCloudAiplatformV1GroundednessInput": { + "description": "Input for groundedness metric.", + "id": "GoogleCloudAiplatformV1GroundednessInput", "properties": { - "header": { - "description": "Response header.", - "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader" + "instance": { + "$ref": "GoogleCloudAiplatformV1GroundednessInstance", + "description": "Required. Groundedness instance." }, - "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": "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1GroundednessSpec", + "description": "Required. Spec for groundedness metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader": { - "id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader", - "description": "Response header with metadata for the requested ReadFeatureValuesRequest.entity_type and Features.", - "type": "object", + "GoogleCloudAiplatformV1GroundednessInstance": { + "description": "Spec for groundedness instance.", + "id": "GoogleCloudAiplatformV1GroundednessInstance", "properties": { - "entityType": { - "description": "The resource name of the EntityType from the ReadFeatureValuesRequest. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.", + "context": { + "description": "Required. Background information provided in context used to compare against the prediction.", "type": "string" }, - "featureDescriptors": { - "description": "List of Feature metadata corresponding to each piece of ReadFeatureValuesResponse.EntityView.data.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor" - } - } - } - }, - "GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor": { - "id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor", - "description": "Metadata for requested Features.", - "type": "object", - "properties": { - "id": { - "description": "Feature ID.", + "prediction": { + "description": "Required. Output of the evaluated model.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView": { - "id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView", - "description": "Entity view with Feature values.", - "type": "object", + "GoogleCloudAiplatformV1GroundednessResult": { + "description": "Spec for groundedness result.", + "id": "GoogleCloudAiplatformV1GroundednessResult", "properties": { - "entityId": { - "description": "ID of the requested entity.", + "confidence": { + "description": "Output only. Confidence for groundedness score.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "explanation": { + "description": "Output only. Explanation for groundedness score.", + "readOnly": true, "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData" - } + "score": { + "description": "Output only. Groundedness score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData": { - "id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData", - "description": "Container to hold value(s), successive in time, for one Feature from the request.", - "type": "object", + "GoogleCloudAiplatformV1GroundednessSpec": { + "description": "Spec for groundedness metric.", + "id": "GoogleCloudAiplatformV1GroundednessSpec", "properties": { - "value": { - "description": "Feature value if a single value is requested.", - "$ref": "GoogleCloudAiplatformV1FeatureValue" - }, - "values": { - "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.", - "$ref": "GoogleCloudAiplatformV1FeatureValueList" + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureValue": { - "id": "GoogleCloudAiplatformV1FeatureValue", - "description": "Value for a feature.", - "type": "object", + "GoogleCloudAiplatformV1GroundingChunk": { + "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.", + "id": "GoogleCloudAiplatformV1GroundingChunk", "properties": { - "boolValue": { - "description": "Bool type feature value.", - "type": "boolean" + "image": { + "$ref": "GoogleCloudAiplatformV1GroundingChunkImage", + "description": "A grounding chunk from an image search result. See the `Image` message for details." }, - "doubleValue": { - "description": "Double type feature value.", - "type": "number", - "format": "double" + "maps": { + "$ref": "GoogleCloudAiplatformV1GroundingChunkMaps", + "description": "A grounding chunk from Google Maps. See the `Maps` message for details." }, - "int64Value": { - "description": "Int64 feature value.", - "type": "string", - "format": "int64" + "retrievedContext": { + "$ref": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", + "description": "A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details" }, - "stringValue": { - "description": "String feature value.", + "web": { + "$ref": "GoogleCloudAiplatformV1GroundingChunkWeb", + "description": "A grounding chunk from a web page, typically from Google Search. See the `Web` message for details." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GroundingChunkImage": { + "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.", + "id": "GoogleCloudAiplatformV1GroundingChunkImage", + "properties": { + "domain": { + "description": "The domain of the image search result page.", "type": "string" }, - "boolArrayValue": { - "description": "A list of bool type feature value.", - "$ref": "GoogleCloudAiplatformV1BoolArray" - }, - "doubleArrayValue": { - "description": "A list of double type feature value.", - "$ref": "GoogleCloudAiplatformV1DoubleArray" - }, - "int64ArrayValue": { - "description": "A list of int64 type feature value.", - "$ref": "GoogleCloudAiplatformV1Int64Array" - }, - "stringArrayValue": { - "description": "A list of string type feature value.", - "$ref": "GoogleCloudAiplatformV1StringArray" - }, - "bytesValue": { - "description": "Bytes feature value.", - "type": "string", - "format": "byte" + "imageUri": { + "description": "The URI of the image.", + "type": "string" }, - "structValue": { - "description": "A struct type feature value.", - "$ref": "GoogleCloudAiplatformV1StructValue" + "sourceUri": { + "description": "The URI of the image search result page.", + "type": "string" }, - "metadata": { - "description": "Metadata of feature value.", - "$ref": "GoogleCloudAiplatformV1FeatureValueMetadata" - } - } - }, - "GoogleCloudAiplatformV1BoolArray": { - "id": "GoogleCloudAiplatformV1BoolArray", - "description": "A list of boolean values.", - "type": "object", - "properties": { - "values": { - "description": "A list of bool values.", - "type": "array", - "items": { - "type": "boolean" - } - } - } - }, - "GoogleCloudAiplatformV1DoubleArray": { - "id": "GoogleCloudAiplatformV1DoubleArray", - "description": "A list of double values.", - "type": "object", - "properties": { - "values": { - "description": "A list of double values.", - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } - } - }, - "GoogleCloudAiplatformV1Int64Array": { - "id": "GoogleCloudAiplatformV1Int64Array", - "description": "A list of int64 values.", - "type": "object", - "properties": { - "values": { - "description": "A list of int64 values.", - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - } - } - }, - "GoogleCloudAiplatformV1StringArray": { - "id": "GoogleCloudAiplatformV1StringArray", - "description": "A list of string values.", - "type": "object", - "properties": { - "values": { - "description": "A list of string values.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1StructValue": { - "id": "GoogleCloudAiplatformV1StructValue", - "description": "Struct (or object) type feature value.", - "type": "object", - "properties": { - "values": { - "description": "A list of field values.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1StructFieldValue" - } + "title": { + "description": "The title of the image search result page.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1StructFieldValue": { - "id": "GoogleCloudAiplatformV1StructFieldValue", - "description": "One field of a Struct (or object) type feature value.", - "type": "object", + "GoogleCloudAiplatformV1GroundingChunkMaps": { + "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.", + "id": "GoogleCloudAiplatformV1GroundingChunkMaps", "properties": { - "name": { - "description": "Name of the field in the struct feature.", + "placeAnswerSources": { + "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources", + "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." + }, + "placeId": { + "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.", + "type": "string" + }, + "route": { + "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsRoute", + "description": "Output only. Route information.", + "readOnly": true + }, + "text": { + "description": "The text of the place answer.", "type": "string" }, - "value": { - "description": "The value for this field.", - "$ref": "GoogleCloudAiplatformV1FeatureValue" - } - } - }, - "GoogleCloudAiplatformV1FeatureValueMetadata": { - "id": "GoogleCloudAiplatformV1FeatureValueMetadata", - "description": "Metadata of feature value.", - "type": "object", - "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.", - "type": "string", - "format": "google-datetime" + "title": { + "description": "The title of the place.", + "type": "string" + }, + "uri": { + "description": "The URI of the place.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureValueList": { - "id": "GoogleCloudAiplatformV1FeatureValueList", - "description": "Container for list of values.", - "type": "object", + "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources": { + "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.", + "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources", "properties": { - "values": { - "description": "A list of feature values. All of them should be the same data type.", - "type": "array", + "reviewSnippets": { + "description": "Snippets of reviews that were used to generate the answer.", "items": { - "$ref": "GoogleCloudAiplatformV1FeatureValue" - } + "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest": { - "id": "GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest", - "description": "Request message for FeaturestoreOnlineServingService.StreamingReadFeatureValues.", - "type": "object", + "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { + "description": "A review snippet that is used to generate the answer.", + "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { - "entityIds": { - "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": "array", - "items": { - "type": "string" - } + "googleMapsUri": { + "description": "A link to show the review on Google Maps.", + "type": "string" }, - "featureSelector": { - "description": "Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.", - "$ref": "GoogleCloudAiplatformV1FeatureSelector" + "reviewId": { + "description": "The ID of the review that is being referenced.", + "type": "string" + }, + "title": { + "description": "The title of the review.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1WriteFeatureValuesRequest": { - "id": "GoogleCloudAiplatformV1WriteFeatureValuesRequest", - "description": "Request message for FeaturestoreOnlineServingService.WriteFeatureValues.", - "type": "object", + "GoogleCloudAiplatformV1GroundingChunkMapsRoute": { + "description": "Route information from Google Maps.", + "id": "GoogleCloudAiplatformV1GroundingChunkMapsRoute", "properties": { - "payloads": { - "description": "Required. The entities to be written. Up to 100,000 feature values can be written across all `payloads`.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1WriteFeatureValuesPayload" - } + "distanceMeters": { + "description": "The total distance of the route, in meters.", + "format": "int32", + "type": "integer" + }, + "duration": { + "description": "The total duration of the route.", + "format": "google-duration", + "type": "string" + }, + "encodedPolyline": { + "description": "An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1WriteFeatureValuesPayload": { - "id": "GoogleCloudAiplatformV1WriteFeatureValuesPayload", - "description": "Contains Feature values to be written for a specific entity.", - "type": "object", + "GoogleCloudAiplatformV1GroundingChunkRetrievedContext": { + "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": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", "properties": { - "entityId": { - "description": "Required. The ID of the entity.", + "documentName": { + "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}`.", + "readOnly": true, "type": "string" }, - "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": "GoogleCloudAiplatformV1FeatureValue" - } + "ragChunk": { + "$ref": "GoogleCloudAiplatformV1RagChunk", + "description": "Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used." + }, + "text": { + "description": "The content of the retrieved data source.", + "type": "string" + }, + "title": { + "description": "The title of the retrieved data source.", + "type": "string" + }, + "uri": { + "description": "The URI of the retrieved data source.", + "type": "string" } - } - }, - "GoogleCloudAiplatformV1WriteFeatureValuesResponse": { - "id": "GoogleCloudAiplatformV1WriteFeatureValuesResponse", - "description": "Response message for FeaturestoreOnlineServingService.WriteFeatureValues.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1Featurestore": { - "id": "GoogleCloudAiplatformV1Featurestore", - "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.", - "type": "object", + "GoogleCloudAiplatformV1GroundingChunkWeb": { + "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.", + "id": "GoogleCloudAiplatformV1GroundingChunkWeb", "properties": { - "name": { - "description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "readOnly": true, + "domain": { + "description": "The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.", "type": "string" }, - "createTime": { - "description": "Output only. Timestamp when this Featurestore was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "title": { + "description": "The title of the web page that contains the evidence.", + "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp when this Featurestore was last updated.", + "uri": { + "description": "The URI of the web page that contains the evidence.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GroundingMetadata": { + "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.", + "id": "GoogleCloudAiplatformV1GroundingMetadata", + "properties": { + "googleMapsWidgetContextToken": { + "description": "Optional. Output only. 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.", "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "etag": { - "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, - "labels": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "groundingChunks": { + "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": "GoogleCloudAiplatformV1GroundingChunk" + }, + "type": "array" }, - "onlineServingConfig": { - "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.", - "$ref": "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig" + "groundingSupports": { + "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": "GoogleCloudAiplatformV1GroundingSupport" + }, + "type": "array" }, - "state": { - "description": "Output only. State of the featurestore.", - "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." - ], - "enum": [ - "STATE_UNSPECIFIED", - "STABLE", - "UPDATING" - ] + "imageSearchQueries": { + "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" + }, + "type": "array" }, - "onlineStorageTtlDays": { - "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", - "type": "integer", - "format": "int32" + "retrievalMetadata": { + "$ref": "GoogleCloudAiplatformV1RetrievalMetadata", + "description": "Optional. Output only. Metadata related to the retrieval grounding source.", + "readOnly": true }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" + "searchEntryPoint": { + "$ref": "GoogleCloudAiplatformV1SearchEntryPoint", + "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." }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", + "sourceFlaggingUris": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri" + }, "readOnly": true, - "type": "boolean" + "type": "array" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig": { - "id": "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig", - "description": "OnlineServingConfig specifies the details for provisioning online serving resources.", - "type": "object", + "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri": { + "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.", + "id": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri", "properties": { - "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.", - "type": "integer", - "format": "int32" + "flagContentUri": { + "description": "The URI that can be used to flag the content.", + "type": "string" }, - "scaling": { - "description": "Online serving scaling configuration. Only one of `fixed_node_count` and `scaling` can be set. Setting one will reset the other.", - "$ref": "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling" + "sourceId": { + "description": "The ID of the place or review.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling": { - "id": "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling", - "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).", - "type": "object", + "GoogleCloudAiplatformV1GroundingSupport": { + "description": "A collection of supporting references for a segment or part of the model's response.", + "id": "GoogleCloudAiplatformV1GroundingSupport", "properties": { - "minNodeCount": { - "description": "Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.", - "type": "integer", - "format": "int32" + "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.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" }, - "maxNodeCount": { - "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'.", - "type": "integer", - "format": "int32" + "groundingChunkIndices": { + "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.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" }, - "cpuUtilizationTarget": { - "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.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1ListFeaturestoresResponse": { - "id": "GoogleCloudAiplatformV1ListFeaturestoresResponse", - "description": "Response message for FeaturestoreService.ListFeaturestores.", - "type": "object", - "properties": { - "featurestores": { - "description": "The Featurestores matching the request.", - "type": "array", + "renderedParts": { + "description": "Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message.", "items": { - "$ref": "GoogleCloudAiplatformV1Featurestore" - } + "format": "int32", + "type": "integer" + }, + "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" + "segment": { + "$ref": "GoogleCloudAiplatformV1Segment", + "description": "The content segment that this support message applies to." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EntityType": { - "id": "GoogleCloudAiplatformV1EntityType", - "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.", - "type": "object", + "GoogleCloudAiplatformV1HyperparameterTuningJob": { + "description": "Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.", + "id": "GoogleCloudAiplatformV1HyperparameterTuningJob", "properties": { - "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.", + "createTime": { + "description": "Output only. Time when the HyperparameterTuningJob was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "description": { - "description": "Optional. Description of the EntityType.", + "displayName": { + "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.", "type": "string" }, - "createTime": { - "description": "Output only. Timestamp when this EntityType was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "updateTime": { - "description": "Output only. Timestamp when this EntityType was most recently updated.", + "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", - "format": "google-datetime" + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.", + "readOnly": true }, "labels": { - "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.", - "type": "object", "additionalProperties": { "type": "string" - } - }, - "etag": { - "description": "Optional. Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", - "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" }, - "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": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfig" + "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" }, - "offlineStorageTtlDays": { - "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.", - "type": "integer", - "format": "int32" + "maxTrialCount": { + "description": "Required. The desired total number of Trials.", + "format": "int32", + "type": "integer" }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", + "name": { + "description": "Output only. Resource name of the HyperparameterTuningJob.", "readOnly": true, - "type": "boolean" + "type": "string" + }, + "parallelTrialCount": { + "description": "Required. The desired number of Trials to run in parallel.", + "format": "int32", + "type": "integer" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1FeaturestoreMonitoringConfig": { - "id": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfig", - "description": "Configuration of how features in Featurestore are monitored.", - "type": "object", - "properties": { - "snapshotAnalysis": { - "description": "The config for Snapshot Analysis Based Feature Monitoring.", - "$ref": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis" - }, - "importFeaturesAnalysis": { - "description": "The config for ImportFeatures Analysis Based Feature Monitoring.", - "$ref": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis" - }, - "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": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig" }, - "categoricalThresholdConfig": { - "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).", - "$ref": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig" - } - } - }, - "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis": { - "id": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis", - "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", - "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.", + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, "type": "boolean" }, - "monitoringIntervalDays": { - "description": "Configuration of the snapshot analysis based monitoring pipeline running interval. The value indicates number of days.", - "type": "integer", - "format": "int32" + "startTime": { + "description": "Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.", + "format": "google-datetime", + "readOnly": true, + "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.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis": { - "id": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis", - "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.", - "type": "object", - "properties": { "state": { - "description": "Whether to enable / disable / inherite default hebavior for import features analysis.", - "type": "string", - "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." - ], + "description": "Output only. The detailed state of the job.", "enum": [ - "STATE_UNSPECIFIED", - "DEFAULT", - "ENABLED", - "DISABLED" - ] - }, - "anomalyDetectionBaseline": { - "description": "The baseline used to do anomaly detection for the statistics generated by import features analysis.", - "type": "string", + "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": [ - "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." + "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": [ - "BASELINE_UNSPECIFIED", - "LATEST_STATS", - "MOST_RECENT_SNAPSHOT_STATS", - "PREVIOUS_IMPORT_FEATURES_STATS" - ] - } - } - }, - "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig": { - "id": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig", - "description": "The config for Featurestore Monitoring threshold.", - "type": "object", - "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" - } - } - }, - "GoogleCloudAiplatformV1ListEntityTypesResponse": { - "id": "GoogleCloudAiplatformV1ListEntityTypesResponse", - "description": "Response message for FeaturestoreService.ListEntityTypes.", - "type": "object", - "properties": { - "entityTypes": { - "description": "The EntityTypes matching the request.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1EntityType" - } - }, - "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" - } - } - }, - "GoogleCloudAiplatformV1Feature": { - "id": "GoogleCloudAiplatformV1Feature", - "description": "Feature Metadata information. For example, color is a feature that describes an apple.", - "type": "object", - "properties": { - "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.", + "readOnly": true, "type": "string" }, - "description": { - "description": "Description of the Feature.", - "type": "string" + "studySpec": { + "$ref": "GoogleCloudAiplatformV1StudySpec", + "description": "Required. Study configuration of the HyperparameterTuningJob." }, - "valueType": { - "description": "Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.", - "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." - ], - "enum": [ - "VALUE_TYPE_UNSPECIFIED", - "BOOL", - "BOOL_ARRAY", - "DOUBLE", - "DOUBLE_ARRAY", - "INT64", - "INT64_ARRAY", - "STRING", - "STRING_ARRAY", - "BYTES", - "STRUCT" - ] + "trialJobSpec": { + "$ref": "GoogleCloudAiplatformV1CustomJobSpec", + "description": "Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials." }, - "createTime": { - "description": "Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.", + "trials": { + "description": "Output only. Trials of the HyperparameterTuningJob.", + "items": { + "$ref": "GoogleCloudAiplatformV1Trial" + }, "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "array" }, "updateTime": { - "description": "Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.", + "description": "Output only. Time when the HyperparameterTuningJob was most recently updated.", + "format": "google-datetime", "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "labels": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "etag": { - "description": "Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" - }, - "disableMonitoring": { - "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.", - "type": "boolean" - }, - "monitoringStatsAnomalies": { - "description": "Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.", - "readOnly": true, - "type": "array", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1IdMatcher": { + "description": "Matcher for Features of an EntityType by Feature ID.", + "id": "GoogleCloudAiplatformV1IdMatcher", + "properties": { + "ids": { + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly" - } - }, - "versionColumnName": { - "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.", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ImageConfig": { + "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": "GoogleCloudAiplatformV1ImageConfig", + "properties": { + "aspectRatio": { + "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\"", "type": "string" }, - "pointOfContact": { - "description": "Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.", + "imageOutputOptions": { + "$ref": "GoogleCloudAiplatformV1ImageConfigImageOutputOptions", + "description": "Optional. The image output format for generated images." + }, + "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" - } - } - }, - "GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly": { - "id": "GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly", - "description": "A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.", - "type": "object", - "properties": { - "objective": { - "description": "Output only. The objective for each stats.", - "readOnly": true, - "type": "string", + }, + "personGeneration": { + "description": "Optional. Controls whether the model can generate people.", + "enum": [ + "PERSON_GENERATION_UNSPECIFIED", + "ALLOW_ALL", + "ALLOW_ADULT", + "ALLOW_NONE" + ], "enumDescriptions": [ - "If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty.", - "Stats are generated by Import Feature Analysis.", - "Stats are generated by Snapshot Analysis." + "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." ], - "enum": [ - "OBJECTIVE_UNSPECIFIED", - "IMPORT_FEATURE_ANALYSIS", - "SNAPSHOT_ANALYSIS" - ] + "type": "string" }, - "featureStatsAnomaly": { - "description": "Output only. The stats and anomalies generated at specific timestamp.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1FeatureStatsAnomaly" + "prominentPeople": { + "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.", + "enum": [ + "PROMINENT_PEOPLE_UNSPECIFIED", + "ALLOW_PROMINENT_PEOPLE", + "BLOCK_PROMINENT_PEOPLE" + ], + "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." + ], + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureStatsAnomaly": { - "id": "GoogleCloudAiplatformV1FeatureStatsAnomaly", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ImageConfigImageOutputOptions": { + "description": "The image output format for generated images.", + "id": "GoogleCloudAiplatformV1ImageConfigImageOutputOptions", "properties": { - "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" - }, - "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" + "compressionQuality": { + "description": "Optional. The compression quality of the output image.", + "format": "int32", + "type": "integer" }, - "anomalyUri": { - "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).", + "mimeType": { + "description": "Optional. The image format that the output should be saved as.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ImportDataConfig": { + "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.", + "id": "GoogleCloudAiplatformV1ImportDataConfig", + "properties": { + "annotationLabels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" }, - "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.", - "type": "number", - "format": "double" - }, - "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" + "dataItemLabels": { + "additionalProperties": { + "type": "string" + }, + "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" }, - "startTime": { - "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).", - "type": "string", - "format": "google-datetime" + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1GcsSource", + "description": "The Google Cloud Storage location for the input content." }, - "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).", - "type": "string", - "format": "google-datetime" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchCreateFeaturesRequest": { - "id": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest", - "description": "Request message for FeaturestoreService.BatchCreateFeatures. Request message for FeatureRegistryService.BatchCreateFeatures.", - "type": "object", + "GoogleCloudAiplatformV1ImportDataOperationMetadata": { + "description": "Runtime operation information for DatasetService.ImportData.", + "id": "GoogleCloudAiplatformV1ImportDataOperationMetadata", "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", + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The common part of the operation metadata." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ImportDataRequest": { + "description": "Request message for DatasetService.ImportData.", + "id": "GoogleCloudAiplatformV1ImportDataRequest", + "properties": { + "importConfigs": { + "description": "Required. The desired input locations. The contents of all input locations will be imported in one batch.", "items": { - "$ref": "GoogleCloudAiplatformV1CreateFeatureRequest" - } + "$ref": "GoogleCloudAiplatformV1ImportDataConfig" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateFeatureRequest": { - "id": "GoogleCloudAiplatformV1CreateFeatureRequest", - "description": "Request message for FeaturestoreService.CreateFeature. Request message for FeatureRegistryService.CreateFeature.", - "type": "object", + "GoogleCloudAiplatformV1ImportDataResponse": { + "description": "Response message for DatasetService.ImportData.", + "id": "GoogleCloudAiplatformV1ImportDataResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata": { + "description": "Details of operations that perform import Feature values.", + "id": "GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata", "properties": { - "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}`", + "blockingOperationIds": { + "description": "List of ImportFeatureValues operations running under a single EntityType that are blocking this operation.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Featurestore import Feature values." + }, + "importedEntityCount": { + "description": "Number of entities that have been imported by the operation.", + "format": "int64", "type": "string" }, - "feature": { - "description": "Required. The Feature to create.", - "$ref": "GoogleCloudAiplatformV1Feature" + "importedFeatureValueCount": { + "description": "Number of Feature values that have been imported by the operation.", + "format": "int64", + "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.", + "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" - } - } - }, - "GoogleCloudAiplatformV1ListFeaturesResponse": { - "id": "GoogleCloudAiplatformV1ListFeaturesResponse", - "description": "Response message for FeaturestoreService.ListFeatures. Response message for FeatureRegistryService.ListFeatures.", - "type": "object", - "properties": { - "features": { - "description": "The Features matching the request.", - "type": "array", + }, + "sourceUris": { + "description": "The source URI from where Feature values are imported.", "items": { - "$ref": "GoogleCloudAiplatformV1Feature" - } + "type": "string" + }, + "type": "array" }, - "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.", + "timestampOutsideRetentionRowsCount": { + "description": "The number rows that weren't ingested due to having timestamps outside the retention boundary.", + "format": "int64", "type": "string" } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1ImportFeatureValuesRequest": { - "id": "GoogleCloudAiplatformV1ImportFeatureValuesRequest", "description": "Request message for FeaturestoreService.ImportFeatureValues.", - "type": "object", + "id": "GoogleCloudAiplatformV1ImportFeatureValuesRequest", "properties": { "avroSource": { "$ref": "GoogleCloudAiplatformV1AvroSource" @@ -37188,14 +44543,13 @@ "csvSource": { "$ref": "GoogleCloudAiplatformV1CsvSource" }, - "featureTimeField": { - "description": "Source column that holds the Feature timestamp for all Feature values in each entity.", - "type": "string" + "disableIngestionAnalysis": { + "description": "If true, API doesn't start ingestion analysis pipeline.", + "type": "boolean" }, - "featureTime": { - "description": "Single Feature timestamp for all entities being imported. The timestamp must not have higher than millisecond precision.", - "type": "string", - "format": "google-datetime" + "disableOnlineServing": { + "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.", + "type": "boolean" }, "entityIdField": { "description": "Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.", @@ -37203,52 +44557,31 @@ }, "featureSpecs": { "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.", - "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec" - } + }, + "type": "array" }, - "disableOnlineServing": { - "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.", - "type": "boolean" + "featureTime": { + "description": "Single Feature timestamp for all entities being imported. The timestamp must not have higher than millisecond precision.", + "format": "google-datetime", + "type": "string" + }, + "featureTimeField": { + "description": "Source column that holds the Feature timestamp for all Feature values in each entity.", + "type": "string" }, "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.", - "type": "integer", - "format": "int32" - }, - "disableIngestionAnalysis": { - "description": "If true, API doesn't start ingestion analysis pipeline.", - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1AvroSource": { - "id": "GoogleCloudAiplatformV1AvroSource", - "description": "The storage details for Avro input content.", - "type": "object", - "properties": { - "gcsSource": { - "description": "Required. Google Cloud Storage location.", - "$ref": "GoogleCloudAiplatformV1GcsSource" - } - } - }, - "GoogleCloudAiplatformV1CsvSource": { - "id": "GoogleCloudAiplatformV1CsvSource", - "description": "The storage details for CSV input content.", - "type": "object", - "properties": { - "gcsSource": { - "description": "Required. Google Cloud Storage location.", - "$ref": "GoogleCloudAiplatformV1GcsSource" + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec": { - "id": "GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec", "description": "Defines the Feature value(s) to import.", - "type": "object", + "id": "GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec", "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.", @@ -37258,4956 +44591,4652 @@ "description": "Source column to get the Feature values from. If not set, uses the column with the same name as the Feature ID.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchReadFeatureValuesRequest": { - "id": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequest", - "description": "Request message for FeaturestoreService.BatchReadFeatureValues.", - "type": "object", + "GoogleCloudAiplatformV1ImportFeatureValuesResponse": { + "description": "Response message for FeaturestoreService.ImportFeatureValues.", + "id": "GoogleCloudAiplatformV1ImportFeatureValuesResponse", "properties": { - "csvReadInstances": { - "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`.", - "$ref": "GoogleCloudAiplatformV1CsvSource" - }, - "bigqueryReadInstances": { - "description": "Similar to csv_read_instances, but from BigQuery source.", - "$ref": "GoogleCloudAiplatformV1BigQuerySource" - }, - "destination": { - "description": "Required. Specifies output location and format.", - "$ref": "GoogleCloudAiplatformV1FeatureValueDestination" - }, - "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": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField" - } - }, - "entityTypeSpecs": { - "description": "Required. Specifies EntityType grouping Features to read values of and settings.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec" - } + "importedEntityCount": { + "description": "Number of entities that have been imported by the operation.", + "format": "int64", + "type": "string" }, - "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.", - "type": "string", - "format": "google-datetime" - } - } - }, - "GoogleCloudAiplatformV1FeatureValueDestination": { - "id": "GoogleCloudAiplatformV1FeatureValueDestination", - "description": "A destination location for Feature values and format.", - "type": "object", - "properties": { - "bigqueryDestination": { - "description": "Output in BigQuery format. BigQueryDestination.output_uri in FeatureValueDestination.bigquery_destination must refer to a table.", - "$ref": "GoogleCloudAiplatformV1BigQueryDestination" + "importedFeatureValueCount": { + "description": "Number of Feature values that have been imported by the operation.", + "format": "int64", + "type": "string" }, - "tfrecordDestination": { - "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", - "$ref": "GoogleCloudAiplatformV1TFRecordDestination" + "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" }, - "csvDestination": { - "description": "Output in CSV format. Array Feature value types are not allowed in CSV format.", - "$ref": "GoogleCloudAiplatformV1CsvDestination" - } - } - }, - "GoogleCloudAiplatformV1TFRecordDestination": { - "id": "GoogleCloudAiplatformV1TFRecordDestination", - "description": "The storage details for TFRecord output content.", - "type": "object", - "properties": { - "gcsDestination": { - "description": "Required. Google Cloud Storage location.", - "$ref": "GoogleCloudAiplatformV1GcsDestination" - } - } - }, - "GoogleCloudAiplatformV1CsvDestination": { - "id": "GoogleCloudAiplatformV1CsvDestination", - "description": "The storage details for CSV output content.", - "type": "object", - "properties": { - "gcsDestination": { - "description": "Required. Google Cloud Storage location.", - "$ref": "GoogleCloudAiplatformV1GcsDestination" + "timestampOutsideRetentionRowsCount": { + "description": "The number rows that weren't ingested due to having feature timestamps outside the retention boundary.", + "format": "int64", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField": { - "id": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField", - "description": "Describe pass-through fields in read_instance source.", - "type": "object", + "GoogleCloudAiplatformV1ImportModelEvaluationRequest": { + "description": "Request message for ModelService.ImportModelEvaluation", + "id": "GoogleCloudAiplatformV1ImportModelEvaluationRequest", "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" + "modelEvaluation": { + "$ref": "GoogleCloudAiplatformV1ModelEvaluation", + "description": "Required. Model evaluation resource to be imported." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec": { - "id": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec", - "description": "Selects Features of an EntityType to read values of and specifies read settings.", - "type": "object", + "GoogleCloudAiplatformV1ImportRagFilesConfig": { + "description": "Config for importing RagFiles.", + "id": "GoogleCloudAiplatformV1ImportRagFilesConfig", "properties": { - "entityTypeId": { - "description": "Required. ID of the EntityType to select Features. The EntityType id is the entity_type_id specified during EntityType creation.", - "type": "string" + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1GcsSource", + "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`" }, - "featureSelector": { - "description": "Required. Selectors choosing which Feature values to read from the EntityType.", - "$ref": "GoogleCloudAiplatformV1FeatureSelector" + "googleDriveSource": { + "$ref": "GoogleCloudAiplatformV1GoogleDriveSource", + "description": "Google Drive location. Supports importing individual files as well as Google Drive folders." }, - "settings": { - "description": "Per-Feature settings for the batch read.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DestinationFeatureSetting" - } - } - } - }, - "GoogleCloudAiplatformV1DestinationFeatureSetting": { - "id": "GoogleCloudAiplatformV1DestinationFeatureSetting", - "type": "object", - "properties": { - "featureId": { - "description": "Required. The ID of the Feature to apply the setting to.", - "type": "string" + "importResultBigquerySink": { + "$ref": "GoogleCloudAiplatformV1BigQueryDestination", + "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." }, - "destinationField": { - "description": "Specify the field name in the export destination. If not specified, Feature ID is used.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1ExportFeatureValuesRequest": { - "id": "GoogleCloudAiplatformV1ExportFeatureValuesRequest", - "description": "Request message for FeaturestoreService.ExportFeatureValues.", - "type": "object", - "properties": { - "snapshotExport": { - "description": "Exports the latest Feature values of all entities of the EntityType within a time range.", - "$ref": "GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport" + "importResultGcsSink": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "The Cloud Storage path to write import result to." }, - "fullExport": { - "description": "Exports all historical values of all entities of the EntityType within a time range", - "$ref": "GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport" + "jiraSource": { + "$ref": "GoogleCloudAiplatformV1JiraSource", + "description": "Jira queries with their corresponding authentication." }, - "destination": { - "description": "Required. Specifies destination location and format.", - "$ref": "GoogleCloudAiplatformV1FeatureValueDestination" + "maxEmbeddingRequestsPerMin": { + "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.", + "format": "int32", + "type": "integer" }, - "featureSelector": { - "description": "Required. Selects Features to export values of.", - "$ref": "GoogleCloudAiplatformV1FeatureSelector" + "partialFailureBigquerySink": { + "$ref": "GoogleCloudAiplatformV1BigQueryDestination", + "deprecated": true, + "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`." }, - "settings": { - "description": "Per-Feature export settings.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DestinationFeatureSetting" - } - } - } - }, - "GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport": { - "id": "GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport", - "description": "Describes exporting the latest Feature values of all entities of the EntityType between [start_time, snapshot_time].", - "type": "object", - "properties": { - "snapshotTime": { - "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", - "format": "google-datetime" + "partialFailureGcsSink": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "deprecated": true, + "description": "The Cloud Storage path to write partial failures to. Deprecated. Prefer to use `import_result_gcs_sink`." }, - "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" - } - } - }, - "GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport": { - "id": "GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport", - "description": "Describes exporting all historical Feature values of all entities of the EntityType between [start_time, end_time].", - "type": "object", - "properties": { - "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" + "ragFileParsingConfig": { + "$ref": "GoogleCloudAiplatformV1RagFileParsingConfig", + "description": "Optional. Specifies the parsing config for RagFiles. RAG will use the default parser if this field is not set." }, - "endTime": { - "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", - "format": "google-datetime" - } - } - }, - "GoogleCloudAiplatformV1DeleteFeatureValuesRequest": { - "id": "GoogleCloudAiplatformV1DeleteFeatureValuesRequest", - "description": "Request message for FeaturestoreService.DeleteFeatureValues.", - "type": "object", - "properties": { - "selectEntity": { - "description": "Select feature values to be deleted by specifying entities.", - "$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity" + "ragFileTransformationConfig": { + "$ref": "GoogleCloudAiplatformV1RagFileTransformationConfig", + "description": "Specifies the transformation config for RagFiles." }, - "selectTimeRangeAndFeature": { - "description": "Select feature values to be deleted by specifying time range and features.", - "$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature" + "rebuildAnnIndex": { + "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.", + "type": "boolean" + }, + "sharePointSources": { + "$ref": "GoogleCloudAiplatformV1SharePointSources", + "description": "SharePoint sources." + }, + "slackSource": { + "$ref": "GoogleCloudAiplatformV1SlackSource", + "description": "Slack channels with their corresponding access tokens." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity": { - "id": "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ImportRagFilesRequest": { + "description": "Request message for VertexRagDataService.ImportRagFiles.", + "id": "GoogleCloudAiplatformV1ImportRagFilesRequest", "properties": { - "entityIdSelector": { - "description": "Required. Selectors choosing feature values of which entity id to be deleted from the EntityType.", - "$ref": "GoogleCloudAiplatformV1EntityIdSelector" + "importRagFilesConfig": { + "$ref": "GoogleCloudAiplatformV1ImportRagFilesConfig", + "description": "Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EntityIdSelector": { - "id": "GoogleCloudAiplatformV1EntityIdSelector", - "description": "Selector for entityId. Getting ids from the given source.", - "type": "object", + "GoogleCloudAiplatformV1Index": { + "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.", + "id": "GoogleCloudAiplatformV1Index", "properties": { - "csvSource": { - "description": "Source of Csv", - "$ref": "GoogleCloudAiplatformV1CsvSource" + "createTime": { + "description": "Output only. Timestamp when this Index was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "entityIdField": { - "description": "Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.", + "deployedIndexes": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1DeployedIndexRef" + }, + "readOnly": true, + "type": "array" + }, + "description": { + "description": "The description of the Index.", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature": { - "id": "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature", - "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.", - "type": "object", - "properties": { - "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": "GoogleCloudAiplatformV1FeatureSelector" + "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" }, - "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" - } - } - }, - "GoogleTypeInterval": { - "id": "GoogleTypeInterval", - "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.", - "type": "object", - "properties": { - "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.", - "type": "string", - "format": "google-datetime" + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "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" - } - } - }, - "GoogleCloudAiplatformV1SearchFeaturesResponse": { - "id": "GoogleCloudAiplatformV1SearchFeaturesResponse", - "description": "Response message for FeaturestoreService.SearchFeatures.", - "type": "object", - "properties": { - "features": { - "description": "The Features matching the request. Fields returned: * `name` * `description` * `labels` * `create_time` * `update_time`", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Feature" - } + "etag": { + "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" }, - "nextPageToken": { - "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.", + "indexStats": { + "$ref": "GoogleCloudAiplatformV1IndexStats", + "description": "Output only. Stats of the index resource.", + "readOnly": true + }, + "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" + ], + "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." + ], + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "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" + }, + "metadata": { + "description": "An additional information about the Index; the schema of the metadata can be found in metadata_schema.", + "type": "any" + }, + "metadataSchemaUri": { + "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.", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1FeatureGroup": { - "id": "GoogleCloudAiplatformV1FeatureGroup", - "description": "Vertex AI Feature Group.", - "type": "object", - "properties": { - "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": "GoogleCloudAiplatformV1FeatureGroupBigQuery" }, "name": { - "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", + "description": "Output only. The resource name of the Index.", + "readOnly": true, "type": "string" }, - "createTime": { - "description": "Output only. Timestamp when this FeatureGroup was created.", + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "boolean" }, "updateTime": { - "description": "Output only. Timestamp when this FeatureGroup was last updated.", + "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.", + "format": "google-datetime", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1IndexDatapoint": { + "description": "A datapoint of Index.", + "id": "GoogleCloudAiplatformV1IndexDatapoint", + "properties": { + "crowdingTag": { + "$ref": "GoogleCloudAiplatformV1IndexDatapointCrowdingTag", + "description": "Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query." }, - "etag": { - "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "datapointId": { + "description": "Required. Unique identifier of the datapoint.", "type": "string" }, - "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", + "embeddingMetadata": { "additionalProperties": { - "type": "string" - } + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The key-value map of additional metadata for the datapoint.", + "type": "object" }, - "description": { - "description": "Optional. Description of the FeatureGroup.", - "type": "string" + "featureVector": { + "description": "Required. Feature embedding vector for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" }, - "serviceAgentType": { - "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.", - "type": "string", - "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." - ], - "enum": [ - "SERVICE_AGENT_TYPE_UNSPECIFIED", - "SERVICE_AGENT_TYPE_PROJECT", - "SERVICE_AGENT_TYPE_FEATURE_GROUP" - ] + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1IndexDatapointNumericRestriction" + }, + "type": "array" }, - "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.", - "readOnly": true, + "restricts": { + "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", + "items": { + "$ref": "GoogleCloudAiplatformV1IndexDatapointRestriction" + }, + "type": "array" + }, + "sparseEmbedding": { + "$ref": "GoogleCloudAiplatformV1IndexDatapointSparseEmbedding", + "description": "Optional. Feature embedding vector for sparse index." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1IndexDatapointCrowdingTag": { + "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.", + "id": "GoogleCloudAiplatformV1IndexDatapointCrowdingTag", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureGroupBigQuery": { - "id": "GoogleCloudAiplatformV1FeatureGroupBigQuery", - "description": "Input source type for BigQuery Tables and Views.", - "type": "object", + "GoogleCloudAiplatformV1IndexDatapointNumericRestriction": { + "description": "This field allows restricts to be based on numeric comparisons rather than categorical tokens.", + "id": "GoogleCloudAiplatformV1IndexDatapointNumericRestriction", "properties": { - "bigQuerySource": { - "description": "Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View.", - "$ref": "GoogleCloudAiplatformV1BigQuerySource" + "namespace": { + "description": "The namespace of this restriction. e.g.: cost.", + "type": "string" }, - "entityIdColumns": { - "description": "Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`.", - "type": "array", - "items": { - "type": "string" - } + "op": { + "description": "This MUST be specified for queries and must NOT be specified for datapoints.", + "enum": [ + "OPERATOR_UNSPECIFIED", + "LESS", + "LESS_EQUAL", + "EQUAL", + "GREATER_EQUAL", + "GREATER", + "NOT_EQUAL" + ], + "enumDescriptions": [ + "Default value of the enum.", + "Datapoints are eligible iff their value is < the query's.", + "Datapoints are eligible iff their value is <= the query's.", + "Datapoints are eligible iff their value is == the query's.", + "Datapoints are eligible iff their value is >= the query's.", + "Datapoints are eligible iff their value is > the query's.", + "Datapoints are eligible iff their value is != the query's." + ], + "type": "string" }, - "staticDataSource": { - "description": "Optional. Set if the data source is not a time-series.", - "type": "boolean" + "valueDouble": { + "description": "Represents 64 bit float.", + "format": "double", + "type": "number" }, - "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": "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries" + "valueFloat": { + "description": "Represents 32 bit float.", + "format": "float", + "type": "number" }, - "dense": { - "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.", - "type": "boolean" + "valueInt": { + "description": "Represents 64 bit integer.", + "format": "int64", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries": { - "id": "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries", - "type": "object", + "GoogleCloudAiplatformV1IndexDatapointRestriction": { + "description": "Restriction of a datapoint which describe its attributes(tokens) from each of several attribute categories(namespaces).", + "id": "GoogleCloudAiplatformV1IndexDatapointRestriction", "properties": { - "timestampColumn": { - "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.", + "allowList": { + "description": "The attributes to allow in this namespace. e.g.: 'red'", + "items": { + "type": "string" + }, + "type": "array" + }, + "denyList": { + "description": "The attributes to deny in this namespace. e.g.: 'blue'", + "items": { + "type": "string" + }, + "type": "array" + }, + "namespace": { + "description": "The namespace of this restriction. e.g.: color.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListFeatureGroupsResponse": { - "id": "GoogleCloudAiplatformV1ListFeatureGroupsResponse", - "description": "Response message for FeatureRegistryService.ListFeatureGroups.", - "type": "object", + "GoogleCloudAiplatformV1IndexDatapointSparseEmbedding": { + "description": "Feature embedding vector for sparse index. An array of numbers whose values are located in the specified dimensions.", + "id": "GoogleCloudAiplatformV1IndexDatapointSparseEmbedding", "properties": { - "featureGroups": { - "description": "The FeatureGroups matching the request.", - "type": "array", + "dimensions": { + "description": "Required. The list of indexes for the embedding values of the sparse vector.", "items": { - "$ref": "GoogleCloudAiplatformV1FeatureGroup" - } + "format": "int64", + "type": "string" + }, + "type": "array" }, - "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" + "values": { + "description": "Required. The list of embedding values of the sparse vector.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureOnlineStore": { - "id": "GoogleCloudAiplatformV1FeatureOnlineStore", - "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.", - "type": "object", + "GoogleCloudAiplatformV1IndexEndpoint": { + "description": "Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.", + "id": "GoogleCloudAiplatformV1IndexEndpoint", "properties": { - "bigtable": { - "description": "Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore.", - "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtable" + "createTime": { + "description": "Output only. Timestamp when this IndexEndpoint was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "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": "GoogleCloudAiplatformV1FeatureOnlineStoreOptimized" + "deployedIndexes": { + "description": "Output only. The indexes deployed in this endpoint.", + "items": { + "$ref": "GoogleCloudAiplatformV1DeployedIndex" + }, + "readOnly": true, + "type": "array" }, - "name": { - "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", + "description": { + "description": "The description of the IndexEndpoint.", "type": "string" }, - "createTime": { - "description": "Output only. Timestamp when this FeatureOnlineStore was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "displayName": { + "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.", + "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp when this FeatureOnlineStore was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "enablePrivateServiceConnect": { + "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.", + "type": "boolean" + }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, "etag": { - "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "labels": { - "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", "additionalProperties": { "type": "string" - } + }, + "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.", + "type": "object" }, - "state": { - "description": "Output only. State of the featureOnlineStore.", + "name": { + "description": "Output only. The resource name of the IndexEndpoint.", "readOnly": true, - "type": "string", - "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" - ] + "type": "string" }, - "dedicatedServingEndpoint": { - "description": "Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.", - "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint" + "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" }, - "encryptionSpec": { - "description": "Optional. Customer-managed encryption key spec for data storage. If set, online store will be secured by this key.", - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" + "privateServiceConnectConfig": { + "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", + "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", + "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" + }, + "publicEndpointEnabled": { + "description": "Optional. If true, the deployed index will be accessible through public endpoint.", "type": "boolean" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1FeatureOnlineStoreBigtable": { - "id": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtable", - "type": "object", - "properties": { - "autoScaling": { - "description": "Required. Autoscaling config applied to Bigtable Instance.", - "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling" }, - "enableDirectBigtableAccess": { - "description": "Optional. It true, enable direct access to the Bigtable instance.", + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, "type": "boolean" }, - "bigtableMetadata": { - "description": "Output only. Metadata of the Bigtable instance. Output only.", + "updateTime": { + "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", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableBigtableMetadata" - } - } - }, - "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling": { - "id": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling", - "type": "object", - "properties": { - "minNodeCount": { - "description": "Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.", - "type": "integer", - "format": "int32" - }, - "maxNodeCount": { - "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", - "format": "int32" - }, - "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" - } - } - }, - "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableBigtableMetadata": { - "id": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableBigtableMetadata", - "description": "Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project.", - "type": "object", - "properties": { - "tenantProjectId": { - "description": "Tenant project ID.", - "type": "string" - }, - "instanceId": { - "description": "The Cloud Bigtable instance id.", - "type": "string" - }, - "tableId": { - "description": "The Cloud Bigtable table id.", "type": "string" } - } - }, - "GoogleCloudAiplatformV1FeatureOnlineStoreOptimized": { - "id": "GoogleCloudAiplatformV1FeatureOnlineStoreOptimized", - "description": "Optimized storage type", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint": { - "id": "GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint", - "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", + "GoogleCloudAiplatformV1IndexPrivateEndpoints": { + "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": "GoogleCloudAiplatformV1IndexPrivateEndpoints", "properties": { - "publicEndpointDomainName": { - "description": "Output only. This field will be populated with the domain name to use for this FeatureOnlineStore", + "matchGrpcAddress": { + "description": "Output only. The ip address used to send match gRPC requests.", "readOnly": true, "type": "string" }, - "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": "GoogleCloudAiplatformV1PrivateServiceConnectConfig" + "pscAutomatedEndpoints": { + "description": "Output only. PscAutomatedEndpoints is populated if private service connect is enabled if PscAutomatedConfig is set.", + "items": { + "$ref": "GoogleCloudAiplatformV1PscAutomatedEndpoints" + }, + "readOnly": true, + "type": "array" }, "serviceAttachment": { - "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled and after FeatureViewSync is created.", + "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled.", "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse": { - "id": "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse", - "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores.", - "type": "object", + "GoogleCloudAiplatformV1IndexStats": { + "description": "Stats of the Index.", + "id": "GoogleCloudAiplatformV1IndexStats", "properties": { - "featureOnlineStores": { - "description": "The FeatureOnlineStores matching the request.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" - } + "shardsCount": { + "description": "Output only. The number of shards in the Index.", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "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.", + "sparseVectorsCount": { + "description": "Output only. The number of sparse vectors in the Index.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "vectorsCount": { + "description": "Output only. The number of dense vectors in the Index.", + "format": "int64", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureView": { - "id": "GoogleCloudAiplatformV1FeatureView", - "description": "FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.", - "type": "object", + "GoogleCloudAiplatformV1InputDataConfig": { + "description": "Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.", + "id": "GoogleCloudAiplatformV1InputDataConfig", "properties": { - "bigQuerySource": { - "description": "Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.", - "$ref": "GoogleCloudAiplatformV1FeatureViewBigQuerySource" + "annotationSchemaUri": { + "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.", + "type": "string" }, - "featureRegistrySource": { - "description": "Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.", - "$ref": "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource" + "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" }, - "vertexRagSource": { - "description": "Optional. The Vertex RAG Source that the FeatureView is linked to.", - "$ref": "GoogleCloudAiplatformV1FeatureViewVertexRagSource" + "bigqueryDestination": { + "$ref": "GoogleCloudAiplatformV1BigQueryDestination", + "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\"" }, - "name": { - "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "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" }, - "createTime": { - "description": "Output only. Timestamp when this FeatureView was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "filterSplit": { + "$ref": "GoogleCloudAiplatformV1FilterSplit", + "description": "Split based on the provided filters for each set." }, - "updateTime": { - "description": "Output only. Timestamp when this FeatureView was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "fractionSplit": { + "$ref": "GoogleCloudAiplatformV1FractionSplit", + "description": "Split based on fractions defining the size of each set." }, - "etag": { - "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", - "type": "string" + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "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}\"" }, - "labels": { - "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", - "additionalProperties": { - "type": "string" - } + "persistMlUseAssignment": { + "description": "Whether to persist the ML use assignment to data item system labels.", + "type": "boolean" }, - "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": "GoogleCloudAiplatformV1FeatureViewSyncConfig" + "predefinedSplit": { + "$ref": "GoogleCloudAiplatformV1PredefinedSplit", + "description": "Supported only for tabular Datasets. Split based on a predefined key." }, - "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": "GoogleCloudAiplatformV1FeatureViewIndexConfig" + "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" }, - "optimizedConfig": { - "description": "Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore.", - "$ref": "GoogleCloudAiplatformV1FeatureViewOptimizedConfig" + "stratifiedSplit": { + "$ref": "GoogleCloudAiplatformV1StratifiedSplit", + "description": "Supported only for tabular Datasets. Split based on the distribution of the specified column." }, - "serviceAgentType": { - "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.", - "type": "string", - "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." - ], - "enum": [ - "SERVICE_AGENT_TYPE_UNSPECIFIED", - "SERVICE_AGENT_TYPE_PROJECT", - "SERVICE_AGENT_TYPE_FEATURE_VIEW" - ] + "timestampSplit": { + "$ref": "GoogleCloudAiplatformV1TimestampSplit", + "description": "Supported only for tabular Datasets. Split based on the timestamp of the input data pieces." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Int64Array": { + "description": "A list of int64 values.", + "id": "GoogleCloudAiplatformV1Int64Array", + "properties": { + "values": { + "description": "A list of int64 values.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1IntegratedGradientsAttribution": { + "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", + "id": "GoogleCloudAiplatformV1IntegratedGradientsAttribution", + "properties": { + "blurBaselineConfig": { + "$ref": "GoogleCloudAiplatformV1BlurBaselineConfig", + "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" }, - "serviceAccountEmail": { - "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.", - "readOnly": true, - "type": "string" + "smoothGradConfig": { + "$ref": "GoogleCloudAiplatformV1SmoothGradConfig", + "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" }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", + "stepCount": { + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1IntermediateExtractedMemory": { + "description": "An extracted memory that is the intermediate result before consolidation.", + "id": "GoogleCloudAiplatformV1IntermediateExtractedMemory", + "properties": { + "context": { + "description": "Output only. Represents the explanation of why the information was extracted from the source content.", "readOnly": true, - "type": "boolean" + "type": "string" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", + "fact": { + "description": "Output only. Represents the fact of the extracted memory.", "readOnly": true, - "type": "boolean" + "type": "string" }, - "bigtableMetadata": { - "description": "Output only. Metadata containing information about the Cloud Bigtable.", + "structuredData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. Represents the structured value of the extracted memory.", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1FeatureViewBigtableMetadata" + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewBigQuerySource": { - "id": "GoogleCloudAiplatformV1FeatureViewBigQuerySource", - "type": "object", + "GoogleCloudAiplatformV1InvokeRequest": { + "description": "Request message for PredictionService.Invoke.", + "id": "GoogleCloudAiplatformV1InvokeRequest", "properties": { - "uri": { - "description": "Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.", + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", "type": "string" }, - "entityIdColumns": { - "description": "Required. Columns to construct entity_id / row keys.", - "type": "array", - "items": { - "type": "string" - } + "httpBody": { + "$ref": "GoogleApiHttpBody", + "description": "The invoke method input. Supports HTTP headers and arbitrary data payload." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource": { - "id": "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource", - "description": "A Feature Registry source for features that need to be synced to Online Store.", - "type": "object", + "GoogleCloudAiplatformV1JiraSource": { + "description": "The Jira source for the ImportRagFilesRequest.", + "id": "GoogleCloudAiplatformV1JiraSource", "properties": { - "featureGroups": { - "description": "Required. List of features that need to be synced to Online Store.", - "type": "array", + "jiraQueries": { + "description": "Required. The Jira queries.", "items": { - "$ref": "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup" - } - }, - "projectNumber": { - "description": "Optional. The project number of the parent project of the Feature Groups.", - "type": "string", - "format": "int64" + "$ref": "GoogleCloudAiplatformV1JiraSourceJiraQueries" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup": { - "id": "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup", - "description": "Features belonging to a single feature group that will be synced to Online Store.", - "type": "object", + "GoogleCloudAiplatformV1JiraSourceJiraQueries": { + "description": "JiraQueries contains the Jira queries and corresponding authentication.", + "id": "GoogleCloudAiplatformV1JiraSourceJiraQueries", "properties": { - "featureGroupId": { - "description": "Required. Identifier of the feature group.", + "apiKeyConfig": { + "$ref": "GoogleCloudAiplatformV1ApiAuthApiKeyConfig", + "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": { + "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/", + "items": { + "type": "string" + }, + "type": "array" + }, + "email": { + "description": "Required. The Jira email address.", "type": "string" }, - "featureIds": { - "description": "Required. Identifiers of features under the feature group.", - "type": "array", + "projects": { + "description": "A list of Jira projects to import in their entirety.", "items": { "type": "string" - } + }, + "type": "array" + }, + "serverUri": { + "description": "Required. The Jira server URI.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewVertexRagSource": { - "id": "GoogleCloudAiplatformV1FeatureViewVertexRagSource", - "description": "A Vertex Rag source for features that need to be synced to Online Store.", - "type": "object", + "GoogleCloudAiplatformV1KeepAliveProbe": { + "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": "GoogleCloudAiplatformV1KeepAliveProbe", "properties": { - "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" + "httpGet": { + "$ref": "GoogleCloudAiplatformV1KeepAliveProbeHttpGet", + "description": "Optional. Specifies the HTTP GET configuration for the probe." }, - "ragCorpusId": { - "description": "Optional. The RAG corpus id corresponding to this FeatureView.", - "type": "string", - "format": "int64" + "maxSeconds": { + "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", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewSyncConfig": { - "id": "GoogleCloudAiplatformV1FeatureViewSyncConfig", - "description": "Configuration for Sync. Only one option is set.", - "type": "object", + "GoogleCloudAiplatformV1KeepAliveProbeHttpGet": { + "description": "Specifies the HTTP GET configuration for the probe.", + "id": "GoogleCloudAiplatformV1KeepAliveProbeHttpGet", "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 * * * *\".", + "path": { + "description": "Required. Specifies the path of the HTTP GET request (e.g., `\"/is_busy\"`).", "type": "string" }, - "continuous": { - "description": "Optional. If true, syncs the FeatureView in a continuous manner to Online Store.", - "type": "boolean" + "port": { + "description": "Optional. Specifies the port number on the container to which the request is sent.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewIndexConfig": { - "id": "GoogleCloudAiplatformV1FeatureViewIndexConfig", - "description": "Configuration for vector indexing.", - "type": "object", + "GoogleCloudAiplatformV1LLMBasedMetricSpec": { + "description": "Specification for an LLM based metric.", + "id": "GoogleCloudAiplatformV1LLMBasedMetricSpec", "properties": { - "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": "GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig" + "additionalConfig": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Optional additional configuration for the metric.", + "type": "object" }, - "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": "GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig" + "judgeAutoraterConfig": { + "$ref": "GoogleCloudAiplatformV1AutoraterConfig", + "description": "Optional. Optional configuration for the judge LLM (Autorater)." }, - "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.", + "metricPromptTemplate": { + "description": "Required. Template for the prompt sent to the judge model.", "type": "string" }, - "filterColumns": { - "description": "Optional. Columns of features that're used to filter vector search results.", - "type": "array", - "items": { - "type": "string" - } + "predefinedRubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec", + "description": "Dynamically generate rubrics using a predefined spec." }, - "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" + "resultParserConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationParserConfig", + "description": "Optional. The parser config for the metric result." }, - "embeddingDimension": { - "description": "Optional. The number of dimensions of the input embedding.", - "type": "integer", - "format": "int32" + "rubricGenerationSpec": { + "$ref": "GoogleCloudAiplatformV1RubricGenerationSpec", + "description": "Dynamically generate rubrics using this specification." }, - "distanceMeasureType": { - "description": "Optional. The distance measure used in nearest neighbor search.", - "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." - ], - "enum": [ - "DISTANCE_MEASURE_TYPE_UNSPECIFIED", - "SQUARED_L2_DISTANCE", - "COSINE_DISTANCE", - "DOT_PRODUCT_DISTANCE" - ] - } - } - }, - "GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig": { - "id": "GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig", - "description": "Configuration options for the tree-AH algorithm.", - "type": "object", - "properties": { - "leafNodeEmbeddingCount": { - "description": "Optional. Number of embeddings on each leaf node. The default value is 1000 if not set.", - "type": "string", - "format": "int64" - } - } - }, - "GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig": { - "id": "GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig", - "description": "Configuration options for using brute force search.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1FeatureViewOptimizedConfig": { - "id": "GoogleCloudAiplatformV1FeatureViewOptimizedConfig", - "description": "Configuration for FeatureViews created in Optimized FeatureOnlineStore.", - "type": "object", - "properties": { - "automaticResources": { - "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.", - "$ref": "GoogleCloudAiplatformV1AutomaticResources" - } - } - }, - "GoogleCloudAiplatformV1FeatureViewBigtableMetadata": { - "id": "GoogleCloudAiplatformV1FeatureViewBigtableMetadata", - "description": "Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances.", - "type": "object", - "properties": { - "readAppProfile": { - "description": "Output only. The Bigtable App Profile to use for reading from Bigtable.", - "readOnly": true, + "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" - } - } - }, - "GoogleCloudAiplatformV1ListFeatureViewsResponse": { - "id": "GoogleCloudAiplatformV1ListFeatureViewsResponse", - "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureViews.", - "type": "object", - "properties": { - "featureViews": { - "description": "The FeatureViews matching the request.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1FeatureView" - } }, - "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" - } - } - }, - "GoogleCloudAiplatformV1SyncFeatureViewRequest": { - "id": "GoogleCloudAiplatformV1SyncFeatureViewRequest", - "description": "Request message for FeatureOnlineStoreAdminService.SyncFeatureView.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1SyncFeatureViewResponse": { - "id": "GoogleCloudAiplatformV1SyncFeatureViewResponse", - "description": "Response message for FeatureOnlineStoreAdminService.SyncFeatureView.", - "type": "object", - "properties": { - "featureViewSync": { - "description": "Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", + "systemInstruction": { + "description": "Optional. System instructions for the judge model.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewSync": { - "id": "GoogleCloudAiplatformV1FeatureViewSync", - "description": "FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store.", - "type": "object", + "GoogleCloudAiplatformV1LargeModelReference": { + "description": "Contains information about the Large Model.", + "id": "GoogleCloudAiplatformV1LargeModelReference", "properties": { "name": { - "description": "Identifier. Name of the FeatureViewSync. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", + "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.", "type": "string" - }, - "createTime": { - "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.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "runTime": { - "description": "Output only. Time when this FeatureViewSync is finished.", - "readOnly": true, - "$ref": "GoogleTypeInterval" - }, - "finalStatus": { - "description": "Output only. Final status of the FeatureViewSync.", - "readOnly": true, - "$ref": "GoogleRpcStatus" - }, - "syncSummary": { - "description": "Output only. Summary of the sync job.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1FeatureViewSyncSyncSummary" - }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" - }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewSyncSyncSummary": { - "id": "GoogleCloudAiplatformV1FeatureViewSyncSyncSummary", - "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.", - "type": "object", + "GoogleCloudAiplatformV1LineageSubgraph": { + "description": "A subgraph of the overall lineage graph. Event edges connect Artifact and Execution nodes.", + "id": "GoogleCloudAiplatformV1LineageSubgraph", "properties": { - "rowSynced": { - "description": "Output only. Total number of rows synced.", - "readOnly": true, - "type": "string", - "format": "int64" + "artifacts": { + "description": "The Artifact nodes in the subgraph.", + "items": { + "$ref": "GoogleCloudAiplatformV1Artifact" + }, + "type": "array" }, - "totalSlot": { - "description": "Output only. BigQuery slot milliseconds consumed for the sync job.", - "readOnly": true, - "type": "string", - "format": "int64" + "events": { + "description": "The Event edges between Artifacts and Executions in the subgraph.", + "items": { + "$ref": "GoogleCloudAiplatformV1Event" + }, + "type": "array" }, - "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" + "executions": { + "description": "The Execution nodes in the subgraph.", + "items": { + "$ref": "GoogleCloudAiplatformV1Execution" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListFeatureViewSyncsResponse": { - "id": "GoogleCloudAiplatformV1ListFeatureViewSyncsResponse", - "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs.", - "type": "object", + "GoogleCloudAiplatformV1ListAnnotationsResponse": { + "description": "Response message for DatasetService.ListAnnotations.", + "id": "GoogleCloudAiplatformV1ListAnnotationsResponse", "properties": { - "featureViewSyncs": { - "description": "The FeatureViewSyncs matching the request.", - "type": "array", + "annotations": { + "description": "A list of Annotations that matches the specified filter in the request.", "items": { - "$ref": "GoogleCloudAiplatformV1FeatureViewSync" - } + "$ref": "GoogleCloudAiplatformV1Annotation" + }, + "type": "array" }, "nextPageToken": { - "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.", + "description": "The standard List next-page token.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FetchFeatureValuesRequest": { - "id": "GoogleCloudAiplatformV1FetchFeatureValuesRequest", - "description": "Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned.", - "type": "object", + "GoogleCloudAiplatformV1ListArtifactsResponse": { + "description": "Response message for MetadataService.ListArtifacts.", + "id": "GoogleCloudAiplatformV1ListArtifactsResponse", "properties": { - "dataKey": { - "description": "Optional. The request key to fetch feature values for.", - "$ref": "GoogleCloudAiplatformV1FeatureViewDataKey" + "artifacts": { + "description": "The Artifacts retrieved from the MetadataStore.", + "items": { + "$ref": "GoogleCloudAiplatformV1Artifact" + }, + "type": "array" }, - "dataFormat": { - "description": "Optional. Response data format. If not set, FeatureViewDataFormat.KEY_VALUE will be used.", - "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." - ], - "enum": [ - "FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED", - "KEY_VALUE", - "PROTO_STRUCT" - ] - } - } - }, - "GoogleCloudAiplatformV1FeatureViewDataKey": { - "id": "GoogleCloudAiplatformV1FeatureViewDataKey", - "description": "Lookup key for a feature view.", - "type": "object", - "properties": { - "key": { - "description": "String key to use for lookup.", + "nextPageToken": { + "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.", "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": "GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey": { - "id": "GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey", - "description": "ID that is comprised from several parts (columns).", - "type": "object", + "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse": { + "description": "Response message for JobService.ListBatchPredictionJobs", + "id": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse", "properties": { - "parts": { - "description": "Parts to construct Entity ID. Should match with the same ID columns as defined in FeatureView in the same order.", - "type": "array", + "batchPredictionJobs": { + "description": "List of BatchPredictionJobs in the requested page.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListBatchPredictionJobsRequest.page_token to obtain that page.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FetchFeatureValuesResponse": { - "id": "GoogleCloudAiplatformV1FetchFeatureValuesResponse", - "description": "Response message for FeatureOnlineStoreService.FetchFeatureValues", - "type": "object", + "GoogleCloudAiplatformV1ListCachedContentsResponse": { + "description": "Response with a list of CachedContents.", + "id": "GoogleCloudAiplatformV1ListCachedContentsResponse", "properties": { - "keyValues": { - "description": "Feature values in KeyValue format.", - "$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList" - }, - "protoStruct": { - "description": "Feature values in proto Struct format.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } + "cachedContents": { + "description": "List of cached contents.", + "items": { + "$ref": "GoogleCloudAiplatformV1CachedContent" + }, + "type": "array" }, - "dataKey": { - "description": "The data key associated with this response. Will only be populated for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs.", - "$ref": "GoogleCloudAiplatformV1FeatureViewDataKey" + "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" }, - "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList": { - "id": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList", - "description": "Response structure in the format of key (feature name) and (feature) value pair.", - "type": "object", + "GoogleCloudAiplatformV1ListContextsResponse": { + "description": "Response message for MetadataService.ListContexts.", + "id": "GoogleCloudAiplatformV1ListContextsResponse", "properties": { - "features": { - "description": "List of feature names and values.", - "type": "array", + "contexts": { + "description": "The Contexts retrieved from the MetadataStore.", "items": { - "$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair" - } + "$ref": "GoogleCloudAiplatformV1Context" + }, + "type": "array" + }, + "nextPageToken": { + "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.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair": { - "id": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair", - "description": "Feature name & value pair.", - "type": "object", + "GoogleCloudAiplatformV1ListCustomJobsResponse": { + "description": "Response message for JobService.ListCustomJobs", + "id": "GoogleCloudAiplatformV1ListCustomJobsResponse", "properties": { - "value": { - "description": "Feature value.", - "$ref": "GoogleCloudAiplatformV1FeatureValue" + "customJobs": { + "description": "List of CustomJobs in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1CustomJob" + }, + "type": "array" }, - "name": { - "description": "Feature short name.", + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListCustomJobsRequest.page_token to obtain that page.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SearchNearestEntitiesRequest": { - "id": "GoogleCloudAiplatformV1SearchNearestEntitiesRequest", - "description": "The request message for FeatureOnlineStoreService.SearchNearestEntities.", - "type": "object", + "GoogleCloudAiplatformV1ListDataItemsResponse": { + "description": "Response message for DatasetService.ListDataItems.", + "id": "GoogleCloudAiplatformV1ListDataItemsResponse", "properties": { - "query": { - "description": "Required. The query.", - "$ref": "GoogleCloudAiplatformV1NearestNeighborQuery" + "dataItems": { + "description": "A list of DataItems that matches the specified filter in the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1DataItem" + }, + "type": "array" }, - "returnFullEntity": { - "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.", - "type": "boolean" + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NearestNeighborQuery": { - "id": "GoogleCloudAiplatformV1NearestNeighborQuery", - "description": "A query to find a number of similar entities.", - "type": "object", + "GoogleCloudAiplatformV1ListDataLabelingJobsResponse": { + "description": "Response message for JobService.ListDataLabelingJobs.", + "id": "GoogleCloudAiplatformV1ListDataLabelingJobsResponse", "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": { - "description": "Optional. The embedding vector that be used for similar search.", - "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryEmbedding" - }, - "neighborCount": { - "description": "Optional. The number of similar entities to be retrieved from feature view for each query.", - "type": "integer", - "format": "int32" - }, - "stringFilters": { - "description": "Optional. The list of string filters.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryStringFilter" - } - }, - "numericFilters": { - "description": "Optional. The list of numeric filters.", - "type": "array", + "dataLabelingJobs": { + "description": "A list of DataLabelingJobs that matches the specified filter in the request.", "items": { - "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter" - } - }, - "perCrowdingAttributeNeighborCount": { - "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", - "format": "int32" + "$ref": "GoogleCloudAiplatformV1DataLabelingJob" + }, + "type": "array" }, - "parameters": { - "description": "Optional. Parameters that can be set to tune query on the fly.", - "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryParameters" + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NearestNeighborQueryEmbedding": { - "id": "GoogleCloudAiplatformV1NearestNeighborQueryEmbedding", - "description": "The embedding vector.", - "type": "object", + "GoogleCloudAiplatformV1ListDatasetVersionsResponse": { + "description": "Response message for DatasetService.ListDatasetVersions.", + "id": "GoogleCloudAiplatformV1ListDatasetVersionsResponse", "properties": { - "value": { - "description": "Optional. Individual value in the embedding.", - "type": "array", + "datasetVersions": { + "description": "A list of DatasetVersions that matches the specified filter in the request.", "items": { - "type": "number", - "format": "float" - } + "$ref": "GoogleCloudAiplatformV1DatasetVersion" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NearestNeighborQueryStringFilter": { - "id": "GoogleCloudAiplatformV1NearestNeighborQueryStringFilter", - "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", + "GoogleCloudAiplatformV1ListDatasetsResponse": { + "description": "Response message for DatasetService.ListDatasets.", + "id": "GoogleCloudAiplatformV1ListDatasetsResponse", "properties": { - "name": { - "description": "Required. Column names in BigQuery that used as filters.", - "type": "string" - }, - "allowTokens": { - "description": "Optional. The allowed tokens.", - "type": "array", + "datasets": { + "description": "A list of Datasets that matches the specified filter in the request.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1Dataset" + }, + "type": "array" }, - "denyTokens": { - "description": "Optional. The denied tokens.", - "type": "array", - "items": { - "type": "string" - } + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter": { - "id": "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter", - "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", - "type": "object", + "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse": { + "description": "Response message for ListDeploymentResourcePools method.", + "id": "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse", "properties": { - "valueInt": { - "description": "int value type.", - "type": "string", - "format": "int64" - }, - "valueFloat": { - "description": "float value type.", - "type": "number", - "format": "float" - }, - "valueDouble": { - "description": "double value type.", - "type": "number", - "format": "double" + "deploymentResourcePools": { + "description": "The DeploymentResourcePools from the specified location.", + "items": { + "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" + }, + "type": "array" }, - "name": { - "description": "Required. Column name in BigQuery that used as filters.", + "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" - }, - "op": { - "description": "Optional. This MUST be specified for queries and must NOT be specified for database points.", - "type": "string", - "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." - ], - "enum": [ - "OPERATOR_UNSPECIFIED", - "LESS", - "LESS_EQUAL", - "EQUAL", - "GREATER_EQUAL", - "GREATER", - "NOT_EQUAL" - ] } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NearestNeighborQueryParameters": { - "id": "GoogleCloudAiplatformV1NearestNeighborQueryParameters", - "description": "Parameters that can be overrided in each query to tune query latency and recall.", - "type": "object", + "GoogleCloudAiplatformV1ListEndpointsResponse": { + "description": "Response message for EndpointService.ListEndpoints.", + "id": "GoogleCloudAiplatformV1ListEndpointsResponse", "properties": { - "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" + "endpoints": { + "description": "List of Endpoints in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1Endpoint" + }, + "type": "array" }, - "leafNodesSearchFraction": { - "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.", - "type": "number", - "format": "double" + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListEndpointsRequest.page_token to obtain that page.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SearchNearestEntitiesResponse": { - "id": "GoogleCloudAiplatformV1SearchNearestEntitiesResponse", - "description": "Response message for FeatureOnlineStoreService.SearchNearestEntities", - "type": "object", + "GoogleCloudAiplatformV1ListEntityTypesResponse": { + "description": "Response message for FeaturestoreService.ListEntityTypes.", + "id": "GoogleCloudAiplatformV1ListEntityTypesResponse", "properties": { - "nearestNeighbors": { - "description": "The nearest neighbors of the query entity.", - "$ref": "GoogleCloudAiplatformV1NearestNeighbors" + "entityTypes": { + "description": "The EntityTypes matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1EntityType" + }, + "type": "array" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NearestNeighbors": { - "id": "GoogleCloudAiplatformV1NearestNeighbors", - "description": "Nearest neighbors for one query.", - "type": "object", + "GoogleCloudAiplatformV1ListEvaluationItemsResponse": { + "description": "Response message for EvaluationManagementService.ListEvaluationItems.", + "id": "GoogleCloudAiplatformV1ListEvaluationItemsResponse", "properties": { - "neighbors": { - "description": "All its neighbors.", - "type": "array", + "evaluationItems": { + "description": "List of EvaluationItems in the requested page.", "items": { - "$ref": "GoogleCloudAiplatformV1NearestNeighborsNeighbor" - } + "$ref": "GoogleCloudAiplatformV1EvaluationItem" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NearestNeighborsNeighbor": { - "id": "GoogleCloudAiplatformV1NearestNeighborsNeighbor", - "description": "A neighbor of the query vector.", - "type": "object", + "GoogleCloudAiplatformV1ListEvaluationRunsResponse": { + "description": "Response message for EvaluationManagementService.ListEvaluationRuns.", + "id": "GoogleCloudAiplatformV1ListEvaluationRunsResponse", "properties": { - "entityId": { - "description": "The id of the similar entity.", - "type": "string" - }, - "distance": { - "description": "The distance between the neighbor and the query vector.", - "type": "number", - "format": "double" + "evaluationRuns": { + "description": "List of EvaluationRuns in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationRun" + }, + "type": "array" }, - "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": "GoogleCloudAiplatformV1FetchFeatureValuesResponse" + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewDirectWriteRequest": { - "id": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequest", - "description": "Request message for FeatureOnlineStoreService.FeatureViewDirectWrite.", - "type": "object", + "GoogleCloudAiplatformV1ListEvaluationSetsResponse": { + "description": "Response message for EvaluationManagementService.ListEvaluationSets.", + "id": "GoogleCloudAiplatformV1ListEvaluationSetsResponse", "properties": { - "dataKeyAndFeatureValues": { - "description": "Required. The data keys and associated feature values.", - "type": "array", + "evaluationSets": { + "description": "List of EvaluationSets in the requested page.", "items": { - "$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValues" - } + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValues": { - "id": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValues", - "description": "A data key and associated feature values to write to the feature view.", - "type": "object", + "GoogleCloudAiplatformV1ListEventsResponse": { + "description": "Response message for SessionService.ListEvents.", + "id": "GoogleCloudAiplatformV1ListEventsResponse", "properties": { - "dataKey": { - "description": "The data key.", - "$ref": "GoogleCloudAiplatformV1FeatureViewDataKey" + "nextPageToken": { + "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": "string" }, - "features": { - "description": "List of features to write.", - "type": "array", + "sessionEvents": { + "description": "A list of events matching the request. Ordered by timestamp in ascending order.", "items": { - "$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature" - } + "$ref": "GoogleCloudAiplatformV1SessionEvent" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature": { - "id": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature", - "description": "Feature name & value pair.", - "type": "object", + "GoogleCloudAiplatformV1ListExecutionsResponse": { + "description": "Response message for MetadataService.ListExecutions.", + "id": "GoogleCloudAiplatformV1ListExecutionsResponse", "properties": { - "value": { - "description": "Feature value. A user provided timestamp may be set in the `FeatureValue.metadata.generate_time` field.", - "$ref": "GoogleCloudAiplatformV1FeatureValue" + "executions": { + "description": "The Executions retrieved from the MetadataStore.", + "items": { + "$ref": "GoogleCloudAiplatformV1Execution" + }, + "type": "array" }, - "name": { - "description": "Feature short name.", + "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" }, - "GoogleCloudAiplatformV1FeatureViewDirectWriteResponse": { - "id": "GoogleCloudAiplatformV1FeatureViewDirectWriteResponse", - "description": "Response message for FeatureOnlineStoreService.FeatureViewDirectWrite.", - "type": "object", + "GoogleCloudAiplatformV1ListFeatureGroupsResponse": { + "description": "Response message for FeatureRegistryService.ListFeatureGroups.", + "id": "GoogleCloudAiplatformV1ListFeatureGroupsResponse", "properties": { - "status": { - "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.", - "$ref": "GoogleRpcStatus" - }, - "writeResponses": { - "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", + "featureGroups": { + "description": "The FeatureGroups matching the request.", "items": { - "$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteResponseWriteResponse" - } + "$ref": "GoogleCloudAiplatformV1FeatureGroup" + }, + "type": "array" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FeatureViewDirectWriteResponseWriteResponse": { - "id": "GoogleCloudAiplatformV1FeatureViewDirectWriteResponseWriteResponse", - "description": "Details about the write for each key.", - "type": "object", + "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse": { + "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores.", + "id": "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse", "properties": { - "dataKey": { - "description": "What key is this write response associated with.", - "$ref": "GoogleCloudAiplatformV1FeatureViewDataKey" + "featureOnlineStores": { + "description": "The FeatureOnlineStores matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" + }, + "type": "array" }, - "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" + "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" } - } - }, - "GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest": { - "id": "GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest", - "description": "Request message for FeatureOnlineStoreService.GenerateFetchAccessToken.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerateFetchAccessTokenResponse": { - "id": "GoogleCloudAiplatformV1GenerateFetchAccessTokenResponse", - "description": "Response message for FeatureOnlineStoreService.GenerateFetchAccessToken.", - "type": "object", + "GoogleCloudAiplatformV1ListFeatureViewSyncsResponse": { + "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs.", + "id": "GoogleCloudAiplatformV1ListFeatureViewSyncsResponse", "properties": { - "accessToken": { - "description": "The OAuth 2.0 access token.", - "type": "string" + "featureViewSyncs": { + "description": "The FeatureViewSyncs matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1FeatureViewSync" + }, + "type": "array" }, - "expireTime": { - "description": "Token expiration time. This is always set", - "type": "string", - "format": "google-datetime" + "nextPageToken": { + "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": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CacheConfig": { - "id": "GoogleCloudAiplatformV1CacheConfig", - "description": "Config of GenAI caching features. This is a singleton resource.", - "type": "object", + "GoogleCloudAiplatformV1ListFeatureViewsResponse": { + "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureViews.", + "id": "GoogleCloudAiplatformV1ListFeatureViewsResponse", "properties": { - "name": { - "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", - "type": "string" + "featureViews": { + "description": "The FeatureViews matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1FeatureView" + }, + "type": "array" }, - "disableCache": { - "description": "If set to true, disables GenAI caching. Otherwise caching is enabled.", - "type": "boolean" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CachedContent": { - "id": "GoogleCloudAiplatformV1CachedContent", - "description": "A resource used in LLM queries for users to explicitly specify what to cache and how to cache.", - "type": "object", + "GoogleCloudAiplatformV1ListFeaturesResponse": { + "description": "Response message for FeaturestoreService.ListFeatures. Response message for FeatureRegistryService.ListFeatures.", + "id": "GoogleCloudAiplatformV1ListFeaturesResponse", "properties": { - "expireTime": { - "description": "Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.", - "type": "string", - "format": "google-datetime" - }, - "ttl": { - "description": "Input only. The TTL for this resource. The expiration time is computed: now + TTL.", - "type": "string", - "format": "google-duration" - }, - "name": { - "description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}", - "type": "string" - }, - "displayName": { - "description": "Optional. Immutable. The user-generated meaningful display name of the cached content.", - "type": "string" - }, - "model": { - "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}", - "type": "string" - }, - "systemInstruction": { - "description": "Optional. Input only. Immutable. Developer set system instruction. Currently, text only", - "$ref": "GoogleCloudAiplatformV1Content" - }, - "contents": { - "description": "Optional. Input only. Immutable. The content to cache", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Content" - } - }, - "tools": { - "description": "Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response", - "type": "array", + "features": { + "description": "The Features matching the request.", "items": { - "$ref": "GoogleCloudAiplatformV1Tool" - } - }, - "toolConfig": { - "description": "Optional. Input only. Immutable. Tool config. This config is shared for all tools", - "$ref": "GoogleCloudAiplatformV1ToolConfig" - }, - "createTime": { - "description": "Output only. Creation time of the cache entry.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. When the cache entry was last updated in UTC time.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "usageMetadata": { - "description": "Output only. Metadata on the usage of the cached content.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1CachedContentUsageMetadata" + "$ref": "GoogleCloudAiplatformV1Feature" + }, + "type": "array" }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ToolConfig": { - "id": "GoogleCloudAiplatformV1ToolConfig", - "description": "Tool config. This config is shared for all tools provided in the request.", - "type": "object", + "GoogleCloudAiplatformV1ListFeaturestoresResponse": { + "description": "Response message for FeaturestoreService.ListFeaturestores.", + "id": "GoogleCloudAiplatformV1ListFeaturestoresResponse", "properties": { - "functionCallingConfig": { - "description": "Optional. Function calling config.", - "$ref": "GoogleCloudAiplatformV1FunctionCallingConfig" + "featurestores": { + "description": "The Featurestores matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1Featurestore" + }, + "type": "array" }, - "retrievalConfig": { - "description": "Optional. Retrieval config.", - "$ref": "GoogleCloudAiplatformV1RetrievalConfig" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FunctionCallingConfig": { - "id": "GoogleCloudAiplatformV1FunctionCallingConfig", - "description": "Function calling config.", - "type": "object", + "GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse": { + "description": "Response message for JobService.ListHyperparameterTuningJobs", + "id": "GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse", "properties": { - "mode": { - "description": "Optional. Function calling mode.", - "type": "string", - "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." - ], - "enum": [ - "MODE_UNSPECIFIED", - "AUTO", - "ANY", - "NONE" - ] - }, - "allowedFunctionNames": { - "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.", - "type": "array", + "hyperparameterTuningJobs": { + "description": "List of HyperparameterTuningJobs in the requested page. HyperparameterTuningJob.trials of the jobs will be not be returned.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListHyperparameterTuningJobsRequest.page_token to obtain that page.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RetrievalConfig": { - "id": "GoogleCloudAiplatformV1RetrievalConfig", - "description": "Retrieval config.", - "type": "object", + "GoogleCloudAiplatformV1ListIndexEndpointsResponse": { + "description": "Response message for IndexEndpointService.ListIndexEndpoints.", + "id": "GoogleCloudAiplatformV1ListIndexEndpointsResponse", "properties": { - "latLng": { - "description": "The location of the user.", - "$ref": "GoogleTypeLatLng" + "indexEndpoints": { + "description": "List of IndexEndpoints in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1IndexEndpoint" + }, + "type": "array" }, - "languageCode": { - "description": "The language code of the user.", + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListIndexEndpointsRequest.page_token to obtain that page.", "type": "string" } - } + }, + "type": "object" }, - "GoogleTypeLatLng": { - "id": "GoogleTypeLatLng", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ListIndexesResponse": { + "description": "Response message for IndexService.ListIndexes.", + "id": "GoogleCloudAiplatformV1ListIndexesResponse", "properties": { - "latitude": { - "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", - "type": "number", - "format": "double" + "indexes": { + "description": "List of indexes in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1Index" + }, + "type": "array" }, - "longitude": { - "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", - "type": "number", - "format": "double" + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListIndexesRequest.page_token to obtain that page.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CachedContentUsageMetadata": { - "id": "GoogleCloudAiplatformV1CachedContentUsageMetadata", - "description": "Metadata on the usage of the cached content.", - "type": "object", + "GoogleCloudAiplatformV1ListMemoriesResponse": { + "description": "Response message for MemoryBankService.ListMemories.", + "id": "GoogleCloudAiplatformV1ListMemoriesResponse", "properties": { - "totalTokenCount": { - "description": "Total number of tokens that the cached content consumes.", - "type": "integer", - "format": "int32" - }, - "textCount": { - "description": "Number of text characters.", - "type": "integer", - "format": "int32" - }, - "imageCount": { - "description": "Number of images.", - "type": "integer", - "format": "int32" - }, - "videoDurationSeconds": { - "description": "Duration of video in seconds.", - "type": "integer", - "format": "int32" + "memories": { + "description": "List of Memories in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1Memory" + }, + "type": "array" }, - "audioDurationSeconds": { - "description": "Duration of audio in seconds.", - "type": "integer", - "format": "int32" + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListMemoriesRequest.page_token to obtain that page.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListCachedContentsResponse": { - "id": "GoogleCloudAiplatformV1ListCachedContentsResponse", - "description": "Response with a list of CachedContents.", - "type": "object", + "GoogleCloudAiplatformV1ListMemoryRevisionsResponse": { + "description": "Response message for MemoryBankService.ListMemoryRevisions.", + "id": "GoogleCloudAiplatformV1ListMemoryRevisionsResponse", "properties": { - "cachedContents": { - "description": "List of cached contents.", - "type": "array", + "memoryRevisions": { + "description": "The list of Memory Revisions in the request page.", "items": { - "$ref": "GoogleCloudAiplatformV1CachedContent" - } + "$ref": "GoogleCloudAiplatformV1MemoryRevision" + }, + "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" }, - "GoogleCloudAiplatformV1TuningJob": { - "id": "GoogleCloudAiplatformV1TuningJob", - "description": "Represents a TuningJob that runs with Google owned models.", - "type": "object", + "GoogleCloudAiplatformV1ListMetadataSchemasResponse": { + "description": "Response message for MetadataService.ListMetadataSchemas.", + "id": "GoogleCloudAiplatformV1ListMetadataSchemasResponse", "properties": { - "baseModel": { - "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).", - "type": "string" - }, - "preTunedModel": { - "description": "The pre-tuned model for continuous tuning.", - "$ref": "GoogleCloudAiplatformV1PreTunedModel" - }, - "supervisedTuningSpec": { - "description": "Tuning Spec for Supervised Fine Tuning.", - "$ref": "GoogleCloudAiplatformV1SupervisedTuningSpec" - }, - "preferenceOptimizationSpec": { - "description": "Tuning Spec for Preference Optimization.", - "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationSpec" + "metadataSchemas": { + "description": "The MetadataSchemas found for the MetadataStore.", + "items": { + "$ref": "GoogleCloudAiplatformV1MetadataSchema" + }, + "type": "array" }, - "name": { - "description": "Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", - "readOnly": true, + "nextPageToken": { + "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.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListMetadataStoresResponse": { + "description": "Response message for MetadataService.ListMetadataStores.", + "id": "GoogleCloudAiplatformV1ListMetadataStoresResponse", + "properties": { + "metadataStores": { + "description": "The MetadataStores found for the Location.", + "items": { + "$ref": "GoogleCloudAiplatformV1MetadataStore" + }, + "type": "array" }, - "tunedModelDisplayName": { - "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.", + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse": { + "description": "Response message for JobService.ListModelDeploymentMonitoringJobs.", + "id": "GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse", + "properties": { + "modelDeploymentMonitoringJobs": { + "description": "A list of ModelDeploymentMonitoringJobs that matches the specified filter in the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob" + }, + "type": "array" }, - "description": { - "description": "Optional. The description of the TuningJob.", + "nextPageToken": { + "description": "The standard List next-page token.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse": { + "description": "Response message for ModelService.ListModelEvaluationSlices.", + "id": "GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse", + "properties": { + "modelEvaluationSlices": { + "description": "List of ModelEvaluations in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModelEvaluationSlice" + }, + "type": "array" }, - "state": { - "description": "Output only. The detailed state of the job.", - "readOnly": true, - "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." - ], - "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" - ] - }, - "createTime": { - "description": "Output only. Time when the TuningJob was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "startTime": { - "description": "Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "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`.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Time when the TuningJob was most recently updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "error": { - "description": "Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", - "readOnly": true, - "$ref": "GoogleRpcStatus" - }, - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "experiment": { - "description": "Output only. The Experiment associated with this TuningJob.", - "readOnly": true, + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListModelEvaluationSlicesRequest.page_token to obtain that page.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListModelEvaluationsResponse": { + "description": "Response message for ModelService.ListModelEvaluations.", + "id": "GoogleCloudAiplatformV1ListModelEvaluationsResponse", + "properties": { + "modelEvaluations": { + "description": "List of ModelEvaluations in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModelEvaluation" + }, + "type": "array" }, - "tunedModel": { - "description": "Output only. The tuned model resources associated with this TuningJob.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1TunedModel" - }, - "tuningDataStats": { - "description": "Output only. The tuning data statistics associated with this TuningJob.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1TuningDataStats" + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListModelEvaluationsRequest.page_token to obtain that page.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse": { + "description": "Response message for ModelService.ListModelVersionCheckpoints", + "id": "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse", + "properties": { + "checkpoints": { + "description": "List of Model Version checkpoints.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModelVersionCheckpoint" + }, + "type": "array" }, - "encryptionSpec": { - "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.", - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListModelVersionCheckpointsRequest.page_token to obtain that page.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListModelVersionsResponse": { + "description": "Response message for ModelService.ListModelVersions", + "id": "GoogleCloudAiplatformV1ListModelVersionsResponse", + "properties": { + "models": { + "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": "GoogleCloudAiplatformV1Model" + }, + "type": "array" }, - "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.", + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListModelVersionsRequest.page_token to obtain that page.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PreTunedModel": { - "id": "GoogleCloudAiplatformV1PreTunedModel", - "description": "A pre-tuned model for continuous tuning.", - "type": "object", + "GoogleCloudAiplatformV1ListModelsResponse": { + "description": "Response message for ModelService.ListModels", + "id": "GoogleCloudAiplatformV1ListModelsResponse", "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}`", + "models": { + "description": "List of Models in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1Model" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListModelsRequest.page_token to obtain that page.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListNasJobsResponse": { + "description": "Response message for JobService.ListNasJobs", + "id": "GoogleCloudAiplatformV1ListNasJobsResponse", + "properties": { + "nasJobs": { + "description": "List of NasJobs in the requested page. NasJob.nas_job_output of the jobs will not be returned.", + "items": { + "$ref": "GoogleCloudAiplatformV1NasJob" + }, + "type": "array" }, - "checkpointId": { - "description": "Optional. The source checkpoint id. If not specified, the default checkpoint will be used.", + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListNasJobsRequest.page_token to obtain that page.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListNasTrialDetailsResponse": { + "description": "Response message for JobService.ListNasTrialDetails", + "id": "GoogleCloudAiplatformV1ListNasTrialDetailsResponse", + "properties": { + "nasTrialDetails": { + "description": "List of top NasTrials in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1NasTrialDetail" + }, + "type": "array" }, - "baseModel": { - "description": "Output only. The name of the base model this PreTunedModel was tuned from.", - "readOnly": true, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListNasTrialDetailsRequest.page_token to obtain that page.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SupervisedTuningSpec": { - "id": "GoogleCloudAiplatformV1SupervisedTuningSpec", - "description": "Tuning Spec for Supervised Tuning for first party models.", - "type": "object", + "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse": { + "description": "Response message for [NotebookService.CreateNotebookExecutionJob]", + "id": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse", "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.", + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListNotebookExecutionJobsRequest.page_token to obtain that page.", "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.", + "notebookExecutionJobs": { + "description": "List of NotebookExecutionJobs in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse": { + "description": "Response message for NotebookService.ListNotebookRuntimeTemplates.", + "id": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListNotebookRuntimeTemplatesRequest.page_token to obtain that page.", "type": "string" }, - "hyperParameters": { - "description": "Optional. Hyperparameters for SFT.", - "$ref": "GoogleCloudAiplatformV1SupervisedHyperParameters" - }, - "exportLastCheckpointOnly": { - "description": "Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.", - "type": "boolean" + "notebookRuntimeTemplates": { + "description": "List of NotebookRuntimeTemplates in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SupervisedHyperParameters": { - "id": "GoogleCloudAiplatformV1SupervisedHyperParameters", - "description": "Hyperparameters for SFT.", - "type": "object", + "GoogleCloudAiplatformV1ListNotebookRuntimesResponse": { + "description": "Response message for NotebookService.ListNotebookRuntimes.", + "id": "GoogleCloudAiplatformV1ListNotebookRuntimesResponse", "properties": { - "epochCount": { - "description": "Optional. Number of complete passes the model makes over the entire training dataset during training.", - "type": "string", - "format": "int64" - }, - "learningRateMultiplier": { - "description": "Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.", - "type": "number", - "format": "double" + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListNotebookRuntimesRequest.page_token to obtain that page.", + "type": "string" }, - "adapterSize": { - "description": "Optional. Adapter size for tuning.", - "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." - ], - "enum": [ - "ADAPTER_SIZE_UNSPECIFIED", - "ADAPTER_SIZE_ONE", - "ADAPTER_SIZE_TWO", - "ADAPTER_SIZE_FOUR", - "ADAPTER_SIZE_EIGHT", - "ADAPTER_SIZE_SIXTEEN", - "ADAPTER_SIZE_THIRTY_TWO" - ] + "notebookRuntimes": { + "description": "List of NotebookRuntimes in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1NotebookRuntime" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PreferenceOptimizationSpec": { - "id": "GoogleCloudAiplatformV1PreferenceOptimizationSpec", - "description": "Tuning Spec for Preference Optimization.", - "type": "object", + "GoogleCloudAiplatformV1ListOptimalTrialsRequest": { + "description": "Request message for VizierService.ListOptimalTrials.", + "id": "GoogleCloudAiplatformV1ListOptimalTrialsRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1ListOptimalTrialsResponse": { + "description": "Response message for VizierService.ListOptimalTrials.", + "id": "GoogleCloudAiplatformV1ListOptimalTrialsResponse", "properties": { - "trainingDatasetUri": { - "description": "Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.", + "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": "GoogleCloudAiplatformV1Trial" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListPersistentResourcesResponse": { + "description": "Response message for PersistentResourceService.ListPersistentResources", + "id": "GoogleCloudAiplatformV1ListPersistentResourcesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListPersistentResourcesRequest.page_token to obtain that page.", "type": "string" }, - "validationDatasetUri": { - "description": "Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.", + "persistentResources": { + "items": { + "$ref": "GoogleCloudAiplatformV1PersistentResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListPipelineJobsResponse": { + "description": "Response message for PipelineService.ListPipelineJobs", + "id": "GoogleCloudAiplatformV1ListPipelineJobsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListPipelineJobsRequest.page_token to obtain that page.", "type": "string" }, - "hyperParameters": { - "description": "Optional. Hyperparameters for Preference Optimization.", - "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters" - }, - "exportLastCheckpointOnly": { - "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": "boolean" + "pipelineJobs": { + "description": "List of PipelineJobs in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1PipelineJob" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters": { - "id": "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters", - "description": "Hyperparameters for Preference Optimization.", - "type": "object", + "GoogleCloudAiplatformV1ListRagCorporaResponse": { + "description": "Response message for VertexRagDataService.ListRagCorpora.", + "id": "GoogleCloudAiplatformV1ListRagCorporaResponse", "properties": { - "epochCount": { - "description": "Optional. Number of complete passes the model makes over the entire training dataset during training.", - "type": "string", - "format": "int64" - }, - "learningRateMultiplier": { - "description": "Optional. Multiplier for adjusting the default learning rate.", - "type": "number", - "format": "double" - }, - "adapterSize": { - "description": "Optional. Adapter size for preference optimization.", - "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." - ], - "enum": [ - "ADAPTER_SIZE_UNSPECIFIED", - "ADAPTER_SIZE_ONE", - "ADAPTER_SIZE_TWO", - "ADAPTER_SIZE_FOUR", - "ADAPTER_SIZE_EIGHT", - "ADAPTER_SIZE_SIXTEEN", - "ADAPTER_SIZE_THIRTY_TWO" - ] + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page.", + "type": "string" }, - "beta": { - "description": "Optional. Weight for KL Divergence regularization.", - "type": "number", - "format": "double" + "ragCorpora": { + "description": "List of RagCorpora in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1RagCorpus" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TunedModel": { - "id": "GoogleCloudAiplatformV1TunedModel", - "description": "The Model Registry Model and Online Prediction Endpoint associated with this TuningJob.", - "type": "object", + "GoogleCloudAiplatformV1ListRagFilesResponse": { + "description": "Response message for VertexRagDataService.ListRagFiles.", + "id": "GoogleCloudAiplatformV1ListRagFilesResponse", "properties": { - "model": { - "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, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page.", "type": "string" }, - "endpoint": { - "description": "Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.", - "readOnly": true, + "ragFiles": { + "description": "List of RagFiles in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1RagFile" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListReasoningEnginesResponse": { + "description": "Response message for ReasoningEngineService.ListReasoningEngines", + "id": "GoogleCloudAiplatformV1ListReasoningEnginesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListReasoningEnginesRequest.page_token to obtain that page.", "type": "string" }, - "checkpoints": { - "description": "Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.", - "readOnly": true, - "type": "array", + "reasoningEngines": { + "description": "List of ReasoningEngines in the requested page.", "items": { - "$ref": "GoogleCloudAiplatformV1TunedModelCheckpoint" - } + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TunedModelCheckpoint": { - "id": "GoogleCloudAiplatformV1TunedModelCheckpoint", - "description": "TunedModelCheckpoint for the Tuned Model of a Tuning Job.", - "type": "object", + "GoogleCloudAiplatformV1ListSandboxEnvironmentSnapshotsResponse": { + "description": "Response message for SandboxEnvironmentService.ListSandboxEnvironmentSnapshots.", + "id": "GoogleCloudAiplatformV1ListSandboxEnvironmentSnapshotsResponse", "properties": { - "checkpointId": { - "description": "The ID of the checkpoint.", + "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" }, - "epoch": { - "description": "The epoch of the checkpoint.", - "type": "string", - "format": "int64" - }, - "step": { - "description": "The step of the checkpoint.", - "type": "string", - "format": "int64" - }, - "endpoint": { - "description": "The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.", - "type": "string" + "sandboxEnvironmentSnapshots": { + "description": "The SandboxEnvironmentSnapshots matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TuningDataStats": { - "id": "GoogleCloudAiplatformV1TuningDataStats", - "description": "The tuning data statistic values for TuningJob.", - "type": "object", + "GoogleCloudAiplatformV1ListSandboxEnvironmentTemplatesResponse": { + "description": "Response message for SandboxEnvironmentService.ListSandboxEnvironmentTemplates.", + "id": "GoogleCloudAiplatformV1ListSandboxEnvironmentTemplatesResponse", "properties": { - "supervisedTuningDataStats": { - "description": "The SFT Tuning data stats.", - "$ref": "GoogleCloudAiplatformV1SupervisedTuningDataStats" + "nextPageToken": { + "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.", + "type": "string" }, - "preferenceOptimizationDataStats": { - "description": "Output only. Statistics for preference optimization.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationDataStats" + "sandboxEnvironmentTemplates": { + "description": "The SandboxEnvironmentTemplates matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SupervisedTuningDataStats": { - "id": "GoogleCloudAiplatformV1SupervisedTuningDataStats", - "description": "Tuning data statistics for Supervised Tuning.", - "type": "object", + "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse": { + "description": "Response message for SandboxEnvironmentService.ListSandboxEnvironments.", + "id": "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse", "properties": { - "tuningDatasetExampleCount": { - "description": "Output only. Number of examples in the tuning dataset.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "totalTuningCharacterCount": { - "description": "Output only. Number of tuning characters in the tuning dataset.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "totalBillableCharacterCount": { - "description": "Output only. Number of billable characters in the tuning dataset.", - "readOnly": true, - "deprecated": true, - "type": "string", - "format": "int64" - }, - "totalBillableTokenCount": { - "description": "Output only. Number of billable tokens in the tuning dataset.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "tuningStepCount": { - "description": "Output only. Number of tuning steps for this Tuning Job.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "userInputTokenDistribution": { - "description": "Output only. Dataset distributions for the user input tokens.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution" - }, - "userOutputTokenDistribution": { - "description": "Output only. Dataset distributions for the user output tokens.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution" - }, - "userMessagePerExampleDistribution": { - "description": "Output only. Dataset distributions for the messages per example.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution" + "nextPageToken": { + "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.", + "type": "string" }, - "userDatasetExamples": { - "description": "Output only. Sample user messages in the training dataset uri.", - "readOnly": true, - "type": "array", + "sandboxEnvironments": { + "description": "The SandboxEnvironments matching the request.", "items": { - "$ref": "GoogleCloudAiplatformV1Content" - } - }, - "totalTruncatedExampleCount": { - "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.", - "readOnly": true, - "type": "string", - "format": "int64" + "$ref": "GoogleCloudAiplatformV1SandboxEnvironment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListSavedQueriesResponse": { + "description": "Response message for DatasetService.ListSavedQueries.", + "id": "GoogleCloudAiplatformV1ListSavedQueriesResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" }, - "truncatedExampleIndices": { - "description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.", - "readOnly": true, - "type": "array", + "savedQueries": { + "description": "A list of SavedQueries that match the specified filter in the request.", "items": { - "type": "string", - "format": "int64" - } + "$ref": "GoogleCloudAiplatformV1SavedQuery" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListSchedulesResponse": { + "description": "Response message for ScheduleService.ListSchedules", + "id": "GoogleCloudAiplatformV1ListSchedulesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListSchedulesRequest.page_token to obtain that page.", + "type": "string" }, - "droppedExampleReasons": { - "description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped.", - "readOnly": true, - "type": "array", + "schedules": { + "description": "List of Schedules in the requested page.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1Schedule" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution": { - "id": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution", - "description": "Dataset distribution for Supervised Tuning.", - "type": "object", + "GoogleCloudAiplatformV1ListSessionsResponse": { + "description": "Response message for SessionService.ListSessions.", + "id": "GoogleCloudAiplatformV1ListSessionsResponse", "properties": { - "sum": { - "description": "Output only. Sum of a given population of values.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "billableSum": { - "description": "Output only. Sum of a given population of values that are billable.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "min": { - "description": "Output only. The minimum of the population values.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "max": { - "description": "Output only. The maximum of the population values.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "mean": { - "description": "Output only. The arithmetic mean of the values in the population.", - "readOnly": true, - "type": "number", - "format": "double" + "nextPageToken": { + "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.", + "type": "string" }, - "median": { - "description": "Output only. The median of the values in the population.", - "readOnly": true, - "type": "number", - "format": "double" + "sessions": { + "description": "A list of sessions matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1Session" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListSpecialistPoolsResponse": { + "description": "Response message for SpecialistPoolService.ListSpecialistPools.", + "id": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" }, - "p5": { - "description": "Output only. The 5th percentile of the values in the population.", - "readOnly": true, - "type": "number", - "format": "double" + "specialistPools": { + "description": "A list of SpecialistPools that matches the specified filter in the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1SpecialistPool" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListStudiesResponse": { + "description": "Response message for VizierService.ListStudies.", + "id": "GoogleCloudAiplatformV1ListStudiesResponse", + "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" }, - "p95": { - "description": "Output only. The 95th percentile of the values in the population.", - "readOnly": true, - "type": "number", - "format": "double" + "studies": { + "description": "The studies associated with the project.", + "items": { + "$ref": "GoogleCloudAiplatformV1Study" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse": { + "description": "Response message for TensorboardService.ListTensorboardExperiments.", + "id": "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse", + "properties": { + "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" }, - "buckets": { - "description": "Output only. Defines the histogram bucket.", - "readOnly": true, - "type": "array", + "tensorboardExperiments": { + "description": "The TensorboardExperiments mathching the request.", "items": { - "$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket" - } + "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket": { - "id": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket", - "description": "Dataset bucket used to create a histogram for the distribution given a population of values.", - "type": "object", + "GoogleCloudAiplatformV1ListTensorboardRunsResponse": { + "description": "Response message for TensorboardService.ListTensorboardRuns.", + "id": "GoogleCloudAiplatformV1ListTensorboardRunsResponse", "properties": { - "count": { - "description": "Output only. Number of values in the bucket.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "left": { - "description": "Output only. Left bound of the bucket.", - "readOnly": true, - "type": "number", - "format": "double" + "nextPageToken": { + "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.", + "type": "string" }, - "right": { - "description": "Output only. Right bound of the bucket.", - "readOnly": true, - "type": "number", - "format": "double" + "tensorboardRuns": { + "description": "The TensorboardRuns mathching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1TensorboardRun" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PreferenceOptimizationDataStats": { - "id": "GoogleCloudAiplatformV1PreferenceOptimizationDataStats", - "description": "Statistics computed for datasets used for preference optimization.", - "type": "object", + "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse": { + "description": "Response message for TensorboardService.ListTensorboardTimeSeries.", + "id": "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse", "properties": { - "tuningDatasetExampleCount": { - "description": "Output only. Number of examples in the tuning dataset.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "totalBillableTokenCount": { - "description": "Output only. Number of billable tokens in the tuning dataset.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "tuningStepCount": { - "description": "Output only. Number of tuning steps for this Tuning Job.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "userInputTokenDistribution": { - "description": "Output only. Dataset distributions for the user input tokens.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1DatasetDistribution" - }, - "userOutputTokenDistribution": { - "description": "Output only. Dataset distributions for the user output tokens.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1DatasetDistribution" - }, - "scoreVariancePerExampleDistribution": { - "description": "Output only. Dataset distributions for scores variance per example.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1DatasetDistribution" - }, - "scoresDistribution": { - "description": "Output only. Dataset distributions for scores.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1DatasetDistribution" + "nextPageToken": { + "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.", + "type": "string" }, - "userDatasetExamples": { - "description": "Output only. Sample user examples in the training dataset.", - "readOnly": true, - "type": "array", + "tensorboardTimeSeries": { + "description": "The TensorboardTimeSeries mathching the request.", "items": { - "$ref": "GoogleCloudAiplatformV1GeminiPreferenceExample" - } + "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListTensorboardsResponse": { + "description": "Response message for TensorboardService.ListTensorboards.", + "id": "GoogleCloudAiplatformV1ListTensorboardsResponse", + "properties": { + "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" }, - "droppedExampleIndices": { - "description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.", - "readOnly": true, - "type": "array", + "tensorboards": { + "description": "The Tensorboards mathching the request.", "items": { - "type": "string", - "format": "int64" - } + "$ref": "GoogleCloudAiplatformV1Tensorboard" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ListTrainingPipelinesResponse": { + "description": "Response message for PipelineService.ListTrainingPipelines", + "id": "GoogleCloudAiplatformV1ListTrainingPipelinesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListTrainingPipelinesRequest.page_token to obtain that page.", + "type": "string" }, - "droppedExampleReasons": { - "description": "Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.", - "readOnly": true, - "type": "array", + "trainingPipelines": { + "description": "List of TrainingPipelines in the requested page.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1TrainingPipeline" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DatasetDistribution": { - "id": "GoogleCloudAiplatformV1DatasetDistribution", - "description": "Distribution computed over a tuning dataset.", - "type": "object", + "GoogleCloudAiplatformV1ListTrialsResponse": { + "description": "Response message for VizierService.ListTrials.", + "id": "GoogleCloudAiplatformV1ListTrialsResponse", "properties": { - "sum": { - "description": "Output only. Sum of a given population of values.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "min": { - "description": "Output only. The minimum of the population values.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "max": { - "description": "Output only. The maximum of the population values.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "mean": { - "description": "Output only. The arithmetic mean of the values in the population.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "median": { - "description": "Output only. The median of the values in the population.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "p5": { - "description": "Output only. The 5th percentile of the values in the population.", - "readOnly": true, - "type": "number", - "format": "double" - }, - "p95": { - "description": "Output only. The 95th percentile of the values in the population.", - "readOnly": true, - "type": "number", - "format": "double" + "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" }, - "buckets": { - "description": "Output only. Defines the histogram bucket.", - "readOnly": true, - "type": "array", + "trials": { + "description": "The Trials associated with the Study.", "items": { - "$ref": "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket" - } + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket": { - "id": "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket", - "description": "Dataset bucket used to create a histogram for the distribution given a population of values.", - "type": "object", + "GoogleCloudAiplatformV1ListTuningJobsResponse": { + "description": "Response message for GenAiTuningService.ListTuningJobs", + "id": "GoogleCloudAiplatformV1ListTuningJobsResponse", "properties": { - "count": { - "description": "Output only. Number of values in the bucket.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "left": { - "description": "Output only. Left bound of the bucket.", - "readOnly": true, - "type": "number", - "format": "double" + "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" }, - "right": { - "description": "Output only. Right bound of the bucket.", - "readOnly": true, - "type": "number", - "format": "double" + "tuningJobs": { + "description": "The tuning jobs that match the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1TuningJob" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GeminiPreferenceExample": { - "id": "GoogleCloudAiplatformV1GeminiPreferenceExample", - "description": "Input example for preference optimization.", - "type": "object", + "GoogleCloudAiplatformV1LogprobsResult": { + "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.", + "id": "GoogleCloudAiplatformV1LogprobsResult", "properties": { - "contents": { - "description": "Multi-turn contents that represents the Prompt.", - "type": "array", + "chosenCandidates": { + "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`.", "items": { - "$ref": "GoogleCloudAiplatformV1Content" - } + "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate" + }, + "type": "array" }, - "completions": { - "description": "List of completions for a given prompt.", - "type": "array", + "topCandidates": { + "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": "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion" - } + "$ref": "GoogleCloudAiplatformV1LogprobsResultTopCandidates" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion": { - "id": "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion", - "description": "Completion and its preference score.", - "type": "object", + "GoogleCloudAiplatformV1LogprobsResultCandidate": { + "description": "A single token and its associated log probability.", + "id": "GoogleCloudAiplatformV1LogprobsResultCandidate", "properties": { - "completion": { - "description": "Single turn completion for the given prompt.", - "$ref": "GoogleCloudAiplatformV1Content" + "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.", + "format": "float", + "type": "number" }, - "score": { - "description": "The score for the given completion.", - "type": "number", - "format": "float" + "token": { + "description": "The token's string representation.", + "type": "string" + }, + "tokenId": { + "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.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListTuningJobsResponse": { - "id": "GoogleCloudAiplatformV1ListTuningJobsResponse", - "description": "Response message for GenAiTuningService.ListTuningJobs", - "type": "object", + "GoogleCloudAiplatformV1LogprobsResultTopCandidates": { + "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.", + "id": "GoogleCloudAiplatformV1LogprobsResultTopCandidates", "properties": { - "tuningJobs": { - "description": "List of TuningJobs in the requested page.", - "type": "array", + "candidates": { + "description": "The list of candidate tokens, sorted by log probability in descending order.", "items": { - "$ref": "GoogleCloudAiplatformV1TuningJob" - } - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListTuningJobsRequest.page_token to obtain that page.", - "type": "string" + "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CancelTuningJobRequest": { - "id": "GoogleCloudAiplatformV1CancelTuningJobRequest", - "description": "Request message for GenAiTuningService.CancelTuningJob.", - "type": "object", - "properties": {} + "GoogleCloudAiplatformV1LookupStudyRequest": { + "description": "Request message for VizierService.LookupStudy.", + "id": "GoogleCloudAiplatformV1LookupStudyRequest", + "properties": { + "displayName": { + "description": "Required. The user-defined display name of the Study", + "type": "string" + } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RebaseTunedModelRequest": { - "id": "GoogleCloudAiplatformV1RebaseTunedModelRequest", - "description": "Request message for GenAiTuningService.RebaseTunedModel.", - "type": "object", + "GoogleCloudAiplatformV1LustreMount": { + "description": "Represents a mount configuration for Lustre file system.", + "id": "GoogleCloudAiplatformV1LustreMount", "properties": { - "tunedModelRef": { - "description": "Required. TunedModel reference to retrieve the legacy model information.", - "$ref": "GoogleCloudAiplatformV1TunedModelRef" + "filesystem": { + "description": "Required. The name of the Lustre filesystem.", + "type": "string" }, - "tuningJob": { - "description": "Optional. The TuningJob to be updated. Users can use this TuningJob field to overwrite tuning configs.", - "$ref": "GoogleCloudAiplatformV1TuningJob" + "instanceIp": { + "description": "Required. IP address of the Lustre instance.", + "type": "string" }, - "artifactDestination": { - "description": "Optional. The Google Cloud Storage location to write the artifacts.", - "$ref": "GoogleCloudAiplatformV1GcsDestination" + "mountPoint": { + "description": "Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/", + "type": "string" }, - "deployToSameEndpoint": { - "description": "Optional. By default, bison to gemini migration will always create new model/endpoint, but for gemini-1.0 to gemini-1.5 migration, we default deploy to the same endpoint. See details in this Section.", - "type": "boolean" + "volumeHandle": { + "description": "Required. The unique identifier of the Lustre volume.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TunedModelRef": { - "id": "GoogleCloudAiplatformV1TunedModelRef", - "description": "TunedModel Reference for legacy model migration.", - "type": "object", + "GoogleCloudAiplatformV1MachineSpec": { + "description": "Specification of a single machine.", + "id": "GoogleCloudAiplatformV1MachineSpec", "properties": { - "tunedModel": { - "description": "Support migration from model registry.", + "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, Vertex will co-schedule 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, Vertex will co-schedule 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" + }, + "acceleratorType": { + "description": "Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.", + "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" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "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." + ], "type": "string" }, - "tuningJob": { - "description": "Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above.", + "gpuPartitionSize": { + "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.", "type": "string" }, - "pipelineJob": { - "description": "Support migration from tuning job list page, from bison model to gemini model.", + "machineType": { + "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", + "type": "string" + }, + "reservationAffinity": { + "$ref": "GoogleCloudAiplatformV1ReservationAffinity", + "description": "Optional. Immutable. Configuration controlling how this resource pool consumes reservation." + }, + "tpuTopology": { + "description": "Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: \"2x2x1\").", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Index": { - "id": "GoogleCloudAiplatformV1Index", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ManualBatchTuningParameters": { + "description": "Manual batch tuning parameters.", + "id": "GoogleCloudAiplatformV1ManualBatchTuningParameters", "properties": { - "name": { - "description": "Output only. The resource name of the Index.", + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Measurement": { + "description": "A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values.", + "id": "GoogleCloudAiplatformV1Measurement", + "properties": { + "elapsedDuration": { + "description": "Output only. Time that the Trial has been running at the point of this Measurement.", + "format": "google-duration", "readOnly": true, "type": "string" }, - "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" + "metrics": { + "description": "Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.", + "items": { + "$ref": "GoogleCloudAiplatformV1MeasurementMetric" + }, + "readOnly": true, + "type": "array" }, - "description": { - "description": "The description of the Index.", + "stepCount": { + "description": "Output only. The number of steps the machine learning model has been trained for. Must be non-negative.", + "format": "int64", + "readOnly": true, "type": "string" - }, - "metadataSchemaUri": { - "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.", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MeasurementMetric": { + "description": "A message representing a metric in the measurement.", + "id": "GoogleCloudAiplatformV1MeasurementMetric", + "properties": { + "metricId": { + "description": "Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.", + "readOnly": true, "type": "string" }, - "metadata": { - "description": "An additional information about the Index; the schema of the metadata can be found in metadata_schema.", - "type": "any" - }, - "deployedIndexes": { - "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.", + "value": { + "description": "Output only. The value for this metric.", + "format": "double", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DeployedIndexRef" - } + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Memory": { + "description": "A memory.", + "id": "GoogleCloudAiplatformV1Memory", + "properties": { + "createTime": { + "description": "Output only. Represents the timestamp when this Memory was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "etag": { - "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "description": { + "description": "Optional. Represents the description of the Memory.", "type": "string" }, - "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" - } + "disableMemoryRevisions": { + "description": "Optional. Input only. Indicates whether no revision will be created for this request.", + "type": "boolean" }, - "createTime": { - "description": "Output only. Timestamp when this Index was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "displayName": { + "description": "Optional. Represents the display name of the Memory.", + "type": "string" }, - "updateTime": { - "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.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "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.", + "format": "google-datetime", + "type": "string" }, - "indexStats": { - "description": "Output only. Stats of the index resource.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1IndexStats" + "fact": { + "description": "Optional. Represents semantic knowledge extracted from the source content.", + "type": "string" }, - "indexUpdateMethod": { - "description": "Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.", - "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." - ], - "enum": [ - "INDEX_UPDATE_METHOD_UNSPECIFIED", - "BATCH_UPDATE", - "STREAM_UPDATE" - ] + "metadata": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1MemoryMetadataValue" + }, + "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.", + "type": "object" }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" + "name": { + "description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "type": "string" }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "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.", + "format": "google-datetime", + "type": "string" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1DeployedIndexRef": { - "id": "GoogleCloudAiplatformV1DeployedIndexRef", - "description": "Points to a DeployedIndex.", - "type": "object", - "properties": { - "indexEndpoint": { - "description": "Immutable. A resource name of the IndexEndpoint.", + "revisionLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.", + "type": "object" + }, + "revisionTtl": { + "description": "Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.", + "format": "google-duration", "type": "string" }, - "deployedIndexId": { - "description": "Immutable. The ID of the DeployedIndex in the above IndexEndpoint.", + "scope": { + "additionalProperties": { + "type": "string" + }, + "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 '*'.", + "type": "object" + }, + "topics": { + "description": "Optional. Represents the Topics of the Memory.", + "items": { + "$ref": "GoogleCloudAiplatformV1MemoryTopicId" + }, + "type": "array" + }, + "ttl": { + "description": "Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.", + "format": "google-duration", "type": "string" }, - "displayName": { - "description": "Output only. The display name of the DeployedIndex.", + "updateTime": { + "description": "Output only. Represents the timestamp when this Memory was most recently updated.", + "format": "google-datetime", "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1IndexStats": { - "id": "GoogleCloudAiplatformV1IndexStats", - "description": "Stats of the Index.", - "type": "object", + "GoogleCloudAiplatformV1MemoryBankCustomizationConfig": { + "description": "Represents configuration for organizing natural language memories for a particular scope.", + "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfig", "properties": { - "vectorsCount": { - "description": "Output only. The number of dense vectors in the Index.", - "readOnly": true, - "type": "string", - "format": "int64" + "consolidationConfig": { + "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigConsolidationConfig", + "description": "Optional. Represents configuration for customizing how memories are consolidated together." }, - "sparseVectorsCount": { - "description": "Output only. The number of sparse vectors in the Index.", - "readOnly": true, - "type": "string", - "format": "int64" + "disableNaturalLanguageMemories": { + "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": "boolean" }, - "shardsCount": { - "description": "Output only. The number of shards in the Index.", - "readOnly": true, - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1ListIndexesResponse": { - "id": "GoogleCloudAiplatformV1ListIndexesResponse", - "description": "Response message for IndexService.ListIndexes.", - "type": "object", - "properties": { - "indexes": { - "description": "List of indexes in the requested page.", - "type": "array", + "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" + }, + "generateMemoriesExamples": { + "description": "Optional. Provides examples of how to generate memories for a particular scope.", "items": { - "$ref": "GoogleCloudAiplatformV1Index" - } + "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExample" + }, + "type": "array" }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass to ListIndexesRequest.page_token to obtain that page.", - "type": "string" + "memoryTopics": { + "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": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopic" + }, + "type": "array" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpsertDatapointsRequest": { - "id": "GoogleCloudAiplatformV1UpsertDatapointsRequest", - "description": "Request message for IndexService.UpsertDatapoints", - "type": "object", + "GoogleCloudAiplatformV1MemoryBankCustomizationConfigConsolidationConfig": { + "description": "Represents configuration for customizing how memories are consolidated.", + "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigConsolidationConfig", "properties": { - "datapoints": { - "description": "A list of datapoints to be created/updated.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1IndexDatapoint" - } - }, - "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" + "revisionsPerCandidateCount": { + "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", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1IndexDatapoint": { - "id": "GoogleCloudAiplatformV1IndexDatapoint", - "description": "A datapoint of Index.", - "type": "object", + "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExample": { + "description": "An example of how to generate memories for a particular scope.", + "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExample", "properties": { - "datapointId": { - "description": "Required. Unique identifier of the datapoint.", - "type": "string" - }, - "featureVector": { - "description": "Required. Feature embedding vector for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].", - "type": "array", - "items": { - "type": "number", - "format": "float" - } - }, - "sparseEmbedding": { - "description": "Optional. Feature embedding vector for sparse index.", - "$ref": "GoogleCloudAiplatformV1IndexDatapointSparseEmbedding" - }, - "restricts": { - "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", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1IndexDatapointRestriction" - } + "conversationSource": { + "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource", + "description": "A conversation source for the example." }, - "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", + "generatedMemories": { + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1IndexDatapointNumericRestriction" - } - }, - "crowdingTag": { - "description": "Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.", - "$ref": "GoogleCloudAiplatformV1IndexDatapointCrowdingTag" - }, - "embeddingMetadata": { - "description": "Optional. The key-value map of additional metadata for the datapoint.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } + "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1IndexDatapointSparseEmbedding": { - "id": "GoogleCloudAiplatformV1IndexDatapointSparseEmbedding", - "description": "Feature embedding vector for sparse index. An array of numbers whose values are located in the specified dimensions.", - "type": "object", + "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource": { + "description": "A conversation source for the example. This is similar to `DirectContentsSource`.", + "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource", "properties": { - "values": { - "description": "Required. The list of embedding values of the sparse vector.", - "type": "array", - "items": { - "type": "number", - "format": "float" - } - }, - "dimensions": { - "description": "Required. The list of indexes for the embedding values of the sparse vector.", - "type": "array", + "events": { + "description": "Optional. Represents the input conversation events for the example.", "items": { - "type": "string", - "format": "int64" - } + "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1IndexDatapointRestriction": { - "id": "GoogleCloudAiplatformV1IndexDatapointRestriction", - "description": "Restriction of a datapoint which describe its attributes(tokens) from each of several attribute categories(namespaces).", - "type": "object", + "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent": { + "description": "A single conversation event.", + "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent", "properties": { - "namespace": { - "description": "The namespace of this restriction. e.g.: color.", + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Required. Represents the content of the event." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory": { + "description": "A memory generated by the operation.", + "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory", + "properties": { + "fact": { + "description": "Required. Represents the fact to generate a memory from.", "type": "string" }, - "allowList": { - "description": "The attributes to allow in this namespace. e.g.: 'red'", - "type": "array", - "items": { - "type": "string" - } - }, - "denyList": { - "description": "The attributes to deny in this namespace. e.g.: 'blue'", - "type": "array", + "topics": { + "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`.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1MemoryTopicId" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1IndexDatapointNumericRestriction": { - "id": "GoogleCloudAiplatformV1IndexDatapointNumericRestriction", - "description": "This field allows restricts to be based on numeric comparisons rather than categorical tokens.", - "type": "object", + "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopic": { + "description": "A topic of information that should be extracted from conversations and stored as memories.", + "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopic", "properties": { - "valueInt": { - "description": "Represents 64 bit integer.", - "type": "string", - "format": "int64" + "customMemoryTopic": { + "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic", + "description": "A custom memory topic defined by the developer." }, - "valueFloat": { - "description": "Represents 32 bit float.", - "type": "number", - "format": "float" - }, - "valueDouble": { - "description": "Represents 64 bit float.", - "type": "number", - "format": "double" - }, - "namespace": { - "description": "The namespace of this restriction. e.g.: cost.", + "managedMemoryTopic": { + "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic", + "description": "A managed memory topic defined by Memory Bank." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic": { + "description": "A custom memory topic defined by the developer.", + "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic", + "properties": { + "description": { + "description": "Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic.", "type": "string" }, - "op": { - "description": "This MUST be specified for queries and must NOT be specified for datapoints.", - "type": "string", - "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" - ] + "label": { + "description": "Required. Represents the label of the topic.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1IndexDatapointCrowdingTag": { - "id": "GoogleCloudAiplatformV1IndexDatapointCrowdingTag", - "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", + "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic": { + "description": "A managed memory topic defined by the system.", + "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic", "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.", + "managedTopicEnum": { + "description": "Required. Represents the managed topic.", + "enum": [ + "MANAGED_TOPIC_ENUM_UNSPECIFIED", + "USER_PERSONAL_INFO", + "USER_PREFERENCES", + "KEY_CONVERSATION_DETAILS", + "EXPLICIT_INSTRUCTIONS" + ], + "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" } - } - }, - "GoogleCloudAiplatformV1UpsertDatapointsResponse": { - "id": "GoogleCloudAiplatformV1UpsertDatapointsResponse", - "description": "Response message for IndexService.UpsertDatapoints", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1RemoveDatapointsRequest": { - "id": "GoogleCloudAiplatformV1RemoveDatapointsRequest", - "description": "Request message for IndexService.RemoveDatapoints", - "type": "object", + "GoogleCloudAiplatformV1MemoryConjunctionFilter": { + "description": "A conjunction of filters that will be combined using AND logic.", + "id": "GoogleCloudAiplatformV1MemoryConjunctionFilter", "properties": { - "datapointIds": { - "description": "A list of datapoint ids to be deleted.", - "type": "array", + "filters": { + "description": "Represents filters that will be combined using AND logic.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1MemoryFilter" + }, + "type": "array" } - } - }, - "GoogleCloudAiplatformV1RemoveDatapointsResponse": { - "id": "GoogleCloudAiplatformV1RemoveDatapointsResponse", - "description": "Response message for IndexService.RemoveDatapoints", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1IndexEndpoint": { - "id": "GoogleCloudAiplatformV1IndexEndpoint", - "description": "Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.", - "type": "object", + "GoogleCloudAiplatformV1MemoryFilter": { + "description": "Filter to apply when retrieving memories.", + "id": "GoogleCloudAiplatformV1MemoryFilter", "properties": { - "name": { - "description": "Output only. The resource name of the IndexEndpoint.", - "readOnly": true, + "key": { + "description": "Represents the key of the filter. For example, \"author\" would apply to `metadata` entries with the key \"author\".", "type": "string" }, - "displayName": { - "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.", - "type": "string" + "negate": { + "description": "Indicates whether the filter will be negated.", + "type": "boolean" }, - "description": { - "description": "The description of the IndexEndpoint.", + "op": { + "description": "Represents the operator to apply to the filter. If not set, then EQUAL will be used.", + "enum": [ + "OPERATOR_UNSPECIFIED", + "EQUAL", + "GREATER_THAN", + "LESS_THAN" + ], + "enumDescriptions": [ + "Represents an unspecified operator. Defaults to EQUAL.", + "Equal to.", + "Greater than.", + "Less than." + ], "type": "string" }, - "deployedIndexes": { - "description": "Output only. The indexes deployed in this endpoint.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DeployedIndex" - } + "value": { + "$ref": "GoogleCloudAiplatformV1MemoryMetadataValue", + "description": "Represents the value to compare to." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MemoryGenerationTriggerConfig": { + "description": "Represents configuration for triggering generation.", + "id": "GoogleCloudAiplatformV1MemoryGenerationTriggerConfig", + "properties": { + "generationRule": { + "$ref": "GoogleCloudAiplatformV1MemoryGenerationTriggerConfigGenerationTriggerRule", + "description": "Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MemoryGenerationTriggerConfigGenerationTriggerRule": { + "description": "Represents the active rule that determines when to flush the buffer.", + "id": "GoogleCloudAiplatformV1MemoryGenerationTriggerConfigGenerationTriggerRule", + "properties": { + "eventCount": { + "description": "Optional. Specifies to trigger generation when the event count reaches this limit.", + "format": "int32", + "type": "integer" }, - "etag": { - "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "fixedInterval": { + "description": "Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity.", + "format": "google-duration", "type": "string" }, - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "createTime": { - "description": "Output only. Timestamp when this IndexEndpoint was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "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.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "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.", + "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.", + "format": "google-duration", "type": "string" - }, - "enablePrivateServiceConnect": { - "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.", - "deprecated": true, + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MemoryMetadataValue": { + "description": "Memory metadata.", + "id": "GoogleCloudAiplatformV1MemoryMetadataValue", + "properties": { + "boolValue": { + "description": "Represents a boolean value.", "type": "boolean" }, - "privateServiceConnectConfig": { - "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.", - "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig" - }, - "publicEndpointEnabled": { - "description": "Optional. If true, the deployed index will be accessible through public endpoint.", - "type": "boolean" + "doubleValue": { + "description": "Represents a double value.", + "format": "double", + "type": "number" }, - "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, + "stringValue": { + "description": "Represents a string value.", "type": "string" }, - "encryptionSpec": { - "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.", - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" - }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" - }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "timestampValue": { + "description": "Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.", + "format": "google-datetime", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployedIndex": { - "id": "GoogleCloudAiplatformV1DeployedIndex", - "description": "A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.", - "type": "object", + "GoogleCloudAiplatformV1MemoryRevision": { + "description": "A revision of a Memory.", + "id": "GoogleCloudAiplatformV1MemoryRevision", "properties": { - "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" - }, - "index": { - "description": "Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's \"original\" Index.", - "type": "string" - }, - "displayName": { - "description": "The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.", - "type": "string" - }, "createTime": { - "description": "Output only. Timestamp when the DeployedIndex was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "privateEndpoints": { - "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.", + "description": "Output only. Represents the timestamp when this Memory Revision was created.", + "format": "google-datetime", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1IndexPrivateEndpoints" + "type": "string" }, - "indexSyncTime": { - "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.", + "expireTime": { + "description": "Output only. Represents the timestamp of when this resource is considered expired.", + "format": "google-datetime", "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "automaticResources": { - "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.", - "$ref": "GoogleCloudAiplatformV1AutomaticResources" - }, - "dedicatedResources": { - "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.", - "$ref": "GoogleCloudAiplatformV1DedicatedResources" - }, - "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" - }, - "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": "GoogleCloudAiplatformV1DeployedIndexAuthConfig" - }, - "reservedIpRanges": { - "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", - "items": { - "type": "string" - } - }, - "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" }, - "deploymentTier": { - "description": "Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier.", - "type": "string", - "enumDescriptions": [ - "Default deployment tier.", - "Optimized for costs." - ], - "enum": [ - "DEPLOYMENT_TIER_UNSPECIFIED", - "STORAGE" - ] - }, - "pscAutomationConfigs": { - "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.", - "type": "array", + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1PSCAutomationConfig" - } - } - } - }, - "GoogleCloudAiplatformV1IndexPrivateEndpoints": { - "id": "GoogleCloudAiplatformV1IndexPrivateEndpoints", - "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.", - "type": "object", - "properties": { - "matchGrpcAddress": { - "description": "Output only. The ip address used to send match gRPC requests.", + "$ref": "GoogleCloudAiplatformV1IntermediateExtractedMemory" + }, + "readOnly": true, + "type": "array" + }, + "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" }, - "serviceAttachment": { - "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled.", + "labels": { + "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, + "type": "object" + }, + "name": { + "description": "Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`", "type": "string" }, - "pscAutomatedEndpoints": { - "description": "Output only. PscAutomatedEndpoints is populated if private service connect is enabled if PscAutomatedConfig is set.", + "structuredData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. Represents the structured value of the memory at the time of revision creation.", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1PscAutomatedEndpoints" - } + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PscAutomatedEndpoints": { - "id": "GoogleCloudAiplatformV1PscAutomatedEndpoints", - "description": "PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig.", - "type": "object", + "GoogleCloudAiplatformV1MemoryTopicId": { + "description": "A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.", + "id": "GoogleCloudAiplatformV1MemoryTopicId", "properties": { - "projectId": { - "description": "Corresponding project_id in pscAutomationConfigs", - "type": "string" - }, - "network": { - "description": "Corresponding network in pscAutomationConfigs.", + "customMemoryTopicLabel": { + "description": "Optional. Represents the custom memory topic label.", "type": "string" }, - "matchAddress": { - "description": "Ip Address created by the automated forwarding rule.", + "managedMemoryTopic": { + "description": "Optional. Represents the managed memory topic.", + "enum": [ + "MANAGED_TOPIC_ENUM_UNSPECIFIED", + "USER_PERSONAL_INFO", + "USER_PREFERENCES", + "KEY_CONVERSATION_DETAILS", + "EXPLICIT_INSTRUCTIONS" + ], + "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" } - } - }, - "GoogleCloudAiplatformV1DeployedIndexAuthConfig": { - "id": "GoogleCloudAiplatformV1DeployedIndexAuthConfig", - "description": "Used to set up the auth on the DeployedIndex's private endpoint.", - "type": "object", - "properties": { - "authProvider": { - "description": "Defines the authentication provider that the DeployedIndex uses.", - "$ref": "GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider" - } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider": { - "id": "GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider", - "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", + "GoogleCloudAiplatformV1MergeVersionAliasesRequest": { + "description": "Request message for ModelService.MergeVersionAliases.", + "id": "GoogleCloudAiplatformV1MergeVersionAliasesRequest", "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.", - "type": "array", - "items": { - "type": "string" - } - }, - "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`", - "type": "array", + "versionAliases": { + "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.", "items": { "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1ListIndexEndpointsResponse": { - "id": "GoogleCloudAiplatformV1ListIndexEndpointsResponse", - "description": "Response message for IndexEndpointService.ListIndexEndpoints.", - "type": "object", - "properties": { - "indexEndpoints": { - "description": "List of IndexEndpoints in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1IndexEndpoint" - } - }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass to ListIndexEndpointsRequest.page_token to obtain that page.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1DeployIndexRequest": { - "id": "GoogleCloudAiplatformV1DeployIndexRequest", - "description": "Request message for IndexEndpointService.DeployIndex.", - "type": "object", - "properties": { - "deployedIndex": { - "description": "Required. The DeployedIndex to be created within the IndexEndpoint.", - "$ref": "GoogleCloudAiplatformV1DeployedIndex" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UndeployIndexRequest": { - "id": "GoogleCloudAiplatformV1UndeployIndexRequest", - "description": "Request message for IndexEndpointService.UndeployIndex.", - "type": "object", + "GoogleCloudAiplatformV1Metadata": { + "description": "Metadata for a chunk.", + "id": "GoogleCloudAiplatformV1Metadata", "properties": { - "deployedIndexId": { - "description": "Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.", - "type": "string" + "attributes": { + "additionalProperties": { + "format": "byte", + "type": "string" + }, + "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.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CustomJob": { - "id": "GoogleCloudAiplatformV1CustomJob", - "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", + "GoogleCloudAiplatformV1MetadataSchema": { + "description": "Instance of a general MetadataSchema.", + "id": "GoogleCloudAiplatformV1MetadataSchema", "properties": { - "name": { - "description": "Output only. Resource name of a CustomJob.", + "createTime": { + "description": "Output only. Timestamp when this MetadataSchema was created.", + "format": "google-datetime", "readOnly": true, "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" - }, - "jobSpec": { - "description": "Required. Job spec.", - "$ref": "GoogleCloudAiplatformV1CustomJobSpec" - }, - "state": { - "description": "Output only. The detailed state of the job.", - "readOnly": true, - "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." - ], - "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": { + "description": "Description of the Metadata Schema", + "type": "string" }, - "createTime": { - "description": "Output only. Time when the CustomJob was created.", + "name": { + "description": "Output only. The resource name of the MetadataSchema.", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "string" }, - "startTime": { - "description": "Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "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" }, - "endTime": { - "description": "Output only. Time when the CustomJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "schemaType": { + "description": "The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.", + "enum": [ + "METADATA_SCHEMA_TYPE_UNSPECIFIED", + "ARTIFACT_TYPE", + "EXECUTION_TYPE", + "CONTEXT_TYPE" + ], + "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." + ], + "type": "string" }, - "updateTime": { - "description": "Output only. Time when the CustomJob was most recently updated.", + "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" + }, + "GoogleCloudAiplatformV1MetadataStore": { + "description": "Instance of a metadata store. Contains a set of metadata that can be queried.", + "id": "GoogleCloudAiplatformV1MetadataStore", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this MetadataStore was created.", + "format": "google-datetime", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "string" }, - "error": { - "description": "Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", - "readOnly": true, - "$ref": "GoogleRpcStatus" + "dataplexConfig": { + "$ref": "GoogleCloudAiplatformV1MetadataStoreDataplexConfig", + "description": "Optional. Dataplex integration settings." }, - "labels": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "description": { + "description": "Description of the MetadataStore.", + "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": "GoogleCloudAiplatformV1EncryptionSpec" + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "webAccessUris": { - "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.", + "name": { + "description": "Output only. The resource name of the MetadataStore instance.", "readOnly": true, - "type": "object", - "additionalProperties": { - "type": "string" - } + "type": "string" }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "state": { + "$ref": "GoogleCloudAiplatformV1MetadataStoreMetadataStoreState", + "description": "Output only. State information of the MetadataStore.", + "readOnly": true }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", + "updateTime": { + "description": "Output only. Timestamp when this MetadataStore was last updated.", + "format": "google-datetime", "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MetadataStoreDataplexConfig": { + "description": "Represents Dataplex integration settings.", + "id": "GoogleCloudAiplatformV1MetadataStoreDataplexConfig", + "properties": { + "enabledPipelinesLineage": { + "description": "Optional. Whether or not Data Lineage synchronization is enabled for Vertex Pipelines.", "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CustomJobSpec": { - "id": "GoogleCloudAiplatformV1CustomJobSpec", - "description": "Represents the spec of a CustomJob.", - "type": "object", + "GoogleCloudAiplatformV1MetadataStoreMetadataStoreState": { + "description": "Represents state information for a MetadataStore.", + "id": "GoogleCloudAiplatformV1MetadataStoreMetadataStoreState", "properties": { - "persistentResourceId": { - "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.", + "diskUtilizationBytes": { + "description": "The disk utilization of the MetadataStore in bytes.", + "format": "int64", "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", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Metric": { + "description": "The metric used for running evaluations.", + "id": "GoogleCloudAiplatformV1Metric", + "properties": { + "aggregationMetrics": { + "description": "Optional. The aggregation metrics to use.", "items": { - "$ref": "GoogleCloudAiplatformV1WorkerPoolSpec" - } + "enum": [ + "AGGREGATION_METRIC_UNSPECIFIED", + "AVERAGE", + "MODE", + "STANDARD_DEVIATION", + "VARIANCE", + "MINIMUM", + "MAXIMUM", + "MEDIAN", + "PERCENTILE_P90", + "PERCENTILE_P95", + "PERCENTILE_P99" + ], + "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." + ], + "type": "string" + }, + "type": "array" }, - "scheduling": { - "description": "Scheduling options for a CustomJob.", - "$ref": "GoogleCloudAiplatformV1Scheduling" + "bleuSpec": { + "$ref": "GoogleCloudAiplatformV1BleuSpec", + "description": "Spec for bleu metric." }, - "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" + "computationBasedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1ComputationBasedMetricSpec", + "description": "Spec for a computation based metric." }, - "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" + "customCodeExecutionSpec": { + "$ref": "GoogleCloudAiplatformV1CustomCodeExecutionSpec", + "description": "Spec for Custom Code Execution metric." }, - "reservedIpRanges": { - "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'].", - "type": "array", - "items": { - "type": "string" - } + "exactMatchSpec": { + "$ref": "GoogleCloudAiplatformV1ExactMatchSpec", + "description": "Spec for exact match metric." }, - "pscInterfaceConfig": { - "description": "Optional. Configuration for PSC-I for CustomJob.", - "$ref": "GoogleCloudAiplatformV1PscInterfaceConfig" + "llmBasedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1LLMBasedMetricSpec", + "description": "Spec for an LLM based metric." }, - "baseOutputDirectory": { - "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/`", - "$ref": "GoogleCloudAiplatformV1GcsDestination" + "metadata": { + "$ref": "GoogleCloudAiplatformV1MetricMetadata", + "description": "Optional. Metadata about the metric, used for visualization and organization." }, - "protectedArtifactLocationId": { - "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", - "type": "string" + "pairwiseMetricSpec": { + "$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec", + "description": "Spec for pairwise metric." }, - "tensorboard": { - "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}`", - "type": "string" + "pointwiseMetricSpec": { + "$ref": "GoogleCloudAiplatformV1PointwiseMetricSpec", + "description": "Spec for pointwise metric." }, - "enableWebAccess": { - "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).", - "type": "boolean" + "predefinedMetricSpec": { + "$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec", + "description": "The spec for a pre-defined metric." }, - "enableDashboardAccess": { - "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).", - "type": "boolean" + "rougeSpec": { + "$ref": "GoogleCloudAiplatformV1RougeSpec", + "description": "Spec for rouge metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MetricMetadata": { + "description": "Metadata about the metric, used for visualization and organization.", + "id": "GoogleCloudAiplatformV1MetricMetadata", + "properties": { + "otherMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Flexible metadata for user-defined attributes.", + "type": "object" }, - "experiment": { - "description": "Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`", - "type": "string" + "scoreRange": { + "$ref": "GoogleCloudAiplatformV1MetricMetadataScoreRange", + "description": "Optional. The range of possible scores for this metric, used for plotting." }, - "experimentRun": { - "description": "Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`", + "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" - }, - "models": { - "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.", - "type": "array", - "items": { - "type": "string" - } } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1WorkerPoolSpec": { - "id": "GoogleCloudAiplatformV1WorkerPoolSpec", - "description": "Represents the spec of a worker pool in a job.", - "type": "object", + "GoogleCloudAiplatformV1MetricMetadataScoreRange": { + "description": "The range of possible scores for this metric, used for plotting.", + "id": "GoogleCloudAiplatformV1MetricMetadataScoreRange", "properties": { - "containerSpec": { - "description": "The custom container task.", - "$ref": "GoogleCloudAiplatformV1ContainerSpec" + "description": { + "description": "Optional. The description of the score explaining the directionality etc.", + "type": "string" }, - "pythonPackageSpec": { - "description": "The Python packaged task.", - "$ref": "GoogleCloudAiplatformV1PythonPackageSpec" + "max": { + "description": "Required. The maximum value of the score range (inclusive).", + "format": "double", + "type": "number" }, - "machineSpec": { - "description": "Optional. Immutable. The specification of a single machine.", - "$ref": "GoogleCloudAiplatformV1MachineSpec" + "min": { + "description": "Required. The minimum value of the score range (inclusive).", + "format": "double", + "type": "number" }, - "replicaCount": { - "description": "Optional. The number of worker replicas to use for this worker pool.", - "type": "string", - "format": "int64" + "step": { + "description": "Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MetricResult": { + "description": "Result for a single metric on a single instance.", + "id": "GoogleCloudAiplatformV1MetricResult", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error status for the metric result.", + "readOnly": true }, - "nfsMounts": { - "description": "Optional. List of NFS mount spec.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1NfsMount" - } + "explanation": { + "description": "Output only. The explanation for the metric result.", + "readOnly": true, + "type": "string" }, - "lustreMounts": { - "description": "Optional. List of Lustre mounts.", - "type": "array", + "rubricVerdicts": { + "description": "Output only. For rubric-based metrics, the verdicts for each rubric.", "items": { - "$ref": "GoogleCloudAiplatformV1LustreMount" - } + "$ref": "GoogleCloudAiplatformV1RubricVerdict" + }, + "readOnly": true, + "type": "array" }, - "diskSpec": { - "description": "Disk spec.", - "$ref": "GoogleCloudAiplatformV1DiskSpec" + "score": { + "description": "Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ContainerSpec": { - "id": "GoogleCloudAiplatformV1ContainerSpec", - "description": "The spec of a Container.", - "type": "object", + "GoogleCloudAiplatformV1MetricSource": { + "description": "The metric source used for evaluation.", + "id": "GoogleCloudAiplatformV1MetricSource", "properties": { - "imageUri": { - "description": "Required. The URI of a container image in the Container Registry that is to be run on each worker replica.", + "metric": { + "$ref": "GoogleCloudAiplatformV1Metric", + "description": "Inline metric config." + }, + "metricResourceName": { + "description": "Optional. Resource name for registered metric.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MetricxInput": { + "description": "Input for MetricX metric.", + "id": "GoogleCloudAiplatformV1MetricxInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1MetricxInstance", + "description": "Required. Metricx instance." }, - "command": { - "description": "The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.", - "type": "array", - "items": { - "type": "string" - } + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1MetricxSpec", + "description": "Required. Spec for Metricx metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MetricxInstance": { + "description": "Spec for MetricX instance - The fields used for evaluation are dependent on the MetricX version.", + "id": "GoogleCloudAiplatformV1MetricxInstance", + "properties": { + "prediction": { + "description": "Required. Output of the evaluated model.", + "type": "string" }, - "args": { - "description": "The arguments to be passed when starting the container.", - "type": "array", - "items": { - "type": "string" - } + "reference": { + "description": "Optional. Ground truth used to compare against the prediction.", + "type": "string" }, - "env": { - "description": "Environment variables to be passed to the container. Maximum limit is 100.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1EnvVar" - } + "source": { + "description": "Optional. Source text in original language.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EnvVar": { - "id": "GoogleCloudAiplatformV1EnvVar", - "description": "Represents an environment variable present in a Container or Python Module.", - "type": "object", + "GoogleCloudAiplatformV1MetricxResult": { + "description": "Spec for MetricX result - calculates the MetricX score for the given instance using the version specified in the spec.", + "id": "GoogleCloudAiplatformV1MetricxResult", "properties": { - "name": { - "description": "Required. Name of the environment variable. Must be a valid C identifier.", + "score": { + "description": "Output only. MetricX score. Range depends on version.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MetricxSpec": { + "description": "Spec for MetricX metric.", + "id": "GoogleCloudAiplatformV1MetricxSpec", + "properties": { + "sourceLanguage": { + "description": "Optional. Source language in BCP-47 format.", "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.", + "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.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PythonPackageSpec": { - "id": "GoogleCloudAiplatformV1PythonPackageSpec", - "description": "The spec of a Python packaged code.", - "type": "object", + "GoogleCloudAiplatformV1MigratableResource": { + "description": "Represents one resource that exists in automl.googleapis.com, datalabeling.googleapis.com or ml.googleapis.com.", + "id": "GoogleCloudAiplatformV1MigratableResource", "properties": { - "executorImageUri": { - "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.", - "type": "string" + "automlDataset": { + "$ref": "GoogleCloudAiplatformV1MigratableResourceAutomlDataset", + "description": "Output only. Represents one Dataset in automl.googleapis.com.", + "readOnly": true }, - "packageUris": { - "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", - "items": { - "type": "string" - } + "automlModel": { + "$ref": "GoogleCloudAiplatformV1MigratableResourceAutomlModel", + "description": "Output only. Represents one Model in automl.googleapis.com.", + "readOnly": true }, - "pythonModule": { - "description": "Required. The Python module name to run after installing the packages.", + "dataLabelingDataset": { + "$ref": "GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset", + "deprecated": true, + "description": "Output only. Deprecated: Data Labeling Dataset migration is no longer supported. Represents one Dataset in datalabeling.googleapis.com.", + "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", + "readOnly": true, "type": "string" }, - "args": { - "description": "Command line arguments to be passed to the Python task.", - "type": "array", - "items": { - "type": "string" - } + "lastUpdateTime": { + "description": "Output only. Timestamp when this MigratableResource was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "env": { - "description": "Environment variables to be passed to the python module. Maximum limit is 100.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1EnvVar" - } + "mlEngineModelVersion": { + "$ref": "GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion", + "description": "Output only. Represents one Version in ml.googleapis.com.", + "readOnly": true } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NfsMount": { - "id": "GoogleCloudAiplatformV1NfsMount", - "description": "Represents a mount configuration for Network File System (NFS) to mount.", - "type": "object", + "GoogleCloudAiplatformV1MigratableResourceAutomlDataset": { + "description": "Represents one Dataset in automl.googleapis.com.", + "id": "GoogleCloudAiplatformV1MigratableResourceAutomlDataset", "properties": { - "server": { - "description": "Required. IP address of the NFS server.", + "dataset": { + "description": "Full resource name of automl Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", "type": "string" }, - "path": { - "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`", + "datasetDisplayName": { + "description": "The Dataset's display name in automl.googleapis.com.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MigratableResourceAutomlModel": { + "description": "Represents one Model in automl.googleapis.com.", + "id": "GoogleCloudAiplatformV1MigratableResourceAutomlModel", + "properties": { + "model": { + "description": "Full resource name of automl Model. Format: `projects/{project}/locations/{location}/models/{model}`.", "type": "string" }, - "mountPoint": { - "description": "Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/", + "modelDisplayName": { + "description": "The Model's display name in automl.googleapis.com.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1LustreMount": { - "id": "GoogleCloudAiplatformV1LustreMount", - "description": "Represents a mount configuration for Lustre file system.", - "type": "object", + "GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset": { + "description": "Represents one Dataset in datalabeling.googleapis.com.", + "id": "GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset", "properties": { - "instanceIp": { - "description": "Required. IP address of the Lustre instance.", - "type": "string" + "dataLabelingAnnotatedDatasets": { + "description": "The migratable AnnotatedDataset in datalabeling.googleapis.com belongs to the data labeling Dataset.", + "items": { + "$ref": "GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset" + }, + "type": "array" }, - "volumeHandle": { - "description": "Required. The unique identifier of the Lustre volume.", + "dataset": { + "description": "Full resource name of data labeling Dataset. Format: `projects/{project}/datasets/{dataset}`.", "type": "string" }, - "filesystem": { - "description": "Required. The name of the Lustre filesystem.", + "datasetDisplayName": { + "description": "The Dataset's display name in datalabeling.googleapis.com.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset": { + "description": "Represents one AnnotatedDataset in datalabeling.googleapis.com.", + "id": "GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset", + "properties": { + "annotatedDataset": { + "description": "Full resource name of data labeling AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.", "type": "string" }, - "mountPoint": { - "description": "Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/", + "annotatedDatasetDisplayName": { + "description": "The AnnotatedDataset's display name in datalabeling.googleapis.com.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DiskSpec": { - "id": "GoogleCloudAiplatformV1DiskSpec", - "description": "Represents the spec of disk options.", - "type": "object", + "GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion": { + "description": "Represents one model Version in ml.googleapis.com.", + "id": "GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion", "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\".", + "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" }, - "bootDiskSizeGb": { - "description": "Size in GB of the boot disk (default is 100GB).", - "type": "integer", - "format": "int32" + "version": { + "description": "Full resource name of ml engine model Version. Format: `projects/{project}/models/{model}/versions/{version}`.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Scheduling": { - "id": "GoogleCloudAiplatformV1Scheduling", - "description": "All parameters related to queuing and scheduling of custom jobs.", - "type": "object", + "GoogleCloudAiplatformV1MigrateResourceRequest": { + "description": "Config of migrating one resource from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.", + "id": "GoogleCloudAiplatformV1MigrateResourceRequest", "properties": { - "timeout": { - "description": "Optional. The maximum job running time. The default is 7 days.", - "type": "string", - "format": "google-duration" + "migrateAutomlDatasetConfig": { + "$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig", + "description": "Config for migrating Dataset in automl.googleapis.com to Vertex AI's Dataset." }, - "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" + "migrateAutomlModelConfig": { + "$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig", + "description": "Config for migrating Model in automl.googleapis.com to Vertex AI's Model." }, - "strategy": { - "description": "Optional. This determines which type of scheduling strategy to use.", - "type": "string", - "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." - ], - "enumDeprecated": [ - false, - true, - true, - false, - false, - false - ], - "enum": [ - "STRATEGY_UNSPECIFIED", - "ON_DEMAND", - "LOW_COST", - "STANDARD", - "SPOT", - "FLEX_START" - ] + "migrateDataLabelingDatasetConfig": { + "$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig", + "deprecated": true, + "description": "Deprecated: Data labeling service is shut down. Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI's Dataset." }, - "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" + "migrateMlEngineModelVersionConfig": { + "$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig", + "description": "Config for migrating Version in ml.googleapis.com to Vertex AI's Model." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig": { + "description": "Config for migrating Dataset in automl.googleapis.com to Vertex AI's Dataset.", + "id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig", + "properties": { + "dataset": { + "description": "Required. Full resource name of automl Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", + "type": "string" }, - "maxWaitDuration": { - "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.", - "type": "string", - "format": "google-duration" + "datasetDisplayName": { + "description": "Required. Display name of the Dataset in Vertex AI. System will pick a display name if unspecified.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PscInterfaceConfig": { - "id": "GoogleCloudAiplatformV1PscInterfaceConfig", - "description": "Configuration for PSC-I.", - "type": "object", + "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig": { + "description": "Config for migrating Model in automl.googleapis.com to Vertex AI's Model.", + "id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig", "properties": { - "networkAttachment": { - "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.", + "model": { + "description": "Required. Full resource name of automl Model. Format: `projects/{project}/locations/{location}/models/{model}`.", "type": "string" }, - "dnsPeeringConfigs": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DnsPeeringConfig" - } + "modelDisplayName": { + "description": "Optional. Display name of the model in Vertex AI. System will pick a display name if unspecified.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DnsPeeringConfig": { - "id": "GoogleCloudAiplatformV1DnsPeeringConfig", - "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.", - "type": "object", + "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig": { + "description": "Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI's Dataset.", + "id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig", "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.", + "dataset": { + "description": "Required. Full resource name of data labeling Dataset. Format: `projects/{project}/datasets/{dataset}`.", "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.", + "datasetDisplayName": { + "description": "Optional. Display name of the Dataset in Vertex AI. System will pick a display name if unspecified.", "type": "string" }, - "targetNetwork": { - "description": "Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.", - "type": "string" + "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": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListCustomJobsResponse": { - "id": "GoogleCloudAiplatformV1ListCustomJobsResponse", - "description": "Response message for JobService.ListCustomJobs", - "type": "object", + "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig": { + "description": "Config for migrating AnnotatedDataset in datalabeling.googleapis.com to Vertex AI's SavedQuery.", + "id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig", "properties": { - "customJobs": { - "description": "List of CustomJobs in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1CustomJob" - } - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListCustomJobsRequest.page_token to obtain that page.", + "annotatedDataset": { + "description": "Required. Full resource name of data labeling AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.", "type": "string" } - } - }, - "GoogleCloudAiplatformV1CancelCustomJobRequest": { - "id": "GoogleCloudAiplatformV1CancelCustomJobRequest", - "description": "Request message for JobService.CancelCustomJob.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1DataLabelingJob": { - "id": "GoogleCloudAiplatformV1DataLabelingJob", - "description": "DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset:", - "type": "object", + "GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig": { + "description": "Config for migrating version in ml.googleapis.com to Vertex AI's Model.", + "id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig", "properties": { - "name": { - "description": "Output only. Resource name of the DataLabelingJob.", - "readOnly": true, + "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" }, - "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.", + "modelDisplayName": { + "description": "Required. Display name of the model in Vertex AI. System will pick a display name if unspecified.", "type": "string" }, - "datasets": { - "description": "Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "type": "array", - "items": { - "type": "string" - } - }, - "annotationLabels": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "labelerCount": { - "description": "Required. Number of labelers to work on each DataItem.", - "type": "integer", - "format": "int32" - }, - "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.", + "modelVersion": { + "description": "Required. Full resource name of ml engine model version. Format: `projects/{project}/models/{model}/versions/{version}`.", "type": "string" - }, - "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": "object" + }, + "GoogleCloudAiplatformV1MigrateResourceResponse": { + "description": "Describes a successfully migrated resource.", + "id": "GoogleCloudAiplatformV1MigrateResourceResponse", + "properties": { + "dataset": { + "description": "Migrated Dataset's resource name.", "type": "string" }, - "inputs": { - "description": "Required. Input config parameters for the DataLabelingJob.", - "type": "any" + "migratableResource": { + "$ref": "GoogleCloudAiplatformV1MigratableResource", + "description": "Before migration, the identifier in ml.googleapis.com, automl.googleapis.com or datalabeling.googleapis.com." }, - "state": { - "description": "Output only. The detailed state of the job.", - "readOnly": true, - "type": "string", + "model": { + "description": "Migrated Model's resource name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModalityTokenCount": { + "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.", + "id": "GoogleCloudAiplatformV1ModalityTokenCount", + "properties": { + "modality": { + "description": "The modality that this token count applies to.", + "enum": [ + "MODALITY_UNSPECIFIED", + "TEXT", + "IMAGE", + "VIDEO", + "AUDIO", + "DOCUMENT" + ], "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." + "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." ], - "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" }, - "labelingProgress": { - "description": "Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished.", - "readOnly": true, - "type": "integer", - "format": "int32" + "tokenCount": { + "description": "The number of tokens counted for this modality.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Model": { + "description": "A trained machine learning Model.", + "id": "GoogleCloudAiplatformV1Model", + "properties": { + "artifactUri": { + "description": "Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.", + "type": "string" }, - "currentSpend": { - "description": "Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.", - "readOnly": true, - "$ref": "GoogleTypeMoney" + "baseModelSource": { + "$ref": "GoogleCloudAiplatformV1ModelBaseModelSource", + "description": "Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models." }, - "createTime": { - "description": "Output only. Timestamp when this DataLabelingJob was created.", + "checkpoints": { + "description": "Optional. Output only. The checkpoints of the model.", + "items": { + "$ref": "GoogleCloudAiplatformV1Checkpoint" + }, "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "array" }, - "updateTime": { - "description": "Output only. Timestamp when this DataLabelingJob was updated most recently.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "containerSpec": { + "$ref": "GoogleCloudAiplatformV1ModelContainerSpec", + "description": "Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." }, - "error": { - "description": "Output only. DataLabelingJob errors. It is only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", + "createTime": { + "description": "Output only. Timestamp when this Model was uploaded into Vertex AI.", + "format": "google-datetime", "readOnly": true, - "$ref": "GoogleRpcStatus" + "type": "string" }, - "labels": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "dataStats": { + "$ref": "GoogleCloudAiplatformV1ModelDataStats", + "description": "Stats of data used for training or evaluating the Model. Only populated when the Model is trained by a TrainingPipeline with data_input_config." }, - "specialistPools": { - "description": "The SpecialistPools' resource names associated with this job.", - "type": "array", - "items": { - "type": "string" - } + "defaultCheckpointId": { + "description": "The default checkpoint id of a model version.", + "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": "GoogleCloudAiplatformV1EncryptionSpec" + "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": "GoogleCloudAiplatformV1DeployedModelRef" + }, + "readOnly": true, + "type": "array" }, - "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": "GoogleCloudAiplatformV1ActiveLearningConfig" - } - } - }, - "GoogleTypeMoney": { - "id": "GoogleTypeMoney", - "description": "Represents an amount of money with its currency type.", - "type": "object", - "properties": { - "currencyCode": { - "description": "The three-letter currency code defined in ISO 4217.", + "description": { + "description": "The description of the Model.", "type": "string" }, - "units": { - "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", - "type": "string", - "format": "int64" - }, - "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.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1ActiveLearningConfig": { - "id": "GoogleCloudAiplatformV1ActiveLearningConfig", - "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.", - "type": "object", - "properties": { - "maxDataItemCount": { - "description": "Max number of human labeled DataItems.", - "type": "string", - "format": "int64" + "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" }, - "maxDataItemPercentage": { - "description": "Max percent of total DataItems for human labeling.", - "type": "integer", - "format": "int32" + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "sampleConfig": { - "description": "Active learning data sampling config. For every active learning labeling iteration, it will select a batch of data based on the sampling strategy.", - "$ref": "GoogleCloudAiplatformV1SampleConfig" + "etag": { + "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" }, - "trainingConfig": { - "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.", - "$ref": "GoogleCloudAiplatformV1TrainingConfig" - } - } - }, - "GoogleCloudAiplatformV1SampleConfig": { - "id": "GoogleCloudAiplatformV1SampleConfig", - "description": "Active learning data sampling config. For every active learning labeling iteration, it will select a batch of data based on the sampling strategy.", - "type": "object", - "properties": { - "initialBatchSamplePercentage": { - "description": "The percentage of data needed to be labeled in the first batch.", - "type": "integer", - "format": "int32" + "explanationSpec": { + "$ref": "GoogleCloudAiplatformV1ExplanationSpec", + "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." }, - "followingBatchSamplePercentage": { - "description": "The percentage of data needed to be labeled in each following batch (except the first batch).", - "type": "integer", - "format": "int32" + "labels": { + "additionalProperties": { + "type": "string" + }, + "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" }, - "sampleStrategy": { - "description": "Field to choose sampling strategy. Sampling strategy will decide which data should be selected for human labeling in every batch.", - "type": "string", - "enumDescriptions": [ - "Default will be treated as UNCERTAINTY.", - "Sample the most uncertain data to label." - ], - "enum": [ - "SAMPLE_STRATEGY_UNSPECIFIED", - "UNCERTAINTY" - ] - } - } - }, - "GoogleCloudAiplatformV1TrainingConfig": { - "id": "GoogleCloudAiplatformV1TrainingConfig", - "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.", - "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.", - "type": "string", - "format": "int64" - } - } - }, - "GoogleCloudAiplatformV1ListDataLabelingJobsResponse": { - "id": "GoogleCloudAiplatformV1ListDataLabelingJobsResponse", - "description": "Response message for JobService.ListDataLabelingJobs.", - "type": "object", - "properties": { - "dataLabelingJobs": { - "description": "A list of DataLabelingJobs that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DataLabelingJob" - } + "metadata": { + "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.", + "type": "any" }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1CancelDataLabelingJobRequest": { - "id": "GoogleCloudAiplatformV1CancelDataLabelingJobRequest", - "description": "Request message for JobService.CancelDataLabelingJob.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1HyperparameterTuningJob": { - "id": "GoogleCloudAiplatformV1HyperparameterTuningJob", - "description": "Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.", - "type": "object", - "properties": { - "name": { - "description": "Output only. Resource name of the HyperparameterTuningJob.", + "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}`.", "readOnly": true, "type": "string" }, - "displayName": { - "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.", + "metadataSchemaUri": { + "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.", "type": "string" }, - "studySpec": { - "description": "Required. Study configuration of the HyperparameterTuningJob.", - "$ref": "GoogleCloudAiplatformV1StudySpec" + "modelSourceInfo": { + "$ref": "GoogleCloudAiplatformV1ModelSourceInfo", + "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.", + "readOnly": true }, - "maxTrialCount": { - "description": "Required. The desired total number of Trials.", - "type": "integer", - "format": "int32" + "name": { + "description": "Identifier. The resource name of the Model.", + "type": "string" }, - "parallelTrialCount": { - "description": "Required. The desired number of Trials to run in parallel.", - "type": "integer", - "format": "int32" + "originalModelInfo": { + "$ref": "GoogleCloudAiplatformV1ModelOriginalModelInfo", + "description": "Output only. If this Model is a copy of another Model, this contains info about the original.", + "readOnly": true }, - "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.", - "type": "integer", - "format": "int32" + "pipelineJob": { + "description": "Optional. This field is populated if the model is produced by a pipeline job.", + "type": "string" }, - "trialJobSpec": { - "description": "Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.", - "$ref": "GoogleCloudAiplatformV1CustomJobSpec" + "predictSchemata": { + "$ref": "GoogleCloudAiplatformV1PredictSchemata", + "description": "The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain." }, - "trials": { - "description": "Output only. Trials of the HyperparameterTuningJob.", + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Trial" - } + "type": "boolean" }, - "state": { - "description": "Output only. The detailed state of the job.", + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", "readOnly": true, - "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." - ], - "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": "boolean" }, - "createTime": { - "description": "Output only. Time when the HyperparameterTuningJob was created.", + "supportedDeploymentResourcesTypes": { + "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.", + "items": { + "enum": [ + "DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED", + "DEDICATED_RESOURCES", + "AUTOMATIC_RESOURCES", + "SHARED_RESOURCES" + ], + "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." + ], + "type": "string" + }, "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "array" }, - "startTime": { - "description": "Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.", + "supportedExportFormats": { + "description": "Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModelExportFormat" + }, "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "array" }, - "endTime": { - "description": "Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.", + "supportedInputStorageFormats": { + "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.", + "items": { + "type": "string" + }, "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "array" }, - "updateTime": { - "description": "Output only. Time when the HyperparameterTuningJob was most recently updated.", + "supportedOutputStorageFormats": { + "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.", + "items": { + "type": "string" + }, "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "array" }, - "error": { - "description": "Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.", + "trainingPipeline": { + "description": "Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.", "readOnly": true, - "$ref": "GoogleRpcStatus" + "type": "string" }, - "labels": { - "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", - "additionalProperties": { + "updateTime": { + "description": "Output only. Timestamp when this Model was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "versionAliases": { + "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.", + "items": { "type": "string" - } + }, + "type": "array" }, - "encryptionSpec": { - "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.", - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" + "versionCreateTime": { + "description": "Output only. Timestamp when this version was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", + "versionDescription": { + "description": "The description of this version.", + "type": "string" + }, + "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": "boolean" + "type": "string" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", + "versionUpdateTime": { + "description": "Output only. Timestamp when this version was most recently updated.", + "format": "google-datetime", "readOnly": true, - "type": "boolean" + "type": "string" } - } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelArmorConfig": { + "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": "GoogleCloudAiplatformV1ModelArmorConfig", + "properties": { + "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" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelBaseModelSource": { + "description": "User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.", + "id": "GoogleCloudAiplatformV1ModelBaseModelSource", + "properties": { + "genieSource": { + "$ref": "GoogleCloudAiplatformV1GenieSource", + "description": "Information about the base model of Genie models." + }, + "modelGardenSource": { + "$ref": "GoogleCloudAiplatformV1ModelGardenSource", + "description": "Source information of Model Garden models." + } + }, + "type": "object" }, - "GoogleCloudAiplatformV1StudySpec": { - "id": "GoogleCloudAiplatformV1StudySpec", - "description": "Represents specification of a Study.", - "type": "object", + "GoogleCloudAiplatformV1ModelContainerSpec": { + "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).", + "id": "GoogleCloudAiplatformV1ModelContainerSpec", "properties": { - "decayCurveStoppingSpec": { - "description": "The automated early stopping spec using decay curve rule.", - "$ref": "GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec" + "args": { + "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" + }, + "type": "array" }, - "medianAutomatedStoppingSpec": { - "description": "The automated early stopping spec using median rule.", - "$ref": "GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec" + "command": { + "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" + }, + "type": "array" }, - "convexAutomatedStoppingSpec": { - "description": "The automated early stopping spec using convex stopping rule.", - "$ref": "GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec" + "deploymentTimeout": { + "description": "Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.", + "format": "google-duration", + "type": "string" }, - "metrics": { - "description": "Required. Metric specs for the Study.", - "type": "array", + "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).", "items": { - "$ref": "GoogleCloudAiplatformV1StudySpecMetricSpec" - } + "$ref": "GoogleCloudAiplatformV1EnvVar" + }, + "type": "array" }, - "parameters": { - "description": "Required. The set of parameters to tune.", - "type": "array", + "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": "GoogleCloudAiplatformV1StudySpecParameterSpec" - } + "$ref": "GoogleCloudAiplatformV1Port" + }, + "type": "array" }, - "algorithm": { - "description": "The search algorithm specified for the Study.", - "type": "string", - "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" - ] + "healthProbe": { + "$ref": "GoogleCloudAiplatformV1Probe", + "description": "Immutable. Specification for Kubernetes readiness probe." }, - "observationNoise": { - "description": "The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.", - "type": "string", - "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." - ], - "enum": [ - "OBSERVATION_NOISE_UNSPECIFIED", - "LOW", - "HIGH" - ] + "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" }, - "measurementSelectionType": { - "description": "Describe which measurement selection type will be used", - "type": "string", - "enumDescriptions": [ - "Will be treated as LAST_MEASUREMENT.", - "Use the last measurement reported.", - "Use the best measurement reported." - ], - "enum": [ - "MEASUREMENT_SELECTION_TYPE_UNSPECIFIED", - "LAST_MEASUREMENT", - "BEST_MEASUREMENT" - ] + "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" }, - "studyStoppingConfig": { - "description": "Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition.", - "$ref": "GoogleCloudAiplatformV1StudySpecStudyStoppingConfig" - } - } - }, - "GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec": { - "id": "GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec", - "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.", - "type": "object", - "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" - } - } - }, - "GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec": { - "id": "GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec", - "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.", - "type": "object", - "properties": { - "useElapsedDuration": { - "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.", - "type": "boolean" + "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" + }, + "livenessProbe": { + "$ref": "GoogleCloudAiplatformV1Probe", + "description": "Immutable. Specification for Kubernetes liveness 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).", + "items": { + "$ref": "GoogleCloudAiplatformV1Port" + }, + "type": "array" + }, + "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" + }, + "sharedMemorySizeMb": { + "description": "Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.", + "format": "int64", + "type": "string" + }, + "startupProbe": { + "$ref": "GoogleCloudAiplatformV1Probe", + "description": "Immutable. Specification for Kubernetes startup probe." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec": { - "id": "GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ModelDataStats": { + "description": "Stats of data used for train or evaluate the Model.", + "id": "GoogleCloudAiplatformV1ModelDataStats", "properties": { - "maxStepCount": { - "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.", - "type": "string", - "format": "int64" + "testAnnotationsCount": { + "description": "Number of Annotations that are used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test Annotations used by the first evaluation. If the Model is not evaluated, the number is 0.", + "format": "int64", + "type": "string" }, - "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.", - "type": "string", - "format": "int64" + "testDataItemsCount": { + "description": "Number of DataItems that were used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test DataItems used by the first evaluation. If the Model is not evaluated, the number is 0.", + "format": "int64", + "type": "string" }, - "minMeasurementCount": { - "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.", - "type": "string", - "format": "int64" + "trainingAnnotationsCount": { + "description": "Number of Annotations that are used for training this Model.", + "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.", + "trainingDataItemsCount": { + "description": "Number of DataItems that were used for training this Model.", + "format": "int64", "type": "string" }, - "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" + "validationAnnotationsCount": { + "description": "Number of Annotations that are used for validating this Model during training.", + "format": "int64", + "type": "string" }, - "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" + "validationDataItemsCount": { + "description": "Number of DataItems that were used for validating this Model during training.", + "format": "int64", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1StudySpecMetricSpec": { - "id": "GoogleCloudAiplatformV1StudySpecMetricSpec", - "description": "Represents a metric to optimize.", - "type": "object", + "GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable": { + "description": "ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name as well as some information of the logs stored in this table.", + "id": "GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable", "properties": { - "metricId": { - "description": "Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.", + "bigqueryTablePath": { + "description": "The created BigQuery table to store logs. Customer could do their own query & analysis. Format: `bq://.model_deployment_monitoring_._`", "type": "string" }, - "goal": { - "description": "Required. The optimization goal of the metric.", - "type": "string", + "logSource": { + "description": "The source of log.", + "enum": [ + "LOG_SOURCE_UNSPECIFIED", + "TRAINING", + "SERVING" + ], "enumDescriptions": [ - "Goal Type will default to maximize.", - "Maximize the goal metric.", - "Minimize the goal metric." + "Unspecified source.", + "Logs coming from Training dataset.", + "Logs coming from Serving traffic." ], + "type": "string" + }, + "logType": { + "description": "The type of log.", "enum": [ - "GOAL_TYPE_UNSPECIFIED", - "MAXIMIZE", - "MINIMIZE" - ] + "LOG_TYPE_UNSPECIFIED", + "PREDICT", + "EXPLAIN" + ], + "enumDescriptions": [ + "Unspecified type.", + "Predict logs.", + "Explain logs." + ], + "type": "string" }, - "safetyConfig": { - "description": "Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.", - "$ref": "GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig" + "requestResponseLoggingSchemaVersion": { + "description": "Output only. The schema version of the request/response logging BigQuery table. Default to v1 if unset.", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig": { - "id": "GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig", - "description": "Used in safe optimization to specify threshold levels and risk tolerance.", - "type": "object", + "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob": { + "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.", + "id": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob", "properties": { - "safetyThreshold": { - "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", - "format": "double" + "analysisInstanceSchemaUri": { + "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.", + "type": "string" }, - "desiredMinSafeTrialsFraction": { - "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.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudAiplatformV1StudySpecParameterSpec": { - "id": "GoogleCloudAiplatformV1StudySpecParameterSpec", - "description": "Represents a single parameter to optimize.", - "type": "object", - "properties": { - "doubleValueSpec": { - "description": "The value spec for a 'DOUBLE' parameter.", - "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec" + "bigqueryTables": { + "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", + "items": { + "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable" + }, + "readOnly": true, + "type": "array" }, - "integerValueSpec": { - "description": "The value spec for an 'INTEGER' parameter.", - "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec" + "createTime": { + "description": "Output only. Timestamp when this ModelDeploymentMonitoringJob was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "categoricalValueSpec": { - "description": "The value spec for a 'CATEGORICAL' parameter.", - "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec" + "displayName": { + "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.", + "type": "string" }, - "discreteValueSpec": { - "description": "The value spec for a 'DISCRETE' parameter.", - "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec" + "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" }, - "parameterId": { - "description": "Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.", + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." + }, + "endpoint": { + "description": "Required. Endpoint resource name. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" }, - "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" - ] + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when the job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", + "readOnly": true }, - "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": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec" - } - } - } - }, - "GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec": { - "id": "GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec", - "description": "Value specification for a parameter in `DOUBLE` type.", - "type": "object", - "properties": { - "minValue": { - "description": "Required. Inclusive minimum value of the parameter.", - "type": "number", - "format": "double" + "labels": { + "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.", + "type": "object" }, - "maxValue": { - "description": "Required. Inclusive maximum value of the parameter.", - "type": "number", - "format": "double" + "latestMonitoringPipelineMetadata": { + "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata", + "description": "Output only. Latest triggered monitoring pipeline metadata.", + "readOnly": true }, - "defaultValue": { - "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": "number", - "format": "double" - } - } - }, - "GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec": { - "id": "GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec", - "description": "Value specification for a parameter in `INTEGER` type.", - "type": "object", - "properties": { - "minValue": { - "description": "Required. Inclusive minimum value of the parameter.", - "type": "string", - "format": "int64" + "logTtl": { + "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.", + "format": "google-duration", + "type": "string" }, - "maxValue": { - "description": "Required. Inclusive maximum value of the parameter.", - "type": "string", - "format": "int64" + "loggingSamplingStrategy": { + "$ref": "GoogleCloudAiplatformV1SamplingStrategy", + "description": "Required. Sample Strategy for logging." }, - "defaultValue": { - "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", - "format": "int64" - } - } - }, - "GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec": { - "id": "GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec", - "description": "Value specification for a parameter in `CATEGORICAL` type.", - "type": "object", - "properties": { - "values": { - "description": "Required. The list of possible categories.", - "type": "array", + "modelDeploymentMonitoringObjectiveConfigs": { + "description": "Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig" + }, + "type": "array" }, - "defaultValue": { - "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.", + "modelDeploymentMonitoringScheduleConfig": { + "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig", + "description": "Required. Schedule config for running the monitoring job." + }, + "modelMonitoringAlertConfig": { + "$ref": "GoogleCloudAiplatformV1ModelMonitoringAlertConfig", + "description": "Alert config for model monitoring." + }, + "name": { + "description": "Output only. Resource name of a ModelDeploymentMonitoringJob.", + "readOnly": true, "type": "string" - } - } - }, - "GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec": { - "id": "GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec", - "description": "Value specification for a parameter in `DISCRETE` type.", - "type": "object", - "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": { - "type": "number", - "format": "double" - } }, - "defaultValue": { - "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": "number", - "format": "double" - } - } - }, - "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec": { - "id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec", - "description": "Represents a parameter spec with condition from its parent parameter.", - "type": "object", - "properties": { - "parentDiscreteValues": { - "description": "The spec for matching values from a parent parameter of `DISCRETE` type.", - "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition" + "nextScheduleTime": { + "description": "Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "parentIntValues": { - "description": "The spec for matching values from a parent parameter of `INTEGER` type.", - "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition" + "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" }, - "parentCategoricalValues": { - "description": "The spec for matching values from a parent parameter of `CATEGORICAL` type.", - "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition" + "samplePredictInstance": { + "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.", + "type": "any" }, - "parameterSpec": { - "description": "Required. The spec for a conditional parameter.", - "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpec" - } - } - }, - "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition": { - "id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition", - "description": "Represents the spec to match discrete values from parent parameter.", - "type": "object", - "properties": { - "values": { - "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.", - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } - } - }, - "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition": { - "id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition", - "description": "Represents the spec to match integer values from parent parameter.", - "type": "object", - "properties": { - "values": { - "description": "Required. Matches values of the parent parameter of 'INTEGER' type. All values must lie in `integer_value_spec` of parent parameter.", - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - } - } - }, - "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition": { - "id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition", - "description": "Represents the spec to match categorical values from parent parameter.", - "type": "object", - "properties": { - "values": { - "description": "Required. Matches values of the parent parameter of 'CATEGORICAL' type. All values must exist in `categorical_value_spec` of parent parameter.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1StudySpecStudyStoppingConfig": { - "id": "GoogleCloudAiplatformV1StudySpecStudyStoppingConfig", - "description": "The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection.", - "type": "object", - "properties": { - "shouldStopAsap": { - "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).", + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, "type": "boolean" }, - "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": "GoogleCloudAiplatformV1StudyTimeConstraint" + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" }, - "maximumRuntimeConstraint": { - "description": "If the specified time or duration has passed, stop the study.", - "$ref": "GoogleCloudAiplatformV1StudyTimeConstraint" + "scheduleState": { + "description": "Output only. Schedule state when the monitoring job is in Running state.", + "enum": [ + "MONITORING_SCHEDULE_STATE_UNSPECIFIED", + "PENDING", + "OFFLINE", + "RUNNING" + ], + "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." + ], + "readOnly": true, + "type": "string" }, - "minNumTrials": { - "description": "If there are fewer than this many COMPLETED trials, do not stop the study.", - "type": "integer", - "format": "int32" + "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" + ], + "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, + "type": "string" }, - "maxNumTrials": { - "description": "If there are more than this many trials, stop the study.", - "type": "integer", - "format": "int32" + "statsAnomaliesBaseDirectory": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "Stats anomalies base folder path." }, - "maxNumTrialsNoProgress": { - "description": "If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies.", - "type": "integer", - "format": "int32" + "updateTime": { + "description": "Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata": { + "description": "All metadata of most recent monitoring pipelines.", + "id": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata", + "properties": { + "runTime": { + "description": "The time that most recent monitoring pipelines that is related to this run.", + "format": "google-datetime", + "type": "string" }, - "maxDurationNoProgress": { - "description": "If the objective value has not improved for this much time, stop the study. WARNING: Effective only for single-objective studies.", - "type": "string", - "format": "google-duration" + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of the most recent monitoring pipeline." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig": { + "description": "ModelDeploymentMonitoringObjectiveConfig contains the pair of deployed_model_id to ModelMonitoringObjectiveConfig.", + "id": "GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig", + "properties": { + "deployedModelId": { + "description": "The DeployedModel ID of the objective config.", + "type": "string" + }, + "objectiveConfig": { + "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig", + "description": "The objective config of for the modelmonitoring job of this deployed model." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1StudyTimeConstraint": { - "id": "GoogleCloudAiplatformV1StudyTimeConstraint", - "description": "Time-based Constraint for Study", - "type": "object", + "GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig": { + "description": "The config for scheduling monitoring job.", + "id": "GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig", "properties": { - "maxDuration": { - "description": "Counts the wallclock time passed since the creation of this Study.", - "type": "string", - "format": "google-duration" + "monitorInterval": { + "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.", + "format": "google-duration", + "type": "string" }, - "endTime": { - "description": "Compares the wallclock time to this time. Must use UTC timezone.", - "type": "string", - "format": "google-datetime" + "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" }, - "GoogleCloudAiplatformV1Trial": { - "id": "GoogleCloudAiplatformV1Trial", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ModelEvaluation": { + "description": "A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.", + "id": "GoogleCloudAiplatformV1ModelEvaluation", "properties": { - "name": { - "description": "Output only. Resource name of the Trial assigned by the service.", - "readOnly": true, + "annotationSchemaUri": { + "description": "Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.predictions, EvaluatedDataItemView.ground_truths, EvaluatedAnnotation.predictions, and EvaluatedAnnotation.ground_truths. 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). This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.", "type": "string" }, - "id": { - "description": "Output only. The identifier of the Trial assigned by the service.", + "createTime": { + "description": "Output only. Timestamp when this ModelEvaluation was created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "state": { - "description": "Output only. The detailed state of the Trial.", - "readOnly": true, - "type": "string", - "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." - ], - "enum": [ - "STATE_UNSPECIFIED", - "REQUESTED", - "ACTIVE", - "STOPPING", - "SUCCEEDED", - "INFEASIBLE" - ] + "dataItemSchemaUri": { + "description": "Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.data_item_payload and EvaluatedAnnotation.data_item_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). This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.", + "type": "string" }, - "parameters": { - "description": "Output only. The parameters of the Trial.", - "readOnly": true, - "type": "array", + "displayName": { + "description": "The display name of the ModelEvaluation.", + "type": "string" + }, + "explanationSpecs": { + "description": "Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.", "items": { - "$ref": "GoogleCloudAiplatformV1TrialParameter" - } + "$ref": "GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec" + }, + "type": "array" }, - "finalMeasurement": { - "description": "Output only. The final measurement containing the objective value.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1Measurement" + "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" }, - "measurements": { - "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.", + "metrics": { + "description": "Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri", + "type": "any" + }, + "metricsSchemaUri": { + "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).", + "type": "string" + }, + "modelExplanation": { + "$ref": "GoogleCloudAiplatformV1ModelExplanation", + "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. " + }, + "name": { + "description": "Output only. The resource name of the ModelEvaluation.", "readOnly": true, - "type": "array", + "type": "string" + }, + "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 = `.", "items": { - "$ref": "GoogleCloudAiplatformV1Measurement" - } + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec": { + "id": "GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec", + "properties": { + "explanationSpec": { + "$ref": "GoogleCloudAiplatformV1ExplanationSpec", + "description": "Explanation spec details." }, - "startTime": { - "description": "Output only. Time when the Trial was started.", + "explanationType": { + "description": "Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelEvaluationSlice": { + "description": "A collection of metrics calculated by comparing Model's predictions on a slice of the test data against ground truth annotations.", + "id": "GoogleCloudAiplatformV1ModelEvaluationSlice", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this ModelEvaluationSlice was created.", + "format": "google-datetime", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "string" }, - "endTime": { - "description": "Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`.", + "metrics": { + "description": "Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "any" }, - "clientId": { - "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.", + "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).", "readOnly": true, "type": "string" }, - "infeasibleReason": { - "description": "Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is `INFEASIBLE`.", - "readOnly": true, - "type": "string" + "modelExplanation": { + "$ref": "GoogleCloudAiplatformV1ModelExplanation", + "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.", + "readOnly": true }, - "customJob": { - "description": "Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.", + "name": { + "description": "Output only. The resource name of the ModelEvaluationSlice.", "readOnly": true, "type": "string" }, - "webAccessUris": { - "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.", - "readOnly": true, - "type": "object", - "additionalProperties": { - "type": "string" - } + "slice": { + "$ref": "GoogleCloudAiplatformV1ModelEvaluationSliceSlice", + "description": "Output only. The slice of the test data that is used to evaluate the Model.", + "readOnly": true } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrialParameter": { - "id": "GoogleCloudAiplatformV1TrialParameter", - "description": "A message representing a parameter to be tuned.", - "type": "object", + "GoogleCloudAiplatformV1ModelEvaluationSliceSlice": { + "description": "Definition of a slice.", + "id": "GoogleCloudAiplatformV1ModelEvaluationSliceSlice", "properties": { - "parameterId": { - "description": "Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters.", + "dimension": { + "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, "type": "string" }, + "sliceSpec": { + "$ref": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec", + "description": "Output only. Specification for how the data was sliced.", + "readOnly": true + }, "value": { - "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'.", + "description": "Output only. The value of the dimension in this slice.", "readOnly": true, - "type": "any" + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Measurement": { - "id": "GoogleCloudAiplatformV1Measurement", - "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", + "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec": { + "description": "Specification for how the data should be sliced.", + "id": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec", "properties": { - "elapsedDuration": { - "description": "Output only. Time that the Trial has been running at the point of this Measurement.", - "readOnly": true, - "type": "string", - "format": "google-duration" - }, - "stepCount": { - "description": "Output only. The number of steps the machine learning model has been trained for. Must be non-negative.", - "readOnly": true, - "type": "string", - "format": "int64" + "configs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig" + }, + "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.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange": { + "description": "A range of values for slice(s). `low` is inclusive, `high` is exclusive.", + "id": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange", + "properties": { + "high": { + "description": "Exclusive high value for the range.", + "format": "float", + "type": "number" }, - "metrics": { - "description": "Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1MeasurementMetric" - } + "low": { + "description": "Inclusive low value for the range.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MeasurementMetric": { - "id": "GoogleCloudAiplatformV1MeasurementMetric", - "description": "A message representing a metric in the measurement.", - "type": "object", + "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig": { + "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.", + "id": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig", "properties": { - "metricId": { - "description": "Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.", - "readOnly": true, - "type": "string" + "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" + }, + "range": { + "$ref": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange", + "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." }, "value": { - "description": "Output only. The value for this metric.", - "readOnly": true, - "type": "number", - "format": "double" + "$ref": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue", + "description": "A unique specific value for a given feature. Example: `{ \"value\": { \"string_value\": \"12345\" } }`" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse": { - "id": "GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse", - "description": "Response message for JobService.ListHyperparameterTuningJobs", - "type": "object", + "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue": { + "description": "Single value that supports strings and floats.", + "id": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue", "properties": { - "hyperparameterTuningJobs": { - "description": "List of HyperparameterTuningJobs in the requested page. HyperparameterTuningJob.trials of the jobs will be not be returned.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob" - } + "floatValue": { + "description": "Float type.", + "format": "float", + "type": "number" }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListHyperparameterTuningJobsRequest.page_token to obtain that page.", + "stringValue": { + "description": "String type.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest": { - "id": "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest", - "description": "Request message for JobService.CancelHyperparameterTuningJob.", - "type": "object", - "properties": {} + "GoogleCloudAiplatformV1ModelExplanation": { + "description": "Aggregated explanation metrics for a Model over a set of instances.", + "id": "GoogleCloudAiplatformV1ModelExplanation", + "properties": { + "meanAttributions": { + "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": "GoogleCloudAiplatformV1Attribution" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NasJob": { - "id": "GoogleCloudAiplatformV1NasJob", - "description": "Represents a Neural Architecture Search (NAS) job.", - "type": "object", + "GoogleCloudAiplatformV1ModelExportFormat": { + "description": "Represents export format supported by the Model. All formats export to Google Cloud Storage.", + "id": "GoogleCloudAiplatformV1ModelExportFormat", "properties": { - "name": { - "description": "Output only. Resource name of the NasJob.", + "exportableContents": { + "description": "Output only. The content of this Model that may be exported.", + "items": { + "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." + ], + "type": "string" + }, "readOnly": true, - "type": "string" + "type": "array" }, - "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.", + "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.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelGardenSource": { + "description": "Contains information about the source of the models generated from Model Garden.", + "id": "GoogleCloudAiplatformV1ModelGardenSource", + "properties": { + "publicModelName": { + "description": "Required. The model garden source model resource name.", "type": "string" }, - "nasJobSpec": { - "description": "Required. The specification of a NasJob.", - "$ref": "GoogleCloudAiplatformV1NasJobSpec" - }, - "nasJobOutput": { - "description": "Output only. Output of the NasJob.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1NasJobOutput" + "skipHfModelCache": { + "description": "Optional. Whether to avoid pulling the model from the HF cache.", + "type": "boolean" }, - "state": { - "description": "Output only. The detailed state of the job.", - "readOnly": true, - "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." - ], - "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" - ] + "versionId": { + "description": "Optional. The model garden source model version ID.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelMonitoringAlertConfig": { + "description": "The alert config for model monitoring.", + "id": "GoogleCloudAiplatformV1ModelMonitoringAlertConfig", + "properties": { + "emailAlertConfig": { + "$ref": "GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig", + "description": "Email alert config." }, - "createTime": { - "description": "Output only. Time when the NasJob was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "enableLogging": { + "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.", + "type": "boolean" }, - "startTime": { - "description": "Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "notificationChannels": { + "description": "Resource names of the NotificationChannels to send alert. Must be of the format `projects//notificationChannels/`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig": { + "description": "The config for email alert.", + "id": "GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig", + "properties": { + "userEmails": { + "description": "The email addresses to send the alert.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig": { + "description": "The objective configuration for model monitoring, including the information needed to detect anomalies for one particular model.", + "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig", + "properties": { + "explanationConfig": { + "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig", + "description": "The config for integrating with Vertex Explainable AI." }, - "endTime": { - "description": "Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "predictionDriftDetectionConfig": { + "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig", + "description": "The config for drift of prediction data." }, - "updateTime": { - "description": "Output only. Time when the NasJob was most recently updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "trainingDataset": { + "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset", + "description": "Training dataset for models. This field has to be set only if TrainingPredictionSkewDetectionConfig is specified." }, - "error": { - "description": "Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.", - "readOnly": true, - "$ref": "GoogleRpcStatus" + "trainingPredictionSkewDetectionConfig": { + "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig", + "description": "The config for skew between training data and prediction data." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig": { + "description": "The config for integrating with Vertex Explainable AI. Only applicable if the Model has explanation_spec populated.", + "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig", + "properties": { + "enableFeatureAttributes": { + "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.", + "type": "boolean" }, - "labels": { - "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", - "additionalProperties": { - "type": "string" - } + "explanationBaseline": { + "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline", + "description": "Predictions generated by the BatchPredictionJob using baseline dataset." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline": { + "description": "Output from BatchPredictionJob for Model Monitoring baseline dataset, which can be used to generate baseline attribution scores.", + "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline", + "properties": { + "bigquery": { + "$ref": "GoogleCloudAiplatformV1BigQueryDestination", + "description": "BigQuery location for BatchExplain output." }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" + "gcs": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "Cloud Storage location for BatchExplain output." }, - "enableRestrictedImageTraining": { - "description": "Optional. Enable a separation of Custom model training and restricted image training for tenant project.", - "deprecated": true, - "type": "boolean" + "predictionFormat": { + "description": "The storage format of the predictions generated BatchPrediction job.", + "enum": [ + "PREDICTION_FORMAT_UNSPECIFIED", + "JSONL", + "BIGQUERY" + ], + "enumDescriptions": [ + "Should not be set.", + "Predictions are in JSONL files.", + "Predictions are in BigQuery." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig": { + "description": "The config for Prediction data drift detection.", + "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig", + "properties": { + "attributionScoreDriftThresholds": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1ThresholdConfig" + }, + "description": "Key is the feature name and value is the threshold. The threshold here is against attribution score distance between different time windows.", + "type": "object" }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "defaultDriftThreshold": { + "$ref": "GoogleCloudAiplatformV1ThresholdConfig", + "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." }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "driftThresholds": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1ThresholdConfig" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NasJobSpec": { - "id": "GoogleCloudAiplatformV1NasJobSpec", - "description": "Represents the spec of a NasJob.", - "type": "object", + "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset": { + "description": "Training Dataset information.", + "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset", "properties": { - "multiTrialAlgorithmSpec": { - "description": "The spec of multi-trial algorithms.", - "$ref": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec" + "bigquerySource": { + "$ref": "GoogleCloudAiplatformV1BigQuerySource", + "description": "The BigQuery table of the unmanaged Dataset used to train this Model." }, - "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.", + "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" }, - "searchSpaceSpec": { - "description": "It defines the search space for Neural Architecture Search (NAS).", + "dataset": { + "description": "The resource name of the Dataset used to train this Model.", + "type": "string" + }, + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1GcsSource", + "description": "The Google Cloud Storage uri of the unmanaged Dataset used to train this Model." + }, + "loggingSamplingStrategy": { + "$ref": "GoogleCloudAiplatformV1SamplingStrategy", + "description": "Strategy to sample data from Training Dataset. If not set, we process the whole dataset." + }, + "targetField": { + "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.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec": { - "id": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec", - "description": "The spec of multi-trial Neural Architecture Search (NAS).", - "type": "object", + "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig": { + "description": "The config for Training & Prediction data skew detection. It specifies the training dataset sources and the skew detection parameters.", + "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig", "properties": { - "multiTrialAlgorithm": { - "description": "The multi-trial Neural Architecture Search (NAS) algorithm type. Defaults to `REINFORCEMENT_LEARNING`.", - "type": "string", - "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)." - ], - "enum": [ - "MULTI_TRIAL_ALGORITHM_UNSPECIFIED", - "REINFORCEMENT_LEARNING", - "GRID_SEARCH" - ] - }, - "metric": { - "description": "Metric specs for the NAS job. Validation for this field is done at `multi_trial_algorithm_spec` field.", - "$ref": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec" + "attributionScoreSkewThresholds": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1ThresholdConfig" + }, + "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" }, - "searchTrialSpec": { - "description": "Required. Spec for search trials.", - "$ref": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec" + "defaultSkewThreshold": { + "$ref": "GoogleCloudAiplatformV1ThresholdConfig", + "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." }, - "trainTrialSpec": { - "description": "Spec for train trials. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.", - "$ref": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec" + "skewThresholds": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1ThresholdConfig" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec": { - "id": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec", - "description": "Represents a metric to optimize.", - "type": "object", + "GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies": { + "description": "Statistics and anomalies generated by Model Monitoring.", + "id": "GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies", "properties": { - "metricId": { - "description": "Required. The ID of the metric. Must not contain whitespaces.", + "anomalyCount": { + "description": "Number of anomalies within all stats.", + "format": "int32", + "type": "integer" + }, + "deployedModelId": { + "description": "Deployed Model ID.", "type": "string" }, - "goal": { - "description": "Required. The optimization goal of the metric.", - "type": "string", + "featureStats": { + "description": "A list of historical Stats and Anomalies generated for all Features.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies" + }, + "type": "array" + }, + "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" + ], "enumDescriptions": [ - "Goal Type will default to maximize.", - "Maximize the goal metric.", - "Minimize the goal metric." + "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": [ - "GOAL_TYPE_UNSPECIFIED", - "MAXIMIZE", - "MINIMIZE" - ] + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec": { - "id": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec", - "description": "Represent spec for search trials.", - "type": "object", + "GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies": { + "description": "Historical Stats (and Anomalies) for a specific Feature.", + "id": "GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies", "properties": { - "searchTrialJobSpec": { - "description": "Required. The spec of a search trial job. The same spec applies to all search trials.", - "$ref": "GoogleCloudAiplatformV1CustomJobSpec" - }, - "maxTrialCount": { - "description": "Required. The maximum number of Neural Architecture Search (NAS) trials to run.", - "type": "integer", - "format": "int32" - }, - "maxParallelTrialCount": { - "description": "Required. The maximum number of trials to run in parallel.", - "type": "integer", - "format": "int32" + "featureDisplayName": { + "description": "Display Name of the Feature.", + "type": "string" }, - "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.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec": { - "id": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec", - "description": "Represent spec for train trials.", - "type": "object", - "properties": { - "trainTrialJobSpec": { - "description": "Required. The spec of a train trial job. The same spec applies to all train trials.", - "$ref": "GoogleCloudAiplatformV1CustomJobSpec" + "predictionStats": { + "description": "A list of historical stats generated by different time window's Prediction Dataset.", + "items": { + "$ref": "GoogleCloudAiplatformV1FeatureStatsAnomaly" + }, + "type": "array" }, - "maxParallelTrialCount": { - "description": "Required. The maximum number of trials to run in parallel.", - "type": "integer", - "format": "int32" + "threshold": { + "$ref": "GoogleCloudAiplatformV1ThresholdConfig", + "description": "Threshold for anomaly detection." }, - "frequency": { - "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", - "format": "int32" + "trainingStats": { + "$ref": "GoogleCloudAiplatformV1FeatureStatsAnomaly", + "description": "Stats calculated for the Training Dataset." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NasJobOutput": { - "id": "GoogleCloudAiplatformV1NasJobOutput", - "description": "Represents a uCAIP NasJob output.", - "type": "object", + "GoogleCloudAiplatformV1ModelOriginalModelInfo": { + "description": "Contains information about the original Model if this Model is a copy.", + "id": "GoogleCloudAiplatformV1ModelOriginalModelInfo", "properties": { - "multiTrialJobOutput": { - "description": "Output only. The output of this multi-trial Neural Architecture Search (NAS) job.", + "model": { + "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}`", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput" + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput": { - "id": "GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput", - "description": "The output of a multi-trial Neural Architecture Search (NAS) jobs.", - "type": "object", + "GoogleCloudAiplatformV1ModelSourceInfo": { + "description": "Detail description of the source information of the model.", + "id": "GoogleCloudAiplatformV1ModelSourceInfo", "properties": { - "searchTrials": { - "description": "Output only. List of NasTrials that were started as part of search stage.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1NasTrial" - } + "copy": { + "description": "If this Model is copy of another Model. If true then source_type pertains to the original.", + "type": "boolean" }, - "trainTrials": { - "description": "Output only. List of NasTrials that were started as part of train stage.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1NasTrial" - } + "sourceType": { + "description": "Type of the model source.", + "enum": [ + "MODEL_SOURCE_TYPE_UNSPECIFIED", + "AUTOML", + "CUSTOM", + "BQML", + "MODEL_GARDEN", + "GENIE", + "CUSTOM_TEXT_EMBEDDING", + "MARKETPLACE" + ], + "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." + ], + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NasTrial": { - "id": "GoogleCloudAiplatformV1NasTrial", - "description": "Represents a uCAIP NasJob trial.", - "type": "object", + "GoogleCloudAiplatformV1ModelVersionCheckpoint": { + "deprecated": true, + "description": "Describes the machine learning model version checkpoint.", + "id": "GoogleCloudAiplatformV1ModelVersionCheckpoint", "properties": { - "id": { - "description": "Output only. The identifier of the NasTrial assigned by the service.", - "readOnly": true, + "checkpointId": { + "description": "The ID of the checkpoint.", "type": "string" }, - "state": { - "description": "Output only. The detailed state of the NasTrial.", - "readOnly": true, - "type": "string", - "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." - ], - "enum": [ - "STATE_UNSPECIFIED", - "REQUESTED", - "ACTIVE", - "STOPPING", - "SUCCEEDED", - "INFEASIBLE" - ] - }, - "finalMeasurement": { - "description": "Output only. The final measurement containing the objective value.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1Measurement" - }, - "startTime": { - "description": "Output only. Time when the NasTrial was started.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "epoch": { + "description": "The epoch of the checkpoint.", + "format": "int64", + "type": "string" }, - "endTime": { - "description": "Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "step": { + "description": "The step of the checkpoint.", + "format": "int64", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListNasJobsResponse": { - "id": "GoogleCloudAiplatformV1ListNasJobsResponse", - "description": "Response message for JobService.ListNasJobs", - "type": "object", + "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig": { + "description": "Configuration for a multi-speaker text-to-speech request.", + "id": "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig", "properties": { - "nasJobs": { - "description": "List of NasJobs in the requested page. NasJob.nas_job_output of the jobs will not be returned.", - "type": "array", + "speakerVoiceConfigs": { + "description": "Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.", "items": { - "$ref": "GoogleCloudAiplatformV1NasJob" - } - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListNasJobsRequest.page_token to obtain that page.", - "type": "string" + "$ref": "GoogleCloudAiplatformV1SpeakerVoiceConfig" + }, + "type": "array" } - } - }, - "GoogleCloudAiplatformV1CancelNasJobRequest": { - "id": "GoogleCloudAiplatformV1CancelNasJobRequest", - "description": "Request message for JobService.CancelNasJob.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1NasTrialDetail": { - "id": "GoogleCloudAiplatformV1NasTrialDetail", - "description": "Represents a NasTrial details along with its parameters. If there is a corresponding train NasTrial, the train NasTrial is also returned.", - "type": "object", + "GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata": { + "description": "Runtime operation information for IndexEndpointService.MutateDeployedIndex.", + "id": "GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata", "properties": { - "name": { - "description": "Output only. Resource name of the NasTrialDetail.", - "readOnly": true, - "type": "string" - }, - "parameters": { - "description": "The parameters for the NasJob NasTrial.", + "deployedIndexId": { + "description": "The unique index id specified by user", "type": "string" }, - "searchTrial": { - "description": "The requested search NasTrial.", - "$ref": "GoogleCloudAiplatformV1NasTrial" - }, - "trainTrial": { - "description": "The train NasTrial corresponding to search_trial. Only populated if search_trial is used for training.", - "$ref": "GoogleCloudAiplatformV1NasTrial" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListNasTrialDetailsResponse": { - "id": "GoogleCloudAiplatformV1ListNasTrialDetailsResponse", - "description": "Response message for JobService.ListNasTrialDetails", - "type": "object", + "GoogleCloudAiplatformV1MutateDeployedIndexResponse": { + "description": "Response message for IndexEndpointService.MutateDeployedIndex.", + "id": "GoogleCloudAiplatformV1MutateDeployedIndexResponse", "properties": { - "nasTrialDetails": { - "description": "List of top NasTrials in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1NasTrialDetail" - } + "deployedIndex": { + "$ref": "GoogleCloudAiplatformV1DeployedIndex", + "description": "The DeployedIndex that had been updated in the IndexEndpoint." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata": { + "description": "Runtime operation information for EndpointService.MutateDeployedModel.", + "id": "GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1MutateDeployedModelRequest": { + "description": "Request message for EndpointService.MutateDeployedModel.", + "id": "GoogleCloudAiplatformV1MutateDeployedModelRequest", + "properties": { + "deployedModel": { + "$ref": "GoogleCloudAiplatformV1DeployedModel", + "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)" }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListNasTrialDetailsRequest.page_token to obtain that page.", + "updateMask": { + "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", + "format": "google-fieldmask", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchPredictionJob": { - "id": "GoogleCloudAiplatformV1BatchPredictionJob", - "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.", - "type": "object", + "GoogleCloudAiplatformV1MutateDeployedModelResponse": { + "description": "Response message for EndpointService.MutateDeployedModel.", + "id": "GoogleCloudAiplatformV1MutateDeployedModelResponse", "properties": { - "name": { - "description": "Output only. Resource name of the BatchPredictionJob.", + "deployedModel": { + "$ref": "GoogleCloudAiplatformV1DeployedModel", + "description": "The DeployedModel that's being mutated." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NasJob": { + "description": "Represents a Neural Architecture Search (NAS) job.", + "id": "GoogleCloudAiplatformV1NasJob", + "properties": { + "createTime": { + "description": "Output only. Time when the NasJob was created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, "displayName": { - "description": "Required. The user-defined name of this BatchPredictionJob.", + "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" }, - "model": { - "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 and unmanaged_container_model 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}`", - "type": "string" + "enableRestrictedImageTraining": { + "deprecated": true, + "description": "Optional. Enable a separation of Custom model training and restricted image training for tenant project.", + "type": "boolean" }, - "modelVersionId": { - "description": "Output only. The version ID of the Model that produces the predictions via this job.", + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." + }, + "endTime": { + "description": "Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "unmanagedContainerModel": { - "description": "Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.", - "$ref": "GoogleCloudAiplatformV1UnmanagedContainerModel" - }, - "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": "GoogleCloudAiplatformV1BatchPredictionJobInputConfig" - }, - "instanceConfig": { - "description": "Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.", - "$ref": "GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig" - }, - "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" - }, - "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": "GoogleCloudAiplatformV1BatchPredictionJobOutputConfig" + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.", + "readOnly": true }, - "dedicatedResources": { - "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.", - "$ref": "GoogleCloudAiplatformV1BatchDedicatedResources" + "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" }, - "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.", + "name": { + "description": "Output only. Resource name of the NasJob.", + "readOnly": true, "type": "string" }, - "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": "GoogleCloudAiplatformV1ManualBatchTuningParameters" + "nasJobOutput": { + "$ref": "GoogleCloudAiplatformV1NasJobOutput", + "description": "Output only. Output of the NasJob.", + "readOnly": true }, - "generateExplanation": { - "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.", + "nasJobSpec": { + "$ref": "GoogleCloudAiplatformV1NasJobSpec", + "description": "Required. The specification of a NasJob." + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, "type": "boolean" }, - "explanationSpec": { - "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.", - "$ref": "GoogleCloudAiplatformV1ExplanationSpec" + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" }, - "outputInfo": { - "description": "Output only. Information further describing the output of this job.", + "startTime": { + "description": "Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state.", + "format": "google-datetime", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1BatchPredictionJobOutputInfo" + "type": "string" }, "state": { "description": "Output only. The detailed state of the job.", - "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.", @@ -42222,591 +49251,680 @@ "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" - ] - }, - "error": { - "description": "Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.", "readOnly": true, - "$ref": "GoogleRpcStatus" + "type": "string" }, - "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.", + "updateTime": { + "description": "Output only. Time when the NasJob was most recently updated.", + "format": "google-datetime", "readOnly": true, - "type": "array", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NasJobOutput": { + "description": "Represents a uCAIP NasJob output.", + "id": "GoogleCloudAiplatformV1NasJobOutput", + "properties": { + "multiTrialJobOutput": { + "$ref": "GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput", + "description": "Output only. The output of this multi-trial Neural Architecture Search (NAS) job.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput": { + "description": "The output of a multi-trial Neural Architecture Search (NAS) jobs.", + "id": "GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput", + "properties": { + "searchTrials": { + "description": "Output only. List of NasTrials that were started as part of search stage.", "items": { - "$ref": "GoogleRpcStatus" - } - }, - "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.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1ResourcesConsumed" - }, - "completionStats": { - "description": "Output only. Statistics on completed and failed prediction instances.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1CompletionStats" - }, - "createTime": { - "description": "Output only. Time when the BatchPredictionJob was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "startTime": { - "description": "Output only. Time when the BatchPredictionJob for the first time entered the `JOB_STATE_RUNNING` state.", + "$ref": "GoogleCloudAiplatformV1NasTrial" + }, "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "array" }, - "endTime": { - "description": "Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.", + "trainTrials": { + "description": "Output only. List of NasTrials that were started as part of train stage.", + "items": { + "$ref": "GoogleCloudAiplatformV1NasTrial" + }, "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NasJobSpec": { + "description": "Represents the spec of a NasJob.", + "id": "GoogleCloudAiplatformV1NasJobSpec", + "properties": { + "multiTrialAlgorithmSpec": { + "$ref": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec", + "description": "The spec of multi-trial algorithms." }, - "updateTime": { - "description": "Output only. Time when the BatchPredictionJob was most recently updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "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" }, - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "searchSpaceSpec": { + "description": "It defines the search space for Neural Architecture Search (NAS).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec": { + "description": "The spec of multi-trial Neural Architecture Search (NAS).", + "id": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec", + "properties": { + "metric": { + "$ref": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec", + "description": "Metric specs for the NAS job. Validation for this field is done at `multi_trial_algorithm_spec` field." }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" + "multiTrialAlgorithm": { + "description": "The multi-trial Neural Architecture Search (NAS) algorithm type. Defaults to `REINFORCEMENT_LEARNING`.", + "enum": [ + "MULTI_TRIAL_ALGORITHM_UNSPECIFIED", + "REINFORCEMENT_LEARNING", + "GRID_SEARCH" + ], + "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)." + ], + "type": "string" }, - "disableContainerLogging": { - "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.", - "type": "boolean" + "searchTrialSpec": { + "$ref": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec", + "description": "Required. Spec for search trials." }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "trainTrialSpec": { + "$ref": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec", + "description": "Spec for train trials. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec": { + "description": "Represents a metric to optimize.", + "id": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec", + "properties": { + "goal": { + "description": "Required. The optimization goal of the metric.", + "enum": [ + "GOAL_TYPE_UNSPECIFIED", + "MAXIMIZE", + "MINIMIZE" + ], + "enumDescriptions": [ + "Goal Type will default to maximize.", + "Maximize the goal metric.", + "Minimize the goal metric." + ], + "type": "string" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "metricId": { + "description": "Required. The ID of the metric. Must not contain whitespaces.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UnmanagedContainerModel": { - "id": "GoogleCloudAiplatformV1UnmanagedContainerModel", - "description": "Contains model information necessary to perform batch prediction without requiring a full model import.", - "type": "object", + "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec": { + "description": "Represent spec for search trials.", + "id": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec", "properties": { - "artifactUri": { - "description": "The path to the directory containing the Model artifact and any of its supporting files.", - "type": "string" + "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" }, - "predictSchemata": { - "description": "Contains the schemata used in Model's predictions and explanations", - "$ref": "GoogleCloudAiplatformV1PredictSchemata" + "maxParallelTrialCount": { + "description": "Required. The maximum number of trials to run in parallel.", + "format": "int32", + "type": "integer" }, - "containerSpec": { - "description": "Input only. The specification of the container that is to be used when deploying this Model.", - "$ref": "GoogleCloudAiplatformV1ModelContainerSpec" + "maxTrialCount": { + "description": "Required. The maximum number of Neural Architecture Search (NAS) trials to run.", + "format": "int32", + "type": "integer" + }, + "searchTrialJobSpec": { + "$ref": "GoogleCloudAiplatformV1CustomJobSpec", + "description": "Required. The spec of a search trial job. The same spec applies to all search trials." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PredictSchemata": { - "id": "GoogleCloudAiplatformV1PredictSchemata", - "description": "Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob.", - "type": "object", + "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec": { + "description": "Represent spec for train trials.", + "id": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec", "properties": { - "instanceSchemaUri": { - "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.", - "type": "string" + "frequency": { + "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.", + "format": "int32", + "type": "integer" }, - "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" + "maxParallelTrialCount": { + "description": "Required. The maximum number of trials to run in parallel.", + "format": "int32", + "type": "integer" }, - "predictionSchemaUri": { - "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.", - "type": "string" + "trainTrialJobSpec": { + "$ref": "GoogleCloudAiplatformV1CustomJobSpec", + "description": "Required. The spec of a train trial job. The same spec applies to all train trials." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelContainerSpec": { - "id": "GoogleCloudAiplatformV1ModelContainerSpec", - "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).", - "type": "object", + "GoogleCloudAiplatformV1NasTrial": { + "description": "Represents a uCAIP NasJob trial.", + "id": "GoogleCloudAiplatformV1NasTrial", "properties": { - "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.", + "endTime": { + "description": "Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "command": { - "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).", - "type": "array", - "items": { - "type": "string" - } - }, - "args": { - "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).", - "type": "array", - "items": { - "type": "string" - } - }, - "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": "GoogleCloudAiplatformV1EnvVar" - } - }, - "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": "GoogleCloudAiplatformV1Port" - } + "finalMeasurement": { + "$ref": "GoogleCloudAiplatformV1Measurement", + "description": "Output only. The final measurement containing the objective value.", + "readOnly": true }, - "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).)", + "id": { + "description": "Output only. The identifier of the NasTrial assigned by the service.", + "readOnly": true, "type": "string" }, - "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).)", + "startTime": { + "description": "Output only. Time when the NasTrial was started.", + "format": "google-datetime", + "readOnly": true, "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.", + "state": { + "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." + ], + "readOnly": true, "type": "string" - }, - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Port" - } - }, - "deploymentTimeout": { - "description": "Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.", - "type": "string", - "format": "google-duration" - }, - "sharedMemorySizeMb": { - "description": "Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.", - "type": "string", - "format": "int64" - }, - "startupProbe": { - "description": "Immutable. Specification for Kubernetes startup probe.", - "$ref": "GoogleCloudAiplatformV1Probe" - }, - "healthProbe": { - "description": "Immutable. Specification for Kubernetes readiness probe.", - "$ref": "GoogleCloudAiplatformV1Probe" - }, - "livenessProbe": { - "description": "Immutable. Specification for Kubernetes liveness probe.", - "$ref": "GoogleCloudAiplatformV1Probe" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Port": { - "id": "GoogleCloudAiplatformV1Port", - "description": "Represents a network port in a container.", - "type": "object", + "GoogleCloudAiplatformV1NasTrialDetail": { + "description": "Represents a NasTrial details along with its parameters. If there is a corresponding train NasTrial, the train NasTrial is also returned.", + "id": "GoogleCloudAiplatformV1NasTrialDetail", "properties": { - "containerPort": { - "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.", - "type": "integer", - "format": "int32" + "name": { + "description": "Output only. Resource name of the NasTrialDetail.", + "readOnly": true, + "type": "string" + }, + "parameters": { + "description": "The parameters for the NasJob NasTrial.", + "type": "string" + }, + "searchTrial": { + "$ref": "GoogleCloudAiplatformV1NasTrial", + "description": "The requested search NasTrial." + }, + "trainTrial": { + "$ref": "GoogleCloudAiplatformV1NasTrial", + "description": "The train NasTrial corresponding to search_trial. Only populated if search_trial is used for training." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Probe": { - "id": "GoogleCloudAiplatformV1Probe", - "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", + "GoogleCloudAiplatformV1NearestNeighborQuery": { + "description": "A query to find a number of similar entities.", + "id": "GoogleCloudAiplatformV1NearestNeighborQuery", "properties": { - "exec": { - "description": "ExecAction probes the health of a container by executing a command.", - "$ref": "GoogleCloudAiplatformV1ProbeExecAction" - }, - "httpGet": { - "description": "HttpGetAction probes the health of a container by sending an HTTP GET request.", - "$ref": "GoogleCloudAiplatformV1ProbeHttpGetAction" - }, - "grpc": { - "description": "GrpcAction probes the health of a container by sending a gRPC request.", - "$ref": "GoogleCloudAiplatformV1ProbeGrpcAction" + "embedding": { + "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryEmbedding", + "description": "Optional. The embedding vector that be used for similar search." }, - "tcpSocket": { - "description": "TcpSocketAction probes the health of a container by opening a TCP socket connection.", - "$ref": "GoogleCloudAiplatformV1ProbeTcpSocketAction" + "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" }, - "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" + "neighborCount": { + "description": "Optional. The number of similar entities to be retrieved from feature view for each query.", + "format": "int32", + "type": "integer" }, - "timeoutSeconds": { - "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'.", - "type": "integer", - "format": "int32" + "numericFilters": { + "description": "Optional. The list of numeric filters.", + "items": { + "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter" + }, + "type": "array" }, - "failureThreshold": { - "description": "Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.", - "type": "integer", - "format": "int32" + "parameters": { + "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryParameters", + "description": "Optional. Parameters that can be set to tune query on the fly." }, - "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" + "perCrowdingAttributeNeighborCount": { + "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.", + "format": "int32", + "type": "integer" }, - "initialDelaySeconds": { - "description": "Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.", - "type": "integer", - "format": "int32" + "stringFilters": { + "description": "Optional. The list of string filters.", + "items": { + "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryStringFilter" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ProbeExecAction": { - "id": "GoogleCloudAiplatformV1ProbeExecAction", - "description": "ExecAction specifies a command to execute.", - "type": "object", + "GoogleCloudAiplatformV1NearestNeighborQueryEmbedding": { + "description": "The embedding vector.", + "id": "GoogleCloudAiplatformV1NearestNeighborQueryEmbedding", "properties": { - "command": { - "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", + "value": { + "description": "Optional. Individual value in the embedding.", "items": { - "type": "string" - } + "format": "float", + "type": "number" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ProbeHttpGetAction": { - "id": "GoogleCloudAiplatformV1ProbeHttpGetAction", - "description": "HttpGetAction describes an action based on HTTP Get requests.", - "type": "object", + "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter": { + "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": "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter", "properties": { - "path": { - "description": "Path to access on the HTTP server.", + "name": { + "description": "Required. Column name in BigQuery that used as filters.", "type": "string" }, - "port": { - "description": "Number of the port to access on the container. Number must be in the range 1 to 65535.", - "type": "integer", - "format": "int32" - }, - "host": { - "description": "Host name to connect to, defaults to the model serving container's IP. You probably want to set \"Host\" in httpHeaders instead.", + "op": { + "description": "Optional. This MUST be specified for queries and must NOT be specified for database points.", + "enum": [ + "OPERATOR_UNSPECIFIED", + "LESS", + "LESS_EQUAL", + "EQUAL", + "GREATER_EQUAL", + "GREATER", + "NOT_EQUAL" + ], + "enumDescriptions": [ + "Unspecified operator.", + "Entities are eligible if their value is < the query's.", + "Entities are eligible if their value is <= the query's.", + "Entities are eligible if their value is == the query's.", + "Entities are eligible if their value is >= the query's.", + "Entities are eligible if their value is > the query's.", + "Entities are eligible if their value is != the query's." + ], "type": "string" }, - "scheme": { - "description": "Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are \"HTTP\" or \"HTTPS\".", - "type": "string" + "valueDouble": { + "description": "double value type.", + "format": "double", + "type": "number" }, - "httpHeaders": { - "description": "Custom headers to set in the request. HTTP allows repeated headers.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ProbeHttpHeader" - } + "valueFloat": { + "description": "float value type.", + "format": "float", + "type": "number" + }, + "valueInt": { + "description": "int value type.", + "format": "int64", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ProbeHttpHeader": { - "id": "GoogleCloudAiplatformV1ProbeHttpHeader", - "description": "HttpHeader describes a custom header to be used in HTTP probes", - "type": "object", + "GoogleCloudAiplatformV1NearestNeighborQueryParameters": { + "description": "Parameters that can be overrided in each query to tune query latency and recall.", + "id": "GoogleCloudAiplatformV1NearestNeighborQueryParameters", "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" + "approximateNeighborCandidates": { + "description": "Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.", + "format": "int32", + "type": "integer" }, - "value": { - "description": "The header field value", - "type": "string" + "leafNodesSearchFraction": { + "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", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ProbeGrpcAction": { - "id": "GoogleCloudAiplatformV1ProbeGrpcAction", - "description": "GrpcAction checks the health of a container using a gRPC service.", - "type": "object", + "GoogleCloudAiplatformV1NearestNeighborQueryStringFilter": { + "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.", + "id": "GoogleCloudAiplatformV1NearestNeighborQueryStringFilter", "properties": { - "port": { - "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", - "type": "integer", - "format": "int32" + "allowTokens": { + "description": "Optional. The allowed tokens.", + "items": { + "type": "string" + }, + "type": "array" }, - "service": { - "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.", + "denyTokens": { + "description": "Optional. The denied tokens.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Required. Column names in BigQuery that used as filters.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ProbeTcpSocketAction": { - "id": "GoogleCloudAiplatformV1ProbeTcpSocketAction", - "description": "TcpSocketAction probes the health of a container by opening a TCP socket connection.", - "type": "object", + "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata": { + "description": "Runtime operation metadata with regard to Matching Engine Index.", + "id": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata", "properties": { - "port": { - "description": "Number of the port to access on the container. Number must be in the range 1 to 65535.", - "type": "integer", - "format": "int32" + "contentValidationStats": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats" + }, + "type": "array" }, - "host": { - "description": "Optional: Host name to connect to, defaults to the model serving container's IP.", + "dataBytesCount": { + "description": "The ingested data size in bytes.", + "format": "int64", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchPredictionJobInputConfig": { - "id": "GoogleCloudAiplatformV1BatchPredictionJobInputConfig", - "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", + "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats": { + "id": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats", "properties": { - "gcsSource": { - "description": "The Cloud Storage location for the input instances.", - "$ref": "GoogleCloudAiplatformV1GcsSource" + "invalidRecordCount": { + "description": "Number of records in this file we skipped due to validate errors.", + "format": "int64", + "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": "GoogleCloudAiplatformV1BigQuerySource" + "invalidSparseRecordCount": { + "description": "Number of sparse records in this file we skipped due to validate errors.", + "format": "int64", + "type": "string" }, - "instancesFormat": { - "description": "Required. The format in which instances are given, must be one of the Model's supported_input_storage_formats.", + "partialErrors": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError" + }, + "type": "array" + }, + "sourceGcsUri": { + "description": "Cloud Storage URI pointing to the original file in user's bucket.", + "type": "string" + }, + "validRecordCount": { + "description": "Number of records in this file that were successfully processed.", + "format": "int64", + "type": "string" + }, + "validSparseRecordCount": { + "description": "Number of sparse records in this file that were successfully processed.", + "format": "int64", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig": { - "id": "GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig", - "description": "Configuration defining how to transform batch prediction input instances to the instances that the Model accepts.", - "type": "object", + "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError": { + "id": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError", "properties": { - "instanceType": { - "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.", + "embeddingId": { + "description": "Empty if the embedding id is failed to parse.", "type": "string" }, - "keyField": { - "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.", + "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" }, - "includedFields": { - "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.", - "type": "array", - "items": { - "type": "string" - } + "errorType": { + "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" + ], + "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." + ], + "type": "string" }, - "excludedFields": { - "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", + "rawRecord": { + "description": "The original content of this record.", + "type": "string" + }, + "sourceGcsUri": { + "description": "Cloud Storage URI pointing to the original file in user's bucket.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NearestNeighbors": { + "description": "Nearest neighbors for one query.", + "id": "GoogleCloudAiplatformV1NearestNeighbors", + "properties": { + "neighbors": { + "description": "All its neighbors.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1NearestNeighborsNeighbor" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchPredictionJobOutputConfig": { - "id": "GoogleCloudAiplatformV1BatchPredictionJobOutputConfig", - "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", + "GoogleCloudAiplatformV1NearestNeighborsNeighbor": { + "description": "A neighbor of the query vector.", + "id": "GoogleCloudAiplatformV1NearestNeighborsNeighbor", "properties": { - "gcsDestination": { - "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.", - "$ref": "GoogleCloudAiplatformV1GcsDestination" - }, - "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": "GoogleCloudAiplatformV1BigQueryDestination" + "distance": { + "description": "The distance between the neighbor and the query vector.", + "format": "double", + "type": "number" }, - "predictionsFormat": { - "description": "Required. The format in which Vertex AI gives the predictions, must be one of the Model's supported_output_storage_formats.", + "entityId": { + "description": "The id of the similar entity.", "type": "string" + }, + "entityKeyValues": { + "$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponse", + "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." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchDedicatedResources": { - "id": "GoogleCloudAiplatformV1BatchDedicatedResources", - "description": "A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration.", - "type": "object", + "GoogleCloudAiplatformV1Neighbor": { + "description": "Neighbors for example-based explanations.", + "id": "GoogleCloudAiplatformV1Neighbor", "properties": { - "machineSpec": { - "description": "Required. Immutable. The specification of a single machine.", - "$ref": "GoogleCloudAiplatformV1MachineSpec" - }, - "startingReplicaCount": { - "description": "Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count", - "type": "integer", - "format": "int32" + "neighborDistance": { + "description": "Output only. The neighbor distance.", + "format": "double", + "readOnly": true, + "type": "number" }, - "maxReplicaCount": { - "description": "Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.", - "type": "integer", - "format": "int32" + "neighborId": { + "description": "Output only. The neighbor id.", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ManualBatchTuningParameters": { - "id": "GoogleCloudAiplatformV1ManualBatchTuningParameters", - "description": "Manual batch tuning parameters.", - "type": "object", + "GoogleCloudAiplatformV1NetworkSpec": { + "description": "Network spec.", + "id": "GoogleCloudAiplatformV1NetworkSpec", "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" + "enableInternetAccess": { + "description": "Whether to enable public internet access. Default false.", + "type": "boolean" + }, + "network": { + "description": "The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)", + "type": "string" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchPredictionJobOutputInfo": { - "id": "GoogleCloudAiplatformV1BatchPredictionJobOutputInfo", - "description": "Further describes this job's output. Supplements output_config.", - "type": "object", + "GoogleCloudAiplatformV1NfsMount": { + "description": "Represents a mount configuration for Network File System (NFS) to mount.", + "id": "GoogleCloudAiplatformV1NfsMount", "properties": { - "gcsOutputDirectory": { - "description": "Output only. The full path of the Cloud Storage directory created, into which the prediction output is written.", - "readOnly": true, + "mountPoint": { + "description": "Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/", "type": "string" }, - "bigqueryOutputDataset": { - "description": "Output only. The path of the BigQuery dataset created, in `bq://projectId.bqDatasetId` format, into which the prediction output is written.", - "readOnly": true, + "path": { + "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`", "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.", - "readOnly": true, + "server": { + "description": "Required. IP address of the NFS server.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ResourcesConsumed": { - "id": "GoogleCloudAiplatformV1ResourcesConsumed", - "description": "Statistics information about resource consumption.", - "type": "object", + "GoogleCloudAiplatformV1NotebookEucConfig": { + "description": "The euc configuration of NotebookRuntimeTemplate.", + "id": "GoogleCloudAiplatformV1NotebookEucConfig", "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.", + "bypassActasCheck": { + "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.", "readOnly": true, - "type": "number", - "format": "double" + "type": "boolean" + }, + "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" }, - "GoogleCloudAiplatformV1CompletionStats": { - "id": "GoogleCloudAiplatformV1CompletionStats", - "description": "Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch.", - "type": "object", + "GoogleCloudAiplatformV1NotebookExecutionJob": { + "description": "NotebookExecutionJob represents an instance of a notebook execution.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJob", "properties": { - "successfulCount": { - "description": "Output only. The number of entities that had been processed successfully.", + "createTime": { + "description": "Output only. Timestamp when this NotebookExecutionJob was created.", + "format": "google-datetime", "readOnly": true, - "type": "string", - "format": "int64" + "type": "string" }, - "failedCount": { - "description": "Output only. The number of entities for which any error was encountered.", - "readOnly": true, - "type": "string", - "format": "int64" + "customEnvironmentSpec": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec", + "description": "The custom compute configuration for an execution job." }, - "incompleteCount": { - "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).", - "readOnly": true, - "type": "string", - "format": "int64" + "dataformRepositorySource": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", + "description": "The Dataform Repository pointing to a single file notebook repository." }, - "successfulForecastPointCount": { - "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.", - "readOnly": true, - "type": "string", - "format": "int64" - } - } - }, - "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse": { - "id": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse", - "description": "Response message for JobService.ListBatchPredictionJobs", - "type": "object", - "properties": { - "batchPredictionJobs": { - "description": "List of BatchPredictionJobs in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" - } + "directNotebookSource": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", + "description": "The contents of an input notebook file." }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListBatchPredictionJobsRequest.page_token to obtain that page.", + "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" - } - } - }, - "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest": { - "id": "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest", - "description": "Request message for JobService.CancelBatchPredictionJob.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob": { - "id": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob", - "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.", - "type": "object", - "properties": { - "name": { - "description": "Output only. Resource name of a ModelDeploymentMonitoringJob.", - "readOnly": true, + }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "description": "Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec." + }, + "executionTimeout": { + "description": "Max running time of the execution job in seconds (default 86400s / 24 hrs).", + "format": "google-duration", "type": "string" }, - "displayName": { - "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.", + "executionUser": { + "description": "The user email to run the execution as. Only supported by Colab runtimes.", "type": "string" }, - "endpoint": { - "description": "Required. Endpoint resource name. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "gcsNotebookSource": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", + "description": "The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`" + }, + "gcsOutputUri": { + "description": "The Cloud Storage location to upload the result to. Format: `gs://bucket-name`", "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'.", - "readOnly": true, - "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." - ], + "jobState": { + "description": "Output only. The state of the NotebookExecutionJob.", "enum": [ "JOB_STATE_UNSPECIFIED", "JOB_STATE_QUEUED", @@ -42820,16133 +49938,15843 @@ "JOB_STATE_EXPIRED", "JOB_STATE_UPDATING", "JOB_STATE_PARTIALLY_SUCCEEDED" - ] - }, - "scheduleState": { - "description": "Output only. Schedule state when the monitoring job is in Running state.", - "readOnly": true, - "type": "string", + ], "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." + "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": [ - "MONITORING_SCHEDULE_STATE_UNSPECIFIED", - "PENDING", - "OFFLINE", - "RUNNING" - ] - }, - "latestMonitoringPipelineMetadata": { - "description": "Output only. Latest triggered monitoring pipeline metadata.", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata" - }, - "modelDeploymentMonitoringObjectiveConfigs": { - "description": "Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig" - } - }, - "modelDeploymentMonitoringScheduleConfig": { - "description": "Required. Schedule config for running the monitoring job.", - "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig" - }, - "loggingSamplingStrategy": { - "description": "Required. Sample Strategy for logging.", - "$ref": "GoogleCloudAiplatformV1SamplingStrategy" - }, - "modelMonitoringAlertConfig": { - "description": "Alert config for model monitoring.", - "$ref": "GoogleCloudAiplatformV1ModelMonitoringAlertConfig" - }, - "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" }, - "samplePredictInstance": { - "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.", - "type": "any" - }, - "analysisInstanceSchemaUri": { - "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.", + "kernelName": { + "description": "The name of the kernel to use during notebook execution. If unset, the default kernel is used.", "type": "string" }, - "bigqueryTables": { - "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, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable" - } - }, - "logTtl": { - "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", - "format": "google-duration" - }, "labels": { - "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.", - "type": "object", "additionalProperties": { "type": "string" - } - }, - "createTime": { - "description": "Output only. Timestamp when this ModelDeploymentMonitoringJob was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + }, + "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.", + "type": "object" }, - "nextScheduleTime": { - "description": "Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round.", + "name": { + "description": "Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "string" }, - "statsAnomaliesBaseDirectory": { - "description": "Stats anomalies base folder path.", - "$ref": "GoogleCloudAiplatformV1GcsDestination" + "notebookRuntimeTemplateResourceName": { + "description": "The NotebookRuntimeTemplate to source compute configuration from.", + "type": "string" }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" + "scheduleResourceName": { + "description": "The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`", + "type": "string" }, - "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" + "serviceAccount": { + "description": "The service account to run the execution as.", + "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" + "status": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.", + "readOnly": true }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", + "updateTime": { + "description": "Output only. Timestamp when this NotebookExecutionJob was most recently updated.", + "format": "google-datetime", "readOnly": true, - "type": "boolean" + "type": "string" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "workbenchRuntime": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime", + "description": "The Workbench runtime configuration to use for the notebook execution." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata": { - "id": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata", - "description": "All metadata of most recent monitoring pipelines.", - "type": "object", + "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec": { + "description": "Compute configuration to use for an execution job.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec", "properties": { - "runTime": { - "description": "The time that most recent monitoring pipelines that is related to this run.", - "type": "string", - "format": "google-datetime" + "machineSpec": { + "$ref": "GoogleCloudAiplatformV1MachineSpec", + "description": "The specification of a single machine for the execution job." }, - "status": { - "description": "The status of the most recent monitoring pipeline.", - "$ref": "GoogleRpcStatus" + "networkSpec": { + "$ref": "GoogleCloudAiplatformV1NetworkSpec", + "description": "The network configuration to use for the execution job." + }, + "persistentDiskSpec": { + "$ref": "GoogleCloudAiplatformV1PersistentDiskSpec", + "description": "The specification of a persistent disk to attach for the execution job." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig": { - "id": "GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig", - "description": "ModelDeploymentMonitoringObjectiveConfig contains the pair of deployed_model_id to ModelMonitoringObjectiveConfig.", - "type": "object", + "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource": { + "description": "The Dataform Repository containing the input notebook.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", "properties": { - "deployedModelId": { - "description": "The DeployedModel ID of the objective config.", + "commitSha": { + "description": "The commit SHA to read repository with. If unset, the file will be read at HEAD.", "type": "string" }, - "objectiveConfig": { - "description": "The objective config of for the modelmonitoring job of this deployed model.", - "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig" + "dataformRepositoryResourceName": { + "description": "The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig": { - "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig", - "description": "The objective configuration for model monitoring, including the information needed to detect anomalies for one particular model.", - "type": "object", + "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource": { + "description": "The content of the input notebook in ipynb format.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", "properties": { - "trainingDataset": { - "description": "Training dataset for models. This field has to be set only if TrainingPredictionSkewDetectionConfig is specified.", - "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset" - }, - "trainingPredictionSkewDetectionConfig": { - "description": "The config for skew between training data and prediction data.", - "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig" - }, - "predictionDriftDetectionConfig": { - "description": "The config for drift of prediction data.", - "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig" - }, - "explanationConfig": { - "description": "The config for integrating with Vertex Explainable AI.", - "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig" + "content": { + "description": "The base64-encoded contents of the input notebook file.", + "format": "byte", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset": { - "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset", - "description": "Training Dataset information.", - "type": "object", + "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource": { + "description": "The Cloud Storage uri for the input notebook.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", "properties": { - "dataset": { - "description": "The resource name of the Dataset used to train this Model.", - "type": "string" - }, - "gcsSource": { - "description": "The Google Cloud Storage uri of the unmanaged Dataset used to train this Model.", - "$ref": "GoogleCloudAiplatformV1GcsSource" - }, - "bigquerySource": { - "description": "The BigQuery table of the unmanaged Dataset used to train this Model.", - "$ref": "GoogleCloudAiplatformV1BigQuerySource" - }, - "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.", + "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" }, - "targetField": { - "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.", + "uri": { + "description": "The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`", "type": "string" - }, - "loggingSamplingStrategy": { - "description": "Strategy to sample data from Training Dataset. If not set, we process the whole dataset.", - "$ref": "GoogleCloudAiplatformV1SamplingStrategy" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SamplingStrategy": { - "id": "GoogleCloudAiplatformV1SamplingStrategy", - "description": "Sampling Strategy for logging, can be for both training and prediction dataset.", - "type": "object", - "properties": { - "randomSampleConfig": { - "description": "Random sample config. Will support more sampling strategies later.", - "$ref": "GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig" - } - } + "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime": { + "description": "Configuration for a Workbench Instances-based environment.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig": { - "id": "GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig", - "description": "Requests are randomly selected.", - "type": "object", + "GoogleCloudAiplatformV1NotebookIdleShutdownConfig": { + "description": "The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.", + "id": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig", "properties": { - "sampleRate": { - "description": "Sample rate (0, 1]", - "type": "number", - "format": "double" + "idleShutdownDisabled": { + "description": "Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.", + "type": "boolean" + }, + "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.", + "format": "google-duration", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig": { - "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig", - "description": "The config for Training & Prediction data skew detection. It specifies the training dataset sources and the skew detection parameters.", - "type": "object", + "GoogleCloudAiplatformV1NotebookReservationAffinity": { + "description": "Notebook Reservation Affinity for consuming Zonal reservation.", + "id": "GoogleCloudAiplatformV1NotebookReservationAffinity", "properties": { - "skewThresholds": { - "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", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1ThresholdConfig" - } + "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.", + "enum": [ + "RESERVATION_AFFINITY_TYPE_UNSPECIFIED", + "RESERVATION_NONE", + "RESERVATION_ANY", + "RESERVATION_SPECIFIC" + ], + "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" }, - "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": "GoogleCloudAiplatformV1ThresholdConfig" - } + "key": { + "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.", + "type": "string" }, - "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": "GoogleCloudAiplatformV1ThresholdConfig" - } - } - }, - "GoogleCloudAiplatformV1ThresholdConfig": { - "id": "GoogleCloudAiplatformV1ThresholdConfig", - "description": "The config for feature monitoring threshold.", - "type": "object", - "properties": { - "value": { - "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.", - "type": "number", - "format": "double" + "values": { + "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full path name of Reservation.", + "items": { + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig": { - "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig", - "description": "The config for Prediction data drift detection.", - "type": "object", + "GoogleCloudAiplatformV1NotebookRuntime": { + "description": "A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.", + "id": "GoogleCloudAiplatformV1NotebookRuntime", "properties": { - "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": "GoogleCloudAiplatformV1ThresholdConfig" - } + "createTime": { + "description": "Output only. Timestamp when this NotebookRuntime was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "attributionScoreDriftThresholds": { - "description": "Key is the feature name and value is the threshold. The threshold here is against attribution score distance between different time windows.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1ThresholdConfig" - } + "dataPersistentDiskSpec": { + "$ref": "GoogleCloudAiplatformV1PersistentDiskSpec", + "description": "Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.", + "readOnly": true }, - "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": "GoogleCloudAiplatformV1ThresholdConfig" - } - } - }, - "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig": { - "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig", - "description": "The config for integrating with Vertex Explainable AI. Only applicable if the Model has explanation_spec populated.", - "type": "object", - "properties": { - "enableFeatureAttributes": { - "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.", - "type": "boolean" + "description": { + "description": "The description of the NotebookRuntime.", + "type": "string" }, - "explanationBaseline": { - "description": "Predictions generated by the BatchPredictionJob using baseline dataset.", - "$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline" - } - } - }, - "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline": { - "id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline", - "description": "Output from BatchPredictionJob for Model Monitoring baseline dataset, which can be used to generate baseline attribution scores.", - "type": "object", - "properties": { - "gcs": { - "description": "Cloud Storage location for BatchExplain output.", - "$ref": "GoogleCloudAiplatformV1GcsDestination" + "displayName": { + "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.", + "type": "string" }, - "bigquery": { - "description": "BigQuery location for BatchExplain output.", - "$ref": "GoogleCloudAiplatformV1BigQueryDestination" + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "description": "Output only. Customer-managed encryption key spec for the notebook runtime.", + "readOnly": true }, - "predictionFormat": { - "description": "The storage format of the predictions generated BatchPrediction job.", - "type": "string", + "eucConfig": { + "$ref": "GoogleCloudAiplatformV1NotebookEucConfig", + "description": "Output only. EUC configuration of the notebook runtime.", + "readOnly": true + }, + "expirationTime": { + "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.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "healthState": { + "description": "Output only. The health state of the NotebookRuntime.", + "enum": [ + "HEALTH_STATE_UNSPECIFIED", + "HEALTHY", + "UNHEALTHY" + ], "enumDescriptions": [ - "Should not be set.", - "Predictions are in JSONL files.", - "Predictions are in BigQuery." + "Unspecified health state.", + "NotebookRuntime is in healthy state. Applies to ACTIVE state.", + "NotebookRuntime is in unhealthy state. Applies to ACTIVE state." ], - "enum": [ - "PREDICTION_FORMAT_UNSPECIFIED", - "JSONL", - "BIGQUERY" - ] - } - } - }, - "GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig": { - "id": "GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig", - "description": "The config for scheduling monitoring job.", - "type": "object", - "properties": { - "monitorInterval": { - "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.", - "type": "string", - "format": "google-duration" + "readOnly": true, + "type": "string" }, - "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.", - "type": "string", - "format": "google-duration" - } - } - }, - "GoogleCloudAiplatformV1ModelMonitoringAlertConfig": { - "id": "GoogleCloudAiplatformV1ModelMonitoringAlertConfig", - "description": "The alert config for model monitoring.", - "type": "object", - "properties": { - "emailAlertConfig": { - "description": "Email alert config.", - "$ref": "GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig" + "idleShutdownConfig": { + "$ref": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig", + "description": "Output only. The idle shutdown configuration of the notebook runtime.", + "readOnly": true + }, + "isUpgradable": { + "description": "Output only. Whether NotebookRuntime is upgradable.", + "readOnly": true, + "type": "boolean" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" }, - "enableLogging": { - "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.", - "type": "boolean" + "machineSpec": { + "$ref": "GoogleCloudAiplatformV1MachineSpec", + "description": "Output only. The specification of a single machine used by the notebook runtime.", + "readOnly": true }, - "notificationChannels": { - "description": "Resource names of the NotificationChannels to send alert. Must be of the format `projects//notificationChannels/`", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig": { - "id": "GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig", - "description": "The config for email alert.", - "type": "object", - "properties": { - "userEmails": { - "description": "The email addresses to send the alert.", - "type": "array", + "name": { + "description": "Output only. The resource name of the NotebookRuntime.", + "readOnly": true, + "type": "string" + }, + "networkSpec": { + "$ref": "GoogleCloudAiplatformV1NetworkSpec", + "description": "Output only. Network spec of the notebook runtime.", + "readOnly": true + }, + "networkTags": { + "description": "Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).", "items": { "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable": { - "id": "GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable", - "description": "ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name as well as some information of the logs stored in this table.", - "type": "object", - "properties": { - "logSource": { - "description": "The source of log.", - "type": "string", - "enumDescriptions": [ - "Unspecified source.", - "Logs coming from Training dataset.", - "Logs coming from Serving traffic." - ], - "enum": [ - "LOG_SOURCE_UNSPECIFIED", - "TRAINING", - "SERVING" - ] + }, + "type": "array" }, - "logType": { - "description": "The type of log.", - "type": "string", + "notebookRuntimeTemplateRef": { + "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplateRef", + "description": "Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.", + "readOnly": true + }, + "notebookRuntimeType": { + "description": "Output only. The type of the notebook runtime.", + "enum": [ + "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED", + "USER_DEFINED", + "ONE_CLICK" + ], "enumDescriptions": [ - "Unspecified type.", - "Predict logs.", - "Explain logs." + "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": [ - "LOG_TYPE_UNSPECIFIED", - "PREDICT", - "EXPLAIN" - ] - }, - "bigqueryTablePath": { - "description": "The created BigQuery table to store logs. Customer could do their own query & analysis. Format: `bq://.model_deployment_monitoring_._`", + "readOnly": true, "type": "string" }, - "requestResponseLoggingSchemaVersion": { - "description": "Output only. The schema version of the request/response logging BigQuery table. Default to v1 if unset.", + "proxyUri": { + "description": "Output only. The proxy endpoint used to access the NotebookRuntime.", "readOnly": true, "type": "string" - } - } - }, - "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest": { - "id": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest", - "description": "Request message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.", - "type": "object", - "properties": { - "deployedModelId": { - "description": "Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].", + }, + "reservationAffinity": { + "$ref": "GoogleCloudAiplatformV1NotebookReservationAffinity", + "description": "Output only. Reservation Affinity of the notebook runtime.", + "readOnly": true + }, + "runtimeState": { + "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." + ], + "readOnly": true, "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\".", + "runtimeUser": { + "description": "Required. The user email of the NotebookRuntime.", "type": "string" }, - "objectives": { - "description": "Required. Objectives of the stats to retrieve.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective" - } + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" }, - "pageSize": { - "description": "The standard list page size.", - "type": "integer", - "format": "int32" + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" }, - "pageToken": { - "description": "A page token received from a previous JobService.SearchModelDeploymentMonitoringStatsAnomalies call.", + "serviceAccount": { + "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.", + "readOnly": true, "type": "string" }, - "startTime": { - "description": "The earliest timestamp of stats being generated. If not set, indicates fetching stats till the earliest possible one.", - "type": "string", - "format": "google-datetime" + "shieldedVmConfig": { + "$ref": "GoogleCloudAiplatformV1ShieldedVmConfig", + "description": "Output only. Runtime Shielded VM spec.", + "readOnly": true }, - "endTime": { - "description": "The latest timestamp of stats being generated. If not set, indicates feching stats till the latest possible one.", - "type": "string", - "format": "google-datetime" - } - } - }, - "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective": { - "id": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective", - "description": "Stats requested for specific objective.", - "type": "object", - "properties": { - "type": { - "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." - ], - "enum": [ - "MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED", - "RAW_FEATURE_SKEW", - "RAW_FEATURE_DRIFT", - "FEATURE_ATTRIBUTION_SKEW", - "FEATURE_ATTRIBUTION_DRIFT" - ] + "softwareConfig": { + "$ref": "GoogleCloudAiplatformV1NotebookSoftwareConfig", + "description": "Output only. Software config of the notebook runtime.", + "readOnly": true }, - "topFeatureCount": { - "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.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse": { - "id": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse", - "description": "Response message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.", - "type": "object", - "properties": { - "monitoringStats": { - "description": "Stats retrieved for requested objectives. There are at most 1000 ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats in the response.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies" - } + "updateTime": { + "description": "Output only. Timestamp when this NotebookRuntime was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "nextPageToken": { - "description": "The page token that can be used by the next JobService.SearchModelDeploymentMonitoringStatsAnomalies call.", + "version": { + "description": "Output only. The VM os image version of NotebookRuntime.", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies": { - "id": "GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies", - "description": "Statistics and anomalies generated by Model Monitoring.", - "type": "object", + "GoogleCloudAiplatformV1NotebookRuntimeTemplate": { + "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.", + "id": "GoogleCloudAiplatformV1NotebookRuntimeTemplate", "properties": { - "objective": { - "description": "Model Monitoring Objective those stats and anomalies belonging to.", - "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." - ], - "enum": [ - "MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED", - "RAW_FEATURE_SKEW", - "RAW_FEATURE_DRIFT", - "FEATURE_ATTRIBUTION_SKEW", - "FEATURE_ATTRIBUTION_DRIFT" - ] - }, - "deployedModelId": { - "description": "Deployed Model ID.", + "createTime": { + "description": "Output only. Timestamp when this NotebookRuntimeTemplate was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "anomalyCount": { - "description": "Number of anomalies within all stats.", - "type": "integer", - "format": "int32" + "dataPersistentDiskSpec": { + "$ref": "GoogleCloudAiplatformV1PersistentDiskSpec", + "description": "Optional. The specification of persistent disk attached to the runtime as data disk storage." }, - "featureStats": { - "description": "A list of historical Stats and Anomalies generated for all Features.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies" - } - } - } - }, - "GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies": { - "id": "GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies", - "description": "Historical Stats (and Anomalies) for a specific Feature.", - "type": "object", - "properties": { - "featureDisplayName": { - "description": "Display Name of the Feature.", + "description": { + "description": "The description of the NotebookRuntimeTemplate.", "type": "string" }, - "threshold": { - "description": "Threshold for anomaly detection.", - "$ref": "GoogleCloudAiplatformV1ThresholdConfig" - }, - "trainingStats": { - "description": "Stats calculated for the Training Dataset.", - "$ref": "GoogleCloudAiplatformV1FeatureStatsAnomaly" + "displayName": { + "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.", + "type": "string" }, - "predictionStats": { - "description": "A list of historical stats generated by different time window's Prediction Dataset.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1FeatureStatsAnomaly" - } - } - } - }, - "GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse": { - "id": "GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse", - "description": "Response message for JobService.ListModelDeploymentMonitoringJobs.", - "type": "object", - "properties": { - "modelDeploymentMonitoringJobs": { - "description": "A list of ModelDeploymentMonitoringJobs that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob" - } + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "description": "Customer-managed encryption key spec for the notebook runtime." }, - "nextPageToken": { - "description": "The standard List next-page token.", + "etag": { + "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest": { - "id": "GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest", - "description": "Request message for JobService.PauseModelDeploymentMonitoringJob.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest": { - "id": "GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest", - "description": "Request message for JobService.ResumeModelDeploymentMonitoringJob.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1PredictRequest": { - "id": "GoogleCloudAiplatformV1PredictRequest", - "description": "Request message for PredictionService.Predict.", - "type": "object", - "properties": { - "instances": { - "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", - "items": { - "type": "any" - } }, - "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" + "eucConfig": { + "$ref": "GoogleCloudAiplatformV1NotebookEucConfig", + "description": "EUC configuration of the NotebookRuntimeTemplate." + }, + "idleShutdownConfig": { + "$ref": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig", + "description": "The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled." + }, + "isDefault": { + "deprecated": true, + "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, + "type": "boolean" }, "labels": { - "description": "Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored.", - "type": "object", "additionalProperties": { "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1PredictResponse": { - "id": "GoogleCloudAiplatformV1PredictResponse", - "description": "Response message for PredictionService.Predict.", - "type": "object", - "properties": { - "predictions": { - "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.", - "type": "array", - "items": { - "type": "any" - } + }, + "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" }, - "deployedModelId": { - "description": "ID of the Endpoint's DeployedModel that served this prediction.", - "type": "string" + "machineSpec": { + "$ref": "GoogleCloudAiplatformV1MachineSpec", + "description": "Optional. Immutable. The specification of a single machine for the template." }, - "model": { - "description": "Output only. The resource name of the Model which is deployed as the DeployedModel that this prediction hits.", - "readOnly": true, + "name": { + "description": "The resource name of the NotebookRuntimeTemplate.", "type": "string" }, - "modelVersionId": { - "description": "Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits.", - "readOnly": true, + "networkSpec": { + "$ref": "GoogleCloudAiplatformV1NetworkSpec", + "description": "Optional. Network spec." + }, + "networkTags": { + "description": "Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).", + "items": { + "type": "string" + }, + "type": "array" + }, + "notebookRuntimeType": { + "description": "Optional. Immutable. The type of the notebook runtime template.", + "enum": [ + "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED", + "USER_DEFINED", + "ONE_CLICK" + ], + "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." + ], "type": "string" }, - "modelDisplayName": { - "description": "Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.", - "readOnly": true, + "reservationAffinity": { + "$ref": "GoogleCloudAiplatformV1NotebookReservationAffinity", + "description": "Optional. Reservation Affinity of the notebook runtime template." + }, + "serviceAccount": { + "deprecated": true, + "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.", "type": "string" }, - "metadata": { - "description": "Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.", + "shieldedVmConfig": { + "$ref": "GoogleCloudAiplatformV1ShieldedVmConfig", + "description": "Optional. Immutable. Runtime Shielded VM spec." + }, + "softwareConfig": { + "$ref": "GoogleCloudAiplatformV1NotebookSoftwareConfig", + "description": "Optional. The notebook software configuration of the notebook runtime." + }, + "updateTime": { + "description": "Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.", + "format": "google-datetime", "readOnly": true, - "type": "any" + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RawPredictRequest": { - "id": "GoogleCloudAiplatformV1RawPredictRequest", - "description": "Request message for PredictionService.RawPredict.", - "type": "object", + "GoogleCloudAiplatformV1NotebookRuntimeTemplateRef": { + "description": "Points to a NotebookRuntimeTemplateRef.", + "id": "GoogleCloudAiplatformV1NotebookRuntimeTemplateRef", "properties": { - "httpBody": { - "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.", - "$ref": "GoogleApiHttpBody" + "notebookRuntimeTemplate": { + "description": "Immutable. A resource name of the NotebookRuntimeTemplate.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleApiHttpBody": { - "id": "GoogleApiHttpBody", - "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.", - "type": "object", + "GoogleCloudAiplatformV1NotebookSoftwareConfig": { + "description": "Notebook Software Config. This is passed to the backend when user makes software configurations in UI.", + "id": "GoogleCloudAiplatformV1NotebookSoftwareConfig", "properties": { - "contentType": { - "description": "The HTTP Content-Type header value specifying the content type of the body.", - "type": "string" - }, - "data": { - "description": "The HTTP request/response body as raw binary.", - "type": "string", - "format": "byte" + "colabImage": { + "$ref": "GoogleCloudAiplatformV1ColabImage", + "description": "Optional. Google-managed NotebookRuntime colab image." }, - "extensions": { - "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", - "type": "array", + "env": { + "description": "Optional. Environment variables to be passed to the container. Maximum limit is 100.", "items": { - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - } - } + "$ref": "GoogleCloudAiplatformV1EnvVar" + }, + "type": "array" + }, + "postStartupScriptConfig": { + "$ref": "GoogleCloudAiplatformV1PostStartupScriptConfig", + "description": "Optional. Post startup script config." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1StreamRawPredictRequest": { - "id": "GoogleCloudAiplatformV1StreamRawPredictRequest", - "description": "Request message for PredictionService.StreamRawPredict.", - "type": "object", + "GoogleCloudAiplatformV1OutputConfig": { + "description": "Config for evaluation output.", + "id": "GoogleCloudAiplatformV1OutputConfig", "properties": { - "httpBody": { - "description": "The prediction input. Supports HTTP headers and arbitrary data payload.", - "$ref": "GoogleApiHttpBody" + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "Cloud storage destination for evaluation output." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DirectPredictRequest": { - "id": "GoogleCloudAiplatformV1DirectPredictRequest", - "description": "Request message for PredictionService.DirectPredict.", - "type": "object", + "GoogleCloudAiplatformV1OutputFieldSpec": { + "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.", + "id": "GoogleCloudAiplatformV1OutputFieldSpec", "properties": { - "inputs": { - "description": "The prediction input.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Tensor" - } + "fieldName": { + "description": "Required. The name of this field in the generated synthetic data, such as \"email_subject\" or \"customer_review\".", + "type": "string" }, - "parameters": { - "description": "The parameters that govern the prediction.", - "$ref": "GoogleCloudAiplatformV1Tensor" - } - } - }, - "GoogleCloudAiplatformV1Tensor": { - "id": "GoogleCloudAiplatformV1Tensor", - "description": "A tensor value type.", - "type": "object", - "properties": { - "dtype": { - "description": "The data type of tensor.", - "type": "string", - "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.", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" - ], + "fieldType": { + "description": "Optional. The data type of the field. Defaults to CONTENT if not set.", "enum": [ - "DATA_TYPE_UNSPECIFIED", - "BOOL", - "STRING", - "FLOAT", - "DOUBLE", - "INT8", - "INT16", - "INT32", - "INT64", - "UINT8", - "UINT16", - "UINT32", - "UINT64" - ] - }, - "shape": { - "description": "Shape of the tensor.", - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "boolVal": { - "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", - "type": "array", - "items": { - "type": "boolean" - } - }, - "stringVal": { - "description": "STRING", - "type": "array", - "items": { - "type": "string" - } - }, - "bytesVal": { - "description": "STRING", - "type": "array", - "items": { - "type": "string", - "format": "byte" - } - }, - "floatVal": { - "description": "FLOAT", - "type": "array", - "items": { - "type": "number", - "format": "float" - } - }, - "doubleVal": { - "description": "DOUBLE", - "type": "array", - "items": { - "type": "number", - "format": "double" - } + "FIELD_TYPE_UNSPECIFIED", + "CONTENT", + "TEXT", + "IMAGE", + "AUDIO" + ], + "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." + ], + "type": "string" }, - "intVal": { - "description": "INT_8 INT_16 INT_32", - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1OutputInfo": { + "description": "Describes the info for output of EvaluationService.", + "id": "GoogleCloudAiplatformV1OutputInfo", + "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" + }, + "GoogleCloudAiplatformV1PSCAutomationConfig": { + "description": "PSC config that is used to automatically create PSC endpoints in the user projects.", + "id": "GoogleCloudAiplatformV1PSCAutomationConfig", + "properties": { + "errorMessage": { + "description": "Output only. Error message if the PSC service automation failed.", + "readOnly": true, + "type": "string" }, - "int64Val": { - "description": "INT64", - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "forwardingRule": { + "description": "Output only. Forwarding rule created by the PSC service automation.", + "readOnly": true, + "type": "string" }, - "uintVal": { - "description": "UINT8 UINT16 UINT32", - "type": "array", - "items": { - "type": "integer", - "format": "uint32" - } + "ipAddress": { + "description": "Output only. IP address rule created by the PSC service automation.", + "readOnly": true, + "type": "string" }, - "uint64Val": { - "description": "UINT64", - "type": "array", - "items": { - "type": "string", - "format": "uint64" - } + "network": { + "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}`.", + "type": "string" }, - "listVal": { - "description": "A list of tensor values.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Tensor" - } + "projectId": { + "description": "Required. Project id used to create forwarding rule.", + "type": "string" }, - "structVal": { - "description": "A map of string to tensor.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1Tensor" - } + "state": { + "description": "Output only. The state of the PSC service automation.", + "enum": [ + "PSC_AUTOMATION_STATE_UNSPECIFIED", + "PSC_AUTOMATION_STATE_SUCCESSFUL", + "PSC_AUTOMATION_STATE_FAILED" + ], + "enumDescriptions": [ + "Should not be used.", + "The PSC service automation is successful.", + "The PSC service automation has failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PairwiseMetricInput": { + "description": "Input for pairwise metric.", + "id": "GoogleCloudAiplatformV1PairwiseMetricInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1PairwiseMetricInstance", + "description": "Required. Pairwise metric instance." }, - "tensorVal": { - "description": "Serialized raw tensor content.", - "type": "string", - "format": "byte" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec", + "description": "Required. Spec for pairwise metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DirectPredictResponse": { - "id": "GoogleCloudAiplatformV1DirectPredictResponse", - "description": "Response message for PredictionService.DirectPredict.", - "type": "object", + "GoogleCloudAiplatformV1PairwiseMetricInstance": { + "description": "Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", + "id": "GoogleCloudAiplatformV1PairwiseMetricInstance", "properties": { - "outputs": { - "description": "The prediction output.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Tensor" - } + "contentMapInstance": { + "$ref": "GoogleCloudAiplatformV1ContentMap", + "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." }, - "parameters": { - "description": "The parameters that govern the prediction.", - "$ref": "GoogleCloudAiplatformV1Tensor" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DirectRawPredictRequest": { - "id": "GoogleCloudAiplatformV1DirectRawPredictRequest", - "description": "Request message for PredictionService.DirectRawPredict.", - "type": "object", + "GoogleCloudAiplatformV1PairwiseMetricResult": { + "description": "Spec for pairwise metric result.", + "id": "GoogleCloudAiplatformV1PairwiseMetricResult", "properties": { - "methodName": { - "description": "Fully qualified name of the API method being invoked to perform predictions. Format: `/namespace.Service/Method/` Example: `/tensorflow.serving.PredictionService/Predict`", + "customOutput": { + "$ref": "GoogleCloudAiplatformV1CustomOutput", + "description": "Output only. Spec for custom output.", + "readOnly": true + }, + "explanation": { + "description": "Output only. Explanation for pairwise metric score.", + "readOnly": true, "type": "string" }, - "input": { - "description": "The prediction input.", - "type": "string", - "format": "byte" + "pairwiseChoice": { + "description": "Output only. Pairwise metric choice.", + "enum": [ + "PAIRWISE_CHOICE_UNSPECIFIED", + "BASELINE", + "CANDIDATE", + "TIE" + ], + "enumDescriptions": [ + "Unspecified prediction choice.", + "Baseline prediction wins", + "Candidate prediction wins", + "Winner cannot be determined" + ], + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DirectRawPredictResponse": { - "id": "GoogleCloudAiplatformV1DirectRawPredictResponse", - "description": "Response message for PredictionService.DirectRawPredict.", - "type": "object", + "GoogleCloudAiplatformV1PairwiseMetricSpec": { + "description": "Spec for pairwise metric.", + "id": "GoogleCloudAiplatformV1PairwiseMetricSpec", "properties": { - "output": { - "description": "The prediction output.", - "type": "string", - "format": "byte" + "baselineResponseFieldName": { + "description": "Optional. The field name of the baseline response.", + "type": "string" + }, + "candidateResponseFieldName": { + "description": "Optional. The field name of the candidate response.", + "type": "string" + }, + "customOutputFormatConfig": { + "$ref": "GoogleCloudAiplatformV1CustomOutputFormatConfig", + "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." + }, + "metricPromptTemplate": { + "description": "Required. Metric prompt template for pairwise metric.", + "type": "string" + }, + "systemInstruction": { + "description": "Optional. System instructions for pairwise metric.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1StreamingPredictRequest": { - "id": "GoogleCloudAiplatformV1StreamingPredictRequest", - "description": "Request message for PredictionService.StreamingPredict. The first message must contain endpoint field and optionally input. The subsequent messages must contain input.", - "type": "object", + "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput": { + "description": "Input for pairwise question answering quality metric.", + "id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput", "properties": { - "inputs": { - "description": "The prediction input.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Tensor" - } + "instance": { + "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance", + "description": "Required. Pairwise question answering quality instance." }, - "parameters": { - "description": "The parameters that govern the prediction.", - "$ref": "GoogleCloudAiplatformV1Tensor" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec", + "description": "Required. Spec for pairwise question answering quality score metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1StreamingPredictResponse": { - "id": "GoogleCloudAiplatformV1StreamingPredictResponse", - "description": "Response message for PredictionService.StreamingPredict.", - "type": "object", + "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance": { + "description": "Spec for pairwise question answering quality instance.", + "id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance", "properties": { - "outputs": { - "description": "The prediction output.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Tensor" - } + "baselinePrediction": { + "description": "Required. Output of the baseline model.", + "type": "string" }, - "parameters": { - "description": "The parameters that govern the prediction.", - "$ref": "GoogleCloudAiplatformV1Tensor" + "context": { + "description": "Required. Text to answer the question.", + "type": "string" + }, + "instruction": { + "description": "Required. Question Answering prompt for LLM.", + "type": "string" + }, + "prediction": { + "description": "Required. Output of the candidate model.", + "type": "string" + }, + "reference": { + "description": "Optional. Ground truth used to compare against the prediction.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PredictLongRunningRequest": { - "id": "GoogleCloudAiplatformV1PredictLongRunningRequest", - "description": "Request message for PredictionService.PredictLongRunning.", - "type": "object", + "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult": { + "description": "Spec for pairwise question answering quality result.", + "id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult", "properties": { - "instances": { - "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", - "items": { - "type": "any" - } + "confidence": { + "description": "Output only. Confidence for question answering quality score.", + "format": "float", + "readOnly": true, + "type": "number" }, - "parameters": { - "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.", - "type": "any" + "explanation": { + "description": "Output only. Explanation for question answering quality score.", + "readOnly": true, + "type": "string" + }, + "pairwiseChoice": { + "description": "Output only. Pairwise question answering prediction choice.", + "enum": [ + "PAIRWISE_CHOICE_UNSPECIFIED", + "BASELINE", + "CANDIDATE", + "TIE" + ], + "enumDescriptions": [ + "Unspecified prediction choice.", + "Baseline prediction wins", + "Candidate prediction wins", + "Winner cannot be determined" + ], + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FetchPredictOperationRequest": { - "id": "GoogleCloudAiplatformV1FetchPredictOperationRequest", - "description": "Request message for PredictionService.FetchPredictOperation.", - "type": "object", + "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec": { + "description": "Spec for pairwise question answering quality score metric.", + "id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec", "properties": { - "operationName": { - "description": "Required. The server-assigned name for the operation.", - "type": "string" + "useReference": { + "description": "Optional. Whether to use instance.reference to compute question answering quality.", + "type": "boolean" + }, + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1InvokeRequest": { - "id": "GoogleCloudAiplatformV1InvokeRequest", - "description": "Request message for PredictionService.Invoke.", - "type": "object", + "GoogleCloudAiplatformV1PairwiseSummarizationQualityInput": { + "description": "Input for pairwise summarization quality metric.", + "id": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInput", "properties": { - "deployedModelId": { - "description": "ID of the DeployedModel that serves the invoke request.", - "type": "string" + "instance": { + "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance", + "description": "Required. Pairwise summarization quality instance." }, - "httpBody": { - "description": "The invoke method input. Supports HTTP headers and arbitrary data payload.", - "$ref": "GoogleApiHttpBody" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec", + "description": "Required. Spec for pairwise summarization quality score metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExplainRequest": { - "id": "GoogleCloudAiplatformV1ExplainRequest", - "description": "Request message for PredictionService.Explain.", - "type": "object", + "GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance": { + "description": "Spec for pairwise summarization quality instance.", + "id": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance", "properties": { - "instances": { - "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.", - "type": "array", - "items": { - "type": "any" - } + "baselinePrediction": { + "description": "Required. Output of the baseline model.", + "type": "string" }, - "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" + "context": { + "description": "Required. Text to be summarized.", + "type": "string" }, - "explanationSpecOverride": { - "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.", - "$ref": "GoogleCloudAiplatformV1ExplanationSpecOverride" + "instruction": { + "description": "Required. Summarization prompt for LLM.", + "type": "string" }, - "deployedModelId": { - "description": "If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split.", + "prediction": { + "description": "Required. Output of the candidate model.", + "type": "string" + }, + "reference": { + "description": "Optional. Ground truth used to compare against the prediction.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExplanationSpecOverride": { - "id": "GoogleCloudAiplatformV1ExplanationSpecOverride", - "description": "The ExplanationSpec entries that can be overridden at online explanation time.", - "type": "object", + "GoogleCloudAiplatformV1PairwiseSummarizationQualityResult": { + "description": "Spec for pairwise summarization quality result.", + "id": "GoogleCloudAiplatformV1PairwiseSummarizationQualityResult", "properties": { - "parameters": { - "description": "The parameters to be overridden. Note that the attribution method cannot be changed. If not specified, no parameter is overridden.", - "$ref": "GoogleCloudAiplatformV1ExplanationParameters" + "confidence": { + "description": "Output only. Confidence for summarization quality score.", + "format": "float", + "readOnly": true, + "type": "number" }, - "metadata": { - "description": "The metadata to be overridden. If not specified, no metadata is overridden.", - "$ref": "GoogleCloudAiplatformV1ExplanationMetadataOverride" + "explanation": { + "description": "Output only. Explanation for summarization quality score.", + "readOnly": true, + "type": "string" }, - "examplesOverride": { - "description": "The example-based explanations parameter overrides.", - "$ref": "GoogleCloudAiplatformV1ExamplesOverride" - } - } - }, - "GoogleCloudAiplatformV1ExplanationMetadataOverride": { - "id": "GoogleCloudAiplatformV1ExplanationMetadataOverride", - "description": "The ExplanationMetadata entries that can be overridden at online explanation time.", - "type": "object", - "properties": { - "inputs": { - "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", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride" - } + "pairwiseChoice": { + "description": "Output only. Pairwise summarization prediction choice.", + "enum": [ + "PAIRWISE_CHOICE_UNSPECIFIED", + "BASELINE", + "CANDIDATE", + "TIE" + ], + "enumDescriptions": [ + "Unspecified prediction choice.", + "Baseline prediction wins", + "Candidate prediction wins", + "Winner cannot be determined" + ], + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride": { - "id": "GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride", - "description": "The input metadata entries to be overridden.", - "type": "object", + "GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec": { + "description": "Spec for pairwise summarization quality score metric.", + "id": "GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec", "properties": { - "inputBaselines": { - "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.", - "type": "array", - "items": { - "type": "any" - } + "useReference": { + "description": "Optional. Whether to use instance.reference to compute pairwise summarization quality.", + "type": "boolean" + }, + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExamplesOverride": { - "id": "GoogleCloudAiplatformV1ExamplesOverride", - "description": "Overrides for example-based explanations.", - "type": "object", + "GoogleCloudAiplatformV1Part": { + "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.", + "id": "GoogleCloudAiplatformV1Part", "properties": { - "neighborCount": { - "description": "The number of neighbors to return.", - "type": "integer", - "format": "int32" + "codeExecutionResult": { + "$ref": "GoogleCloudAiplatformV1CodeExecutionResult", + "description": "Optional. The result of executing the ExecutableCode." }, - "crowdingCount": { - "description": "The number of neighbors to return that have the same crowding tag.", - "type": "integer", - "format": "int32" + "executableCode": { + "$ref": "GoogleCloudAiplatformV1ExecutableCode", + "description": "Optional. Code generated by the model that is intended to be executed." }, - "restrictions": { - "description": "Restrict the resulting nearest neighbors to respect these constraints.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ExamplesRestrictionsNamespace" - } + "fileData": { + "$ref": "GoogleCloudAiplatformV1FileData", + "description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage." }, - "returnEmbeddings": { - "description": "If true, return the embeddings instead of neighbors.", + "functionCall": { + "$ref": "GoogleCloudAiplatformV1FunctionCall", + "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." + }, + "functionResponse": { + "$ref": "GoogleCloudAiplatformV1FunctionResponse", + "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." + }, + "inlineData": { + "$ref": "GoogleCloudAiplatformV1Blob", + "description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request." + }, + "mediaResolution": { + "$ref": "GoogleCloudAiplatformV1PartMediaResolution", + "description": "per part media resolution. Media resolution for the input media." + }, + "text": { + "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.", + "type": "string" + }, + "thought": { + "description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning.", "type": "boolean" }, - "dataFormat": { - "description": "The format of the data being provided with each call.", - "type": "string", + "thoughtSignature": { + "description": "Optional. An opaque signature for the thought so it can be reused in subsequent requests.", + "format": "byte", + "type": "string" + }, + "videoMetadata": { + "$ref": "GoogleCloudAiplatformV1VideoMetadata", + "description": "Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PartMediaResolution": { + "description": "per part media resolution. Media resolution for the input media.", + "id": "GoogleCloudAiplatformV1PartMediaResolution", + "properties": { + "level": { + "description": "The tokenization quality used for given media.", + "enum": [ + "MEDIA_RESOLUTION_UNSPECIFIED", + "MEDIA_RESOLUTION_LOW", + "MEDIA_RESOLUTION_MEDIUM", + "MEDIA_RESOLUTION_HIGH", + "MEDIA_RESOLUTION_ULTRA_HIGH" + ], "enumDescriptions": [ - "Unspecified format. Must not be used.", - "Provided data is a set of model inputs.", - "Provided data is a set of embeddings." + "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." ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PartialArg": { + "description": "Partial argument value of the function call.", + "id": "GoogleCloudAiplatformV1PartialArg", + "properties": { + "boolValue": { + "description": "Optional. Represents a boolean value.", + "type": "boolean" + }, + "jsonPath": { + "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\".", + "type": "string" + }, + "nullValue": { + "description": "Optional. Represents a null value.", "enum": [ - "DATA_FORMAT_UNSPECIFIED", - "INSTANCES", - "EMBEDDINGS" - ] + "NULL_VALUE" + ], + "enumDescriptions": [ + "Null value." + ], + "type": "string" + }, + "numberValue": { + "description": "Optional. Represents a double value.", + "format": "double", + "type": "number" + }, + "stringValue": { + "description": "Optional. Represents a string value.", + "type": "string" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExamplesRestrictionsNamespace": { - "id": "GoogleCloudAiplatformV1ExamplesRestrictionsNamespace", - "description": "Restrictions namespace for example-based explanations overrides.", - "type": "object", + "GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest": { + "description": "Request message for JobService.PauseModelDeploymentMonitoringJob.", + "id": "GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1PauseScheduleRequest": { + "description": "Request message for ScheduleService.PauseSchedule.", + "id": "GoogleCloudAiplatformV1PauseScheduleRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1PersistentDiskSpec": { + "description": "Represents the spec of persistent disk options.", + "id": "GoogleCloudAiplatformV1PersistentDiskSpec", "properties": { - "namespaceName": { - "description": "The namespace name.", + "diskSizeGb": { + "description": "Size in GB of the disk (default is 100GB).", + "format": "int64", "type": "string" }, - "allow": { - "description": "The list of allowed tags.", - "type": "array", - "items": { + "diskType": { + "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)", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PersistentResource": { + "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": "GoogleCloudAiplatformV1PersistentResource", + "properties": { + "createTime": { + "description": "Output only. Time when the PersistentResource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "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.", + "type": "string" + }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when persistent resource's state is `STOPPING` or `ERROR`.", + "readOnly": true + }, + "labels": { + "additionalProperties": { "type": "string" - } + }, + "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" }, - "deny": { - "description": "The list of deny tags.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1ExplainResponse": { - "id": "GoogleCloudAiplatformV1ExplainResponse", - "description": "Response message for PredictionService.Explain.", - "type": "object", - "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": "GoogleCloudAiplatformV1Explanation" - } + "name": { + "description": "Immutable. Resource name of a PersistentResource.", + "type": "string" }, - "deployedModelId": { - "description": "ID of the Endpoint's DeployedModel that served this explanation.", + "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" }, - "predictions": { - "description": "The predictions that are the output of the predictions call. Same as PredictResponse.predictions.", - "type": "array", - "items": { - "type": "any" - } - } - } - }, - "GoogleCloudAiplatformV1Explanation": { - "id": "GoogleCloudAiplatformV1Explanation", - "description": "Explanation of a prediction (provided in PredictResponse.predictions) produced by the Model on a given instance.", - "type": "object", - "properties": { - "attributions": { - "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.", - "readOnly": true, - "type": "array", + "pscInterfaceConfig": { + "$ref": "GoogleCloudAiplatformV1PscInterfaceConfig", + "description": "Optional. Configuration for PSC-I for PersistentResource." + }, + "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": { - "$ref": "GoogleCloudAiplatformV1Attribution" - } + "type": "string" + }, + "type": "array" }, - "neighbors": { - "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.", - "readOnly": true, - "type": "array", + "resourcePools": { + "description": "Required. The spec of the pools of different resources.", "items": { - "$ref": "GoogleCloudAiplatformV1Neighbor" - } - } - } - }, - "GoogleCloudAiplatformV1Attribution": { - "id": "GoogleCloudAiplatformV1Attribution", - "description": "Attribution that explains a particular prediction output.", - "type": "object", - "properties": { - "baselineOutputValue": { - "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, - "type": "number", - "format": "double" + "$ref": "GoogleCloudAiplatformV1ResourcePool" + }, + "type": "array" }, - "instanceOutputValue": { - "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.", - "readOnly": true, - "type": "number", - "format": "double" + "resourceRuntime": { + "$ref": "GoogleCloudAiplatformV1ResourceRuntime", + "description": "Output only. Runtime information of the Persistent Resource.", + "readOnly": true }, - "featureAttributions": { - "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).", + "resourceRuntimeSpec": { + "$ref": "GoogleCloudAiplatformV1ResourceRuntimeSpec", + "description": "Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration." + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", "readOnly": true, - "type": "any" + "type": "boolean" }, - "outputIndex": { - "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.", + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", "readOnly": true, - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } + "type": "boolean" }, - "outputDisplayName": { - "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.", + "startTime": { + "description": "Output only. Time when the PersistentResource for the first time entered the `RUNNING` state.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "approximationError": { - "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.", + "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": "number", - "format": "double" + "type": "string" }, - "outputName": { - "description": "Output only. Name of the explain output. Specified as the key in ExplanationMetadata.outputs.", + "updateTime": { + "description": "Output only. Time when the PersistentResource was most recently updated.", + "format": "google-datetime", "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Neighbor": { - "id": "GoogleCloudAiplatformV1Neighbor", - "description": "Neighbors for example-based explanations.", - "type": "object", + "GoogleCloudAiplatformV1PipelineJob": { + "description": "An instance of a machine learning PipelineJob.", + "id": "GoogleCloudAiplatformV1PipelineJob", "properties": { - "neighborId": { - "description": "Output only. The neighbor id.", + "createTime": { + "description": "Output only. Pipeline creation time.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "neighborDistance": { - "description": "Output only. The neighbor distance.", - "readOnly": true, - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudAiplatformV1GenerateContentRequest": { - "id": "GoogleCloudAiplatformV1GenerateContentRequest", - "description": "Request message for [PredictionService.GenerateContent].", - "type": "object", - "properties": { - "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": "GoogleCloudAiplatformV1Content" - } + "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" }, - "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": "GoogleCloudAiplatformV1Content" + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "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}`", + "endTime": { + "description": "Output only. Pipeline end time.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Tool" - } + "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 }, - "toolConfig": { - "description": "Optional. Tool config. This config is shared for all tools provided in the request.", - "$ref": "GoogleCloudAiplatformV1ToolConfig" + "jobDetail": { + "$ref": "GoogleCloudAiplatformV1PipelineJobDetail", + "description": "Output only. The details of pipeline run. Not available in the list view.", + "readOnly": true }, "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.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "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" }, - "safetySettings": { - "description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", - "type": "array", + "name": { + "description": "Output only. The resource name of the PipelineJob.", + "readOnly": true, + "type": "string" + }, + "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" + }, + "pipelineSpec": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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" + }, + "preflightValidations": { + "description": "Optional. Whether to do component level validations before job creation.", + "type": "boolean" + }, + "pscInterfaceConfig": { + "$ref": "GoogleCloudAiplatformV1PscInterfaceConfig", + "description": "Optional. Configuration for PSC-I for PipelineJob." + }, + "reservedIpRanges": { + "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'].", "items": { - "$ref": "GoogleCloudAiplatformV1SafetySetting" - } + "type": "string" + }, + "type": "array" }, - "modelArmorConfig": { - "description": "Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.", - "$ref": "GoogleCloudAiplatformV1ModelArmorConfig" + "runtimeConfig": { + "$ref": "GoogleCloudAiplatformV1PipelineJobRuntimeConfig", + "description": "Runtime config of the pipeline." }, - "generationConfig": { - "description": "Optional. Generation config.", - "$ref": "GoogleCloudAiplatformV1GenerationConfig" - } - } - }, - "GoogleCloudAiplatformV1SafetySetting": { - "id": "GoogleCloudAiplatformV1SafetySetting", - "description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.", - "type": "object", - "properties": { - "category": { - "description": "Required. The harm category to be blocked.", - "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" - ] + "scheduleName": { + "description": "Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.", + "readOnly": true, + "type": "string" }, - "threshold": { - "description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.", - "type": "string", - "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." - ], - "enum": [ - "HARM_BLOCK_THRESHOLD_UNSPECIFIED", - "BLOCK_LOW_AND_ABOVE", - "BLOCK_MEDIUM_AND_ABOVE", - "BLOCK_ONLY_HIGH", - "BLOCK_NONE", - "OFF" - ] + "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" }, - "method": { - "description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.", - "type": "string", + "startTime": { + "description": "Output only. Pipeline start time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The detailed state of the job.", + "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" + ], "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." + "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": [ - "HARM_BLOCK_METHOD_UNSPECIFIED", - "SEVERITY", - "PROBABILITY" - ] - } - } - }, - "GoogleCloudAiplatformV1ModelArmorConfig": { - "id": "GoogleCloudAiplatformV1ModelArmorConfig", - "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.", - "type": "object", - "properties": { - "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}`.", + "readOnly": true, "type": "string" }, - "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}`.", + "templateMetadata": { + "$ref": "GoogleCloudAiplatformV1PipelineTemplateMetadata", + "description": "Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.", + "readOnly": true + }, + "templateUri": { + "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.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this PipelineJob was most recently updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerateContentResponse": { - "id": "GoogleCloudAiplatformV1GenerateContentResponse", - "description": "Response message for [PredictionService.GenerateContent].", - "type": "object", + "GoogleCloudAiplatformV1PipelineJobDetail": { + "description": "The runtime detail of PipelineJob.", + "id": "GoogleCloudAiplatformV1PipelineJobDetail", "properties": { - "candidates": { - "description": "Output only. Generated candidates.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Candidate" - } + "pipelineContext": { + "$ref": "GoogleCloudAiplatformV1Context", + "description": "Output only. The context of the pipeline.", + "readOnly": true }, - "modelVersion": { - "description": "Output only. The model version used to generate the response.", - "readOnly": true, - "type": "string" + "pipelineRunContext": { + "$ref": "GoogleCloudAiplatformV1Context", + "description": "Output only. The context of the current pipeline run.", + "readOnly": true }, - "createTime": { - "description": "Output only. Timestamp when the request is made to the server.", + "taskDetails": { + "description": "Output only. The runtime details of the tasks under the pipeline.", + "items": { + "$ref": "GoogleCloudAiplatformV1PipelineTaskDetail" + }, "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PipelineJobRuntimeConfig": { + "description": "The runtime config of a PipelineJob.", + "id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfig", + "properties": { + "failurePolicy": { + "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.", + "enum": [ + "PIPELINE_FAILURE_POLICY_UNSPECIFIED", + "PIPELINE_FAILURE_POLICY_FAIL_SLOW", + "PIPELINE_FAILURE_POLICY_FAIL_FAST" + ], + "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" }, - "responseId": { - "description": "Output only. response_id is used to identify each response. It is the encoding of the event_id.", - "readOnly": true, + "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" }, - "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": "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback" + "inputArtifacts": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact" + }, + "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" }, - "usageMetadata": { - "description": "Usage metadata about the response(s).", - "$ref": "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata" + "parameterValues": { + "additionalProperties": { + "type": "any" + }, + "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.", + "type": "object" + }, + "parameters": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1Value" + }, + "deprecated": true, + "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.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Candidate": { - "id": "GoogleCloudAiplatformV1Candidate", - "description": "A response candidate generated from the model.", - "type": "object", + "GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact": { + "description": "The type of an input artifact.", + "id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact", "properties": { - "index": { - "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.", + "artifactId": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PipelineTaskDetail": { + "description": "The runtime detail of a task execution.", + "id": "GoogleCloudAiplatformV1PipelineTaskDetail", + "properties": { + "createTime": { + "description": "Output only. Task create time.", + "format": "google-datetime", "readOnly": true, - "type": "integer", - "format": "int32" + "type": "string" }, - "content": { - "description": "Output only. The content of the candidate.", + "endTime": { + "description": "Output only. Task end time.", + "format": "google-datetime", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1Content" + "type": "string" }, - "avgLogprobs": { - "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.", - "readOnly": true, - "type": "number", - "format": "double" + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.", + "readOnly": true }, - "logprobsResult": { - "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\".", + "execution": { + "$ref": "GoogleCloudAiplatformV1Execution", + "description": "Output only. The execution metadata of the task.", + "readOnly": true + }, + "executorDetail": { + "$ref": "GoogleCloudAiplatformV1PipelineTaskExecutorDetail", + "description": "Output only. The detailed execution info.", + "readOnly": true + }, + "inputs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1PipelineTaskDetailArtifactList" + }, + "description": "Output only. The runtime input artifacts of the task.", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1LogprobsResult" + "type": "object" }, - "finishReason": { - "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.", + "outputs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1PipelineTaskDetailArtifactList" + }, + "description": "Output only. The runtime output artifacts of the task.", "readOnly": true, - "type": "string", - "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." - ], - "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" - ] + "type": "object" }, - "safetyRatings": { - "description": "Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.", + "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": "array", + "type": "string" + }, + "pipelineTaskStatus": { + "description": "Output only. A list of task status. This field keeps a record of task status evolving over time.", "items": { - "$ref": "GoogleCloudAiplatformV1SafetyRating" - } + "$ref": "GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus" + }, + "readOnly": true, + "type": "array" }, - "finishMessage": { - "description": "Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.", + "startTime": { + "description": "Output only. Task start time.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "citationMetadata": { - "description": "Output only. A collection of citations that apply to the generated content.", + "state": { + "description": "Output only. State of the task.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "CANCEL_PENDING", + "CANCELLING", + "CANCELLED", + "FAILED", + "SKIPPED", + "NOT_TRIGGERED" + ], + "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, - "$ref": "GoogleCloudAiplatformV1CitationMetadata" + "type": "string" }, - "groundingMetadata": { - "description": "Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.", + "taskId": { + "description": "Output only. The system generated ID of the task.", + "format": "int64", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1GroundingMetadata" + "type": "string" }, - "urlContextMetadata": { - "description": "Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", + "taskName": { + "description": "Output only. The user specified name of the task that is defined in pipeline_spec.", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1UrlContextMetadata" - } - } - }, - "GoogleCloudAiplatformV1LogprobsResult": { - "id": "GoogleCloudAiplatformV1LogprobsResult", - "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.", - "type": "object", - "properties": { - "topCandidates": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1LogprobsResultTopCandidates" - } + "type": "string" }, - "chosenCandidates": { - "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`.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate" - } + "taskUniqueName": { + "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\".", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1LogprobsResultTopCandidates": { - "id": "GoogleCloudAiplatformV1LogprobsResultTopCandidates", - "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.", - "type": "object", + "GoogleCloudAiplatformV1PipelineTaskDetailArtifactList": { + "description": "A list of artifact metadata.", + "id": "GoogleCloudAiplatformV1PipelineTaskDetailArtifactList", "properties": { - "candidates": { - "description": "The list of candidate tokens, sorted by log probability in descending order.", - "type": "array", + "artifacts": { + "description": "Output only. A list of artifact metadata.", "items": { - "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate" - } + "$ref": "GoogleCloudAiplatformV1Artifact" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1LogprobsResultCandidate": { - "id": "GoogleCloudAiplatformV1LogprobsResultCandidate", - "description": "A single token and its associated log probability.", - "type": "object", + "GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus": { + "description": "A single record of the task status.", + "id": "GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus", "properties": { - "token": { - "description": "The token's string representation.", - "type": "string" - }, - "tokenId": { - "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.", - "type": "integer", - "format": "int32" + "error": { + "$ref": "GoogleRpcStatus", + "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.", + "readOnly": true }, - "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" - } - } - }, - "GoogleCloudAiplatformV1SafetyRating": { - "id": "GoogleCloudAiplatformV1SafetyRating", - "description": "A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.", - "type": "object", - "properties": { - "category": { - "description": "Output only. The harm category of this rating.", - "readOnly": true, - "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 - ], + "state": { + "description": "Output only. The state of the task.", "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" - ] - }, - "probability": { - "description": "Output only. The probability of harm for this category.", - "readOnly": true, - "type": "string", - "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." + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "CANCEL_PENDING", + "CANCELLING", + "CANCELLED", + "FAILED", + "SKIPPED", + "NOT_TRIGGERED" ], - "enum": [ - "HARM_PROBABILITY_UNSPECIFIED", - "NEGLIGIBLE", - "LOW", - "MEDIUM", - "HIGH" - ] - }, - "probabilityScore": { - "description": "Output only. The probability score of harm for this category.", - "readOnly": true, - "type": "number", - "format": "float" - }, - "severity": { - "description": "Output only. The severity of harm for this category.", - "readOnly": true, - "type": "string", "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." + "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." ], - "enum": [ - "HARM_SEVERITY_UNSPECIFIED", - "HARM_SEVERITY_NEGLIGIBLE", - "HARM_SEVERITY_LOW", - "HARM_SEVERITY_MEDIUM", - "HARM_SEVERITY_HIGH" - ] - }, - "severityScore": { - "description": "Output only. The severity score of harm for this category.", - "readOnly": true, - "type": "number", - "format": "float" - }, - "blocked": { - "description": "Output only. Indicates whether the content was blocked because of this rating.", "readOnly": true, - "type": "boolean" + "type": "string" }, - "overwrittenThreshold": { - "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.", + "updateTime": { + "description": "Output only. Update time of this status.", + "format": "google-datetime", "readOnly": true, - "type": "string", - "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." - ], - "enum": [ - "HARM_BLOCK_THRESHOLD_UNSPECIFIED", - "BLOCK_LOW_AND_ABOVE", - "BLOCK_MEDIUM_AND_ABOVE", - "BLOCK_ONLY_HIGH", - "BLOCK_NONE", - "OFF" - ] + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CitationMetadata": { - "id": "GoogleCloudAiplatformV1CitationMetadata", - "description": "A collection of citations that apply to a piece of generated content.", - "type": "object", + "GoogleCloudAiplatformV1PipelineTaskExecutorDetail": { + "description": "The runtime detail of a pipeline executor.", + "id": "GoogleCloudAiplatformV1PipelineTaskExecutorDetail", "properties": { - "citations": { - "description": "Output only. A list of citations for the content.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Citation" - } + "containerDetail": { + "$ref": "GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail", + "description": "Output only. The detailed info for a container executor.", + "readOnly": true + }, + "customJobDetail": { + "$ref": "GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail", + "description": "Output only. The detailed info for a custom job executor.", + "readOnly": true } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Citation": { - "id": "GoogleCloudAiplatformV1Citation", - "description": "A citation for a piece of generatedcontent.", - "type": "object", + "GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail": { + "description": "The detail of a container execution. It contains the job names of the lifecycle of a container execution.", + "id": "GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail", "properties": { - "startIndex": { - "description": "Output only. The start index of the citation in the content.", + "failedMainJobs": { + "description": "Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.", + "items": { + "type": "string" + }, "readOnly": true, - "type": "integer", - "format": "int32" + "type": "array" }, - "endIndex": { - "description": "Output only. The end index of the citation in the content.", + "failedPreCachingCheckJobs": { + "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.", + "items": { + "type": "string" + }, "readOnly": true, - "type": "integer", - "format": "int32" + "type": "array" }, - "uri": { - "description": "Output only. The URI of the source of the citation.", + "mainJob": { + "description": "Output only. The name of the CustomJob for the main container execution.", "readOnly": true, "type": "string" }, - "title": { - "description": "Output only. The title of the source of the citation.", + "preCachingCheckJob": { + "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.", "readOnly": true, "type": "string" - }, - "license": { - "description": "Output only. The license of the source of the citation.", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail": { + "description": "The detailed info for a custom job executor.", + "id": "GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail", + "properties": { + "failedJobs": { + "description": "Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.", + "items": { + "type": "string" + }, "readOnly": true, - "type": "string" + "type": "array" }, - "publicationDate": { - "description": "Output only. The publication date of the source of the citation.", + "job": { + "description": "Output only. The name of the CustomJob.", "readOnly": true, - "$ref": "GoogleTypeDate" + "type": "string" } - } + }, + "type": "object" }, - "GoogleTypeDate": { - "id": "GoogleTypeDate", - "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", + "GoogleCloudAiplatformV1PipelineTemplateMetadata": { + "description": "Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry.", + "id": "GoogleCloudAiplatformV1PipelineTemplateMetadata", "properties": { - "year": { - "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", - "type": "integer", - "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.", - "type": "integer", - "format": "int32" - }, - "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" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GroundingMetadata": { - "id": "GoogleCloudAiplatformV1GroundingMetadata", - "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.", - "type": "object", + "GoogleCloudAiplatformV1PointwiseMetricInput": { + "description": "Input for pointwise metric.", + "id": "GoogleCloudAiplatformV1PointwiseMetricInput", "properties": { - "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.", - "type": "array", - "items": { - "type": "string" - } - }, - "searchEntryPoint": { - "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.", - "$ref": "GoogleCloudAiplatformV1SearchEntryPoint" - }, - "groundingChunks": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1GroundingChunk" - } + "instance": { + "$ref": "GoogleCloudAiplatformV1PointwiseMetricInstance", + "description": "Required. Pointwise metric instance." }, - "groundingSupports": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1GroundingSupport" - } + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1PointwiseMetricSpec", + "description": "Required. Spec for pointwise metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PointwiseMetricInstance": { + "description": "Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", + "id": "GoogleCloudAiplatformV1PointwiseMetricInstance", + "properties": { + "contentMapInstance": { + "$ref": "GoogleCloudAiplatformV1ContentMap", + "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." }, - "retrievalMetadata": { - "description": "Optional. Output only. Metadata related to the retrieval grounding source.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1RetrievalMetadata" + "jsonInstance": { + "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PointwiseMetricResult": { + "description": "Spec for pointwise metric result.", + "id": "GoogleCloudAiplatformV1PointwiseMetricResult", + "properties": { + "customOutput": { + "$ref": "GoogleCloudAiplatformV1CustomOutput", + "description": "Output only. Spec for custom output.", + "readOnly": true }, - "googleMapsWidgetContextToken": { - "description": "Optional. Output only. 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.", + "explanation": { + "description": "Output only. Explanation for pointwise metric score.", "readOnly": true, "type": "string" }, - "sourceFlaggingUris": { - "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.", + "score": { + "description": "Output only. Pointwise metric score.", + "format": "float", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri" - } + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SearchEntryPoint": { - "id": "GoogleCloudAiplatformV1SearchEntryPoint", - "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.", - "type": "object", + "GoogleCloudAiplatformV1PointwiseMetricSpec": { + "description": "Spec for pointwise metric.", + "id": "GoogleCloudAiplatformV1PointwiseMetricSpec", "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.", + "customOutputFormatConfig": { + "$ref": "GoogleCloudAiplatformV1CustomOutputFormatConfig", + "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." + }, + "metricPromptTemplate": { + "description": "Required. Metric prompt template for pointwise metric.", "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" + "systemInstruction": { + "description": "Optional. System instructions for pointwise metric.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GroundingChunk": { - "id": "GoogleCloudAiplatformV1GroundingChunk", - "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.", - "type": "object", + "GoogleCloudAiplatformV1Port": { + "description": "Represents a network port in a container.", + "id": "GoogleCloudAiplatformV1Port", "properties": { - "web": { - "description": "A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.", - "$ref": "GoogleCloudAiplatformV1GroundingChunkWeb" + "containerPort": { + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PostStartupScriptConfig": { + "description": "Post startup script config.", + "id": "GoogleCloudAiplatformV1PostStartupScriptConfig", + "properties": { + "postStartupScript": { + "description": "Optional. Post startup script to run after runtime is started.", + "type": "string" }, - "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": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext" + "postStartupScriptBehavior": { + "description": "Optional. Post startup script behavior that defines download and execution behavior.", + "enum": [ + "POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED", + "RUN_ONCE", + "RUN_EVERY_START", + "DOWNLOAD_AND_RUN_EVERY_START" + ], + "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." + ], + "type": "string" }, - "maps": { - "description": "A grounding chunk from Google Maps. See the `Maps` message for details.", - "$ref": "GoogleCloudAiplatformV1GroundingChunkMaps" + "postStartupScriptUrl": { + "description": "Optional. Post startup script url to download. Example: `gs://bucket/script.sh`", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GroundingChunkWeb": { - "id": "GoogleCloudAiplatformV1GroundingChunkWeb", - "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.", - "type": "object", + "GoogleCloudAiplatformV1PreTunedModel": { + "description": "A pre-tuned model for continuous tuning.", + "id": "GoogleCloudAiplatformV1PreTunedModel", "properties": { - "uri": { - "description": "The URI of the web page that contains the evidence.", + "baseModel": { + "description": "Output only. The name of the base model this PreTunedModel was tuned from.", + "readOnly": true, "type": "string" }, - "title": { - "description": "The title of the web page that contains the evidence.", + "checkpointId": { + "description": "Optional. The source checkpoint id. If not specified, the default checkpoint will be used.", "type": "string" }, - "domain": { - "description": "The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GroundingChunkRetrievedContext": { - "id": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", - "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.", - "type": "object", + "GoogleCloudAiplatformV1PrebuiltVoiceConfig": { + "description": "Configuration for a prebuilt voice.", + "id": "GoogleCloudAiplatformV1PrebuiltVoiceConfig", "properties": { - "ragChunk": { - "description": "Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.", - "$ref": "GoogleCloudAiplatformV1RagChunk" - }, - "uri": { - "description": "The URI of the retrieved data source.", + "voiceName": { + "description": "The name of the prebuilt voice to use.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PredefinedMetricSpec": { + "description": "The spec for a pre-defined metric.", + "id": "GoogleCloudAiplatformV1PredefinedMetricSpec", + "properties": { + "metricSpecName": { + "description": "Required. The name of a pre-defined metric, such as \"instruction_following_v1\" or \"text_quality_v1\".", "type": "string" }, - "title": { - "description": "The title of the retrieved data source.", + "metricSpecParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The parameters needed to run the pre-defined metric.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PredefinedSplit": { + "description": "Assigns input data to training, validation, and test sets based on the value of a provided key. Supported only for tabular Datasets.", + "id": "GoogleCloudAiplatformV1PredefinedSplit", + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PredictLongRunningRequest": { + "description": "Request message for PredictionService.PredictLongRunning.", + "id": "GoogleCloudAiplatformV1PredictLongRunningRequest", + "properties": { + "instances": { + "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.", + "items": { + "type": "any" + }, + "type": "array" }, - "text": { - "description": "The content of the retrieved data source.", - "type": "string" + "labels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" }, - "documentName": { - "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}`.", - "readOnly": true, - "type": "string" + "parameters": { + "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.", + "type": "any" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagChunk": { - "id": "GoogleCloudAiplatformV1RagChunk", - "description": "A RagChunk includes the content of a chunk of a RagFile, and associated metadata.", - "type": "object", + "GoogleCloudAiplatformV1PredictRequest": { + "description": "Request message for PredictionService.Predict.", + "id": "GoogleCloudAiplatformV1PredictRequest", "properties": { - "text": { - "description": "The content of the chunk.", - "type": "string" + "instances": { + "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.", + "items": { + "type": "any" + }, + "type": "array" }, - "pageSpan": { - "description": "If populated, represents where the chunk starts and ends in the document.", - "$ref": "GoogleCloudAiplatformV1RagChunkPageSpan" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored.", + "type": "object" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagChunkPageSpan": { - "id": "GoogleCloudAiplatformV1RagChunkPageSpan", - "description": "Represents where the chunk starts and ends in the document.", - "type": "object", + "GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig": { + "description": "Configuration for logging request-response to a BigQuery table.", + "id": "GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig", "properties": { - "firstPage": { - "description": "Page where chunk starts in the document. Inclusive. 1-indexed.", - "type": "integer", - "format": "int32" + "bigqueryDestination": { + "$ref": "GoogleCloudAiplatformV1BigQueryDestination", + "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`" }, - "lastPage": { - "description": "Page where chunk ends in the document. Inclusive. 1-indexed.", - "type": "integer", - "format": "int32" + "enabled": { + "description": "If logging is enabled or not.", + "type": "boolean" + }, + "samplingRate": { + "description": "Percentage of requests to be logged, expressed as a fraction in range(0,1].", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GroundingChunkMaps": { - "id": "GoogleCloudAiplatformV1GroundingChunkMaps", - "description": "A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.", - "type": "object", + "GoogleCloudAiplatformV1PredictResponse": { + "description": "Response message for PredictionService.Predict.", + "id": "GoogleCloudAiplatformV1PredictResponse", "properties": { - "uri": { - "description": "The URI of the place.", + "deployedModelId": { + "description": "ID of the Endpoint's DeployedModel that served this prediction.", "type": "string" }, - "title": { - "description": "The title of the place.", + "metadata": { + "description": "Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.", + "readOnly": true, + "type": "any" + }, + "model": { + "description": "Output only. The resource name of the Model which is deployed as the DeployedModel that this prediction hits.", + "readOnly": true, "type": "string" }, - "text": { - "description": "The text of the place answer.", + "modelDisplayName": { + "description": "Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.", + "readOnly": true, "type": "string" }, - "placeId": { - "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.", + "modelVersionId": { + "description": "Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits.", + "readOnly": true, "type": "string" }, - "placeAnswerSources": { - "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.", - "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources" - } - } - }, - "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources": { - "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources", - "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", - "properties": { - "reviewSnippets": { - "description": "Snippets of reviews that were used to generate the answer.", - "type": "array", + "predictions": { + "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": { - "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet" - } + "type": "any" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { - "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", - "description": "A review snippet that is used to generate the answer.", - "type": "object", + "GoogleCloudAiplatformV1PredictSchemata": { + "description": "Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob.", + "id": "GoogleCloudAiplatformV1PredictSchemata", "properties": { - "reviewId": { - "description": "The ID of the review that is being referenced.", + "instanceSchemaUri": { + "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.", "type": "string" }, - "googleMapsUri": { - "description": "A link to show the review on Google Maps.", + "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" }, - "title": { - "description": "The title of the review.", + "predictionSchemaUri": { + "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.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GroundingSupport": { - "id": "GoogleCloudAiplatformV1GroundingSupport", - "description": "A collection of supporting references for a segment of the model's response.", - "type": "object", + "GoogleCloudAiplatformV1PreferenceOptimizationDataStats": { + "description": "Statistics computed for datasets used for preference optimization.", + "id": "GoogleCloudAiplatformV1PreferenceOptimizationDataStats", "properties": { - "segment": { - "description": "The content segment that this support message applies to.", - "$ref": "GoogleCloudAiplatformV1Segment" - }, - "groundingChunkIndices": { - "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.", - "type": "array", + "droppedExampleIndices": { + "description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.", "items": { - "type": "integer", - "format": "int32" - } + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" }, - "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", + "droppedExampleReasons": { + "description": "Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.", "items": { - "type": "number", - "format": "float" - } - } - } - }, - "GoogleCloudAiplatformV1Segment": { - "id": "GoogleCloudAiplatformV1Segment", - "description": "A segment of the content.", - "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.", + "type": "string" + }, "readOnly": true, - "type": "integer", - "format": "int32" + "type": "array" }, - "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.", + "scoreVariancePerExampleDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for scores variance per example.", + "readOnly": true + }, + "scoresDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for scores.", + "readOnly": true + }, + "totalBillableTokenCount": { + "description": "Output only. Number of billable tokens in the tuning dataset.", + "format": "int64", "readOnly": true, - "type": "integer", - "format": "int32" + "type": "string" }, - "endIndex": { - "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.", + "tuningDatasetExampleCount": { + "description": "Output only. Number of examples in the tuning dataset.", + "format": "int64", "readOnly": true, - "type": "integer", - "format": "int32" + "type": "string" }, - "text": { - "description": "Output only. The text of the segment.", + "tuningStepCount": { + "description": "Output only. Number of tuning steps for this Tuning Job.", + "format": "int64", "readOnly": true, "type": "string" + }, + "userDatasetExamples": { + "description": "Output only. Sample user examples in the training dataset.", + "items": { + "$ref": "GoogleCloudAiplatformV1GeminiPreferenceExample" + }, + "readOnly": true, + "type": "array" + }, + "userInputTokenDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for the user input tokens.", + "readOnly": true + }, + "userOutputTokenDistribution": { + "$ref": "GoogleCloudAiplatformV1DatasetDistribution", + "description": "Output only. Dataset distributions for the user output tokens.", + "readOnly": true } - } - }, - "GoogleCloudAiplatformV1RetrievalMetadata": { - "id": "GoogleCloudAiplatformV1RetrievalMetadata", - "description": "Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.", - "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" - } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri": { - "id": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri", - "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.", - "type": "object", + "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters": { + "description": "Hyperparameters for Preference Optimization.", + "id": "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters", "properties": { - "sourceId": { - "description": "The ID of the place or review.", + "adapterSize": { + "description": "Optional. Adapter size for preference optimization.", + "enum": [ + "ADAPTER_SIZE_UNSPECIFIED", + "ADAPTER_SIZE_ONE", + "ADAPTER_SIZE_TWO", + "ADAPTER_SIZE_FOUR", + "ADAPTER_SIZE_EIGHT", + "ADAPTER_SIZE_SIXTEEN", + "ADAPTER_SIZE_THIRTY_TWO" + ], + "enumDescriptions": [ + "Adapter size is unspecified.", + "Adapter size 1.", + "Adapter size 2.", + "Adapter size 4.", + "Adapter size 8.", + "Adapter size 16.", + "Adapter size 32." + ], "type": "string" }, - "flagContentUri": { - "description": "The URI that can be used to flag the content.", + "beta": { + "description": "Optional. Weight for KL Divergence regularization.", + "format": "double", + "type": "number" + }, + "epochCount": { + "description": "Optional. Number of complete passes the model makes over the entire training dataset during training.", + "format": "int64", "type": "string" + }, + "learningRateMultiplier": { + "description": "Optional. Multiplier for adjusting the default learning rate.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UrlContextMetadata": { - "id": "GoogleCloudAiplatformV1UrlContextMetadata", - "description": "Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", - "type": "object", + "GoogleCloudAiplatformV1PreferenceOptimizationSpec": { + "description": "Tuning Spec for Preference Optimization.", + "id": "GoogleCloudAiplatformV1PreferenceOptimizationSpec", "properties": { - "urlMetadata": { - "description": "Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1UrlMetadata" - } + "exportLastCheckpointOnly": { + "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": "boolean" + }, + "hyperParameters": { + "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters", + "description": "Optional. Hyperparameters for Preference Optimization." + }, + "trainingDatasetUri": { + "description": "Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.", + "type": "string" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UrlMetadata": { - "id": "GoogleCloudAiplatformV1UrlMetadata", - "description": "The metadata for a single URL retrieval.", - "type": "object", + "GoogleCloudAiplatformV1Presets": { + "description": "Preset configuration for example-based explanations", + "id": "GoogleCloudAiplatformV1Presets", "properties": { - "retrievedUrl": { - "description": "The URL retrieved by the tool.", + "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.", + "enum": [ + "MODALITY_UNSPECIFIED", + "IMAGE", + "TEXT", + "TABULAR" + ], + "enumDescriptions": [ + "Should not be set. Added as a recommended best practice for enums", + "IMAGE modality", + "TEXT modality", + "TABULAR modality" + ], "type": "string" }, - "urlRetrievalStatus": { - "description": "The status of the URL retrieval.", - "type": "string", + "query": { + "description": "Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.", + "enum": [ + "PRECISE", + "FAST" + ], "enumDescriptions": [ - "Default value. This value is unused.", - "The URL was retrieved successfully.", - "The URL retrieval failed." + "More precise neighbors as a trade-off against slower response.", + "Faster response as a trade-off against less precise neighbors." ], - "enum": [ - "URL_RETRIEVAL_STATUS_UNSPECIFIED", - "URL_RETRIEVAL_STATUS_SUCCESS", - "URL_RETRIEVAL_STATUS_ERROR" - ] + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback": { - "id": "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback", - "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.", - "type": "object", + "GoogleCloudAiplatformV1PrivateEndpoints": { + "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": "GoogleCloudAiplatformV1PrivateEndpoints", "properties": { - "blockReason": { - "description": "Output only. The reason why the prompt was blocked.", + "explainHttpUri": { + "description": "Output only. Http(s) path to send explain requests.", "readOnly": true, - "type": "string", - "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." - ], - "enum": [ - "BLOCKED_REASON_UNSPECIFIED", - "SAFETY", - "OTHER", - "BLOCKLIST", - "PROHIBITED_CONTENT", - "MODEL_ARMOR", - "IMAGE_SAFETY", - "JAILBREAK" - ] + "type": "string" }, - "safetyRatings": { - "description": "Output only. A list of safety ratings for the prompt. There is one rating per category.", + "healthHttpUri": { + "description": "Output only. Http(s) path to send health check requests.", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SafetyRating" - } + "type": "string" }, - "blockReasonMessage": { - "description": "Output only. A readable message that explains the reason why the prompt was blocked.", + "predictHttpUri": { + "description": "Output only. Http(s) path to send prediction requests.", + "readOnly": true, + "type": "string" + }, + "serviceAttachment": { + "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled.", "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata": { - "id": "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata", - "description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", - "type": "object", + "GoogleCloudAiplatformV1PrivateServiceConnectConfig": { + "description": "Represents configuration for private service connect.", + "id": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", "properties": { - "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.", - "type": "integer", - "format": "int32" + "enablePrivateServiceConnect": { + "description": "Required. If true, expose the IndexEndpoint via private service connect.", + "type": "boolean" }, - "candidatesTokenCount": { - "description": "The total number of tokens in the generated candidates.", - "type": "integer", - "format": "int32" + "projectAllowlist": { + "description": "A list of Projects from which the forwarding rule will target the service attachment.", + "items": { + "type": "string" + }, + "type": "array" }, - "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`.", - "type": "integer", - "format": "int32" + "pscAutomationConfigs": { + "description": "Optional. List of projects and networks where the PSC endpoints will be created. This field is used by Online Inference(Prediction) only.", + "items": { + "$ref": "GoogleCloudAiplatformV1PSCAutomationConfig" + }, + "type": "array" }, - "toolUsePromptTokenCount": { - "description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.", + "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": "integer", - "format": "int32" + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Probe": { + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", + "id": "GoogleCloudAiplatformV1Probe", + "properties": { + "exec": { + "$ref": "GoogleCloudAiplatformV1ProbeExecAction", + "description": "ExecAction probes the health of a container by executing a command." }, - "thoughtsTokenCount": { - "description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", - "readOnly": true, - "type": "integer", - "format": "int32" + "failureThreshold": { + "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", + "type": "integer" }, - "cachedContentTokenCount": { - "description": "Output only. The number of tokens in the cached content that was used for this request.", - "readOnly": true, - "type": "integer", - "format": "int32" + "grpc": { + "$ref": "GoogleCloudAiplatformV1ProbeGrpcAction", + "description": "GrpcAction probes the health of a container by sending a gRPC request." }, - "promptTokensDetails": { - "description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" - } + "httpGet": { + "$ref": "GoogleCloudAiplatformV1ProbeHttpGetAction", + "description": "HttpGetAction probes the health of a container by sending an HTTP GET request." }, - "cacheTokensDetails": { - "description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" - } + "initialDelaySeconds": { + "description": "Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.", + "format": "int32", + "type": "integer" }, - "candidatesTokensDetails": { - "description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", - "readOnly": true, - "type": "array", + "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'.", + "format": "int32", + "type": "integer" + }, + "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'.", + "format": "int32", + "type": "integer" + }, + "tcpSocket": { + "$ref": "GoogleCloudAiplatformV1ProbeTcpSocketAction", + "description": "TcpSocketAction probes the health of a container by opening a TCP socket connection." + }, + "timeoutSeconds": { + "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'.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ProbeExecAction": { + "description": "ExecAction specifies a command to execute.", + "id": "GoogleCloudAiplatformV1ProbeExecAction", + "properties": { + "command": { + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" - } + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ProbeGrpcAction": { + "description": "GrpcAction checks the health of a container using a gRPC service.", + "id": "GoogleCloudAiplatformV1ProbeGrpcAction", + "properties": { + "port": { + "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", + "format": "int32", + "type": "integer" }, - "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", + "service": { + "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.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ProbeHttpGetAction": { + "description": "HttpGetAction describes an action based on HTTP Get requests.", + "id": "GoogleCloudAiplatformV1ProbeHttpGetAction", + "properties": { + "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" + }, + "httpHeaders": { + "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { - "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" - } + "$ref": "GoogleCloudAiplatformV1ProbeHttpHeader" + }, + "type": "array" }, - "trafficType": { - "description": "Output only. The traffic type for this request.", - "readOnly": true, - "type": "string", - "enumDescriptions": [ - "Unspecified request traffic type.", - "The request was processed using Pay-As-You-Go quota.", - "Type for Provisioned Throughput traffic." - ], - "enum": [ - "TRAFFIC_TYPE_UNSPECIFIED", - "ON_DEMAND", - "PROVISIONED_THROUGHPUT" - ] + "path": { + "description": "Path to access on the HTTP server.", + "type": "string" + }, + "port": { + "description": "Number of the port to access on the container. Number must be in the range 1 to 65535.", + "format": "int32", + "type": "integer" + }, + "scheme": { + "description": "Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are \"HTTP\" or \"HTTPS\".", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModalityTokenCount": { - "id": "GoogleCloudAiplatformV1ModalityTokenCount", - "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", + "GoogleCloudAiplatformV1ProbeHttpHeader": { + "description": "HttpHeader describes a custom header to be used in HTTP probes", + "id": "GoogleCloudAiplatformV1ProbeHttpHeader", "properties": { - "modality": { - "description": "The modality that this token count applies to.", - "type": "string", - "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." - ], - "enum": [ - "MODALITY_UNSPECIFIED", - "TEXT", - "IMAGE", - "VIDEO", - "AUDIO", - "DOCUMENT" - ] + "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" }, - "tokenCount": { - "description": "The number of tokens counted for this modality.", - "type": "integer", - "format": "int32" + "value": { + "description": "The header field value", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EmbedContentRequest": { - "id": "GoogleCloudAiplatformV1EmbedContentRequest", - "description": "Request message for PredictionService.EmbedContent.", - "type": "object", + "GoogleCloudAiplatformV1ProbeTcpSocketAction": { + "description": "TcpSocketAction probes the health of a container by opening a TCP socket connection.", + "id": "GoogleCloudAiplatformV1ProbeTcpSocketAction", "properties": { - "content": { - "description": "Required. Input content to be embedded. Required.", - "$ref": "GoogleCloudAiplatformV1Content" - }, - "title": { - "description": "Optional. An optional title for the text.", + "host": { + "description": "Optional: Host name to connect to, defaults to the model serving container's IP.", "type": "string" }, - "taskType": { - "description": "Optional. 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." - ], - "enum": [ - "UNSPECIFIED", - "RETRIEVAL_QUERY", - "RETRIEVAL_DOCUMENT", - "SEMANTIC_SIMILARITY", - "CLASSIFICATION", - "CLUSTERING", - "QUESTION_ANSWERING", - "FACT_VERIFICATION", - "CODE_RETRIEVAL_QUERY" - ] - }, - "outputDimensionality": { - "description": "Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.", - "type": "integer", - "format": "int32" - }, - "autoTruncate": { - "description": "Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.", - "type": "boolean" + "port": { + "description": "Number of the port to access on the container. Number must be in the range 1 to 65535.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EmbedContentResponse": { - "id": "GoogleCloudAiplatformV1EmbedContentResponse", - "description": "Response message for PredictionService.EmbedContent.", - "type": "object", + "GoogleCloudAiplatformV1PscAutomatedEndpoints": { + "description": "PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig.", + "id": "GoogleCloudAiplatformV1PscAutomatedEndpoints", "properties": { - "embedding": { - "description": "The embedding generated from the input content.", - "$ref": "GoogleCloudAiplatformV1EmbedContentResponseEmbedding" + "matchAddress": { + "description": "Ip Address created by the automated forwarding rule.", + "type": "string" }, - "usageMetadata": { - "description": "Metadata about the response(s).", - "$ref": "GoogleCloudAiplatformV1UsageMetadata" + "network": { + "description": "Corresponding network in pscAutomationConfigs.", + "type": "string" }, - "truncated": { - "description": "Whether the input content was truncated before generating the embedding.", - "type": "boolean" + "projectId": { + "description": "Corresponding project_id in pscAutomationConfigs", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EmbedContentResponseEmbedding": { - "id": "GoogleCloudAiplatformV1EmbedContentResponseEmbedding", - "description": "A list of floats representing an embedding.", - "type": "object", + "GoogleCloudAiplatformV1PscInterfaceConfig": { + "description": "Configuration for PSC-I.", + "id": "GoogleCloudAiplatformV1PscInterfaceConfig", "properties": { - "values": { - "description": "Embedding vector values.", - "type": "array", + "dnsPeeringConfigs": { + "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.", "items": { - "type": "number", - "format": "float" - } + "$ref": "GoogleCloudAiplatformV1DnsPeeringConfig" + }, + "type": "array" + }, + "networkAttachment": { + "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.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UsageMetadata": { - "id": "GoogleCloudAiplatformV1UsageMetadata", - "description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", - "type": "object", + "GoogleCloudAiplatformV1PublisherModel": { + "description": "A Model Garden Publisher Model.", + "id": "GoogleCloudAiplatformV1PublisherModel", "properties": { - "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.", - "type": "integer", - "format": "int32" - }, - "candidatesTokenCount": { - "description": "The total number of tokens in the generated candidates.", - "type": "integer", - "format": "int32" - }, - "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`.", - "type": "integer", - "format": "int32" + "frameworks": { + "description": "Optional. Additional information about the model's Frameworks.", + "items": { + "type": "string" + }, + "type": "array" }, - "toolUsePromptTokenCount": { - "description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.", - "readOnly": true, - "type": "integer", - "format": "int32" + "launchStage": { + "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." + ], + "type": "string" }, - "thoughtsTokenCount": { - "description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", + "name": { + "description": "Output only. Identifier. The resource name of the PublisherModel.", "readOnly": true, - "type": "integer", - "format": "int32" + "type": "string" }, - "cachedContentTokenCount": { - "description": "Output only. The number of tokens in the cached content that was used for this request.", - "readOnly": true, - "type": "integer", - "format": "int32" + "openSourceCategory": { + "description": "Required. Indicates the open source category of the publisher model.", + "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" + ], + "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" }, - "promptTokensDetails": { - "description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" - } + "predictSchemata": { + "$ref": "GoogleCloudAiplatformV1PredictSchemata", + "description": "Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict." }, - "cacheTokensDetails": { - "description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", + "publisherModelTemplate": { + "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, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" - } + "type": "string" }, - "candidatesTokensDetails": { - "description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" - } + "supportedActions": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToAction", + "description": "Optional. Supported call-to-action options." }, - "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.", + "versionId": { + "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.", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" - } + "type": "string" }, - "trafficType": { - "description": "Output only. The traffic type for this request.", - "readOnly": true, - "type": "string", + "versionState": { + "description": "Optional. Indicates the state of the model version.", + "enum": [ + "VERSION_STATE_UNSPECIFIED", + "VERSION_STATE_STABLE", + "VERSION_STATE_UNSTABLE" + ], "enumDescriptions": [ - "Unspecified request traffic type.", - "Type for Pay-As-You-Go traffic.", - "Type for Provisioned Throughput traffic." + "The version state is unspecified.", + "Used to indicate the version is stable.", + "Used to indicate the version is unstable." ], - "enum": [ - "TRAFFIC_TYPE_UNSPECIFIED", - "ON_DEMAND", - "PROVISIONED_THROUGHPUT" - ] + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CountTokensRequest": { - "id": "GoogleCloudAiplatformV1CountTokensRequest", - "description": "Request message for PredictionService.CountTokens.", - "type": "object", + "GoogleCloudAiplatformV1PublisherModelCallToAction": { + "description": "Actions could take on this Publisher Model.", + "id": "GoogleCloudAiplatformV1PublisherModelCallToAction", "properties": { - "model": { - "description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", - "type": "string" + "createApplication": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", + "description": "Optional. Create application using the PublisherModel." }, - "instances": { - "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", - "type": "array", - "items": { - "type": "any" - } + "deploy": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy", + "description": "Optional. Deploy the PublisherModel to Vertex Endpoint." }, - "contents": { - "description": "Optional. Input content.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Content" - } + "deployGke": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke", + "description": "Optional. Deploy PublisherModel to Google Kubernetes Engine." }, - "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": "GoogleCloudAiplatformV1Content" + "multiDeployVertex": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex", + "description": "Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint." }, - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Tool" - } + "openEvaluationPipeline": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", + "description": "Optional. Open evaluation pipeline of the PublisherModel." }, - "generationConfig": { - "description": "Optional. Generation config that the model will use to generate the response.", - "$ref": "GoogleCloudAiplatformV1GenerationConfig" - } - } - }, - "GoogleCloudAiplatformV1CountTokensResponse": { - "id": "GoogleCloudAiplatformV1CountTokensResponse", - "description": "Response message for PredictionService.CountTokens.", - "type": "object", - "properties": { - "totalTokens": { - "description": "The total number of tokens counted across all instances from the request.", - "type": "integer", - "format": "int32" + "openFineTuningPipeline": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", + "description": "Optional. Open fine-tuning pipeline of the PublisherModel." }, - "totalBillableCharacters": { - "description": "The total number of billable characters counted across all instances from the request.", - "type": "integer", - "format": "int32" + "openFineTuningPipelines": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines", + "description": "Optional. Open fine-tuning pipelines of the PublisherModel." }, - "promptTokensDetails": { - "description": "Output only. List of modalities that were processed in the request input.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" - } - } - } - }, - "GoogleCloudAiplatformV1ComputeTokensRequest": { - "id": "GoogleCloudAiplatformV1ComputeTokensRequest", - "description": "Request message for ComputeTokens RPC call.", - "type": "object", - "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.", - "type": "array", - "items": { - "type": "any" - } + "openGenerationAiStudio": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", + "description": "Optional. Open in Generation AI Studio." }, - "model": { - "description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", - "type": "string" + "openGenie": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", + "description": "Optional. Open Genie / Playground." }, - "contents": { - "description": "Optional. Input content.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Content" - } - } - } - }, - "GoogleCloudAiplatformV1ComputeTokensResponse": { - "id": "GoogleCloudAiplatformV1ComputeTokensResponse", - "description": "Response message for ComputeTokens RPC call.", - "type": "object", - "properties": { - "tokensInfo": { - "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", - "items": { - "$ref": "GoogleCloudAiplatformV1TokensInfo" - } - } - } - }, - "GoogleCloudAiplatformV1TokensInfo": { - "id": "GoogleCloudAiplatformV1TokensInfo", - "description": "Tokens info with a list of tokens and the corresponding list of token ids.", - "type": "object", - "properties": { - "tokens": { - "description": "A list of tokens from the input.", - "type": "array", - "items": { - "type": "string", - "format": "byte" - } + "openNotebook": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", + "description": "Optional. Open notebook of the PublisherModel." }, - "tokenIds": { - "description": "A list of token ids from the input.", - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "openNotebooks": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks", + "description": "Optional. Open notebooks of the PublisherModel." }, - "role": { - "description": "Optional. Optional fields for the role from the corresponding Content.", - "type": "string" + "openPromptTuningPipeline": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", + "description": "Optional. Open prompt-tuning pipeline of the PublisherModel." + }, + "requestAccess": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", + "description": "Optional. Request for access." + }, + "viewRestApi": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi", + "description": "Optional. To view Rest API docs." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FindNeighborsRequest": { - "id": "GoogleCloudAiplatformV1FindNeighborsRequest", - "description": "The request message for MatchService.FindNeighbors.", - "type": "object", + "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy": { + "description": "Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.", + "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy", "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.", + "artifactUri": { + "description": "Optional. The path to the directory containing the Model artifact and any of its supporting files.", "type": "string" }, - "queries": { - "description": "The list of queries.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1FindNeighborsRequestQuery" - } + "automaticResources": { + "$ref": "GoogleCloudAiplatformV1AutomaticResources", + "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration." }, - "returnFullDatapoint": { - "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.", - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1FindNeighborsRequestQuery": { - "id": "GoogleCloudAiplatformV1FindNeighborsRequestQuery", - "description": "A query to find a number of the nearest neighbors (most similar vectors) of a vector.", - "type": "object", - "properties": { - "rrf": { - "description": "Optional. Represents RRF algorithm that combines search results.", - "$ref": "GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF" + "containerSpec": { + "$ref": "GoogleCloudAiplatformV1ModelContainerSpec", + "description": "Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models." }, - "datapoint": { - "description": "Required. The datapoint/vector whose nearest neighbors should be searched for.", - "$ref": "GoogleCloudAiplatformV1IndexDatapoint" + "dedicatedResources": { + "$ref": "GoogleCloudAiplatformV1DedicatedResources", + "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration." }, - "neighborCount": { - "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).", - "type": "integer", - "format": "int32" + "deployMetadata": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata", + "description": "Optional. Metadata information about this deployment config." }, - "perCrowdingAttributeNeighborCount": { - "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.", - "type": "integer", - "format": "int32" + "deployTaskName": { + "description": "Optional. The name of the deploy task (e.g., \"text to image generation\").", + "type": "string" }, - "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.", - "type": "integer", - "format": "int32" + "largeModelReference": { + "$ref": "GoogleCloudAiplatformV1LargeModelReference", + "description": "Optional. Large model reference. When this is set, model_artifact_spec is not needed." }, - "fractionLeafNodesToSearchOverride": { - "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.", - "type": "number", - "format": "double" + "modelDisplayName": { + "description": "Optional. Default model display name.", + "type": "string" + }, + "publicArtifactUri": { + "description": "Optional. The signed URI for ephemeral Cloud Storage access to model artifact.", + "type": "string" + }, + "sharedResources": { + "description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "type": "string" + }, + "title": { + "description": "Required. The title of the regional resource reference.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF": { - "id": "GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF", - "description": "Parameters for RRF algorithm that combines search results.", - "type": "object", + "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata": { + "description": "Metadata information about the deployment for managing deployment config.", + "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata", "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.", - "type": "number", - "format": "float" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the deployment config. For managing deployment config like verifying, source of deployment config, etc.", + "type": "object" + }, + "sampleRequest": { + "description": "Optional. Sample request for deployed endpoint.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FindNeighborsResponse": { - "id": "GoogleCloudAiplatformV1FindNeighborsResponse", - "description": "The response message for MatchService.FindNeighbors.", - "type": "object", + "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke": { + "description": "Configurations for PublisherModel GKE deployment", + "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke", "properties": { - "nearestNeighbors": { - "description": "The nearest neighbors of the query datapoints.", - "type": "array", + "gkeYamlConfigs": { + "description": "Optional. GKE deployment configuration in yaml format.", "items": { - "$ref": "GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors" - } + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors": { - "id": "GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors", - "description": "Nearest neighbors for one query.", - "type": "object", + "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex": { + "description": "Multiple setups to deploy the PublisherModel.", + "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex", "properties": { - "id": { - "description": "The ID of the query datapoint.", - "type": "string" - }, - "neighbors": { - "description": "All its neighbors.", - "type": "array", + "multiDeployVertex": { + "description": "Optional. One click deployment configurations.", "items": { - "$ref": "GoogleCloudAiplatformV1FindNeighborsResponseNeighbor" - } - } - } - }, - "GoogleCloudAiplatformV1FindNeighborsResponseNeighbor": { - "id": "GoogleCloudAiplatformV1FindNeighborsResponseNeighbor", - "description": "A neighbor of the query vector.", - "type": "object", - "properties": { - "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": "GoogleCloudAiplatformV1IndexDatapoint" - }, - "distance": { - "description": "The distance between the neighbor and the dense embedding query.", - "type": "number", - "format": "double" - }, - "sparseDistance": { - "description": "The distance between the neighbor and the query sparse_embedding.", - "type": "number", - "format": "double" + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReadIndexDatapointsRequest": { - "id": "GoogleCloudAiplatformV1ReadIndexDatapointsRequest", - "description": "The request message for MatchService.ReadIndexDatapoints.", - "type": "object", + "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines": { + "description": "Open fine tuning pipelines.", + "id": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines", "properties": { - "deployedIndexId": { - "description": "The ID of the DeployedIndex that will serve the request.", - "type": "string" - }, - "ids": { - "description": "IDs of the datapoints to be searched for.", - "type": "array", + "fineTuningPipelines": { + "description": "Required. Regional resource references to fine tuning pipelines.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReadIndexDatapointsResponse": { - "id": "GoogleCloudAiplatformV1ReadIndexDatapointsResponse", - "description": "The response message for MatchService.ReadIndexDatapoints.", - "type": "object", + "GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks": { + "description": "Open notebooks.", + "id": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks", "properties": { - "datapoints": { - "description": "The result list of datapoints.", - "type": "array", + "notebooks": { + "description": "Required. Regional resource references to notebooks.", "items": { - "$ref": "GoogleCloudAiplatformV1IndexDatapoint" - } + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MetadataStore": { - "id": "GoogleCloudAiplatformV1MetadataStore", - "description": "Instance of a metadata store. Contains a set of metadata that can be queried.", - "type": "object", + "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences": { + "description": "The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc..", + "id": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", "properties": { - "name": { - "description": "Output only. The resource name of the MetadataStore instance.", - "readOnly": true, - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp when this MetadataStore was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "colabNotebookDisabled": { + "description": "Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the \"open notebook\" dialog in UI.", + "type": "boolean" }, - "updateTime": { - "description": "Output only. Timestamp when this MetadataStore was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "references": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1PublisherModelResourceReference" + }, + "description": "Required.", + "type": "object" }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" + "resourceDescription": { + "description": "Optional. Description of the resource.", + "type": "string" }, - "description": { - "description": "Description of the MetadataStore.", + "resourceTitle": { + "description": "Optional. Title of the resource.", "type": "string" }, - "state": { - "description": "Output only. State information of the MetadataStore.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1MetadataStoreMetadataStoreState" + "resourceUseCase": { + "description": "Optional. Use case (CUJ) of the resource.", + "type": "string" }, - "dataplexConfig": { - "description": "Optional. Dataplex integration settings.", - "$ref": "GoogleCloudAiplatformV1MetadataStoreDataplexConfig" - } - } - }, - "GoogleCloudAiplatformV1MetadataStoreMetadataStoreState": { - "id": "GoogleCloudAiplatformV1MetadataStoreMetadataStoreState", - "description": "Represents state information for a MetadataStore.", - "type": "object", - "properties": { - "diskUtilizationBytes": { - "description": "The disk utilization of the MetadataStore in bytes.", - "type": "string", - "format": "int64" - } - } - }, - "GoogleCloudAiplatformV1MetadataStoreDataplexConfig": { - "id": "GoogleCloudAiplatformV1MetadataStoreDataplexConfig", - "description": "Represents Dataplex integration settings.", - "type": "object", - "properties": { - "enabledPipelinesLineage": { - "description": "Optional. Whether or not Data Lineage synchronization is enabled for Vertex Pipelines.", + "supportsWorkbench": { + "description": "Optional. For notebook resource, whether the notebook supports Workbench.", "type": "boolean" + }, + "title": { + "description": "Required. ", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListMetadataStoresResponse": { - "id": "GoogleCloudAiplatformV1ListMetadataStoresResponse", - "description": "Response message for MetadataService.ListMetadataStores.", - "type": "object", + "GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi": { + "description": "Rest API docs.", + "id": "GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi", "properties": { - "metadataStores": { - "description": "The MetadataStores found for the Location.", - "type": "array", + "documentations": { + "description": "Required.", "items": { - "$ref": "GoogleCloudAiplatformV1MetadataStore" - } + "$ref": "GoogleCloudAiplatformV1PublisherModelDocumentation" + }, + "type": "array" }, - "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.", + "title": { + "description": "Required. The title of the view rest API.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Artifact": { - "id": "GoogleCloudAiplatformV1Artifact", - "description": "Instance of a general artifact.", - "type": "object", + "GoogleCloudAiplatformV1PublisherModelDocumentation": { + "description": "A named piece of documentation.", + "id": "GoogleCloudAiplatformV1PublisherModelDocumentation", "properties": { - "name": { - "description": "Output only. The resource name of the Artifact.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "User provided display name of the Artifact. May be up to 128 Unicode characters.", + "content": { + "description": "Required. Content of this piece of document (in Markdown format).", "type": "string" }, - "uri": { - "description": "The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.", + "title": { + "description": "Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA, NODE.JS, etc..", "type": "string" - }, - "etag": { - "description": "An eTag used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PublisherModelResourceReference": { + "description": "Reference to a resource.", + "id": "GoogleCloudAiplatformV1PublisherModelResourceReference", + "properties": { + "description": { + "deprecated": true, + "description": "Description of the resource.", "type": "string" }, - "labels": { - "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).", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "createTime": { - "description": "Output only. Timestamp when this Artifact was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this Artifact was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "state": { - "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.", - "type": "string", - "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." - ], - "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "LIVE" - ] - }, - "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.", + "resourceName": { + "description": "The resource name of the Google Cloud resource.", "type": "string" }, - "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.", + "uri": { + "description": "The URI of the resource.", "type": "string" }, - "metadata": { - "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.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } - }, - "description": { - "description": "Description of the Artifact", + "useCase": { + "deprecated": true, + "description": "Use case (CUJ) of the resource.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListArtifactsResponse": { - "id": "GoogleCloudAiplatformV1ListArtifactsResponse", - "description": "Response message for MetadataService.ListArtifacts.", - "type": "object", + "GoogleCloudAiplatformV1PurgeArtifactsMetadata": { + "description": "Details of operations that perform MetadataService.PurgeArtifacts.", + "id": "GoogleCloudAiplatformV1PurgeArtifactsMetadata", "properties": { - "artifacts": { - "description": "The Artifacts retrieved from the MetadataStore.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Artifact" - } - }, - "nextPageToken": { - "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.", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for purging Artifacts." } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1PurgeArtifactsRequest": { - "id": "GoogleCloudAiplatformV1PurgeArtifactsRequest", "description": "Request message for MetadataService.PurgeArtifacts.", - "type": "object", + "id": "GoogleCloudAiplatformV1PurgeArtifactsRequest", "properties": { "filter": { - "description": "Required. A required filter matching the Artifacts to be purged. E.g., `update_time \u003c= 2020-11-19T11:30:00-04:00`.", + "description": "Required. A required filter matching the Artifacts to be purged. E.g., `update_time <= 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 Artifact names that would be deleted.", "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Context": { - "id": "GoogleCloudAiplatformV1Context", - "description": "Instance of a general context.", - "type": "object", + "GoogleCloudAiplatformV1PurgeArtifactsResponse": { + "description": "Response message for MetadataService.PurgeArtifacts.", + "id": "GoogleCloudAiplatformV1PurgeArtifactsResponse", "properties": { - "name": { - "description": "Immutable. The resource name of the Context.", - "type": "string" - }, - "displayName": { - "description": "User provided display name of the Context. 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.", + "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" }, - "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" - } - }, - "createTime": { - "description": "Output only. Timestamp when this Context was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this Context was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "parentContexts": { - "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.", - "readOnly": true, - "type": "array", + "purgeSample": { + "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).", "items": { "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" - }, - "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" - }, - "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." - } - }, - "description": { - "description": "Description of the Context", - "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListContextsResponse": { - "id": "GoogleCloudAiplatformV1ListContextsResponse", - "description": "Response message for MetadataService.ListContexts.", - "type": "object", + "GoogleCloudAiplatformV1PurgeContextsMetadata": { + "description": "Details of operations that perform MetadataService.PurgeContexts.", + "id": "GoogleCloudAiplatformV1PurgeContextsMetadata", "properties": { - "contexts": { - "description": "The Contexts retrieved from the MetadataStore.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Context" - } - }, - "nextPageToken": { - "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.", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for purging Contexts." } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1PurgeContextsRequest": { - "id": "GoogleCloudAiplatformV1PurgeContextsRequest", "description": "Request message for MetadataService.PurgeContexts.", - "type": "object", + "id": "GoogleCloudAiplatformV1PurgeContextsRequest", "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`.", + "description": "Required. A required filter matching the Contexts to be purged. E.g., `update_time <= 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 Context names that would be deleted.", "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest": { - "id": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest", - "description": "Request message for MetadataService.AddContextArtifactsAndExecutions.", - "type": "object", + "GoogleCloudAiplatformV1PurgeContextsResponse": { + "description": "Response message for MetadataService.PurgeContexts.", + "id": "GoogleCloudAiplatformV1PurgeContextsResponse", "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" - } + "purgeCount": { + "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.", + "format": "int64", + "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", + "purgeSample": { + "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).", "items": { "type": "string" - } + }, + "type": "array" } - } - }, - "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse": { - "id": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse", - "description": "Response message for MetadataService.AddContextArtifactsAndExecutions.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1AddContextChildrenRequest": { - "id": "GoogleCloudAiplatformV1AddContextChildrenRequest", - "description": "Request message for MetadataService.AddContextChildren.", - "type": "object", + "GoogleCloudAiplatformV1PurgeExecutionsMetadata": { + "description": "Details of operations that perform MetadataService.PurgeExecutions.", + "id": "GoogleCloudAiplatformV1PurgeExecutionsMetadata", "properties": { - "childContexts": { - "description": "The resource names of the child Contexts.", - "type": "array", - "items": { - "type": "string" - } + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for purging Executions." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AddContextChildrenResponse": { - "id": "GoogleCloudAiplatformV1AddContextChildrenResponse", - "description": "Response message for MetadataService.AddContextChildren.", - "type": "object", - "properties": {} + "GoogleCloudAiplatformV1PurgeExecutionsRequest": { + "description": "Request message for MetadataService.PurgeExecutions.", + "id": "GoogleCloudAiplatformV1PurgeExecutionsRequest", + "properties": { + "filter": { + "description": "Required. A required filter matching the Executions to be purged. E.g., `update_time <= 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" }, - "GoogleCloudAiplatformV1RemoveContextChildrenRequest": { - "id": "GoogleCloudAiplatformV1RemoveContextChildrenRequest", - "description": "Request message for MetadataService.DeleteContextChildrenRequest.", - "type": "object", + "GoogleCloudAiplatformV1PurgeExecutionsResponse": { + "description": "Response message for MetadataService.PurgeExecutions.", + "id": "GoogleCloudAiplatformV1PurgeExecutionsResponse", "properties": { - "childContexts": { - "description": "The resource names of the child Contexts.", - "type": "array", + "purgeCount": { + "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.", + "format": "int64", + "type": "string" + }, + "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" } - } - }, - "GoogleCloudAiplatformV1RemoveContextChildrenResponse": { - "id": "GoogleCloudAiplatformV1RemoveContextChildrenResponse", - "description": "Response message for MetadataService.RemoveContextChildren.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1LineageSubgraph": { - "id": "GoogleCloudAiplatformV1LineageSubgraph", - "description": "A subgraph of the overall lineage graph. Event edges connect Artifact and Execution nodes.", - "type": "object", + "GoogleCloudAiplatformV1PurgeMemoriesRequest": { + "description": "Request message for MemoryBankService.PurgeMemories.", + "id": "GoogleCloudAiplatformV1PurgeMemoriesRequest", "properties": { - "artifacts": { - "description": "The Artifact nodes in the subgraph.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Artifact" - } + "filter": { + "description": "Required. The standard list filter to determine which memories to purge. More detail in [AIP-160](https://google.aip.dev/160).", + "type": "string" }, - "executions": { - "description": "The Execution nodes in the subgraph.", - "type": "array", + "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\"))`.", "items": { - "$ref": "GoogleCloudAiplatformV1Execution" - } + "$ref": "GoogleCloudAiplatformV1MemoryConjunctionFilter" + }, + "type": "array" }, - "events": { - "description": "The Event edges between Artifacts and Executions in the subgraph.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Event" - } + "force": { + "description": "Optional. If true, the memories will actually be purged. If false, the purge request will be validated but not executed.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Execution": { - "id": "GoogleCloudAiplatformV1Execution", - "description": "Instance of a general execution.", - "type": "object", + "GoogleCloudAiplatformV1PythonPackageSpec": { + "description": "The spec of a Python packaged code.", + "id": "GoogleCloudAiplatformV1PythonPackageSpec", "properties": { - "name": { - "description": "Output only. The resource name of the Execution.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "User provided display name of the Execution. May be up to 128 Unicode characters.", - "type": "string" - }, - "state": { - "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.", - "type": "string", - "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." - ], - "enum": [ - "STATE_UNSPECIFIED", - "NEW", - "RUNNING", - "COMPLETE", - "FAILED", - "CACHED", - "CANCELLED" - ] - }, - "etag": { - "description": "An eTag used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", - "type": "string" - }, - "labels": { - "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", - "additionalProperties": { + "args": { + "description": "Command line arguments to be passed to the Python task.", + "items": { "type": "string" - } - }, - "createTime": { - "description": "Output only. Timestamp when this Execution was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this Execution was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + }, + "type": "array" }, - "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" + "env": { + "description": "Environment variables to be passed to the python module. Maximum limit is 100.", + "items": { + "$ref": "GoogleCloudAiplatformV1EnvVar" + }, + "type": "array" }, - "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.", + "executorImageUri": { + "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.", "type": "string" }, - "metadata": { - "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.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } + "packageUris": { + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "description": { - "description": "Description of the Execution", + "pythonModule": { + "description": "Required. The Python module name to run after installing the packages.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Event": { - "id": "GoogleCloudAiplatformV1Event", - "description": "An edge describing the relationship between an Artifact and an Execution in a lineage graph.", - "type": "object", + "GoogleCloudAiplatformV1QueryDeployedModelsResponse": { + "description": "Response message for QueryDeployedModels method.", + "id": "GoogleCloudAiplatformV1QueryDeployedModelsResponse", "properties": { - "artifact": { - "description": "Required. The relative resource name of the Artifact in the Event.", - "type": "string" - }, - "execution": { - "description": "Output only. The relative resource name of the Execution in the Event.", - "readOnly": true, - "type": "string" - }, - "eventTime": { - "description": "Output only. Time the Event occurred.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "type": { - "description": "Required. The type of the Event.", - "type": "string", - "enumDescriptions": [ - "Unspecified whether input or output of the Execution.", - "An input of the Execution.", - "An output of the Execution." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "INPUT", - "OUTPUT" - ] + "deployedModelRefs": { + "description": "References to the DeployedModels that share the specified deploymentResourcePool.", + "items": { + "$ref": "GoogleCloudAiplatformV1DeployedModelRef" + }, + "type": "array" }, - "labels": { - "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": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1ListExecutionsResponse": { - "id": "GoogleCloudAiplatformV1ListExecutionsResponse", - "description": "Response message for MetadataService.ListExecutions.", - "type": "object", - "properties": { - "executions": { - "description": "The Executions retrieved from the MetadataStore.", - "type": "array", + "deployedModels": { + "deprecated": true, + "description": "DEPRECATED Use deployed_model_refs instead.", "items": { - "$ref": "GoogleCloudAiplatformV1Execution" - } + "$ref": "GoogleCloudAiplatformV1DeployedModel" + }, + "type": "array" }, "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.", + "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" + }, + "totalDeployedModelCount": { + "description": "The total number of DeployedModels on this DeploymentResourcePool.", + "format": "int32", + "type": "integer" + }, + "totalEndpointCount": { + "description": "The total number of Endpoints that have DeployedModels on this DeploymentResourcePool.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PurgeExecutionsRequest": { - "id": "GoogleCloudAiplatformV1PurgeExecutionsRequest", - "description": "Request message for MetadataService.PurgeExecutions.", - "type": "object", + "GoogleCloudAiplatformV1QueryReasoningEngineRequest": { + "description": "Request message for ReasoningEngineExecutionService.Query.", + "id": "GoogleCloudAiplatformV1QueryReasoningEngineRequest", "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`.", + "classMethod": { + "description": "Optional. Class method to be used for the query. It is optional and defaults to \"query\" if unspecified.", "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" + "input": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AddExecutionEventsRequest": { - "id": "GoogleCloudAiplatformV1AddExecutionEventsRequest", - "description": "Request message for MetadataService.AddExecutionEvents.", - "type": "object", + "GoogleCloudAiplatformV1QueryReasoningEngineResponse": { + "description": "Response message for ReasoningEngineExecutionService.Query", + "id": "GoogleCloudAiplatformV1QueryReasoningEngineResponse", "properties": { - "events": { - "description": "The Events to create and add.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Event" - } + "output": { + "description": "Response provided by users in JSON object format.", + "type": "any" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AddExecutionEventsResponse": { - "id": "GoogleCloudAiplatformV1AddExecutionEventsResponse", - "description": "Response message for MetadataService.AddExecutionEvents.", - "type": "object", - "properties": {} + "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput": { + "description": "Input for question answering correctness metric.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance", + "description": "Required. Question answering correctness instance." + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec", + "description": "Required. Spec for question answering correctness score metric." + } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MetadataSchema": { - "id": "GoogleCloudAiplatformV1MetadataSchema", - "description": "Instance of a general MetadataSchema.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance": { + "description": "Spec for question answering correctness instance.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance", "properties": { - "name": { - "description": "Output only. The resource name of the MetadataSchema.", - "readOnly": true, + "context": { + "description": "Optional. Text provided as context to answer the question.", "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.", + "instruction": { + "description": "Required. The question asked and other instruction in the inference prompt.", "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)", + "prediction": { + "description": "Required. Output of the evaluated model.", "type": "string" }, - "schemaType": { - "description": "The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.", - "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." - ], - "enum": [ - "METADATA_SCHEMA_TYPE_UNSPECIFIED", - "ARTIFACT_TYPE", - "EXECUTION_TYPE", - "CONTEXT_TYPE" - ] - }, - "createTime": { - "description": "Output only. Timestamp when this MetadataSchema was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "description": { - "description": "Description of the Metadata Schema", + "reference": { + "description": "Optional. Ground truth used to compare against the prediction.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListMetadataSchemasResponse": { - "id": "GoogleCloudAiplatformV1ListMetadataSchemasResponse", - "description": "Response message for MetadataService.ListMetadataSchemas.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult": { + "description": "Spec for question answering correctness result.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult", "properties": { - "metadataSchemas": { - "description": "The MetadataSchemas found for the MetadataStore.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1MetadataSchema" - } + "confidence": { + "description": "Output only. Confidence for question answering correctness score.", + "format": "float", + "readOnly": true, + "type": "number" }, - "nextPageToken": { - "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.", + "explanation": { + "description": "Output only. Explanation for question answering correctness score.", + "readOnly": true, "type": "string" + }, + "score": { + "description": "Output only. Question Answering Correctness score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SearchMigratableResourcesRequest": { - "id": "GoogleCloudAiplatformV1SearchMigratableResourcesRequest", - "description": "Request message for MigrationService.SearchMigratableResources.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec": { + "description": "Spec for question answering correctness metric.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec", "properties": { - "pageSize": { - "description": "The standard page size. The default and maximum value is 100.", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard page token.", - "type": "string" + "useReference": { + "description": "Optional. Whether to use instance.reference to compute question answering correctness.", + "type": "boolean" }, - "filter": { - "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.", - "type": "string" + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SearchMigratableResourcesResponse": { - "id": "GoogleCloudAiplatformV1SearchMigratableResourcesResponse", - "description": "Response message for MigrationService.SearchMigratableResources.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput": { + "description": "Input for question answering helpfulness metric.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput", "properties": { - "migratableResources": { - "description": "All migratable resources that can be migrated to the location specified in the request.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1MigratableResource" - } + "instance": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance", + "description": "Required. Question answering helpfulness instance." }, - "nextPageToken": { - "description": "The standard next-page token. The migratable_resources may not fill page_size in SearchMigratableResourcesRequest even when there are subsequent pages.", - "type": "string" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec", + "description": "Required. Spec for question answering helpfulness score metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigratableResource": { - "id": "GoogleCloudAiplatformV1MigratableResource", - "description": "Represents one resource that exists in automl.googleapis.com, datalabeling.googleapis.com or ml.googleapis.com.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance": { + "description": "Spec for question answering helpfulness instance.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance", "properties": { - "mlEngineModelVersion": { - "description": "Output only. Represents one Version in ml.googleapis.com.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion" + "context": { + "description": "Optional. Text provided as context to answer the question.", + "type": "string" }, - "automlModel": { - "description": "Output only. Represents one Model in automl.googleapis.com.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1MigratableResourceAutomlModel" + "instruction": { + "description": "Required. The question asked and other instruction in the inference prompt.", + "type": "string" }, - "automlDataset": { - "description": "Output only. Represents one Dataset in automl.googleapis.com.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1MigratableResourceAutomlDataset" + "prediction": { + "description": "Required. Output of the evaluated model.", + "type": "string" }, - "dataLabelingDataset": { - "description": "Output only. Represents one Dataset in datalabeling.googleapis.com.", + "reference": { + "description": "Optional. Ground truth used to compare against the prediction.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult": { + "description": "Spec for question answering helpfulness result.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult", + "properties": { + "confidence": { + "description": "Output only. Confidence for question answering helpfulness score.", + "format": "float", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset" + "type": "number" }, - "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.", + "explanation": { + "description": "Output only. Explanation for question answering helpfulness score.", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "string" }, - "lastUpdateTime": { - "description": "Output only. Timestamp when this MigratableResource was last updated.", + "score": { + "description": "Output only. Question Answering Helpfulness score.", + "format": "float", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion": { - "id": "GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion", - "description": "Represents one model Version in ml.googleapis.com.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec": { + "description": "Spec for question answering helpfulness metric.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec", "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" + "useReference": { + "description": "Optional. Whether to use instance.reference to compute question answering helpfulness.", + "type": "boolean" }, "version": { - "description": "Full resource name of ml engine model Version. Format: `projects/{project}/models/{model}/versions/{version}`.", - "type": "string" + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigratableResourceAutomlModel": { - "id": "GoogleCloudAiplatformV1MigratableResourceAutomlModel", - "description": "Represents one Model in automl.googleapis.com.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringQualityInput": { + "description": "Input for question answering quality metric.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringQualityInput", "properties": { - "model": { - "description": "Full resource name of automl Model. Format: `projects/{project}/locations/{location}/models/{model}`.", - "type": "string" + "instance": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringQualityInstance", + "description": "Required. Question answering quality instance." }, - "modelDisplayName": { - "description": "The Model's display name in automl.googleapis.com.", - "type": "string" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringQualitySpec", + "description": "Required. Spec for question answering quality score metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigratableResourceAutomlDataset": { - "id": "GoogleCloudAiplatformV1MigratableResourceAutomlDataset", - "description": "Represents one Dataset in automl.googleapis.com.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringQualityInstance": { + "description": "Spec for question answering quality instance.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringQualityInstance", "properties": { - "dataset": { - "description": "Full resource name of automl Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", + "context": { + "description": "Required. Text to answer the question.", "type": "string" }, - "datasetDisplayName": { - "description": "The Dataset's display name in automl.googleapis.com.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset": { - "id": "GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset", - "description": "Represents one Dataset in datalabeling.googleapis.com.", - "type": "object", - "properties": { - "dataset": { - "description": "Full resource name of data labeling Dataset. Format: `projects/{project}/datasets/{dataset}`.", + "instruction": { + "description": "Required. Question Answering prompt for LLM.", "type": "string" }, - "datasetDisplayName": { - "description": "The Dataset's display name in datalabeling.googleapis.com.", + "prediction": { + "description": "Required. Output of the evaluated model.", "type": "string" }, - "dataLabelingAnnotatedDatasets": { - "description": "The migratable AnnotatedDataset in datalabeling.googleapis.com belongs to the data labeling Dataset.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset" - } + "reference": { + "description": "Optional. Ground truth used to compare against the prediction.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset": { - "id": "GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset", - "description": "Represents one AnnotatedDataset in datalabeling.googleapis.com.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringQualityResult": { + "description": "Spec for question answering quality result.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringQualityResult", "properties": { - "annotatedDataset": { - "description": "Full resource name of data labeling AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.", - "type": "string" + "confidence": { + "description": "Output only. Confidence for question answering quality score.", + "format": "float", + "readOnly": true, + "type": "number" }, - "annotatedDatasetDisplayName": { - "description": "The AnnotatedDataset's display name in datalabeling.googleapis.com.", + "explanation": { + "description": "Output only. Explanation for question answering quality score.", + "readOnly": true, "type": "string" + }, + "score": { + "description": "Output only. Question Answering Quality score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchMigrateResourcesRequest": { - "id": "GoogleCloudAiplatformV1BatchMigrateResourcesRequest", - "description": "Request message for MigrationService.BatchMigrateResources.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringQualitySpec": { + "description": "Spec for question answering quality score metric.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringQualitySpec", "properties": { - "migrateResourceRequests": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1MigrateResourceRequest" - } + "useReference": { + "description": "Optional. Whether to use instance.reference to compute question answering quality.", + "type": "boolean" + }, + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigrateResourceRequest": { - "id": "GoogleCloudAiplatformV1MigrateResourceRequest", - "description": "Config of migrating one resource from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput": { + "description": "Input for question answering relevance metric.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput", "properties": { - "migrateMlEngineModelVersionConfig": { - "description": "Config for migrating Version in ml.googleapis.com to Vertex AI's Model.", - "$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig" - }, - "migrateAutomlModelConfig": { - "description": "Config for migrating Model in automl.googleapis.com to Vertex AI's Model.", - "$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig" - }, - "migrateAutomlDatasetConfig": { - "description": "Config for migrating Dataset in automl.googleapis.com to Vertex AI's Dataset.", - "$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig" + "instance": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance", + "description": "Required. Question answering relevance instance." }, - "migrateDataLabelingDatasetConfig": { - "description": "Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI's Dataset.", - "$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec", + "description": "Required. Spec for question answering relevance score metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig": { - "id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig", - "description": "Config for migrating version in ml.googleapis.com to Vertex AI's Model.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance": { + "description": "Spec for question answering relevance instance.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance", "properties": { - "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", + "context": { + "description": "Optional. Text provided as context to answer the question.", "type": "string" }, - "modelVersion": { - "description": "Required. Full resource name of ml engine model version. Format: `projects/{project}/models/{model}/versions/{version}`.", + "instruction": { + "description": "Required. The question asked and other instruction in the inference prompt.", "type": "string" }, - "modelDisplayName": { - "description": "Required. Display name of the model in Vertex AI. System will pick a display name if unspecified.", + "prediction": { + "description": "Required. Output of the evaluated model.", + "type": "string" + }, + "reference": { + "description": "Optional. Ground truth used to compare against the prediction.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig": { - "id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig", - "description": "Config for migrating Model in automl.googleapis.com to Vertex AI's Model.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult": { + "description": "Spec for question answering relevance result.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult", "properties": { - "model": { - "description": "Required. Full resource name of automl Model. Format: `projects/{project}/locations/{location}/models/{model}`.", - "type": "string" + "confidence": { + "description": "Output only. Confidence for question answering relevance score.", + "format": "float", + "readOnly": true, + "type": "number" }, - "modelDisplayName": { - "description": "Optional. Display name of the model in Vertex AI. System will pick a display name if unspecified.", + "explanation": { + "description": "Output only. Explanation for question answering relevance score.", + "readOnly": true, "type": "string" + }, + "score": { + "description": "Output only. Question Answering Relevance score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig": { - "id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig", - "description": "Config for migrating Dataset in automl.googleapis.com to Vertex AI's Dataset.", - "type": "object", + "GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec": { + "description": "Spec for question answering relevance metric.", + "id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec", "properties": { - "dataset": { - "description": "Required. Full resource name of automl Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", - "type": "string" + "useReference": { + "description": "Optional. Whether to use instance.reference to compute question answering relevance.", + "type": "boolean" }, - "datasetDisplayName": { - "description": "Required. Display name of the Dataset in Vertex AI. System will pick a display name if unspecified.", - "type": "string" + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig": { - "id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig", - "description": "Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI's Dataset.", - "type": "object", + "GoogleCloudAiplatformV1RagChunk": { + "description": "A RagChunk includes the content of a chunk of a RagFile, and associated metadata.", + "id": "GoogleCloudAiplatformV1RagChunk", "properties": { - "dataset": { - "description": "Required. Full resource name of data labeling Dataset. Format: `projects/{project}/datasets/{dataset}`.", - "type": "string" + "pageSpan": { + "$ref": "GoogleCloudAiplatformV1RagChunkPageSpan", + "description": "If populated, represents where the chunk starts and ends in the document." }, - "datasetDisplayName": { - "description": "Optional. Display name of the Dataset in Vertex AI. System will pick a display name if unspecified.", + "text": { + "description": "The content of the chunk.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RagChunkPageSpan": { + "description": "Represents where the chunk starts and ends in the document.", + "id": "GoogleCloudAiplatformV1RagChunkPageSpan", + "properties": { + "firstPage": { + "description": "Page where chunk starts in the document. Inclusive. 1-indexed.", + "format": "int32", + "type": "integer" }, - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig" - } + "lastPage": { + "description": "Page where chunk ends in the document. Inclusive. 1-indexed.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig": { - "id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig", - "description": "Config for migrating AnnotatedDataset in datalabeling.googleapis.com to Vertex AI's SavedQuery.", - "type": "object", + "GoogleCloudAiplatformV1RagContexts": { + "description": "Relevant contexts for one query.", + "id": "GoogleCloudAiplatformV1RagContexts", "properties": { - "annotatedDataset": { - "description": "Required. Full resource name of data labeling AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.", - "type": "string" + "contexts": { + "description": "All its contexts.", + "items": { + "$ref": "GoogleCloudAiplatformV1RagContextsContext" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UploadModelRequest": { - "id": "GoogleCloudAiplatformV1UploadModelRequest", - "description": "Request message for ModelService.UploadModel.", - "type": "object", + "GoogleCloudAiplatformV1RagContextsContext": { + "description": "A context of the query.", + "id": "GoogleCloudAiplatformV1RagContextsContext", "properties": { - "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" + "chunk": { + "$ref": "GoogleCloudAiplatformV1RagChunk", + "description": "Context of the retrieved chunk." }, - "modelId": { - "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.", + "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" + }, + "sourceDisplayName": { + "description": "The file display name.", "type": "string" }, - "model": { - "description": "Required. The Model to create.", - "$ref": "GoogleCloudAiplatformV1Model" + "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" }, - "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.).", + "text": { + "description": "The text chunk.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Model": { - "id": "GoogleCloudAiplatformV1Model", - "description": "A trained machine learning Model.", - "type": "object", + "GoogleCloudAiplatformV1RagCorpus": { + "description": "A RagCorpus is a RagFile container and a project can have multiple RagCorpora.", + "id": "GoogleCloudAiplatformV1RagCorpus", "properties": { - "name": { - "description": "The resource name of the Model.", - "type": "string" - }, - "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" - }, - "versionAliases": { - "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.", - "type": "array", - "items": { - "type": "string" - } - }, - "versionCreateTime": { - "description": "Output only. Timestamp when this version was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "versionUpdateTime": { - "description": "Output only. Timestamp when this version was most recently updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "corpusStatus": { + "$ref": "GoogleCloudAiplatformV1CorpusStatus", + "description": "Output only. RagCorpus state.", + "readOnly": true }, - "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.", + "createTime": { + "description": "Output only. Timestamp when this RagCorpus was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, "description": { - "description": "The description of the Model.", - "type": "string" - }, - "versionDescription": { - "description": "The description of this version.", + "description": "Optional. The description of the RagCorpus.", "type": "string" }, - "defaultCheckpointId": { - "description": "The default checkpoint id of a model version.", + "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" }, - "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": "GoogleCloudAiplatformV1PredictSchemata" + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "metadataSchemaUri": { - "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.", + "name": { + "description": "Output only. The resource name of the RagCorpus.", + "readOnly": true, "type": "string" }, - "metadata": { - "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.", - "type": "any" - }, - "supportedExportFormats": { - "description": "Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.", + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModelExportFormat" - } + "type": "boolean" }, - "trainingPipeline": { - "description": "Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.", + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", "readOnly": true, - "type": "string" + "type": "boolean" }, - "pipelineJob": { - "description": "Optional. This field is populated if the model is produced by a pipeline job.", + "updateTime": { + "description": "Output only. Timestamp when this RagCorpus was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "containerSpec": { - "description": "Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models.", - "$ref": "GoogleCloudAiplatformV1ModelContainerSpec" + "vectorDbConfig": { + "$ref": "GoogleCloudAiplatformV1RagVectorDbConfig", + "description": "Optional. Immutable. The config for the Vector DBs." }, - "artifactUri": { - "description": "Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.", + "vertexAiSearchConfig": { + "$ref": "GoogleCloudAiplatformV1VertexAiSearchConfig", + "description": "Optional. Immutable. The config for the Vertex AI Search." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RagEmbeddingModelConfig": { + "description": "Config for the embedding model to use for RAG.", + "id": "GoogleCloudAiplatformV1RagEmbeddingModelConfig", + "properties": { + "vertexPredictionEndpoint": { + "$ref": "GoogleCloudAiplatformV1RagEmbeddingModelConfigVertexPredictionEndpoint", + "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." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RagEmbeddingModelConfigVertexPredictionEndpoint": { + "description": "Config representing a model hosted on Vertex Prediction Endpoint.", + "id": "GoogleCloudAiplatformV1RagEmbeddingModelConfigVertexPredictionEndpoint", + "properties": { + "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" }, - "supportedDeploymentResourcesTypes": { - "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, - "type": "array", - "items": { - "type": "string", - "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" - ] - } - }, - "supportedInputStorageFormats": { - "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.", + "model": { + "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": "array", - "items": { - "type": "string" - } + "type": "string" }, - "supportedOutputStorageFormats": { - "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.", + "modelVersionId": { + "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, - "type": "array", - "items": { - "type": "string" - } + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RagEngineConfig": { + "description": "Config for RagEngine.", + "id": "GoogleCloudAiplatformV1RagEngineConfig", + "properties": { + "name": { + "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "type": "string" }, + "ragManagedDbConfig": { + "$ref": "GoogleCloudAiplatformV1RagManagedDbConfig", + "description": "The config of the RagManagedDb used by RagEngine." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RagFile": { + "description": "A RagFile contains user data for chunking, embedding and indexing.", + "id": "GoogleCloudAiplatformV1RagFile", + "properties": { "createTime": { - "description": "Output only. Timestamp when this Model was uploaded into Vertex AI.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this Model was most recently updated.", + "description": "Output only. Timestamp when this RagFile was created.", + "format": "google-datetime", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "string" }, - "deployedModels": { - "description": "Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1DeployedModelRef" - } + "description": { + "description": "Optional. The description of the RagFile.", + "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": "GoogleCloudAiplatformV1ExplanationSpec" + "directUploadSource": { + "$ref": "GoogleCloudAiplatformV1DirectUploadSource", + "description": "Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.", + "readOnly": true }, - "etag": { - "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "displayName": { + "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.", "type": "string" }, - "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" - } - }, - "dataStats": { - "description": "Stats of data used for training or evaluating the Model. Only populated when the Model is trained by a TrainingPipeline with data_input_config.", - "$ref": "GoogleCloudAiplatformV1ModelDataStats" + "fileStatus": { + "$ref": "GoogleCloudAiplatformV1FileStatus", + "description": "Output only. State of the RagFile.", + "readOnly": true }, - "encryptionSpec": { - "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.", - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1GcsSource", + "description": "Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.", + "readOnly": true }, - "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.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1ModelSourceInfo" + "googleDriveSource": { + "$ref": "GoogleCloudAiplatformV1GoogleDriveSource", + "description": "Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.", + "readOnly": true }, - "originalModelInfo": { - "description": "Output only. If this Model is a copy of another Model, this contains info about the original.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1ModelOriginalModelInfo" + "jiraSource": { + "$ref": "GoogleCloudAiplatformV1JiraSource", + "description": "The RagFile is imported from a Jira query." }, - "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}`.", + "name": { + "description": "Output only. The resource name of the RagFile.", "readOnly": true, "type": "string" }, - "baseModelSource": { - "description": "Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.", - "$ref": "GoogleCloudAiplatformV1ModelBaseModelSource" - }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "sharePointSources": { + "$ref": "GoogleCloudAiplatformV1SharePointSources", + "description": "The RagFile is imported from a SharePoint source." }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "slackSource": { + "$ref": "GoogleCloudAiplatformV1SlackSource", + "description": "The RagFile is imported from a Slack channel." }, - "checkpoints": { - "description": "Optional. Output only. The checkpoints of the model.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Checkpoint" - } - } - } - }, - "GoogleCloudAiplatformV1ModelExportFormat": { - "id": "GoogleCloudAiplatformV1ModelExportFormat", - "description": "Represents export format supported by the Model. All formats export to Google Cloud Storage.", - "type": "object", - "properties": { - "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.", + "updateTime": { + "description": "Output only. Timestamp when this RagFile was last updated.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "exportableContents": { - "description": "Output only. The content of this Model that may be exported.", + "userMetadata": { + "description": "Output only. The metadata for metadata search. The user_metadata Needs to be in JSON format.", "readOnly": true, - "type": "array", - "items": { - "type": "string", - "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." - ], - "enum": [ - "EXPORTABLE_CONTENT_UNSPECIFIED", - "ARTIFACT", - "IMAGE" - ] - } + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelDataStats": { - "id": "GoogleCloudAiplatformV1ModelDataStats", - "description": "Stats of data used for train or evaluate the Model.", - "type": "object", + "GoogleCloudAiplatformV1RagFileChunkingConfig": { + "description": "Specifies the size and overlap of chunks for RagFiles.", + "id": "GoogleCloudAiplatformV1RagFileChunkingConfig", "properties": { - "trainingDataItemsCount": { - "description": "Number of DataItems that were used for training this Model.", - "type": "string", - "format": "int64" - }, - "validationDataItemsCount": { - "description": "Number of DataItems that were used for validating this Model during training.", - "type": "string", - "format": "int64" - }, - "testDataItemsCount": { - "description": "Number of DataItems that were used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test DataItems used by the first evaluation. If the Model is not evaluated, the number is 0.", - "type": "string", - "format": "int64" - }, - "trainingAnnotationsCount": { - "description": "Number of Annotations that are used for training this Model.", - "type": "string", - "format": "int64" - }, - "validationAnnotationsCount": { - "description": "Number of Annotations that are used for validating this Model during training.", - "type": "string", - "format": "int64" - }, - "testAnnotationsCount": { - "description": "Number of Annotations that are used for evaluating this Model. If the Model is evaluated multiple times, this will be the number of test Annotations used by the first evaluation. If the Model is not evaluated, the number is 0.", - "type": "string", - "format": "int64" + "fixedLengthChunking": { + "$ref": "GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking", + "description": "Specifies the fixed length chunking config." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelSourceInfo": { - "id": "GoogleCloudAiplatformV1ModelSourceInfo", - "description": "Detail description of the source information of the model.", - "type": "object", + "GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking": { + "description": "Specifies the fixed length chunking config.", + "id": "GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking", "properties": { - "sourceType": { - "description": "Type of the model source.", - "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" - ] + "chunkOverlap": { + "description": "The overlap between chunks.", + "format": "int32", + "type": "integer" }, - "copy": { - "description": "If this Model is copy of another Model. If true then source_type pertains to the original.", - "type": "boolean" + "chunkSize": { + "description": "The size of the chunks.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelOriginalModelInfo": { - "id": "GoogleCloudAiplatformV1ModelOriginalModelInfo", - "description": "Contains information about the original Model if this Model is a copy.", - "type": "object", + "GoogleCloudAiplatformV1RagFileParsingConfig": { + "description": "Specifies the parsing config for RagFiles.", + "id": "GoogleCloudAiplatformV1RagFileParsingConfig", "properties": { - "model": { - "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}`", - "readOnly": true, - "type": "string" + "layoutParser": { + "$ref": "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser", + "description": "The Layout Parser to use for RagFiles." + }, + "llmParser": { + "$ref": "GoogleCloudAiplatformV1RagFileParsingConfigLlmParser", + "description": "The LLM Parser to use for RagFiles." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelBaseModelSource": { - "id": "GoogleCloudAiplatformV1ModelBaseModelSource", - "description": "User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.", - "type": "object", + "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser": { + "description": "Document AI Layout Parser config.", + "id": "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser", "properties": { - "modelGardenSource": { - "description": "Source information of Model Garden models.", - "$ref": "GoogleCloudAiplatformV1ModelGardenSource" + "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" }, - "genieSource": { - "description": "Information about the base model of Genie models.", - "$ref": "GoogleCloudAiplatformV1GenieSource" + "processorName": { + "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}`", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelGardenSource": { - "id": "GoogleCloudAiplatformV1ModelGardenSource", - "description": "Contains information about the source of the models generated from Model Garden.", - "type": "object", + "GoogleCloudAiplatformV1RagFileParsingConfigLlmParser": { + "description": "Specifies the LLM parsing for RagFiles.", + "id": "GoogleCloudAiplatformV1RagFileParsingConfigLlmParser", "properties": { - "publicModelName": { - "description": "Required. The model garden source model resource name.", + "customParsingPrompt": { + "description": "The prompt to use for parsing. If not specified, a default prompt will be used.", "type": "string" }, - "versionId": { - "description": "Optional. The model garden source model version ID.", - "type": "string" + "maxParsingRequestsPerMin": { + "description": "The maximum number of requests the job is allowed to make to the LLM model per minute. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If unspecified, a default value of 5000 QPM would be used.", + "format": "int32", + "type": "integer" }, - "skipHfModelCache": { - "description": "Optional. Whether to avoid pulling the model from the HF cache.", - "type": "boolean" + "modelName": { + "description": "The name of a LLM model used for parsing. Format: * `projects/{project_id}/locations/{location}/publishers/{publisher}/models/{model}`", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenieSource": { - "id": "GoogleCloudAiplatformV1GenieSource", - "description": "Contains information about the source of the models generated from Generative AI Studio.", - "type": "object", + "GoogleCloudAiplatformV1RagFileTransformationConfig": { + "description": "Specifies the transformation config for RagFiles.", + "id": "GoogleCloudAiplatformV1RagFileTransformationConfig", "properties": { - "baseModelUri": { - "description": "Required. The public base model URI.", - "type": "string" + "ragFileChunkingConfig": { + "$ref": "GoogleCloudAiplatformV1RagFileChunkingConfig", + "description": "Specifies the chunking config for RagFiles." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Checkpoint": { - "id": "GoogleCloudAiplatformV1Checkpoint", - "description": "Describes the machine learning model version checkpoint.", - "type": "object", + "GoogleCloudAiplatformV1RagManagedDbConfig": { + "description": "Configuration message for RagManagedDb used by RagEngine.", + "id": "GoogleCloudAiplatformV1RagManagedDbConfig", "properties": { - "checkpointId": { - "description": "The ID of the checkpoint.", - "type": "string" + "basic": { + "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigBasic", + "deprecated": true, + "description": "Deprecated: Use `mode` instead to set the tier under Spanner. Sets the RagManagedDb to the Basic tier." }, - "epoch": { - "description": "The epoch of the checkpoint.", - "type": "string", - "format": "int64" + "scaled": { + "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigScaled", + "deprecated": true, + "description": "Deprecated: Use `mode` instead to set the tier under Spanner. Sets the RagManagedDb to the Scaled tier." }, - "step": { - "description": "The step of the checkpoint.", - "type": "string", - "format": "int64" + "serverless": { + "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigServerless", + "description": "Sets the backend to be the serverless mode offered by RAG Engine." + }, + "spanner": { + "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigSpanner", + "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." + }, + "unprovisioned": { + "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned", + "deprecated": true, + "description": "Deprecated: Use `mode` instead to set the tier under Spanner. Sets the RagManagedDb to the Unprovisioned tier." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListModelsResponse": { - "id": "GoogleCloudAiplatformV1ListModelsResponse", - "description": "Response message for ModelService.ListModels", - "type": "object", + "GoogleCloudAiplatformV1RagManagedDbConfigBasic": { + "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.", + "id": "GoogleCloudAiplatformV1RagManagedDbConfigBasic", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1RagManagedDbConfigScaled": { + "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": "GoogleCloudAiplatformV1RagManagedDbConfigScaled", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1RagManagedDbConfigServerless": { + "description": "Message to configure the serverless mode offered by RAG Engine.", + "id": "GoogleCloudAiplatformV1RagManagedDbConfigServerless", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1RagManagedDbConfigSpanner": { + "description": "Message to configure the Spanner database used by RagManagedDb.", + "id": "GoogleCloudAiplatformV1RagManagedDbConfigSpanner", "properties": { - "models": { - "description": "List of Models in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Model" - } + "basic": { + "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigBasic", + "description": "Sets the RagManagedDb to the Basic tier. This is the default tier for Spanner mode if not explicitly chosen." }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass to ListModelsRequest.page_token to obtain that page.", - "type": "string" + "scaled": { + "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigScaled", + "description": "Sets the RagManagedDb to the Scaled tier." + }, + "unprovisioned": { + "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned", + "description": "Sets the RagManagedDb to the Unprovisioned tier." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListModelVersionsResponse": { - "id": "GoogleCloudAiplatformV1ListModelVersionsResponse", - "description": "Response message for ModelService.ListModelVersions", - "type": "object", + "GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned": { + "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.", + "id": "GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1RagQuery": { + "description": "A query to retrieve relevant contexts.", + "id": "GoogleCloudAiplatformV1RagQuery", "properties": { - "models": { - "description": "List of Model versions in the requested page. In the returned Model name field, version ID instead of regvision tag will be included.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Model" - } + "ragRetrievalConfig": { + "$ref": "GoogleCloudAiplatformV1RagRetrievalConfig", + "description": "Optional. The retrieval config for the query." }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListModelVersionsRequest.page_token to obtain that page.", + "text": { + "description": "Optional. The query in text format to get relevant contexts.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse": { - "id": "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse", - "description": "Response message for ModelService.ListModelVersionCheckpoints", - "type": "object", + "GoogleCloudAiplatformV1RagRetrievalConfig": { + "description": "Specifies the context retrieval config.", + "id": "GoogleCloudAiplatformV1RagRetrievalConfig", "properties": { - "checkpoints": { - "description": "List of Model Version checkpoints.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModelVersionCheckpoint" - } + "filter": { + "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigFilter", + "description": "Optional. Config for filters." }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListModelVersionCheckpointsRequest.page_token to obtain that page.", - "type": "string" + "ranking": { + "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigRanking", + "description": "Optional. Config for ranking and reranking." + }, + "topK": { + "description": "Optional. The number of contexts to retrieve.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelVersionCheckpoint": { - "id": "GoogleCloudAiplatformV1ModelVersionCheckpoint", - "deprecated": true, - "description": "Describes the machine learning model version checkpoint.", - "type": "object", + "GoogleCloudAiplatformV1RagRetrievalConfigFilter": { + "description": "Config for filters.", + "id": "GoogleCloudAiplatformV1RagRetrievalConfigFilter", "properties": { - "checkpointId": { - "description": "The ID of the checkpoint.", + "metadataFilter": { + "description": "Optional. String for metadata filtering.", "type": "string" }, - "epoch": { - "description": "The epoch of the checkpoint.", - "type": "string", - "format": "int64" + "vectorDistanceThreshold": { + "description": "Optional. Only returns contexts with vector distance smaller than the threshold.", + "format": "double", + "type": "number" }, - "step": { - "description": "The step of the checkpoint.", - "type": "string", - "format": "int64" + "vectorSimilarityThreshold": { + "description": "Optional. Only returns contexts with vector similarity larger than the threshold.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateExplanationDatasetRequest": { - "id": "GoogleCloudAiplatformV1UpdateExplanationDatasetRequest", - "description": "Request message for ModelService.UpdateExplanationDataset.", - "type": "object", + "GoogleCloudAiplatformV1RagRetrievalConfigRanking": { + "description": "Config for ranking and reranking.", + "id": "GoogleCloudAiplatformV1RagRetrievalConfigRanking", "properties": { - "examples": { - "description": "The example config containing the location of the dataset.", - "$ref": "GoogleCloudAiplatformV1Examples" + "llmRanker": { + "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker", + "description": "Optional. Config for LlmRanker." + }, + "rankService": { + "$ref": "GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService", + "description": "Optional. Config for Rank Service." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MergeVersionAliasesRequest": { - "id": "GoogleCloudAiplatformV1MergeVersionAliasesRequest", - "description": "Request message for ModelService.MergeVersionAliases.", - "type": "object", + "GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker": { + "description": "Config for LlmRanker.", + "id": "GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker", "properties": { - "versionAliases": { - "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", - "items": { - "type": "string" - } + "modelName": { + "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).", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExportModelRequest": { - "id": "GoogleCloudAiplatformV1ExportModelRequest", - "description": "Request message for ModelService.ExportModel.", - "type": "object", + "GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService": { + "description": "Config for Rank Service.", + "id": "GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService", "properties": { - "outputConfig": { - "description": "Required. The desired output location and configuration.", - "$ref": "GoogleCloudAiplatformV1ExportModelRequestOutputConfig" + "modelName": { + "description": "Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExportModelRequestOutputConfig": { - "id": "GoogleCloudAiplatformV1ExportModelRequestOutputConfig", - "description": "Output configuration for the Model export.", - "type": "object", + "GoogleCloudAiplatformV1RagVectorDbConfig": { + "description": "Config for the Vector DB to use for RAG.", + "id": "GoogleCloudAiplatformV1RagVectorDbConfig", "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" + "apiAuth": { + "$ref": "GoogleCloudAiplatformV1ApiAuth", + "description": "Authentication config for the chosen Vector DB." }, - "artifactDestination": { - "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`.", - "$ref": "GoogleCloudAiplatformV1GcsDestination" + "pinecone": { + "$ref": "GoogleCloudAiplatformV1RagVectorDbConfigPinecone", + "description": "The config for the Pinecone." }, - "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": "GoogleCloudAiplatformV1ContainerRegistryDestination" + "ragEmbeddingModelConfig": { + "$ref": "GoogleCloudAiplatformV1RagEmbeddingModelConfig", + "description": "Optional. Immutable. The embedding model config of the Vector DB." + }, + "ragManagedDb": { + "$ref": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb", + "description": "The config for the RAG-managed Vector DB." + }, + "vertexVectorSearch": { + "$ref": "GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch", + "description": "The config for the Vertex Vector Search." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ContainerRegistryDestination": { - "id": "GoogleCloudAiplatformV1ContainerRegistryDestination", - "description": "The Container Registry location for the container image.", - "type": "object", + "GoogleCloudAiplatformV1RagVectorDbConfigPinecone": { + "description": "The config for the Pinecone.", + "id": "GoogleCloudAiplatformV1RagVectorDbConfigPinecone", "properties": { - "outputUri": { - "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.", + "indexName": { + "description": "Pinecone index name. This value cannot be changed after it's set.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CopyModelRequest": { - "id": "GoogleCloudAiplatformV1CopyModelRequest", - "description": "Request message for ModelService.CopyModel.", - "type": "object", + "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb": { + "description": "The config for the default RAG-managed Vector DB.", + "id": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb", "properties": { - "modelId": { - "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.", - "type": "string" - }, - "parentModel": { - "description": "Optional. Specify this field to copy source_model into this existing Model as a new version. Format: `projects/{project}/locations/{location}/models/{model}`", - "type": "string" - }, - "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" + "ann": { + "$ref": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN", + "description": "Performs an ANN search on RagCorpus. Use this if you have a lot of files (> 10K) in your RagCorpus and want to reduce the search latency." }, - "encryptionSpec": { - "description": "Customer-managed encryption key options. If this is set, then the Model copy will be encrypted with the provided encryption key.", - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" + "knn": { + "$ref": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN", + "description": "Performs a KNN search on RagCorpus. Default choice if not specified." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ImportModelEvaluationRequest": { - "id": "GoogleCloudAiplatformV1ImportModelEvaluationRequest", - "description": "Request message for ModelService.ImportModelEvaluation", - "type": "object", + "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN": { + "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.", + "id": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN", "properties": { - "modelEvaluation": { - "description": "Required. Model evaluation resource to be imported.", - "$ref": "GoogleCloudAiplatformV1ModelEvaluation" + "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" + }, + "treeDepth": { + "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", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelEvaluation": { - "id": "GoogleCloudAiplatformV1ModelEvaluation", - "description": "A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.", - "type": "object", + "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN": { + "description": "Config for KNN search.", + "id": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch": { + "description": "The config for the Vertex Vector Search.", + "id": "GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch", "properties": { - "name": { - "description": "Output only. The resource name of the ModelEvaluation.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "The display name of the ModelEvaluation.", + "index": { + "description": "The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}`", "type": "string" }, - "metricsSchemaUri": { - "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).", + "indexEndpoint": { + "description": "The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", "type": "string" - }, - "metrics": { - "description": "Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri", - "type": "any" - }, - "createTime": { - "description": "Output only. Timestamp when this ModelEvaluation was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "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", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RawOutput": { + "description": "Raw output.", + "id": "GoogleCloudAiplatformV1RawOutput", + "properties": { + "rawOutput": { + "description": "Output only. Raw output string.", "items": { "type": "string" - } - }, - "dataItemSchemaUri": { - "description": "Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.data_item_payload and EvaluatedAnnotation.data_item_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). This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.", - "type": "string" - }, - "annotationSchemaUri": { - "description": "Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.predictions, EvaluatedDataItemView.ground_truths, EvaluatedAnnotation.predictions, and EvaluatedAnnotation.ground_truths. 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). This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.", - "type": "string" - }, - "modelExplanation": { - "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. ", - "$ref": "GoogleCloudAiplatformV1ModelExplanation" - }, - "explanationSpecs": { - "description": "Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec" - } - }, - "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" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelExplanation": { - "id": "GoogleCloudAiplatformV1ModelExplanation", - "description": "Aggregated explanation metrics for a Model over a set of instances.", - "type": "object", + "GoogleCloudAiplatformV1RawPredictRequest": { + "description": "Request message for PredictionService.RawPredict.", + "id": "GoogleCloudAiplatformV1RawPredictRequest", "properties": { - "meanAttributions": { - "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.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Attribution" - } + "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" }, - "GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec": { - "id": "GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec", - "type": "object", + "GoogleCloudAiplatformV1RayLogsSpec": { + "description": "Configuration for the Ray OSS Logs.", + "id": "GoogleCloudAiplatformV1RayLogsSpec", "properties": { - "explanationType": { - "description": "Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai`", - "type": "string" - }, - "explanationSpec": { - "description": "Explanation spec details.", - "$ref": "GoogleCloudAiplatformV1ExplanationSpec" + "disabled": { + "description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest": { - "id": "GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest", - "description": "Request message for ModelService.BatchImportModelEvaluationSlices", - "type": "object", + "GoogleCloudAiplatformV1RayMetricSpec": { + "description": "Configuration for the Ray metrics.", + "id": "GoogleCloudAiplatformV1RayMetricSpec", "properties": { - "modelEvaluationSlices": { - "description": "Required. Model evaluation slice resource to be imported.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModelEvaluationSlice" - } + "disabled": { + "description": "Optional. Flag to disable the Ray metrics collection.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelEvaluationSlice": { - "id": "GoogleCloudAiplatformV1ModelEvaluationSlice", - "description": "A collection of metrics calculated by comparing Model's predictions on a slice of the test data against ground truth annotations.", - "type": "object", + "GoogleCloudAiplatformV1RaySpec": { + "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": "GoogleCloudAiplatformV1RaySpec", "properties": { - "name": { - "description": "Output only. The resource name of the ModelEvaluationSlice.", - "readOnly": true, + "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" }, - "slice": { - "description": "Output only. The slice of the test data that is used to evaluate the Model.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1ModelEvaluationSliceSlice" - }, - "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).", - "readOnly": true, + "imageUri": { + "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.", "type": "string" }, - "metrics": { - "description": "Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri", - "readOnly": true, - "type": "any" + "rayLogsSpec": { + "$ref": "GoogleCloudAiplatformV1RayLogsSpec", + "description": "Optional. OSS Ray logging configurations." }, - "createTime": { - "description": "Output only. Timestamp when this ModelEvaluationSlice was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "rayMetricSpec": { + "$ref": "GoogleCloudAiplatformV1RayMetricSpec", + "description": "Optional. Ray metrics configurations." }, - "modelExplanation": { - "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.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1ModelExplanation" + "resourcePoolImages": { + "additionalProperties": { + "type": "string" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelEvaluationSliceSlice": { - "id": "GoogleCloudAiplatformV1ModelEvaluationSliceSlice", - "description": "Definition of a slice.", - "type": "object", + "GoogleCloudAiplatformV1ReadFeatureValuesRequest": { + "description": "Request message for FeaturestoreOnlineServingService.ReadFeatureValues.", + "id": "GoogleCloudAiplatformV1ReadFeatureValuesRequest", "properties": { - "dimension": { - "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, + "entityId": { + "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`.", "type": "string" }, - "value": { - "description": "Output only. The value of the dimension in this slice.", - "readOnly": true, - "type": "string" + "featureSelector": { + "$ref": "GoogleCloudAiplatformV1FeatureSelector", + "description": "Required. Selector choosing Features of the target EntityType." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReadFeatureValuesResponse": { + "description": "Response message for FeaturestoreOnlineServingService.ReadFeatureValues.", + "id": "GoogleCloudAiplatformV1ReadFeatureValuesResponse", + "properties": { + "entityView": { + "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView", + "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." }, - "sliceSpec": { - "description": "Output only. Specification for how the data was sliced.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec" + "header": { + "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader", + "description": "Response header." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec": { - "id": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec", - "description": "Specification for how the data should be sliced.", - "type": "object", + "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView": { + "description": "Entity view with Feature values.", + "id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView", "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.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig" - } + "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": "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData" + }, + "type": "array" + }, + "entityId": { + "description": "ID of the requested entity.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig": { - "id": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData": { + "description": "Container to hold value(s), successive in time, for one Feature from the request.", + "id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData", "properties": { "value": { - "description": "A unique specific value for a given feature. Example: `{ \"value\": { \"string_value\": \"12345\" } }`", - "$ref": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue" + "$ref": "GoogleCloudAiplatformV1FeatureValue", + "description": "Feature value if a single value is requested." }, - "range": { - "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.", - "$ref": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange" - }, - "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" + "values": { + "$ref": "GoogleCloudAiplatformV1FeatureValueList", + "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." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue": { - "id": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue", - "description": "Single value that supports strings and floats.", - "type": "object", + "GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor": { + "description": "Metadata for requested Features.", + "id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor", "properties": { - "stringValue": { - "description": "String type.", + "id": { + "description": "Feature ID.", "type": "string" - }, - "floatValue": { - "description": "Float type.", - "type": "number", - "format": "float" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange": { - "id": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange", - "description": "A range of values for slice(s). `low` is inclusive, `high` is exclusive.", - "type": "object", + "GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader": { + "description": "Response header with metadata for the requested ReadFeatureValuesRequest.entity_type and Features.", + "id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader", "properties": { - "low": { - "description": "Inclusive low value for the range.", - "type": "number", - "format": "float" + "entityType": { + "description": "The resource name of the EntityType from the ReadFeatureValuesRequest. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.", + "type": "string" }, - "high": { - "description": "Exclusive high value for the range.", - "type": "number", - "format": "float" + "featureDescriptors": { + "description": "List of Feature metadata corresponding to each piece of ReadFeatureValuesResponse.EntityView.data.", + "items": { + "$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse": { - "id": "GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse", - "description": "Response message for ModelService.BatchImportModelEvaluationSlices", - "type": "object", + "GoogleCloudAiplatformV1ReadIndexDatapointsRequest": { + "description": "The request message for MatchService.ReadIndexDatapoints.", + "id": "GoogleCloudAiplatformV1ReadIndexDatapointsRequest", "properties": { - "importedModelEvaluationSlices": { - "description": "Output only. List of imported ModelEvaluationSlice.name.", - "readOnly": true, - "type": "array", + "deployedIndexId": { + "description": "The ID of the DeployedIndex that will serve the request.", + "type": "string" + }, + "ids": { + "description": "IDs of the datapoints to be searched for.", "items": { "type": "string" - } + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest": { - "id": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest", - "description": "Request message for ModelService.BatchImportEvaluatedAnnotations", - "type": "object", + "GoogleCloudAiplatformV1ReadIndexDatapointsResponse": { + "description": "The response message for MatchService.ReadIndexDatapoints.", + "id": "GoogleCloudAiplatformV1ReadIndexDatapointsResponse", "properties": { - "evaluatedAnnotations": { - "description": "Required. Evaluated annotations resource to be imported.", - "type": "array", + "datapoints": { + "description": "The result list of datapoints.", "items": { - "$ref": "GoogleCloudAiplatformV1EvaluatedAnnotation" - } + "$ref": "GoogleCloudAiplatformV1IndexDatapoint" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluatedAnnotation": { - "id": "GoogleCloudAiplatformV1EvaluatedAnnotation", - "description": "True positive, false positive, or false negative. EvaluatedAnnotation is only available under ModelEvaluationSlice with slice of `annotationSpec` dimension.", - "type": "object", + "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse": { + "description": "Response message for TensorboardService.ReadTensorboardBlobData.", + "id": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse", "properties": { - "type": { - "description": "Output only. Type of the EvaluatedAnnotation.", - "readOnly": true, - "type": "string", - "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." - ], - "enum": [ - "EVALUATED_ANNOTATION_TYPE_UNSPECIFIED", - "TRUE_POSITIVE", - "FALSE_POSITIVE", - "FALSE_NEGATIVE" - ] - }, - "predictions": { - "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", - "readOnly": true, - "type": "array", - "items": { - "type": "any" - } - }, - "groundTruths": { - "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", - "readOnly": true, - "type": "array", - "items": { - "type": "any" - } - }, - "dataItemPayload": { - "description": "Output only. The data item payload that the Model predicted this EvaluatedAnnotation on.", - "readOnly": true, - "type": "any" - }, - "evaluatedDataItemViewId": { - "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.", - "readOnly": true, - "type": "string" - }, - "explanations": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1EvaluatedAnnotationExplanation" - } - }, - "errorAnalysisAnnotations": { - "description": "Annotations of model error analysis results.", - "type": "array", + "blobs": { + "description": "Blob messages containing blob bytes.", "items": { - "$ref": "GoogleCloudAiplatformV1ErrorAnalysisAnnotation" - } + "$ref": "GoogleCloudAiplatformV1TensorboardBlob" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1EvaluatedAnnotationExplanation": { - "id": "GoogleCloudAiplatformV1EvaluatedAnnotationExplanation", - "description": "Explanation result of the prediction produced by the Model.", - "type": "object", + "GoogleCloudAiplatformV1ReadTensorboardSizeResponse": { + "description": "Response message for TensorboardService.ReadTensorboardSize.", + "id": "GoogleCloudAiplatformV1ReadTensorboardSizeResponse", "properties": { - "explanationType": { - "description": "Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai`", + "storageSizeByte": { + "description": "Payload storage size for the TensorBoard", + "format": "int64", "type": "string" - }, - "explanation": { - "description": "Explanation attribution response details.", - "$ref": "GoogleCloudAiplatformV1Explanation" - } - } - }, - "GoogleCloudAiplatformV1ErrorAnalysisAnnotation": { - "id": "GoogleCloudAiplatformV1ErrorAnalysisAnnotation", - "description": "Model error analysis for each annotation.", - "type": "object", - "properties": { - "attributedItems": { - "description": "Attributed items for a given annotation, typically representing neighbors from the training sets constrained by the query type.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem" - } - }, - "queryType": { - "description": "The query type used for finding the attributed items.", - "type": "string", - "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." - ], - "enum": [ - "QUERY_TYPE_UNSPECIFIED", - "ALL_SIMILAR", - "SAME_CLASS_SIMILAR", - "SAME_CLASS_DISSIMILAR" - ] - }, - "outlierScore": { - "description": "The outlier score of this annotated item. Usually defined as the min of all distances from attributed items.", - "type": "number", - "format": "double" - }, - "outlierThreshold": { - "description": "The threshold used to determine if this annotation is an outlier or not.", - "type": "number", - "format": "double" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem": { - "id": "GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem", - "description": "Attributed items for a given annotation, typically representing neighbors from the training sets constrained by the query type.", - "type": "object", + "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse": { + "description": "Response message for TensorboardService.ReadTensorboardTimeSeriesData.", + "id": "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse", "properties": { - "annotationResourceName": { - "description": "The unique ID for each annotation. Used by FE to allocate the annotation in DB.", - "type": "string" - }, - "distance": { - "description": "The distance of this item to the annotation.", - "type": "number", - "format": "double" + "timeSeriesData": { + "$ref": "GoogleCloudAiplatformV1TimeSeriesData", + "description": "The returned time series data." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse": { - "id": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse", - "description": "Response message for ModelService.BatchImportEvaluatedAnnotations", - "type": "object", + "GoogleCloudAiplatformV1ReadTensorboardUsageResponse": { + "description": "Response message for TensorboardService.ReadTensorboardUsage.", + "id": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse", "properties": { - "importedEvaluatedAnnotationsCount": { - "description": "Output only. Number of EvaluatedAnnotations imported.", - "readOnly": true, - "type": "integer", - "format": "int32" + "monthlyUsageData": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData" + }, + "description": "Maps year-month (YYYYMM) string to per month usage data.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListModelEvaluationsResponse": { - "id": "GoogleCloudAiplatformV1ListModelEvaluationsResponse", - "description": "Response message for ModelService.ListModelEvaluations.", - "type": "object", + "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData": { + "description": "Per month usage data", + "id": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData", "properties": { - "modelEvaluations": { - "description": "List of ModelEvaluations in the requested page.", - "type": "array", + "userUsageData": { + "description": "Usage data for each user in the given month.", "items": { - "$ref": "GoogleCloudAiplatformV1ModelEvaluation" - } - }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass to ListModelEvaluationsRequest.page_token to obtain that page.", - "type": "string" + "$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse": { - "id": "GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse", - "description": "Response message for ModelService.ListModelEvaluationSlices.", - "type": "object", + "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData": { + "description": "Per user usage data.", + "id": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData", "properties": { - "modelEvaluationSlices": { - "description": "List of ModelEvaluations in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ModelEvaluationSlice" - } + "username": { + "description": "User's username", + "type": "string" }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass to ListModelEvaluationSlicesRequest.page_token to obtain that page.", + "viewCount": { + "description": "Number of times the user has read data within the Tensorboard.", + "format": "int64", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NotebookRuntimeTemplate": { - "id": "GoogleCloudAiplatformV1NotebookRuntimeTemplate", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ReasoningEngine": { + "description": "ReasoningEngine provides a customizable runtime for models to determine which actions to take and in which order.", + "id": "GoogleCloudAiplatformV1ReasoningEngine", "properties": { - "name": { - "description": "The resource name of the NotebookRuntimeTemplate.", - "type": "string" + "contextSpec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineContextSpec", + "description": "Optional. Configuration for how Agent Engine sub-resources should manage context." }, - "displayName": { - "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.", + "createTime": { + "description": "Output only. Timestamp when this ReasoningEngine was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, "description": { - "description": "The description of the NotebookRuntimeTemplate.", + "description": "Optional. The description of the ReasoningEngine.", "type": "string" }, - "isDefault": { - "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, - "deprecated": true, - "type": "boolean" - }, - "machineSpec": { - "description": "Optional. Immutable. The specification of a single machine for the template.", - "$ref": "GoogleCloudAiplatformV1MachineSpec" - }, - "dataPersistentDiskSpec": { - "description": "Optional. The specification of persistent disk attached to the runtime as data disk storage.", - "$ref": "GoogleCloudAiplatformV1PersistentDiskSpec" - }, - "networkSpec": { - "description": "Optional. Network spec.", - "$ref": "GoogleCloudAiplatformV1NetworkSpec" - }, - "serviceAccount": { - "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.", - "deprecated": true, + "displayName": { + "description": "Required. The display name of the ReasoningEngine.", "type": "string" }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." + }, "etag": { - "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "labels": { - "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", "additionalProperties": { "type": "string" - } - }, - "idleShutdownConfig": { - "description": "The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.", - "$ref": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig" + }, + "description": "Labels for the ReasoningEngine.", + "type": "object" }, - "eucConfig": { - "description": "EUC configuration of the NotebookRuntimeTemplate.", - "$ref": "GoogleCloudAiplatformV1NotebookEucConfig" + "name": { + "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "type": "string" }, - "createTime": { - "description": "Output only. Timestamp when this NotebookRuntimeTemplate was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "spec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpec", + "description": "Optional. Configurations of the ReasoningEngine" }, "updateTime": { - "description": "Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.", + "description": "Output only. Timestamp when this ReasoningEngine was most recently updated.", + "format": "google-datetime", "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "notebookRuntimeType": { - "description": "Optional. Immutable. The type of the notebook runtime template.", - "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" - ] - }, - "shieldedVmConfig": { - "description": "Optional. Immutable. Runtime Shielded VM spec.", - "$ref": "GoogleCloudAiplatformV1ShieldedVmConfig" - }, - "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": "GoogleCloudAiplatformV1NotebookReservationAffinity" - }, - "encryptionSpec": { - "description": "Customer-managed encryption key spec for the notebook runtime.", - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" - }, - "softwareConfig": { - "description": "Optional. The notebook software configuration of the notebook runtime.", - "$ref": "GoogleCloudAiplatformV1NotebookSoftwareConfig" - } - } - }, - "GoogleCloudAiplatformV1PersistentDiskSpec": { - "id": "GoogleCloudAiplatformV1PersistentDiskSpec", - "description": "Represents the spec of persistent disk options.", - "type": "object", - "properties": { - "diskType": { - "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)", "type": "string" - }, - "diskSizeGb": { - "description": "Size in GB of the disk (default is 100GB).", - "type": "string", - "format": "int64" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NetworkSpec": { - "id": "GoogleCloudAiplatformV1NetworkSpec", - "description": "Network spec.", - "type": "object", + "GoogleCloudAiplatformV1ReasoningEngineContextSpec": { + "description": "Configuration for how Agent Engine sub-resources should manage context.", + "id": "GoogleCloudAiplatformV1ReasoningEngineContextSpec", "properties": { - "enableInternetAccess": { - "description": "Whether to enable public internet access. Default false.", - "type": "boolean" - }, - "network": { - "description": "The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)", - "type": "string" - }, - "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" + "memoryBankConfig": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfig", + "description": "Optional. Specification for a Memory Bank, which manages memories for the Agent Engine." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NotebookIdleShutdownConfig": { - "id": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig", - "description": "The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.", - "type": "object", + "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfig": { + "description": "Specification for a Memory Bank.", + "id": "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfig", "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" + "customizationConfigs": { + "description": "Optional. Configuration for how to customize Memory Bank behavior for a particular scope.", + "items": { + "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfig" + }, + "type": "array" }, - "idleShutdownDisabled": { - "description": "Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.", - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1NotebookEucConfig": { - "id": "GoogleCloudAiplatformV1NotebookEucConfig", - "description": "The euc configuration of NotebookRuntimeTemplate.", - "type": "object", - "properties": { - "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.", + "disableMemoryRevisions": { + "description": "If true, no memory revisions will be created for any requests to the Memory Bank.", "type": "boolean" }, - "bypassActasCheck": { - "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.", - "readOnly": true, - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1ShieldedVmConfig": { - "id": "GoogleCloudAiplatformV1ShieldedVmConfig", - "description": "A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).", - "type": "object", - "properties": { - "enableSecureBoot": { - "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": "boolean" - } - } - }, - "GoogleCloudAiplatformV1NotebookReservationAffinity": { - "id": "GoogleCloudAiplatformV1NotebookReservationAffinity", - "description": "Notebook Reservation Affinity for consuming Zonal reservation.", - "type": "object", - "properties": { - "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.", - "type": "string", - "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." - ], - "enum": [ - "RESERVATION_AFFINITY_TYPE_UNSPECIFIED", - "RESERVATION_NONE", - "RESERVATION_ANY", - "RESERVATION_SPECIFIC" - ] + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig", + "description": "Optional. Configuration for how to generate memories for the Memory Bank." }, - "key": { - "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.", - "type": "string" + "similaritySearchConfig": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfig", + "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`." }, - "values": { - "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full path name of Reservation.", - "type": "array", - "items": { - "type": "string" - } + "ttlConfig": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigTtlConfig", + "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." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NotebookSoftwareConfig": { - "id": "GoogleCloudAiplatformV1NotebookSoftwareConfig", - "description": "Notebook Software Config. This is passed to the backend when user makes software configurations in UI.", - "type": "object", + "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig": { + "description": "Configuration for how to generate memories.", + "id": "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig", "properties": { - "colabImage": { - "description": "Optional. Google-managed NotebookRuntime colab image.", - "$ref": "GoogleCloudAiplatformV1ColabImage" - }, - "env": { - "description": "Optional. Environment variables to be passed to the container. Maximum limit is 100.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1EnvVar" - } + "generationTriggerConfig": { + "$ref": "GoogleCloudAiplatformV1MemoryGenerationTriggerConfig", + "description": "Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`." }, - "postStartupScriptConfig": { - "description": "Optional. Post startup script config.", - "$ref": "GoogleCloudAiplatformV1PostStartupScriptConfig" + "model": { + "description": "Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ColabImage": { - "id": "GoogleCloudAiplatformV1ColabImage", - "description": "Colab image of the runtime.", - "type": "object", + "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfig": { + "description": "Configuration for how to perform similarity search on memories.", + "id": "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfig", "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": { - "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\"", - "readOnly": true, + "embeddingModel": { + "description": "Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PostStartupScriptConfig": { - "id": "GoogleCloudAiplatformV1PostStartupScriptConfig", - "description": "Post startup script config.", - "type": "object", + "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigTtlConfig": { + "description": "Configuration for automatically setting the TTL (\"time-to-live\") of the memories in the Memory Bank.", + "id": "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigTtlConfig", "properties": { - "postStartupScript": { - "description": "Optional. Post startup script to run after runtime is started.", - "type": "string" - }, - "postStartupScriptUrl": { - "description": "Optional. Post startup script url to download. Example: `gs://bucket/script.sh`", + "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" }, - "postStartupScriptBehavior": { - "description": "Optional. Post startup script behavior that defines download and execution behavior.", - "type": "string", - "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" - ] - } - } - }, - "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse": { - "id": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse", - "description": "Response message for NotebookService.ListNotebookRuntimeTemplates.", - "type": "object", - "properties": { - "notebookRuntimeTemplates": { - "description": "List of NotebookRuntimeTemplates in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate" - } + "granularTtlConfig": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig", + "description": "Optional. The granular TTL configuration of the memories in the Memory Bank." }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass to ListNotebookRuntimeTemplatesRequest.page_token to obtain that page.", + "memoryRevisionDefaultTtl": { + "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.", + "format": "google-duration", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AssignNotebookRuntimeRequest": { - "id": "GoogleCloudAiplatformV1AssignNotebookRuntimeRequest", - "description": "Request message for NotebookService.AssignNotebookRuntime.", - "type": "object", + "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig": { + "description": "Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory.", + "id": "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig", "properties": { - "notebookRuntimeTemplate": { - "description": "Required. The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be assigned (reuse or create a new one).", + "createTtl": { + "description": "Optional. The TTL duration for memories uploaded via CreateMemory.", + "format": "google-duration", "type": "string" }, - "notebookRuntime": { - "description": "Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment.", - "$ref": "GoogleCloudAiplatformV1NotebookRuntime" + "generateCreatedTtl": { + "description": "Optional. The TTL duration for memories newly generated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.CREATED).", + "format": "google-duration", + "type": "string" }, - "notebookRuntimeId": { - "description": "Optional. User specified ID for the notebook runtime.", + "generateUpdatedTtl": { + "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).", + "format": "google-duration", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NotebookRuntime": { - "id": "GoogleCloudAiplatformV1NotebookRuntime", - "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", + "GoogleCloudAiplatformV1ReasoningEngineSpec": { + "description": "ReasoningEngine configurations", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpec", "properties": { - "name": { - "description": "Output only. The resource name of the NotebookRuntime.", - "readOnly": true, - "type": "string" - }, - "runtimeUser": { - "description": "Required. The user email of the NotebookRuntime.", + "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" }, - "notebookRuntimeTemplateRef": { - "description": "Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplateRef" + "classMethods": { + "description": "Optional. Declarations for object class methods in OpenAPI specification format.", + "items": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "type": "array" }, - "proxyUri": { - "description": "Output only. The proxy endpoint used to access the NotebookRuntime.", - "readOnly": true, - "type": "string" + "containerSpec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecContainerSpec", + "description": "Deploy from a container image with a defined entrypoint and commands." }, - "createTime": { - "description": "Output only. Timestamp when this NotebookRuntime was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "deploymentSpec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec", + "description": "Optional. The specification of a Reasoning Engine deployment." }, - "updateTime": { - "description": "Output only. Timestamp when this NotebookRuntime was most recently updated.", + "effectiveIdentity": { + "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, - "type": "string", - "format": "google-datetime" + "type": "string" }, - "healthState": { - "description": "Output only. The health state of the NotebookRuntime.", - "readOnly": true, - "type": "string", + "identityType": { + "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.", + "enum": [ + "IDENTITY_TYPE_UNSPECIFIED", + "SERVICE_ACCOUNT", + "AGENT_IDENTITY" + ], "enumDescriptions": [ - "Unspecified health state.", - "NotebookRuntime is in healthy state. Applies to ACTIVE state.", - "NotebookRuntime is in unhealthy state. Applies to ACTIVE state." + "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": [ - "HEALTH_STATE_UNSPECIFIED", - "HEALTHY", - "UNHEALTHY" - ] - }, - "displayName": { - "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.", "type": "string" }, - "description": { - "description": "The description of the NotebookRuntime.", - "type": "string" + "packageSpec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec", + "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." }, "serviceAccount": { - "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.", - "readOnly": true, - "type": "string" - }, - "runtimeState": { - "description": "Output only. The runtime (instance) state of the NotebookRuntime.", - "readOnly": true, - "type": "string", - "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." - ], - "enum": [ - "RUNTIME_STATE_UNSPECIFIED", - "RUNNING", - "BEING_STARTED", - "BEING_STOPPED", - "STOPPED", - "BEING_UPGRADED", - "ERROR", - "INVALID" - ] - }, - "isUpgradable": { - "description": "Output only. Whether NotebookRuntime is upgradable.", - "readOnly": true, - "type": "boolean" - }, - "labels": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "expirationTime": { - "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.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "version": { - "description": "Output only. The VM os image version of NotebookRuntime.", - "readOnly": true, + "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" }, - "notebookRuntimeType": { - "description": "Output only. The type of the notebook runtime.", - "readOnly": true, - "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" - ] - }, - "machineSpec": { - "description": "Output only. The specification of a single machine used by the notebook runtime.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1MachineSpec" - }, - "dataPersistentDiskSpec": { - "description": "Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1PersistentDiskSpec" - }, - "networkSpec": { - "description": "Output only. Network spec of the notebook runtime.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1NetworkSpec" - }, - "idleShutdownConfig": { - "description": "Output only. The idle shutdown configuration of the notebook runtime.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig" - }, - "eucConfig": { - "description": "Output only. EUC configuration of the notebook runtime.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1NotebookEucConfig" - }, - "shieldedVmConfig": { - "description": "Output only. Runtime Shielded VM spec.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1ShieldedVmConfig" - }, - "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": "Output only. Reservation Affinity of the notebook runtime.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1NotebookReservationAffinity" - }, - "softwareConfig": { - "description": "Output only. Software config of the notebook runtime.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1NotebookSoftwareConfig" - }, - "encryptionSpec": { - "description": "Output only. Customer-managed encryption key spec for the notebook runtime.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" - }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" - }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1NotebookRuntimeTemplateRef": { - "id": "GoogleCloudAiplatformV1NotebookRuntimeTemplateRef", - "description": "Points to a NotebookRuntimeTemplateRef.", - "type": "object", - "properties": { - "notebookRuntimeTemplate": { - "description": "Immutable. A resource name of the NotebookRuntimeTemplate.", - "type": "string" + "sourceCodeSpec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec", + "description": "Deploy from source code files with a defined entrypoint." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListNotebookRuntimesResponse": { - "id": "GoogleCloudAiplatformV1ListNotebookRuntimesResponse", - "description": "Response message for NotebookService.ListNotebookRuntimes.", - "type": "object", + "GoogleCloudAiplatformV1ReasoningEngineSpecContainerSpec": { + "description": "Specification for deploying from a container image.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecContainerSpec", "properties": { - "notebookRuntimes": { - "description": "List of NotebookRuntimes in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1NotebookRuntime" - } - }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass to ListNotebookRuntimesRequest.page_token to obtain that page.", + "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" } - } - }, - "GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest": { - "id": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest", - "description": "Request message for NotebookService.UpgradeNotebookRuntime.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1StartNotebookRuntimeRequest": { - "id": "GoogleCloudAiplatformV1StartNotebookRuntimeRequest", - "description": "Request message for NotebookService.StartNotebookRuntime.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1StopNotebookRuntimeRequest": { - "id": "GoogleCloudAiplatformV1StopNotebookRuntimeRequest", - "description": "Request message for NotebookService.StopNotebookRuntime.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1NotebookExecutionJob": { - "id": "GoogleCloudAiplatformV1NotebookExecutionJob", - "description": "NotebookExecutionJob represents an instance of a notebook execution.", - "type": "object", + "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec": { + "description": "The specification of a Reasoning Engine deployment.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec", "properties": { - "dataformRepositorySource": { - "description": "The Dataform Repository pointing to a single file notebook repository.", - "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource" + "containerConcurrency": { + "description": "Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.", + "format": "int32", + "type": "integer" }, - "gcsNotebookSource": { - "description": "The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`", - "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource" + "env": { + "description": "Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.", + "items": { + "$ref": "GoogleCloudAiplatformV1EnvVar" + }, + "type": "array" }, - "directNotebookSource": { - "description": "The contents of an input notebook file.", - "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource" + "keepAliveProbe": { + "$ref": "GoogleCloudAiplatformV1KeepAliveProbe", + "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." }, - "notebookRuntimeTemplateResourceName": { - "description": "The NotebookRuntimeTemplate to source compute configuration from.", - "type": "string" + "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" }, - "customEnvironmentSpec": { - "description": "The custom compute configuration for an execution job.", - "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec" + "minInstances": { + "description": "Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 75].", + "format": "int32", + "type": "integer" }, - "gcsOutputUri": { - "description": "The Cloud Storage location to upload the result to. Format: `gs://bucket-name`", - "type": "string" + "pscInterfaceConfig": { + "$ref": "GoogleCloudAiplatformV1PscInterfaceConfig", + "description": "Optional. Configuration for PSC-I." }, - "executionUser": { - "description": "The user email to run the execution as. Only supported by Colab runtimes.", - "type": "string" + "resourceLimits": { + "additionalProperties": { + "type": "string" + }, + "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", + "type": "object" }, - "serviceAccount": { - "description": "The service account to run the execution as.", + "secretEnv": { + "description": "Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.", + "items": { + "$ref": "GoogleCloudAiplatformV1SecretEnvVar" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec": { + "description": "User-provided package specification, containing pickled object and package requirements.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec", + "properties": { + "dependencyFilesGcsUri": { + "description": "Optional. The Cloud Storage URI of the dependency files in tar.gz format.", "type": "string" }, - "workbenchRuntime": { - "description": "The Workbench runtime configuration to use for the notebook execution.", - "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime" - }, - "name": { - "description": "Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`", - "readOnly": true, + "pickleObjectGcsUri": { + "description": "Optional. The Cloud Storage URI of the pickled python object.", "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.", + "pythonVersion": { + "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.", "type": "string" }, - "executionTimeout": { - "description": "Max running time of the execution job in seconds (default 86400s / 24 hrs).", - "type": "string", - "format": "google-duration" - }, - "scheduleResourceName": { - "description": "The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`", + "requirementsGcsUri": { + "description": "Optional. The Cloud Storage URI of the `requirements.txt` file", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec": { + "description": "Specification for deploying from source code.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec", + "properties": { + "agentConfigSource": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecAgentConfigSource", + "description": "Source code is generated from the agent config." }, - "jobState": { - "description": "Output only. The state of the NotebookExecutionJob.", - "readOnly": true, - "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." - ], - "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" - ] + "developerConnectSource": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecDeveloperConnectSource", + "description": "Source code is in a Git repository managed by Developer Connect." }, - "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" + "imageSpec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecImageSpec", + "description": "Optional. Configuration for building an image with custom config file." }, - "createTime": { - "description": "Output only. Timestamp when this NotebookExecutionJob was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "inlineSource": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource", + "description": "Source code is provided directly in the request." }, - "updateTime": { - "description": "Output only. Timestamp when this NotebookExecutionJob was most recently updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "pythonSpec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec", + "description": "Configuration for a Python application." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecAgentConfigSource": { + "description": "Specification for the deploying from agent config.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecAgentConfigSource", + "properties": { + "adkConfig": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecAgentConfigSourceAdkConfig", + "description": "Required. The ADK configuration." }, - "labels": { - "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.", - "type": "object", + "inlineSource": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource", + "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." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecAgentConfigSourceAdkConfig": { + "description": "Configuration for the Agent Development Kit (ADK).", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecAgentConfigSourceAdkConfig", + "properties": { + "jsonConfig": { "additionalProperties": { - "type": "string" - } + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. The value of the ADK config in JSON format.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecDeveloperConnectConfig": { + "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.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecDeveloperConnectConfig", + "properties": { + "dir": { + "description": "Required. Directory, relative to the source root, in which to run the build.", + "type": "string" }, - "kernelName": { - "description": "The name of the kernel to use during notebook execution. If unset, the default kernel is used.", + "gitRepositoryLink": { + "description": "Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.", "type": "string" }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" + "revision": { + "description": "Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource": { - "id": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", - "description": "The Dataform Repository containing the input notebook.", - "type": "object", + "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecDeveloperConnectSource": { + "description": "Specifies source code to be fetched from a Git repository managed through the Developer Connect service.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecDeveloperConnectSource", "properties": { - "dataformRepositoryResourceName": { - "description": "The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`", - "type": "string" - }, - "commitSha": { - "description": "The commit SHA to read repository with. If unset, the file will be read at HEAD.", + "config": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecDeveloperConnectConfig", + "description": "Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecImageSpec": { + "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.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecImageSpec", + "properties": { + "buildArgs": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Build arguments to be used. They will be passed through --build-arg flags.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource": { + "description": "Specifies source code provided as a byte stream.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource", + "properties": { + "sourceArchive": { + "description": "Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file.", + "format": "byte", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource": { - "id": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", - "description": "The Cloud Storage uri for the input notebook.", - "type": "object", + "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec": { + "description": "Specification for running a Python application from source.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec", "properties": { - "uri": { - "description": "The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`", + "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" }, - "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.", + "entrypointObject": { + "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`.", + "type": "string" + }, + "requirementsFile": { + "description": "Optional. The path to the requirements file, relative to the source root. If not specified, defaults to \"requirements.txt\".", + "type": "string" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource": { - "id": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", - "description": "The content of the input notebook in ipynb format.", - "type": "object", + "GoogleCloudAiplatformV1RebaseTunedModelRequest": { + "description": "Request message for GenAiTuningService.RebaseTunedModel.", + "id": "GoogleCloudAiplatformV1RebaseTunedModelRequest", "properties": { - "content": { - "description": "The base64-encoded contents of the input notebook file.", - "type": "string", - "format": "byte" + "artifactDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "Optional. The Google Cloud Storage location to write the artifacts to." + }, + "deployToSameEndpoint": { + "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.", + "type": "boolean" + }, + "tunedModelRef": { + "$ref": "GoogleCloudAiplatformV1TunedModelRef", + "description": "Required. A reference to the tuned model to rebase." + }, + "tuningJob": { + "$ref": "GoogleCloudAiplatformV1TuningJob", + "description": "Optional. The tuning job to be updated. Users can use this field to overwrite tuning configs." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec": { - "id": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec", - "description": "Compute configuration to use for an execution job.", - "type": "object", + "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata": { + "description": "Details of operations that perform reboot PersistentResource.", + "id": "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata", "properties": { - "machineSpec": { - "description": "The specification of a single machine for the execution job.", - "$ref": "GoogleCloudAiplatformV1MachineSpec" - }, - "persistentDiskSpec": { - "description": "The specification of a persistent disk to attach for the execution job.", - "$ref": "GoogleCloudAiplatformV1PersistentDiskSpec" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for PersistentResource." }, - "networkSpec": { - "description": "The network configuration to use for the execution job.", - "$ref": "GoogleCloudAiplatformV1NetworkSpec" + "progressMessage": { + "description": "Progress Message for Reboot LRO", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime": { - "id": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime", - "description": "Configuration for a Workbench Instances-based environment.", - "type": "object", - "properties": {} + "GoogleCloudAiplatformV1RebootPersistentResourceRequest": { + "description": "Request message for PersistentResourceService.RebootPersistentResource.", + "id": "GoogleCloudAiplatformV1RebootPersistentResourceRequest", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse": { - "id": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse", - "description": "Response message for [NotebookService.CreateNotebookExecutionJob]", - "type": "object", + "GoogleCloudAiplatformV1RemoveContextChildrenRequest": { + "description": "Request message for MetadataService.DeleteContextChildrenRequest.", + "id": "GoogleCloudAiplatformV1RemoveContextChildrenRequest", "properties": { - "notebookExecutionJobs": { - "description": "List of NotebookExecutionJobs in the requested page.", - "type": "array", + "childContexts": { + "description": "The resource names of the child Contexts.", "items": { - "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" - } - }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass to ListNotebookExecutionJobsRequest.page_token to obtain that page.", - "type": "string" + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PersistentResource": { - "id": "GoogleCloudAiplatformV1PersistentResource", - "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.", - "type": "object", + "GoogleCloudAiplatformV1RemoveContextChildrenResponse": { + "description": "Response message for MetadataService.RemoveContextChildren.", + "id": "GoogleCloudAiplatformV1RemoveContextChildrenResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1RemoveDatapointsRequest": { + "description": "Request message for IndexService.RemoveDatapoints", + "id": "GoogleCloudAiplatformV1RemoveDatapointsRequest", "properties": { - "name": { - "description": "Immutable. Resource name of a PersistentResource.", + "datapointIds": { + "description": "A list of datapoint ids to be deleted.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RemoveDatapointsResponse": { + "description": "Response message for IndexService.RemoveDatapoints", + "id": "GoogleCloudAiplatformV1RemoveDatapointsResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1ReplicatedVoiceConfig": { + "description": "The configuration for the replicated voice to use.", + "id": "GoogleCloudAiplatformV1ReplicatedVoiceConfig", + "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" }, - "displayName": { - "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.", + "voiceSampleAudio": { + "description": "Optional. The sample of the custom voice.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReservationAffinity": { + "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.", + "id": "GoogleCloudAiplatformV1ReservationAffinity", + "properties": { + "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" }, - "resourcePools": { - "description": "Required. The spec of the pools of different resources.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1ResourcePool" - } - }, - "state": { - "description": "Output only. The detailed state of a Study.", - "readOnly": true, - "type": "string", + "reservationAffinityType": { + "description": "Required. Specifies the reservation affinity type.", + "enum": [ + "TYPE_UNSPECIFIED", + "NO_RESERVATION", + "ANY_RESERVATION", + "SPECIFIC_RESERVATION" + ], "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." + "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." ], - "enum": [ - "STATE_UNSPECIFIED", - "PROVISIONING", - "RUNNING", - "STOPPING", - "ERROR", - "REBOOTING", - "UPDATING" - ] - }, - "error": { - "description": "Output only. Only populated when persistent resource's state is `STOPPING` or `ERROR`.", - "readOnly": true, - "$ref": "GoogleRpcStatus" - }, - "createTime": { - "description": "Output only. Time when the PersistentResource was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "startTime": { - "description": "Output only. Time when the PersistentResource for the first time entered the `RUNNING` state.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Time when the PersistentResource was most recently updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "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" - } - }, - "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" }, - "pscInterfaceConfig": { - "description": "Optional. Configuration for PSC-I for PersistentResource.", - "$ref": "GoogleCloudAiplatformV1PscInterfaceConfig" - }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" - }, - "resourceRuntimeSpec": { - "description": "Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.", - "$ref": "GoogleCloudAiplatformV1ResourceRuntimeSpec" - }, - "resourceRuntime": { - "description": "Output only. Runtime information of the Persistent Resource.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1ResourceRuntime" - }, - "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'].", - "type": "array", + "values": { + "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.", "items": { "type": "string" - } - }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" - }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + }, + "type": "array" } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1ResourcePool": { - "id": "GoogleCloudAiplatformV1ResourcePool", "description": "Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.", - "type": "object", + "id": "GoogleCloudAiplatformV1ResourcePool", "properties": { + "autoscalingSpec": { + "$ref": "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec", + "description": "Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling" + }, + "diskSpec": { + "$ref": "GoogleCloudAiplatformV1DiskSpec", + "description": "Optional. Disk spec for the machine in this node pool." + }, "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": { - "description": "Required. Immutable. The specification of a single machine.", - "$ref": "GoogleCloudAiplatformV1MachineSpec" + "$ref": "GoogleCloudAiplatformV1MachineSpec", + "description": "Required. Immutable. The specification of a single machine." }, "replicaCount": { "description": "Optional. The total number of machines to use for this resource pool.", - "type": "string", - "format": "int64" - }, - "diskSpec": { - "description": "Optional. Disk spec for the machine in this node pool.", - "$ref": "GoogleCloudAiplatformV1DiskSpec" + "format": "int64", + "type": "string" }, "usedReplicaCount": { "description": "Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.", + "format": "int64", "readOnly": true, - "type": "string", - "format": "int64" - }, - "autoscalingSpec": { - "description": "Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling", - "$ref": "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec" + "type": "string" } - } + }, + "type": "object" }, "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec": { - "id": "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec", "description": "The min/max number of replicas allowed if enabling autoscaling", - "type": "object", + "id": "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec", "properties": { + "maxReplicaCount": { + "description": "Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error", + "format": "int64", + "type": "string" + }, "minReplicaCount": { - "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.", - "type": "string", - "format": "int64" + "description": "Optional. min replicas in the node pool, must be ≤ replica_count and < 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 > 0, we added a corresponding validation inside CreatePersistentResourceRequestValidator.java.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ResourceRuntime": { + "description": "Persistent Cluster runtime information as output", + "id": "GoogleCloudAiplatformV1ResourceRuntime", + "properties": { + "accessUris": { + "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, + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ResourceRuntimeSpec": { + "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.", + "id": "GoogleCloudAiplatformV1ResourceRuntimeSpec", + "properties": { + "raySpec": { + "$ref": "GoogleCloudAiplatformV1RaySpec", + "description": "Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource." + }, + "serviceAccountSpec": { + "$ref": "GoogleCloudAiplatformV1ServiceAccountSpec", + "description": "Optional. Configure the use of workload identity on the PersistentResource" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ResourcesConsumed": { + "description": "Statistics information about resource consumption.", + "id": "GoogleCloudAiplatformV1ResourcesConsumed", + "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.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata": { + "description": "Runtime operation information for DatasetService.RestoreDatasetVersion.", + "id": "GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The common part of the operation metadata." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest": { + "description": "Request message for JobService.ResumeModelDeploymentMonitoringJob.", + "id": "GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1ResumeScheduleRequest": { + "description": "Request message for ScheduleService.ResumeSchedule.", + "id": "GoogleCloudAiplatformV1ResumeScheduleRequest", + "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" + }, + "GoogleCloudAiplatformV1Retrieval": { + "description": "Defines a retrieval tool that model can call to access external knowledge.", + "id": "GoogleCloudAiplatformV1Retrieval", + "properties": { + "disableAttribution": { + "deprecated": true, + "description": "Optional. Deprecated. This option is no longer supported.", + "type": "boolean" + }, + "externalApi": { + "$ref": "GoogleCloudAiplatformV1ExternalApi", + "description": "Use data source powered by external API for grounding." + }, + "vertexAiSearch": { + "$ref": "GoogleCloudAiplatformV1VertexAISearch", + "description": "Set to use data source powered by Vertex AI Search." + }, + "vertexRagStore": { + "$ref": "GoogleCloudAiplatformV1VertexRagStore", + "description": "Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RetrievalConfig": { + "description": "Retrieval config.", + "id": "GoogleCloudAiplatformV1RetrievalConfig", + "properties": { + "languageCode": { + "description": "The language code of the user.", + "type": "string" + }, + "latLng": { + "$ref": "GoogleTypeLatLng", + "description": "The location of the user." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RetrievalMetadata": { + "description": "Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.", + "id": "GoogleCloudAiplatformV1RetrievalMetadata", + "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.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RetrieveContextsRequest": { + "description": "Request message for VertexRagService.RetrieveContexts.", + "id": "GoogleCloudAiplatformV1RetrieveContextsRequest", + "properties": { + "query": { + "$ref": "GoogleCloudAiplatformV1RagQuery", + "description": "Required. Single RAG retrieve query." + }, + "vertexRagStore": { + "$ref": "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStore", + "description": "The data source for Vertex RagStore." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStore": { + "description": "The data source for Vertex RagStore.", + "id": "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStore", + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStoreRagResource" + }, + "type": "array" + }, + "vectorDistanceThreshold": { + "deprecated": true, + "description": "Optional. Only return contexts with vector distance smaller than the threshold.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStoreRagResource": { + "description": "The definition of the Rag resource.", + "id": "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStoreRagResource", + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RetrieveContextsResponse": { + "description": "Response message for VertexRagService.RetrieveContexts.", + "id": "GoogleCloudAiplatformV1RetrieveContextsResponse", + "properties": { + "contexts": { + "$ref": "GoogleCloudAiplatformV1RagContexts", + "description": "The contexts of the query." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RetrieveMemoriesRequest": { + "description": "Request message for MemoryBankService.RetrieveMemories.", + "id": "GoogleCloudAiplatformV1RetrieveMemoriesRequest", + "properties": { + "filter": { + "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`)", + "type": "string" + }, + "filterGroups": { + "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\"))`.", + "items": { + "$ref": "GoogleCloudAiplatformV1MemoryConjunctionFilter" + }, + "type": "array" + }, + "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": { + "enum": [ + "MEMORY_TYPE_UNSPECIFIED", + "NATURAL_LANGUAGE_COLLECTION", + "STRUCTURED_PROFILE" + ], + "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." + ], + "type": "string" + }, + "type": "array" }, - "maxReplicaCount": { - "description": "Optional. max replicas in the node pool, must be ≥ replica_count and \u003e min_replica_count or will throw error", - "type": "string", - "format": "int64" + "scope": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" + }, + "similaritySearchParams": { + "$ref": "GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams", + "description": "Parameters for semantic similarity search based retrieval." + }, + "simpleRetrievalParams": { + "$ref": "GoogleCloudAiplatformV1RetrieveMemoriesRequestSimpleRetrievalParams", + "description": "Parameters for simple (non-similarity search) retrieval." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ResourceRuntimeSpec": { - "id": "GoogleCloudAiplatformV1ResourceRuntimeSpec", - "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.", - "type": "object", + "GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams": { + "description": "Parameters for semantic similarity search based retrieval.", + "id": "GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams", "properties": { - "serviceAccountSpec": { - "description": "Optional. Configure the use of workload identity on the PersistentResource", - "$ref": "GoogleCloudAiplatformV1ServiceAccountSpec" + "searchQuery": { + "description": "Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig set.", + "type": "string" }, - "raySpec": { - "description": "Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.", - "$ref": "GoogleCloudAiplatformV1RaySpec" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ServiceAccountSpec": { - "id": "GoogleCloudAiplatformV1ServiceAccountSpec", - "description": "Configuration for the use of custom service account to run the workloads.", - "type": "object", + "GoogleCloudAiplatformV1RetrieveMemoriesRequestSimpleRetrievalParams": { + "description": "Parameters for simple (non-similarity search) retrieval.", + "id": "GoogleCloudAiplatformV1RetrieveMemoriesRequestSimpleRetrievalParams", "properties": { - "enableCustomServiceAccount": { - "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": "boolean" + "pageSize": { + "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" }, - "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.", + "pageToken": { + "description": "Optional. A page token, received from a previous `RetrieveMemories` call. Provide this to retrieve the subsequent page.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RaySpec": { - "id": "GoogleCloudAiplatformV1RaySpec", - "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.", - "type": "object", + "GoogleCloudAiplatformV1RetrieveMemoriesResponse": { + "description": "Response message for MemoryBankService.RetrieveMemories.", + "id": "GoogleCloudAiplatformV1RetrieveMemoriesResponse", "properties": { - "imageUri": { - "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.", - "type": "string" - }, - "resourcePoolImages": { - "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", - "additionalProperties": { - "type": "string" - } - }, - "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.", + "nextPageToken": { + "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": "string" }, - "rayMetricSpec": { - "description": "Optional. Ray metrics configurations.", - "$ref": "GoogleCloudAiplatformV1RayMetricSpec" - }, - "rayLogsSpec": { - "description": "Optional. OSS Ray logging configurations.", - "$ref": "GoogleCloudAiplatformV1RayLogsSpec" - } - } - }, - "GoogleCloudAiplatformV1RayMetricSpec": { - "id": "GoogleCloudAiplatformV1RayMetricSpec", - "description": "Configuration for the Ray metrics.", - "type": "object", - "properties": { - "disabled": { - "description": "Optional. Flag to disable the Ray metrics collection.", - "type": "boolean" + "retrievedMemories": { + "description": "The retrieved memories.", + "items": { + "$ref": "GoogleCloudAiplatformV1RetrieveMemoriesResponseRetrievedMemory" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RayLogsSpec": { - "id": "GoogleCloudAiplatformV1RayLogsSpec", - "description": "Configuration for the Ray OSS Logs.", - "type": "object", + "GoogleCloudAiplatformV1RetrieveMemoriesResponseRetrievedMemory": { + "description": "A retrieved memory.", + "id": "GoogleCloudAiplatformV1RetrieveMemoriesResponseRetrievedMemory", "properties": { - "disabled": { - "description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", - "type": "boolean" + "distance": { + "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.", + "format": "double", + "type": "number" + }, + "memory": { + "$ref": "GoogleCloudAiplatformV1Memory", + "description": "The retrieved Memory." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ResourceRuntime": { - "id": "GoogleCloudAiplatformV1ResourceRuntime", - "description": "Persistent Cluster runtime information as output", - "type": "object", + "GoogleCloudAiplatformV1RollbackMemoryRequest": { + "description": "Request message for MemoryBankService.RollbackMemory.", + "id": "GoogleCloudAiplatformV1RollbackMemoryRequest", "properties": { - "accessUris": { - "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, - "type": "object", - "additionalProperties": { - "type": "string" - } + "targetRevisionId": { + "description": "Required. The ID of the revision to rollback to.", + "format": "int64", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListPersistentResourcesResponse": { - "id": "GoogleCloudAiplatformV1ListPersistentResourcesResponse", - "description": "Response message for PersistentResourceService.ListPersistentResources", - "type": "object", + "GoogleCloudAiplatformV1RougeInput": { + "description": "Input for rouge metric.", + "id": "GoogleCloudAiplatformV1RougeInput", "properties": { - "persistentResources": { - "type": "array", + "instances": { + "description": "Required. Repeated rouge instances.", "items": { - "$ref": "GoogleCloudAiplatformV1PersistentResource" - } + "$ref": "GoogleCloudAiplatformV1RougeInstance" + }, + "type": "array" }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass to ListPersistentResourcesRequest.page_token to obtain that page.", - "type": "string" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1RougeSpec", + "description": "Required. Spec for rouge score metric." } - } - }, - "GoogleCloudAiplatformV1RebootPersistentResourceRequest": { - "id": "GoogleCloudAiplatformV1RebootPersistentResourceRequest", - "description": "Request message for PersistentResourceService.RebootPersistentResource.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrainingPipeline": { - "id": "GoogleCloudAiplatformV1TrainingPipeline", - "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.", - "type": "object", + "GoogleCloudAiplatformV1RougeInstance": { + "description": "Spec for rouge instance.", + "id": "GoogleCloudAiplatformV1RougeInstance", "properties": { - "name": { - "description": "Output only. Resource name of the TrainingPipeline.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "Required. The user-defined name of this TrainingPipeline.", - "type": "string" - }, - "inputDataConfig": { - "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.", - "$ref": "GoogleCloudAiplatformV1InputDataConfig" - }, - "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" - }, - "trainingTaskInputs": { - "description": "Required. The training task's parameter(s), as specified in the training_task_definition's `inputs`.", - "type": "any" - }, - "trainingTaskMetadata": { - "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.", - "readOnly": true, - "type": "any" - }, - "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": "GoogleCloudAiplatformV1Model" - }, - "modelId": { - "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.", + "prediction": { + "description": "Required. Output of the evaluated model.", "type": "string" }, - "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`.", + "reference": { + "description": "Required. Ground truth used to compare against the prediction.", "type": "string" - }, - "state": { - "description": "Output only. The detailed state of the pipeline.", - "readOnly": true, - "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." - ], - "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" - ] - }, - "error": { - "description": "Output only. Only populated when the pipeline's state is `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.", - "readOnly": true, - "$ref": "GoogleRpcStatus" - }, - "createTime": { - "description": "Output only. Time when the TrainingPipeline was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "startTime": { - "description": "Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "endTime": { - "description": "Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`.", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RougeMetricValue": { + "description": "Rouge metric value for an instance.", + "id": "GoogleCloudAiplatformV1RougeMetricValue", + "properties": { + "score": { + "description": "Output only. Rouge score.", + "format": "float", "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Time when the TrainingPipeline was most recently updated.", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RougeResults": { + "description": "Results for rouge metric.", + "id": "GoogleCloudAiplatformV1RougeResults", + "properties": { + "rougeMetricValues": { + "description": "Output only. Rouge metric values.", + "items": { + "$ref": "GoogleCloudAiplatformV1RougeMetricValue" + }, "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "labels": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1InputDataConfig": { - "id": "GoogleCloudAiplatformV1InputDataConfig", - "description": "Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.", - "type": "object", + "GoogleCloudAiplatformV1RougeSpec": { + "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.", + "id": "GoogleCloudAiplatformV1RougeSpec", "properties": { - "fractionSplit": { - "description": "Split based on fractions defining the size of each set.", - "$ref": "GoogleCloudAiplatformV1FractionSplit" - }, - "filterSplit": { - "description": "Split based on the provided filters for each set.", - "$ref": "GoogleCloudAiplatformV1FilterSplit" - }, - "predefinedSplit": { - "description": "Supported only for tabular Datasets. Split based on a predefined key.", - "$ref": "GoogleCloudAiplatformV1PredefinedSplit" - }, - "timestampSplit": { - "description": "Supported only for tabular Datasets. Split based on the timestamp of the input data pieces.", - "$ref": "GoogleCloudAiplatformV1TimestampSplit" - }, - "stratifiedSplit": { - "description": "Supported only for tabular Datasets. Split based on the distribution of the specified column.", - "$ref": "GoogleCloudAiplatformV1StratifiedSplit" - }, - "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": "GoogleCloudAiplatformV1GcsDestination" - }, - "bigqueryDestination": { - "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\"", - "$ref": "GoogleCloudAiplatformV1BigQueryDestination" - }, - "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" - }, - "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" - }, - "annotationSchemaUri": { - "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.", + "rougeType": { + "description": "Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.", "type": "string" }, - "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" + "splitSummaries": { + "description": "Optional. Whether to split summaries while using rougeLsum.", + "type": "boolean" }, - "persistMlUseAssignment": { - "description": "Whether to persist the ML use assignment to data item system labels.", + "useStemmer": { + "description": "Optional. Whether to use stemmer to compute rouge score.", "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FractionSplit": { - "id": "GoogleCloudAiplatformV1FractionSplit", - "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", + "GoogleCloudAiplatformV1Rubric": { + "description": "Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.", + "id": "GoogleCloudAiplatformV1Rubric", "properties": { - "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.", - "type": "number", - "format": "double" + "content": { + "$ref": "GoogleCloudAiplatformV1RubricContent", + "description": "Required. The actual testable criteria for the rubric." }, - "testFraction": { - "description": "The fraction of the input data that is to be used to evaluate the Model.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudAiplatformV1FilterSplit": { - "id": "GoogleCloudAiplatformV1FilterSplit", - "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. ", - "type": "object", - "properties": { - "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.", + "importance": { + "description": "Optional. The relative importance of this rubric.", + "enum": [ + "IMPORTANCE_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW" + ], + "enumDescriptions": [ + "Importance is not specified.", + "High importance.", + "Medium importance.", + "Low importance." + ], "type": "string" }, - "validationFilter": { - "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.", + "rubricId": { + "description": "Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.", "type": "string" }, - "testFilter": { - "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.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PredefinedSplit": { - "id": "GoogleCloudAiplatformV1PredefinedSplit", - "description": "Assigns input data to training, validation, and test sets based on the value of a provided key. Supported only for tabular Datasets.", - "type": "object", + "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput": { + "description": "Instance and metric spec for RubricBasedInstructionFollowing metric.", + "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput", "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" + "instance": { + "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance", + "description": "Required. Instance for RubricBasedInstructionFollowing metric." + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec", + "description": "Required. Spec for RubricBasedInstructionFollowing metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TimestampSplit": { - "id": "GoogleCloudAiplatformV1TimestampSplit", - "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", + "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance": { + "description": "Instance for RubricBasedInstructionFollowing metric - one instance corresponds to one row in an evaluation dataset.", + "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance", "properties": { - "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.", - "type": "number", - "format": "double" - }, - "testFraction": { - "description": "The fraction of the input data that is to be used to evaluate 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.", + "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" }, - "GoogleCloudAiplatformV1StratifiedSplit": { - "id": "GoogleCloudAiplatformV1StratifiedSplit", - "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.", - "type": "object", + "GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult": { + "description": "Result for RubricBasedInstructionFollowing metric.", + "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult", "properties": { - "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.", - "type": "number", - "format": "double" - }, - "testFraction": { - "description": "The fraction of the input data that is to be used to evaluate the Model.", - "type": "number", - "format": "double" + "rubricCritiqueResults": { + "description": "Output only. List of per rubric critique results.", + "items": { + "$ref": "GoogleCloudAiplatformV1RubricCritiqueResult" + }, + "readOnly": true, + "type": "array" }, - "key": { - "description": "Required. The key is a name of one of the Dataset's data columns. The key provided must be for a categorical column.", - "type": "string" + "score": { + "description": "Output only. Overall score for the instruction following.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListTrainingPipelinesResponse": { - "id": "GoogleCloudAiplatformV1ListTrainingPipelinesResponse", - "description": "Response message for PipelineService.ListTrainingPipelines", - "type": "object", + "GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec": { + "description": "Spec for RubricBasedInstructionFollowing metric - returns rubrics and verdicts corresponding to rubrics along with overall score.", + "id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1RubricContent": { + "description": "Content of the rubric, defining the testable criteria.", + "id": "GoogleCloudAiplatformV1RubricContent", "properties": { - "trainingPipelines": { - "description": "List of TrainingPipelines in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TrainingPipeline" - } - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListTrainingPipelinesRequest.page_token to obtain that page.", - "type": "string" + "property": { + "$ref": "GoogleCloudAiplatformV1RubricContentProperty", + "description": "Evaluation criteria based on a specific property." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CancelTrainingPipelineRequest": { - "id": "GoogleCloudAiplatformV1CancelTrainingPipelineRequest", - "description": "Request message for PipelineService.CancelTrainingPipeline.", - "type": "object", - "properties": {} + "GoogleCloudAiplatformV1RubricContentProperty": { + "description": "Defines criteria based on a specific property.", + "id": "GoogleCloudAiplatformV1RubricContentProperty", + "properties": { + "description": { + "description": "Description of the property being evaluated. Example: \"The model's response is grammatically correct.\"", + "type": "string" + } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PipelineJob": { - "id": "GoogleCloudAiplatformV1PipelineJob", - "description": "An instance of a machine learning PipelineJob.", - "type": "object", + "GoogleCloudAiplatformV1RubricCritiqueResult": { + "description": "Rubric critique result.", + "id": "GoogleCloudAiplatformV1RubricCritiqueResult", "properties": { - "name": { - "description": "Output only. The resource name of the PipelineJob.", + "rubric": { + "description": "Output only. Rubric to be evaluated.", "readOnly": true, "type": "string" }, - "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" - }, - "createTime": { - "description": "Output only. Pipeline creation time.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "startTime": { - "description": "Output only. Pipeline start time.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "endTime": { - "description": "Output only. Pipeline end time.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this PipelineJob was most recently updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "pipelineSpec": { - "description": "The spec of the pipeline.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } - }, - "state": { - "description": "Output only. The detailed state of the job.", - "readOnly": true, - "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." - ], - "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" - ] - }, - "jobDetail": { - "description": "Output only. The details of pipeline run. Not available in the list view.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1PipelineJobDetail" - }, - "error": { - "description": "Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.", + "verdict": { + "description": "Output only. Verdict for the rubric - true if the rubric is met, false otherwise.", "readOnly": true, - "$ref": "GoogleRpcStatus" - }, - "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" - } - }, - "runtimeConfig": { - "description": "Runtime config of the pipeline.", - "$ref": "GoogleCloudAiplatformV1PipelineJobRuntimeConfig" - }, - "encryptionSpec": { - "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.", - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RubricGenerationSpec": { + "description": "Specification for how rubrics should be generated.", + "id": "GoogleCloudAiplatformV1RubricGenerationSpec", + "properties": { + "modelConfig": { + "$ref": "GoogleCloudAiplatformV1AutoraterConfig", + "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." }, - "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.", + "promptTemplate": { + "description": "Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.", "type": "string" }, - "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.", + "rubricContentType": { + "description": "The type of rubric content to be generated.", + "enum": [ + "RUBRIC_CONTENT_TYPE_UNSPECIFIED", + "PROPERTY", + "NL_QUESTION_ANSWER", + "PYTHON_CODE_ASSERTION" + ], + "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" }, - "reservedIpRanges": { - "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'].", - "type": "array", + "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.", "items": { "type": "string" - } - }, - "pscInterfaceConfig": { - "description": "Optional. Configuration for PSC-I for PipelineJob.", - "$ref": "GoogleCloudAiplatformV1PscInterfaceConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RubricGroup": { + "description": "A group of rubrics, used for grouping rubrics based on a metric or a version.", + "id": "GoogleCloudAiplatformV1RubricGroup", + "properties": { + "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" }, - "templateUri": { - "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.", + "groupId": { + "description": "Unique identifier for the group.", "type": "string" }, - "templateMetadata": { - "description": "Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1PipelineTemplateMetadata" + "rubrics": { + "description": "Rubrics that are part of this group.", + "items": { + "$ref": "GoogleCloudAiplatformV1Rubric" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RubricVerdict": { + "description": "Represents the verdict of an evaluation against a single rubric.", + "id": "GoogleCloudAiplatformV1RubricVerdict", + "properties": { + "evaluatedRubric": { + "$ref": "GoogleCloudAiplatformV1Rubric", + "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." }, - "scheduleName": { - "description": "Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.", - "readOnly": true, + "reasoning": { + "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.", "type": "string" }, - "preflightValidations": { - "description": "Optional. Whether to do component level validations before job creation.", + "verdict": { + "description": "Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a \"Pass\", `false` indicates a \"Fail\".", "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PipelineJobDetail": { - "id": "GoogleCloudAiplatformV1PipelineJobDetail", - "description": "The runtime detail of PipelineJob.", - "type": "object", + "GoogleCloudAiplatformV1SafetyInput": { + "description": "Input for safety metric.", + "id": "GoogleCloudAiplatformV1SafetyInput", "properties": { - "pipelineContext": { - "description": "Output only. The context of the pipeline.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1Context" - }, - "pipelineRunContext": { - "description": "Output only. The context of the current pipeline run.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1Context" + "instance": { + "$ref": "GoogleCloudAiplatformV1SafetyInstance", + "description": "Required. Safety instance." }, - "taskDetails": { - "description": "Output only. The runtime details of the tasks under the pipeline.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1PipelineTaskDetail" - } + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1SafetySpec", + "description": "Required. Spec for safety metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PipelineTaskDetail": { - "id": "GoogleCloudAiplatformV1PipelineTaskDetail", - "description": "The runtime detail of a task execution.", - "type": "object", + "GoogleCloudAiplatformV1SafetyInstance": { + "description": "Spec for safety instance.", + "id": "GoogleCloudAiplatformV1SafetyInstance", "properties": { - "taskId": { - "description": "Output only. The system generated ID of the task.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "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.", + "prediction": { + "description": "Required. Output of the evaluated model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SafetyRating": { + "description": "A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.", + "id": "GoogleCloudAiplatformV1SafetyRating", + "properties": { + "blocked": { + "description": "Output only. Indicates whether the content was blocked because of this rating.", "readOnly": true, - "type": "string", - "format": "int64" + "type": "boolean" }, - "taskName": { - "description": "Output only. The user specified name of the task that is defined in pipeline_spec.", + "category": { + "description": "Output only. The harm category of this rating.", + "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" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false + ], + "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." + ], "readOnly": true, "type": "string" }, - "createTime": { - "description": "Output only. Task create time.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "startTime": { - "description": "Output only. Task start time.", + "overwrittenThreshold": { + "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.", + "enum": [ + "HARM_BLOCK_THRESHOLD_UNSPECIFIED", + "BLOCK_LOW_AND_ABOVE", + "BLOCK_MEDIUM_AND_ABOVE", + "BLOCK_ONLY_HIGH", + "BLOCK_NONE", + "OFF" + ], + "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." + ], "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "string" }, - "endTime": { - "description": "Output only. Task end time.", + "probability": { + "description": "Output only. The probability of harm for this category.", + "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." + ], "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "string" }, - "executorDetail": { - "description": "Output only. The detailed execution info.", + "probabilityScore": { + "description": "Output only. The probability score of harm for this category.", + "format": "float", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1PipelineTaskExecutorDetail" + "type": "number" }, - "state": { - "description": "Output only. State of the task.", - "readOnly": true, - "type": "string", + "severity": { + "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": [ - "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." + "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." ], - "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "SUCCEEDED", - "CANCEL_PENDING", - "CANCELLING", - "CANCELLED", - "FAILED", - "SKIPPED", - "NOT_TRIGGERED" - ] - }, - "execution": { - "description": "Output only. The execution metadata of the task.", "readOnly": true, - "$ref": "GoogleCloudAiplatformV1Execution" + "type": "string" }, - "error": { - "description": "Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.", + "severityScore": { + "description": "Output only. The severity score of harm for this category.", + "format": "float", "readOnly": true, - "$ref": "GoogleRpcStatus" - }, - "pipelineTaskStatus": { - "description": "Output only. A list of task status. This field keeps a record of task status evolving over time.", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SafetyResult": { + "description": "Spec for safety result.", + "id": "GoogleCloudAiplatformV1SafetyResult", + "properties": { + "confidence": { + "description": "Output only. Confidence for safety score.", + "format": "float", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus" - } + "type": "number" }, - "inputs": { - "description": "Output only. The runtime input artifacts of the task.", + "explanation": { + "description": "Output only. Explanation for safety score.", "readOnly": true, - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1PipelineTaskDetailArtifactList" - } + "type": "string" }, - "outputs": { - "description": "Output only. The runtime output artifacts of the task.", + "score": { + "description": "Output only. Safety score.", + "format": "float", "readOnly": true, - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1PipelineTaskDetailArtifactList" - } + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SafetySetting": { + "description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.", + "id": "GoogleCloudAiplatformV1SafetySetting", + "properties": { + "category": { + "description": "Required. The harm category to be blocked.", + "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" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false + ], + "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." + ], + "type": "string" }, - "taskUniqueName": { - "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\".", - "readOnly": true, + "method": { + "description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.", + "enum": [ + "HARM_BLOCK_METHOD_UNSPECIFIED", + "SEVERITY", + "PROBABILITY" + ], + "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": "string" + }, + "threshold": { + "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" + ], + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PipelineTaskExecutorDetail": { - "id": "GoogleCloudAiplatformV1PipelineTaskExecutorDetail", - "description": "The runtime detail of a pipeline executor.", - "type": "object", + "GoogleCloudAiplatformV1SafetySpec": { + "description": "Spec for safety metric.", + "id": "GoogleCloudAiplatformV1SafetySpec", "properties": { - "containerDetail": { - "description": "Output only. The detailed info for a container executor.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail" + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SampleConfig": { + "description": "Active learning data sampling config. For every active learning labeling iteration, it will select a batch of data based on the sampling strategy.", + "id": "GoogleCloudAiplatformV1SampleConfig", + "properties": { + "followingBatchSamplePercentage": { + "description": "The percentage of data needed to be labeled in each following batch (except the first batch).", + "format": "int32", + "type": "integer" }, - "customJobDetail": { - "description": "Output only. The detailed info for a custom job executor.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail" + "initialBatchSamplePercentage": { + "description": "The percentage of data needed to be labeled in the first batch.", + "format": "int32", + "type": "integer" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail": { - "id": "GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail", - "description": "The detail of a container execution. It contains the job names of the lifecycle of a container execution.", - "type": "object", + "GoogleCloudAiplatformV1SampledShapleyAttribution": { + "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": "GoogleCloudAiplatformV1SampledShapleyAttribution", "properties": { - "mainJob": { - "description": "Output only. The name of the CustomJob for the main container execution.", + "pathCount": { + "description": "Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SamplingStrategy": { + "description": "Sampling Strategy for logging, can be for both training and prediction dataset.", + "id": "GoogleCloudAiplatformV1SamplingStrategy", + "properties": { + "randomSampleConfig": { + "$ref": "GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig", + "description": "Random sample config. Will support more sampling strategies later." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig": { + "description": "Requests are randomly selected.", + "id": "GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig", + "properties": { + "sampleRate": { + "description": "Sample rate (0, 1]", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SandboxEnvironment": { + "description": "SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.", + "id": "GoogleCloudAiplatformV1SandboxEnvironment", + "properties": { + "connectionInfo": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentConnectionInfo", + "description": "Output only. The connection information of the SandboxEnvironment.", + "readOnly": true + }, + "createTime": { + "description": "Output only. The timestamp when this SandboxEnvironment was created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "preCachingCheckJob": { - "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.", - "readOnly": true, + "displayName": { + "description": "Required. The display name of the SandboxEnvironment.", "type": "string" }, - "failedMainJobs": { - "description": "Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } + "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" }, - "failedPreCachingCheckJobs": { - "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.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail": { - "id": "GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail", - "description": "The detailed info for a custom job executor.", - "type": "object", - "properties": { - "job": { - "description": "Output only. The name of the CustomJob.", + "latestSandboxEnvironmentSnapshot": { + "description": "Output only. The resource name of the latest snapshot taken for this SandboxEnvironment.", "readOnly": true, "type": "string" }, - "failedJobs": { - "description": "Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus": { - "id": "GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus", - "description": "A single record of the task status.", - "type": "object", - "properties": { - "updateTime": { - "description": "Output only. Update time of this status.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "name": { + "description": "Identifier. The name of the SandboxEnvironment.", + "type": "string" + }, + "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" + }, + "sandboxEnvironmentSnapshot": { + "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}`", + "type": "string" + }, + "sandboxEnvironmentTemplate": { + "description": "Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from.", + "type": "string" + }, + "spec": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSpec", + "description": "Optional. The configuration of the SandboxEnvironment." }, "state": { - "description": "Output only. The state of the task.", - "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." - ], + "description": "Output only. The runtime state of the SandboxEnvironment.", "enum": [ "STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "SUCCEEDED", - "CANCEL_PENDING", - "CANCELLING", - "CANCELLED", - "FAILED", - "SKIPPED", - "NOT_TRIGGERED" - ] + "STATE_PROVISIONING", + "STATE_RUNNING", + "STATE_DEPROVISIONING", + "STATE_TERMINATED", + "STATE_DELETED" + ], + "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." + ], + "readOnly": true, + "type": "string" + }, + "ttl": { + "description": "Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.", + "format": "google-duration", + "type": "string" }, - "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.", + "updateTime": { + "description": "Output only. The timestamp when this SandboxEnvironment was most recently updated.", + "format": "google-datetime", "readOnly": true, - "$ref": "GoogleRpcStatus" + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PipelineTaskDetailArtifactList": { - "id": "GoogleCloudAiplatformV1PipelineTaskDetailArtifactList", - "description": "A list of artifact metadata.", - "type": "object", + "GoogleCloudAiplatformV1SandboxEnvironmentConnectionInfo": { + "description": "The connection information of the SandboxEnvironment.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentConnectionInfo", "properties": { - "artifacts": { - "description": "Output only. A list of artifact metadata.", + "loadBalancerHostname": { + "description": "Output only. The hostname of the load balancer.", "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Artifact" - } + "type": "string" + }, + "loadBalancerIp": { + "description": "Output only. The IP address of the load balancer.", + "readOnly": true, + "type": "string" + }, + "routingToken": { + "description": "Output only. The routing token for the SandboxEnvironment.", + "readOnly": true, + "type": "string" + }, + "sandboxInternalIp": { + "description": "Output only. The internal IP address of the SandboxEnvironment.", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PipelineJobRuntimeConfig": { - "id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfig", - "description": "The runtime config of a PipelineJob.", - "type": "object", + "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot": { + "description": "SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot", "properties": { - "parameters": { - "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.", - "deprecated": true, - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1Value" - } + "createTime": { + "description": "Output only. The timestamp when this SandboxEnvironmentSnapshot was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "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.", + "displayName": { + "description": "Required. The display name of the SandboxEnvironmentSnapshot.", "type": "string" }, - "parameterValues": { - "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.", - "type": "object", - "additionalProperties": { - "type": "any" - } + "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" }, - "failurePolicy": { - "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.", - "type": "string", + "name": { + "description": "Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", + "type": "string" + }, + "owner": { + "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.", + "type": "string" + }, + "parentSnapshot": { + "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.", + "readOnly": true, + "type": "string" + }, + "postSnapshotAction": { + "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.", + "enum": [ + "POST_SNAPSHOT_ACTION_UNSPECIFIED", + "RUNNING", + "PAUSE" + ], "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." + "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": [ - "PIPELINE_FAILURE_POLICY_UNSPECIFIED", - "PIPELINE_FAILURE_POLICY_FAIL_SLOW", - "PIPELINE_FAILURE_POLICY_FAIL_FAST" - ] + "type": "string" }, - "inputArtifacts": { - "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", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact" - } - } - } - }, - "GoogleCloudAiplatformV1Value": { - "id": "GoogleCloudAiplatformV1Value", - "description": "Value is the value of the field.", - "type": "object", - "properties": { - "intValue": { - "description": "An integer value.", - "type": "string", - "format": "int64" + "sizeBytes": { + "description": "Optional. Output only. Size of the snapshot data in bytes.", + "format": "int64", + "readOnly": true, + "type": "string" }, - "doubleValue": { - "description": "A double value.", - "type": "number", - "format": "double" + "sourceSandboxEnvironment": { + "description": "Required. The resource name of the source SandboxEnvironment this snapshot was taken from.", + "type": "string" }, - "stringValue": { - "description": "A string value.", + "ttl": { + "description": "Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.", + "format": "google-duration", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when this SandboxEnvironment was most recently updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact": { - "id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact", - "description": "The type of an input artifact.", - "type": "object", + "GoogleCloudAiplatformV1SandboxEnvironmentSpec": { + "description": "The specification of a SandboxEnvironment.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentSpec", "properties": { - "artifactId": { - "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.", - "type": "string" + "codeExecutionEnvironment": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSpecCodeExecutionEnvironment", + "description": "Optional. The code execution environment." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PipelineTemplateMetadata": { - "id": "GoogleCloudAiplatformV1PipelineTemplateMetadata", - "description": "Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry.", - "type": "object", + "GoogleCloudAiplatformV1SandboxEnvironmentSpecCodeExecutionEnvironment": { + "description": "The code execution environment with customized settings.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentSpecCodeExecutionEnvironment", "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...\".", + "codeLanguage": { + "description": "The coding language supported in this environment.", + "enum": [ + "LANGUAGE_UNSPECIFIED", + "LANGUAGE_PYTHON", + "LANGUAGE_JAVASCRIPT" + ], + "enumDescriptions": [ + "The default value. This value is unused.", + "The coding language is Python.", + "The coding language is JavaScript." + ], + "type": "string" + }, + "machineConfig": { + "description": "The machine config of the code execution environment.", + "enum": [ + "MACHINE_CONFIG_UNSPECIFIED", + "MACHINE_CONFIG_VCPU4_RAM4GIB" + ], + "enumDescriptions": [ + "The default value: milligcu 2000, memory 1.5Gib", + "The default value: milligcu 4000, memory 4 Gib" + ], "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListPipelineJobsResponse": { - "id": "GoogleCloudAiplatformV1ListPipelineJobsResponse", - "description": "Response message for PipelineService.ListPipelineJobs", - "type": "object", + "GoogleCloudAiplatformV1SandboxEnvironmentTemplate": { + "description": "The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate", "properties": { - "pipelineJobs": { - "description": "List of PipelineJobs in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1PipelineJob" - } + "createTime": { + "description": "Output only. The timestamp when this SandboxEnvironmentTemplate was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListPipelineJobsRequest.page_token to obtain that page.", + "customContainerEnvironment": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerEnvironment", + "description": "The sandbox environment for custom container workloads." + }, + "defaultContainerEnvironment": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment", + "description": "The sandbox environment for default container workloads." + }, + "displayName": { + "description": "Required. The display name of the SandboxEnvironmentTemplate.", + "type": "string" + }, + "egressControlConfig": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig", + "description": "Optional. The configuration for egress control of this template." + }, + "name": { + "description": "Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", + "type": "string" + }, + "state": { + "description": "Output only. The state of the sandbox environment template.", + "enum": [ + "UNSPECIFIED", + "PROVISIONING", + "ACTIVE", + "DEPROVISIONING", + "DELETED", + "FAILED" + ], + "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." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest": { - "id": "GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest", - "description": "Request message for PipelineService.BatchDeletePipelineJobs.", - "type": "object", + "GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerEnvironment": { + "description": "The customized sandbox runtime environment for BYOC.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerEnvironment", "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", + "customContainerSpec": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerSpec", + "description": "The specification of the custom container environment." + }, + "ports": { + "description": "Ports to expose from the container.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateNetworkPort" + }, + "type": "array" + }, + "resources": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateResourceRequirements", + "description": "Resource requests and limits for the container." } - } - }, - "GoogleCloudAiplatformV1CancelPipelineJobRequest": { - "id": "GoogleCloudAiplatformV1CancelPipelineJobRequest", - "description": "Request message for PipelineService.CancelPipelineJob.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest": { - "id": "GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest", - "description": "Request message for PipelineService.BatchCancelPipelineJobs.", - "type": "object", + "GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerSpec": { + "description": "Specification for deploying from a custom container image.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerSpec", "properties": { - "names": { - "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}`", - "type": "array", - "items": { - "type": "string" - } + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QueryReasoningEngineRequest": { - "id": "GoogleCloudAiplatformV1QueryReasoningEngineRequest", - "description": "Request message for ReasoningEngineExecutionService.Query.", - "type": "object", + "GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment": { + "description": "The default sandbox runtime environment for default container workloads.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment", "properties": { - "input": { - "description": "Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.", - "type": "object", - "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.", + "defaultContainerCategory": { + "description": "Required. The category of the default container image.", + "enum": [ + "DEFAULT_CONTAINER_CATEGORY_UNSPECIFIED", + "DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE" + ], + "enumDescriptions": [ + "The default value. This value is unused.", + "The default container image for Computer Use." + ], "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1QueryReasoningEngineResponse": { - "id": "GoogleCloudAiplatformV1QueryReasoningEngineResponse", - "description": "Response message for ReasoningEngineExecutionService.Query", - "type": "object", + "GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig": { + "description": "Configuration for egress control of sandbox instances.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig", "properties": { - "output": { - "description": "Response provided by users in JSON object format.", - "type": "any" + "internetAccess": { + "description": "Optional. Whether to allow internet access.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest": { - "id": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest", - "description": "Request message for ReasoningEngineExecutionService.StreamQuery.", - "type": "object", + "GoogleCloudAiplatformV1SandboxEnvironmentTemplateNetworkPort": { + "description": "Represents a network port in a container.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateNetworkPort", "properties": { - "input": { - "description": "Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } + "port": { + "description": "Optional. Port number to expose. This must be a valid port number, between 1 and 65535.", + "format": "int32", + "type": "integer" }, - "classMethod": { - "description": "Optional. Class method to be used for the stream query. It is optional and defaults to \"stream_query\" if unspecified.", + "protocol": { + "description": "Optional. Protocol for port. Defaults to TCP if not specified.", + "enum": [ + "PROTOCOL_UNSPECIFIED", + "TCP", + "UDP" + ], + "enumDescriptions": [ + "Unspecified protocol. Defaults to TCP.", + "TCP protocol.", + "UDP protocol." + ], "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReasoningEngine": { - "id": "GoogleCloudAiplatformV1ReasoningEngine", - "description": "ReasoningEngine provides a customizable runtime for models to determine which actions to take and in which order.", - "type": "object", + "GoogleCloudAiplatformV1SandboxEnvironmentTemplateResourceRequirements": { + "description": "Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateResourceRequirements", "properties": { - "name": { - "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "type": "string" - }, - "displayName": { - "description": "Required. The display name of the ReasoningEngine.", - "type": "string" + "limits": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., \"cpu\", \"memory\"). Values are quantities (e.g., \"500m\", \"1Gi\").", + "type": "object" }, - "description": { - "description": "Optional. The description of the ReasoningEngine.", + "requests": { + "additionalProperties": { + "type": "string" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SavedQuery": { + "description": "A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.", + "id": "GoogleCloudAiplatformV1SavedQuery", + "properties": { + "annotationFilter": { + "description": "Output only. Filters on the Annotations in the dataset.", + "readOnly": true, "type": "string" }, - "spec": { - "description": "Optional. Configurations of the ReasoningEngine", - "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpec" + "annotationSpecCount": { + "description": "Output only. Number of AnnotationSpecs in the context of the SavedQuery.", + "format": "int32", + "readOnly": true, + "type": "integer" }, "createTime": { - "description": "Output only. Timestamp when this ReasoningEngine was created.", + "description": "Output only. Timestamp when this SavedQuery was created.", + "format": "google-datetime", "readOnly": true, - "type": "string", - "format": "google-datetime" + "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp when this ReasoningEngine was most recently updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "displayName": { + "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.", + "type": "string" }, "etag": { - "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "description": "Used to perform a consistent read-modify-write update. If not set, a blind \"overwrite\" update happens.", "type": "string" }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" - }, - "labels": { - "description": "Labels for the ReasoningEngine.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1ReasoningEngineSpec": { - "id": "GoogleCloudAiplatformV1ReasoningEngineSpec", - "description": "ReasoningEngine configurations", - "type": "object", - "properties": { - "sourceCodeSpec": { - "description": "Deploy from source code files with a defined entrypoint.", - "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec" + "metadata": { + "description": "Some additional information about the SavedQuery.", + "type": "any" }, - "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.", + "name": { + "description": "Output only. Resource name of the SavedQuery.", + "readOnly": true, "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": "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec" - }, - "deploymentSpec": { - "description": "Optional. The specification of a Reasoning Engine deployment.", - "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec" + "problemType": { + "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", + "type": "string" }, - "classMethods": { - "description": "Optional. Declarations for object class methods in OpenAPI specification format.", - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } - } + "supportAutomlTraining": { + "description": "Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.", + "readOnly": true, + "type": "boolean" }, - "agentFramework": { - "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"google-adk\", \"langchain\", \"langgraph\", \"ag2\", \"llama-index\", \"custom\".", + "updateTime": { + "description": "Output only. Timestamp when SavedQuery was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } - } - }, - "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec": { - "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec", - "description": "Specification for deploying from source code.", - "type": "object", - "properties": { - "inlineSource": { - "description": "Source code is provided directly in the request.", - "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource" - }, - "pythonSpec": { - "description": "Configuration for a Python application.", - "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec" - } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource": { - "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource", - "description": "Specifies source code provided as a byte stream.", - "type": "object", + "GoogleCloudAiplatformV1Scalar": { + "description": "One point viewable on a scalar metric plot.", + "id": "GoogleCloudAiplatformV1Scalar", "properties": { - "sourceArchive": { - "description": "Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file.", - "type": "string", - "format": "byte" + "value": { + "description": "Value of the point at this step / timestamp.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec": { - "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec", - "description": "Specification for running a Python application from source.", - "type": "object", + "GoogleCloudAiplatformV1Schedule": { + "description": "An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.", + "id": "GoogleCloudAiplatformV1Schedule", "properties": { - "version": { - "description": "Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10.", + "allowQueueing": { + "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.", + "type": "boolean" + }, + "catchUp": { + "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, + "type": "boolean" + }, + "createNotebookExecutionJobRequest": { + "$ref": "GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest", + "description": "Request for NotebookService.CreateNotebookExecutionJob." + }, + "createPipelineJobRequest": { + "$ref": "GoogleCloudAiplatformV1CreatePipelineJobRequest", + "description": "Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location})." + }, + "createTime": { + "description": "Output only. Timestamp when this Schedule was created.", + "format": "google-datetime", + "readOnly": true, "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.", + "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" }, - "entrypointObject": { - "description": "Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to \"root_agent\".", + "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" }, - "requirementsFile": { - "description": "Optional. The path to the requirements file, relative to the source root. If not specified, defaults to \"requirements.txt\".", + "endTime": { + "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 >= 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.", + "format": "google-datetime", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec": { - "id": "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec", - "description": "User-provided package specification, containing pickled object and package requirements.", - "type": "object", - "properties": { - "pickleObjectGcsUri": { - "description": "Optional. The Cloud Storage URI of the pickled python object.", + }, + "lastPauseTime": { + "description": "Output only. Timestamp when this Schedule was last paused. Unset if never paused.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "dependencyFilesGcsUri": { - "description": "Optional. The Cloud Storage URI of the dependency files in tar.gz format.", + "lastResumeTime": { + "description": "Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "requirementsGcsUri": { - "description": "Optional. The Cloud Storage URI of the `requirements.txt` file", + "lastScheduledRunResponse": { + "$ref": "GoogleCloudAiplatformV1ScheduleRunResponse", + "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 + }, + "maxConcurrentActiveRunCount": { + "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.", + "format": "int64", "type": "string" }, - "pythonVersion": { - "description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.", + "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" - } - } - }, - "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec": { - "id": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec", - "description": "The specification of a Reasoning Engine deployment.", - "type": "object", - "properties": { - "env": { - "description": "Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1EnvVar" - } }, - "secretEnv": { - "description": "Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SecretEnvVar" - } + "maxRunCount": { + "description": "Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= 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.", + "format": "int64", + "type": "string" }, - "pscInterfaceConfig": { - "description": "Optional. Configuration for PSC-I.", - "$ref": "GoogleCloudAiplatformV1PscInterfaceConfig" + "name": { + "description": "Immutable. The resource name of the Schedule.", + "type": "string" }, - "minInstances": { - "description": "Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].", - "type": "integer", - "format": "int32" + "nextRunTime": { + "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.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "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].", - "type": "integer", - "format": "int32" + "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" }, - "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", - "type": "object", - "additionalProperties": { - "type": "string" - } + "startedRunCount": { + "description": "Output only. The number of runs started by this schedule.", + "format": "int64", + "readOnly": true, + "type": "string" }, - "containerConcurrency": { - "description": "Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.", - "type": "integer", - "format": "int32" + "state": { + "description": "Output only. The state of this Schedule.", + "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." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this Schedule was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SecretEnvVar": { - "id": "GoogleCloudAiplatformV1SecretEnvVar", - "description": "Represents an environment variable where the value is a secret in Cloud Secret Manager.", - "type": "object", + "GoogleCloudAiplatformV1ScheduleRunResponse": { + "description": "Status of a scheduled run.", + "id": "GoogleCloudAiplatformV1ScheduleRunResponse", "properties": { - "name": { - "description": "Required. Name of the secret environment variable.", + "runResponse": { + "description": "The response of the scheduled run.", "type": "string" }, - "secretRef": { - "description": "Required. Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.", - "$ref": "GoogleCloudAiplatformV1SecretRef" + "scheduledRunTime": { + "description": "The scheduled run time based on the user-specified schedule.", + "format": "google-datetime", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SecretRef": { - "id": "GoogleCloudAiplatformV1SecretRef", - "description": "Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.", - "type": "object", + "GoogleCloudAiplatformV1Scheduling": { + "description": "All parameters related to queuing and scheduling of custom jobs.", + "id": "GoogleCloudAiplatformV1Scheduling", "properties": { - "secret": { - "description": "Required. The name of the secret in Cloud Secret Manager. Format: {secret_name}.", + "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": { + "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.", + "format": "google-duration", + "type": "string" + }, + "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" + }, + "strategy": { + "description": "Optional. This determines which type of scheduling strategy to use.", + "enum": [ + "STRATEGY_UNSPECIFIED", + "ON_DEMAND", + "LOW_COST", + "STANDARD", + "SPOT", + "FLEX_START" + ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false + ], + "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." + ], "type": "string" }, - "version": { - "description": "The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.", + "timeout": { + "description": "Optional. The maximum job running time. The default is 7 days.", + "format": "google-duration", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListReasoningEnginesResponse": { - "id": "GoogleCloudAiplatformV1ListReasoningEnginesResponse", - "description": "Response message for ReasoningEngineService.ListReasoningEngines", - "type": "object", + "GoogleCloudAiplatformV1Schema": { + "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).", + "id": "GoogleCloudAiplatformV1Schema", "properties": { - "reasoningEngines": { - "description": "List of ReasoningEngines in the requested page.", - "type": "array", + "additionalProperties": { + "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.", + "type": "any" + }, + "anyOf": { + "description": "Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.", "items": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" - } + "$ref": "GoogleCloudAiplatformV1Schema" + }, + "type": "array" }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListReasoningEnginesRequest.page_token to obtain that page.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1Schedule": { - "id": "GoogleCloudAiplatformV1Schedule", - "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", - "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 * * * *\".", + "default": { + "description": "Optional. Default value to use if the field is not specified.", + "type": "any" + }, + "defs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1Schema" + }, + "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.", + "type": "object" + }, + "description": { + "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.", "type": "string" }, - "createPipelineJobRequest": { - "description": "Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).", - "$ref": "GoogleCloudAiplatformV1CreatePipelineJobRequest" + "enum": { + "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\"]}`", + "items": { + "type": "string" + }, + "type": "array" }, - "createNotebookExecutionJobRequest": { - "description": "Request for NotebookService.CreateNotebookExecutionJob.", - "$ref": "GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest" + "example": { + "description": "Optional. Example of an instance of this schema.", + "type": "any" }, - "name": { - "description": "Immutable. The resource name of the Schedule.", + "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" }, - "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1Schema", + "description": "Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array." + }, + "maxItems": { + "description": "Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.", + "format": "int64", "type": "string" }, - "startTime": { - "description": "Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.", - "type": "string", - "format": "google-datetime" + "maxLength": { + "description": "Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.", + "format": "int64", + "type": "string" }, - "endTime": { - "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.", - "type": "string", - "format": "google-datetime" + "maxProperties": { + "description": "Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.", + "format": "int64", + "type": "string" }, - "maxRunCount": { - "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", - "format": "int64" + "maximum": { + "description": "Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.", + "format": "double", + "type": "number" }, - "startedRunCount": { - "description": "Output only. The number of runs started by this schedule.", - "readOnly": true, - "type": "string", - "format": "int64" + "minItems": { + "description": "Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.", + "format": "int64", + "type": "string" }, - "state": { - "description": "Output only. The state of this Schedule.", - "readOnly": true, - "type": "string", - "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." - ], - "enum": [ - "STATE_UNSPECIFIED", - "ACTIVE", - "PAUSED", - "COMPLETED" - ] + "minLength": { + "description": "Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.", + "format": "int64", + "type": "string" }, - "createTime": { - "description": "Output only. Timestamp when this Schedule was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "minProperties": { + "description": "Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.", + "format": "int64", + "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp when this Schedule was updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "minimum": { + "description": "Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.", + "format": "double", + "type": "number" }, - "nextRunTime": { - "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", - "format": "google-datetime" + "nullable": { + "description": "Optional. Indicates if the value of this field can be null.", + "type": "boolean" }, - "lastPauseTime": { - "description": "Output only. Timestamp when this Schedule was last paused. Unset if never paused.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "pattern": { + "description": "Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.", + "type": "string" }, - "lastResumeTime": { - "description": "Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "properties": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1Schema" + }, + "description": "Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.", + "type": "object" }, - "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).", - "type": "string", - "format": "int64" + "propertyOrdering": { + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "allowQueueing": { - "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.", - "type": "boolean" + "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" }, - "catchUp": { - "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, - "type": "boolean" + "required": { + "description": "Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.", + "items": { + "type": "string" + }, + "type": "array" }, - "lastScheduledRunResponse": { - "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, - "$ref": "GoogleCloudAiplatformV1ScheduleRunResponse" - } - } - }, - "GoogleCloudAiplatformV1CreatePipelineJobRequest": { - "id": "GoogleCloudAiplatformV1CreatePipelineJobRequest", - "description": "Request message for PipelineService.CreatePipelineJob.", - "type": "object", - "properties": { - "parent": { - "description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`", + "title": { + "description": "Optional. Title for the schema.", "type": "string" }, - "pipelineJob": { - "description": "Required. The PipelineJob to create.", - "$ref": "GoogleCloudAiplatformV1PipelineJob" - }, - "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": { + "description": "Optional. Data type of the schema field.", + "enum": [ + "TYPE_UNSPECIFIED", + "STRING", + "NUMBER", + "INTEGER", + "BOOLEAN", + "ARRAY", + "OBJECT", + "NULL" + ], + "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" + ], "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest": { - "id": "GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest", - "description": "Request message for [NotebookService.CreateNotebookExecutionJob]", - "type": "object", + "GoogleCloudAiplatformV1SchemaAnnotationSpecColor": { + "description": "An entry of mapping between color and AnnotationSpec. The mapping is used in segmentation mask.", + "id": "GoogleCloudAiplatformV1SchemaAnnotationSpecColor", "properties": { - "parent": { - "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", - "type": "string" + "color": { + "$ref": "GoogleTypeColor", + "description": "The color of the AnnotationSpec in a segmentation mask." }, - "notebookExecutionJob": { - "description": "Required. The NotebookExecutionJob to create.", - "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" + "displayName": { + "description": "The display name of the AnnotationSpec represented by the color in the segmentation mask.", + "type": "string" }, - "notebookExecutionJobId": { - "description": "Optional. User specified ID for the NotebookExecutionJob.", + "id": { + "description": "The ID of the AnnotationSpec represented by the color in the segmentation mask.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ScheduleRunResponse": { - "id": "GoogleCloudAiplatformV1ScheduleRunResponse", - "description": "Status of a scheduled run.", - "type": "object", + "GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation": { + "description": "Annotation details specific to image object detection.", + "id": "GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation", "properties": { - "scheduledRunTime": { - "description": "The scheduled run time based on the user-specified schedule.", - "type": "string", - "format": "google-datetime" + "annotationSpecId": { + "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", + "type": "string" }, - "runResponse": { - "description": "The response of the scheduled run.", + "displayName": { + "description": "The display name of the AnnotationSpec that this Annotation pertains to.", "type": "string" + }, + "xMax": { + "description": "The rightmost coordinate of the bounding box.", + "format": "double", + "type": "number" + }, + "xMin": { + "description": "The leftmost coordinate of the bounding box.", + "format": "double", + "type": "number" + }, + "yMax": { + "description": "The bottommost coordinate of the bounding box.", + "format": "double", + "type": "number" + }, + "yMin": { + "description": "The topmost coordinate of the bounding box.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListSchedulesResponse": { - "id": "GoogleCloudAiplatformV1ListSchedulesResponse", - "description": "Response message for ScheduleService.ListSchedules", - "type": "object", + "GoogleCloudAiplatformV1SchemaImageClassificationAnnotation": { + "description": "Annotation details specific to image classification.", + "id": "GoogleCloudAiplatformV1SchemaImageClassificationAnnotation", "properties": { - "schedules": { - "description": "List of Schedules in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Schedule" - } + "annotationSpecId": { + "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", + "type": "string" }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListSchedulesRequest.page_token to obtain that page.", + "displayName": { + "description": "The display name of the AnnotationSpec that this Annotation pertains to.", "type": "string" } - } - }, - "GoogleCloudAiplatformV1PauseScheduleRequest": { - "id": "GoogleCloudAiplatformV1PauseScheduleRequest", - "description": "Request message for ScheduleService.PauseSchedule.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1ResumeScheduleRequest": { - "id": "GoogleCloudAiplatformV1ResumeScheduleRequest", - "description": "Request message for ScheduleService.ResumeSchedule.", - "type": "object", + "GoogleCloudAiplatformV1SchemaImageDataItem": { + "description": "Payload of Image DataItem.", + "id": "GoogleCloudAiplatformV1SchemaImageDataItem", "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" + "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", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SpecialistPool": { - "id": "GoogleCloudAiplatformV1SpecialistPool", - "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.", - "type": "object", + "GoogleCloudAiplatformV1SchemaImageDatasetMetadata": { + "description": "The metadata of Datasets that contain Image DataItems.", + "id": "GoogleCloudAiplatformV1SchemaImageDatasetMetadata", "properties": { - "name": { - "description": "Required. The resource name of the SpecialistPool.", + "dataItemSchemaUri": { + "description": "Points to a YAML file stored on Google Cloud Storage describing payload of the Image DataItems that belong to this Dataset.", "type": "string" }, - "displayName": { - "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.", + "gcsBucket": { + "description": "Google Cloud Storage Bucket name that contains the blob data of this Dataset.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation": { + "description": "Annotation details specific to image segmentation.", + "id": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation", + "properties": { + "maskAnnotation": { + "$ref": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation", + "description": "Mask based segmentation annotation. Only one mask annotation can exist for one image." }, - "specialistManagersCount": { - "description": "Output only. The number of managers in this SpecialistPool.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "specialistManagerEmails": { - "description": "The email addresses of the managers in the SpecialistPool.", - "type": "array", - "items": { - "type": "string" - } - }, - "pendingDataLabelingJobs": { - "description": "Output only. The resource name of the pending data labeling jobs.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } + "polygonAnnotation": { + "$ref": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation", + "description": "Polygon annotation." }, - "specialistWorkerEmails": { - "description": "The email addresses of workers in the SpecialistPool.", - "type": "array", - "items": { - "type": "string" - } + "polylineAnnotation": { + "$ref": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation", + "description": "Polyline annotation." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListSpecialistPoolsResponse": { - "id": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse", - "description": "Response message for SpecialistPoolService.ListSpecialistPools.", - "type": "object", + "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation": { + "description": "The mask based segmentation annotation.", + "id": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation", "properties": { - "specialistPools": { - "description": "A list of SpecialistPools that matches the specified filter in the request.", - "type": "array", + "annotationSpecColors": { + "description": "The mapping between color and AnnotationSpec for this Annotation.", "items": { - "$ref": "GoogleCloudAiplatformV1SpecialistPool" - } + "$ref": "GoogleCloudAiplatformV1SchemaAnnotationSpecColor" + }, + "type": "array" }, - "nextPageToken": { - "description": "The standard List next-page token.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Tensorboard": { - "id": "GoogleCloudAiplatformV1Tensorboard", - "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", + "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation": { + "description": "Represents a polygon in image.", + "id": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation", "properties": { - "name": { - "description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "readOnly": true, + "annotationSpecId": { + "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "displayName": { - "description": "Required. User provided name of this Tensorboard.", - "type": "string" - }, - "description": { - "description": "Description of this Tensorboard.", + "description": "The display name of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, - "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": "GoogleCloudAiplatformV1EncryptionSpec" - }, - "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 '/'.", - "readOnly": true, + "vertexes": { + "description": "The vertexes are connected one by one and the last vertex is connected to the first one to represent a polygon.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaVertex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation": { + "description": "Represents a polyline in image.", + "id": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation", + "properties": { + "annotationSpecId": { + "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, - "runCount": { - "description": "Output only. The number of Runs stored in this Tensorboard.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "createTime": { - "description": "Output only. Timestamp when this Tensorboard was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this Tensorboard was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "labels": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "etag": { - "description": "Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "displayName": { + "description": "The display name of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, - "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": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" - }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "vertexes": { + "description": "The vertexes are connected one by one and the last vertex in not connected to the first one.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaVertex" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListTensorboardsResponse": { - "id": "GoogleCloudAiplatformV1ListTensorboardsResponse", - "description": "Response message for TensorboardService.ListTensorboards.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics": { + "description": "Bounding box matching model metrics for a single intersection-over-union threshold and multiple label match confidence thresholds.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics", "properties": { - "tensorboards": { - "description": "The Tensorboards mathching the request.", - "type": "array", + "confidenceMetrics": { + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1Tensorboard" - } + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics" + }, + "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" + "iouThreshold": { + "description": "The intersection-over-union threshold value used to compute this metrics entry.", + "format": "float", + "type": "number" + }, + "meanAveragePrecision": { + "description": "The mean average precision, most often close to `auPrc`.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReadTensorboardUsageResponse": { - "id": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse", - "description": "Response message for TensorboardService.ReadTensorboardUsage.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics": { + "description": "Metrics for a single confidence threshold.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics", "properties": { - "monthlyUsageData": { - "description": "Maps year-month (YYYYMM) string to per month usage data.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData" - } + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision under the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall under the given confidence threshold.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData": { - "id": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData", - "description": "Per month usage data", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics": { + "description": "Metrics for classification evaluation results.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics", "properties": { - "userUsageData": { - "description": "Usage data for each user in the given month.", - "type": "array", + "auPrc": { + "description": "The Area Under Precision-Recall Curve metric. Micro-averaged for the overall evaluation.", + "format": "float", + "type": "number" + }, + "auRoc": { + "description": "The Area Under Receiver Operating Characteristic curve metric. Micro-averaged for the overall evaluation.", + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData" - } - } - } - }, - "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData": { - "id": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData", - "description": "Per user usage data.", - "type": "object", - "properties": { - "username": { - "description": "User's username", - "type": "string" + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics" + }, + "type": "array" }, - "viewCount": { - "description": "Number of times the user has read data within the Tensorboard.", - "type": "string", - "format": "int64" - } - } - }, - "GoogleCloudAiplatformV1ReadTensorboardSizeResponse": { - "id": "GoogleCloudAiplatformV1ReadTensorboardSizeResponse", - "description": "Response message for TensorboardService.ReadTensorboardSize.", - "type": "object", - "properties": { - "storageSizeByte": { - "description": "Payload storage size for the TensorBoard", - "type": "string", - "format": "int64" + "confusionMatrix": { + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix", + "description": "Confusion matrix of the evaluation." + }, + "logLoss": { + "description": "The Log Loss metric.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TensorboardExperiment": { - "id": "GoogleCloudAiplatformV1TensorboardExperiment", - "description": "A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics": { + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics", "properties": { - "name": { - "description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "readOnly": true, - "type": "string" + "confidenceThreshold": { + "description": "Metrics are computed with an assumption that the Model never returns predictions with score lower than this value.", + "format": "float", + "type": "number" }, - "displayName": { - "description": "User provided name of this TensorboardExperiment.", + "confusionMatrix": { + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix", + "description": "Confusion matrix of the evaluation for this confidence_threshold." + }, + "f1Score": { + "description": "The harmonic mean of recall and precision. For summary metrics, it computes the micro-averaged F1 score.", + "format": "float", + "type": "number" + }, + "f1ScoreAt1": { + "description": "The harmonic mean of recallAt1 and precisionAt1.", + "format": "float", + "type": "number" + }, + "f1ScoreMacro": { + "description": "Macro-averaged F1 Score.", + "format": "float", + "type": "number" + }, + "f1ScoreMicro": { + "description": "Micro-averaged F1 Score.", + "format": "float", + "type": "number" + }, + "falseNegativeCount": { + "description": "The number of ground truth labels that are not matched by a Model created label.", + "format": "int64", "type": "string" }, - "description": { - "description": "Description of this TensorboardExperiment.", + "falsePositiveCount": { + "description": "The number of Model created labels that do not match a ground truth label.", + "format": "int64", "type": "string" }, - "createTime": { - "description": "Output only. Timestamp when this TensorboardExperiment was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "falsePositiveRate": { + "description": "False Positive Rate for the given confidence threshold.", + "format": "float", + "type": "number" }, - "updateTime": { - "description": "Output only. Timestamp when this TensorboardExperiment was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "falsePositiveRateAt1": { + "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.", + "format": "float", + "type": "number" }, - "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" - } + "maxPredictions": { + "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`.", + "format": "int32", + "type": "integer" }, - "etag": { - "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "precisionAt1": { + "description": "The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each DataItem.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall (True Positive Rate) for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recallAt1": { + "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", + "type": "number" + }, + "trueNegativeCount": { + "description": "The number of labels that were not created by the Model, but if they would, they would not match a ground truth label.", + "format": "int64", "type": "string" }, - "source": { - "description": "Immutable. Source of the TensorboardExperiment. Example: a custom training job.", + "truePositiveCount": { + "description": "The number of Model created labels that match a ground truth label.", + "format": "int64", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse": { - "id": "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse", - "description": "Response message for TensorboardService.ListTensorboardExperiments.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix": { + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix", "properties": { - "tensorboardExperiments": { - "description": "The TensorboardExperiments mathching the request.", - "type": "array", + "annotationSpecs": { + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" - } + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef" + }, + "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" + "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.", + "items": { + "items": { + "type": "any" + }, + "type": "array" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TensorboardRun": { - "id": "GoogleCloudAiplatformV1TensorboardRun", - "description": "TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef": { + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef", "properties": { - "name": { - "description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "readOnly": true, - "type": "string" - }, "displayName": { - "description": "Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.", - "type": "string" - }, - "description": { - "description": "Description of this TensorboardRun.", + "description": "Display name of the AnnotationSpec.", "type": "string" }, - "createTime": { - "description": "Output only. Timestamp when this TensorboardRun was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this TensorboardRun was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "labels": { - "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.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "etag": { - "description": "Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "id": { + "description": "ID of the AnnotationSpec.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest": { - "id": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest", - "description": "Request message for TensorboardService.BatchCreateTensorboardRuns.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics": { + "description": "Metrics for forecasting evaluation results.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics", "properties": { - "requests": { - "description": "Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.", - "type": "array", + "meanAbsoluteError": { + "description": "Mean Absolute Error (MAE).", + "format": "float", + "type": "number" + }, + "meanAbsolutePercentageError": { + "description": "Mean absolute percentage error. Infinity when there are zeros in the ground truth.", + "format": "float", + "type": "number" + }, + "quantileMetrics": { + "description": "The quantile metrics entries for each quantile.", "items": { - "$ref": "GoogleCloudAiplatformV1CreateTensorboardRunRequest" - } + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry" + }, + "type": "array" + }, + "rSquared": { + "description": "Coefficient of determination as Pearson correlation coefficient. Undefined when ground truth or predictions are constant or near constant.", + "format": "float", + "type": "number" + }, + "rootMeanSquaredError": { + "description": "Root Mean Squared Error (RMSE).", + "format": "float", + "type": "number" + }, + "rootMeanSquaredLogError": { + "description": "Root mean squared log error. Undefined when there are negative ground truth values or predictions.", + "format": "float", + "type": "number" + }, + "rootMeanSquaredPercentageError": { + "description": "Root Mean Square Percentage Error. Square root of MSPE. Undefined/imaginary when MSPE is negative.", + "format": "float", + "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.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateTensorboardRunRequest": { - "id": "GoogleCloudAiplatformV1CreateTensorboardRunRequest", - "description": "Request message for TensorboardService.CreateTensorboardRun.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry": { + "description": "Entry for the Quantiles loss type optimization objective.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry", "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" + "observedQuantile": { + "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.", + "format": "double", + "type": "number" }, - "tensorboardRun": { - "description": "Required. The TensorboardRun to create.", - "$ref": "GoogleCloudAiplatformV1TensorboardRun" + "quantile": { + "description": "The quantile for this entry.", + "format": "double", + "type": "number" }, - "tensorboardRunId": { - "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-/`.", - "type": "string" + "scaledPinballLoss": { + "description": "The scaled pinball loss of this quantile.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse": { - "id": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse", - "description": "Response message for TensorboardService.BatchCreateTensorboardRuns.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics": { + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics", "properties": { - "tensorboardRuns": { - "description": "The created TensorboardRuns.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TensorboardRun" - } + "bleu": { + "description": "BLEU (bilingual evaluation understudy) scores based on sacrebleu implementation.", + "format": "float", + "type": "number" + }, + "rougeLSum": { + "description": "ROUGE-L (Longest Common Subsequence) scoring at summary level.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListTensorboardRunsResponse": { - "id": "GoogleCloudAiplatformV1ListTensorboardRunsResponse", - "description": "Response message for TensorboardService.ListTensorboardRuns.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics": { + "description": "Metrics for image object detection evaluation results.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics", "properties": { - "tensorboardRuns": { - "description": "The TensorboardRuns mathching the request.", - "type": "array", + "boundingBoxMeanAveragePrecision": { + "description": "The single metric for bounding boxes evaluation: the `meanAveragePrecision` averaged over all `boundingBoxMetricsEntries`.", + "format": "float", + "type": "number" + }, + "boundingBoxMetrics": { + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1TensorboardRun" - } + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics" + }, + "type": "array" }, - "nextPageToken": { - "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.", - "type": "string" + "evaluatedBoundingBoxCount": { + "description": "The total number of bounding boxes (i.e. summed over all images) the ground truth used to create this evaluation had.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest": { - "id": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest", - "description": "Request message for TensorboardService.BatchCreateTensorboardTimeSeries.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics": { + "description": "Metrics for image segmentation evaluation results.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics", "properties": { - "requests": { - "description": "Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.", - "type": "array", + "confidenceMetricsEntries": { + "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": "GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest" - } + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest": { - "id": "GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest", - "description": "Request message for TensorboardService.CreateTensorboardTimeSeries.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry": { + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry", "properties": { - "parent": { - "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" + "confidenceThreshold": { + "description": "Metrics are computed with an assumption that the model never returns predictions with score lower than this value.", + "format": "float", + "type": "number" }, - "tensorboardTimeSeriesId": { - "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" + "confusionMatrix": { + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix", + "description": "Confusion matrix for the given confidence threshold." }, - "tensorboardTimeSeries": { - "description": "Required. The TensorboardTimeSeries to create.", - "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" + "diceScoreCoefficient": { + "description": "DSC or the F1 score, The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "iouScore": { + "description": "The intersection-over-union score. The measure of overlap of the annotation's category mask with ground truth category mask on the DataItem.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall (True Positive Rate) for the given confidence threshold.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TensorboardTimeSeries": { - "id": "GoogleCloudAiplatformV1TensorboardTimeSeries", - "description": "TensorboardTimeSeries maps to times series produced in training runs", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics": { + "description": "Metrics for general pairwise text generation evaluation results.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics", "properties": { - "name": { - "description": "Output only. Name of the TensorboardTimeSeries.", - "readOnly": true, - "type": "string" + "accuracy": { + "description": "Fraction of cases where the autorater agreed with the human raters.", + "format": "float", + "type": "number" }, - "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).", + "baselineModelWinRate": { + "description": "Percentage of time the autorater decided the baseline model had the better response.", + "format": "float", + "type": "number" + }, + "cohensKappa": { + "description": "A measurement of agreement between the autorater and human raters that takes the likelihood of random agreement into account.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "Harmonic mean of precision and recall.", + "format": "float", + "type": "number" + }, + "falseNegativeCount": { + "description": "Number of examples where the autorater chose the baseline model, but humans preferred the model.", + "format": "int64", "type": "string" }, - "description": { - "description": "Description of this TensorboardTimeSeries.", + "falsePositiveCount": { + "description": "Number of examples where the autorater chose the model, but humans preferred the baseline model.", + "format": "int64", "type": "string" }, - "valueType": { - "description": "Required. Immutable. Type of TensorboardTimeSeries value.", - "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" - ] + "humanPreferenceBaselineModelWinRate": { + "description": "Percentage of time humans decided the baseline model had the better response.", + "format": "float", + "type": "number" }, - "createTime": { - "description": "Output only. Timestamp when this TensorboardTimeSeries was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "humanPreferenceModelWinRate": { + "description": "Percentage of time humans decided the model had the better response.", + "format": "float", + "type": "number" }, - "updateTime": { - "description": "Output only. Timestamp when this TensorboardTimeSeries was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "modelWinRate": { + "description": "Percentage of time the autorater decided the model had the better response.", + "format": "float", + "type": "number" }, - "etag": { - "description": "Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", - "type": "string" + "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" }, - "pluginName": { - "description": "Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob", - "type": "string" + "recall": { + "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.", + "format": "float", + "type": "number" }, - "pluginData": { - "description": "Data of the current plugin, with the size limited to 65KB.", - "type": "string", - "format": "byte" + "trueNegativeCount": { + "description": "Number of examples where both the autorater and humans decided that the model had the worse response.", + "format": "int64", + "type": "string" }, - "metadata": { - "description": "Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata" + "truePositiveCount": { + "description": "Number of examples where both the autorater and humans decided that the model had the better response.", + "format": "int64", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata": { - "id": "GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata", - "description": "Describes metadata for a TensorboardTimeSeries.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics": { + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics", "properties": { - "maxStep": { - "description": "Output only. Max step index of all data points within a TensorboardTimeSeries.", - "readOnly": true, - "type": "string", - "format": "int64" + "exactMatch": { + "description": "The rate at which the input predicted strings exactly match their references.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics": { + "description": "Metrics for regression evaluation results.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics", + "properties": { + "meanAbsoluteError": { + "description": "Mean Absolute Error (MAE).", + "format": "float", + "type": "number" }, - "maxWallTime": { - "description": "Output only. Max wall clock timestamp of all data points within a TensorboardTimeSeries.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "meanAbsolutePercentageError": { + "description": "Mean absolute percentage error. Infinity when there are zeros in the ground truth.", + "format": "float", + "type": "number" }, - "maxBlobSequenceLength": { - "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", - "format": "int64" + "rSquared": { + "description": "Coefficient of determination as Pearson correlation coefficient. Undefined when ground truth or predictions are constant or near constant.", + "format": "float", + "type": "number" + }, + "rootMeanSquaredError": { + "description": "Root Mean Squared Error (RMSE).", + "format": "float", + "type": "number" + }, + "rootMeanSquaredLogError": { + "description": "Root mean squared log error. Undefined when there are negative ground truth values or predictions.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse": { - "id": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse", - "description": "Response message for TensorboardService.BatchCreateTensorboardTimeSeries.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics": { + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics", "properties": { - "tensorboardTimeSeries": { - "description": "The created TensorboardTimeSeries.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" - } + "rougeLSum": { + "description": "ROUGE-L (Longest Common Subsequence) scoring at summary level.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse": { - "id": "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse", - "description": "Response message for TensorboardService.ListTensorboardTimeSeries.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics": { + "description": "Metrics for text extraction evaluation results.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics", "properties": { - "tensorboardTimeSeries": { - "description": "The TensorboardTimeSeries mathching the request.", - "type": "array", + "confidenceMetrics": { + "description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from them.", "items": { - "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" - } + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics" + }, + "type": "array" }, - "nextPageToken": { - "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.", - "type": "string" + "confusionMatrix": { + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix", + "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." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse": { - "id": "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse", - "description": "Response message for TensorboardService.BatchReadTensorboardTimeSeriesData.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics": { + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics", "properties": { - "timeSeriesData": { - "description": "The returned time series data.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TimeSeriesData" - } + "confidenceThreshold": { + "description": "Metrics are computed with an assumption that the Model never returns predictions with score lower than this value.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall (True Positive Rate) for the given confidence threshold.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TimeSeriesData": { - "id": "GoogleCloudAiplatformV1TimeSeriesData", - "description": "All the data stored in a TensorboardTimeSeries.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics": { + "description": "Model evaluation metrics for text sentiment problems.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics", "properties": { - "tensorboardTimeSeriesId": { - "description": "Required. The ID of the TensorboardTimeSeries, which will become the final component of the TensorboardTimeSeries' resource name", - "type": "string" + "confusionMatrix": { + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix", + "description": "Confusion matrix of the evaluation. Only set for ModelEvaluations, not for ModelEvaluationSlices." }, - "valueType": { - "description": "Required. Immutable. The value type of this time series. All the values in this time series data must match this value type.", - "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" - ] + "f1Score": { + "description": "The harmonic mean of recall and precision.", + "format": "float", + "type": "number" }, - "values": { - "description": "Required. Data points in this time series.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TimeSeriesDataPoint" - } + "linearKappa": { + "description": "Linear weighted kappa. Only set for ModelEvaluations, not for ModelEvaluationSlices.", + "format": "float", + "type": "number" + }, + "meanAbsoluteError": { + "description": "Mean absolute error. Only set for ModelEvaluations, not for ModelEvaluationSlices.", + "format": "float", + "type": "number" + }, + "meanSquaredError": { + "description": "Mean squared error. Only set for ModelEvaluations, not for ModelEvaluationSlices.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision.", + "format": "float", + "type": "number" + }, + "quadraticKappa": { + "description": "Quadratic weighted kappa. Only set for ModelEvaluations, not for ModelEvaluationSlices.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TimeSeriesDataPoint": { - "id": "GoogleCloudAiplatformV1TimeSeriesDataPoint", - "description": "A TensorboardTimeSeries data point.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics": { + "description": "UNIMPLEMENTED. Track matching model metrics for a single track match threshold and multiple label match confidence thresholds.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics", "properties": { - "scalar": { - "description": "A scalar value.", - "$ref": "GoogleCloudAiplatformV1Scalar" + "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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics" + }, + "type": "array" }, - "tensor": { - "description": "A tensor value.", - "$ref": "GoogleCloudAiplatformV1TensorboardTensor" + "iouThreshold": { + "description": "The intersection-over-union threshold value between bounding boxes across frames used to compute this metric entry.", + "format": "float", + "type": "number" }, - "blobs": { - "description": "A blob sequence value.", - "$ref": "GoogleCloudAiplatformV1TensorboardBlobSequence" + "meanBoundingBoxIou": { + "description": "The mean bounding box iou over all confidence thresholds.", + "format": "float", + "type": "number" }, - "wallTime": { - "description": "Wall clock timestamp when this data point is generated by the end user.", - "type": "string", - "format": "google-datetime" + "meanMismatchRate": { + "description": "The mean mismatch rate over all confidence thresholds.", + "format": "float", + "type": "number" }, - "step": { - "description": "Step index of this data point within the run.", - "type": "string", - "format": "int64" - } - } - }, - "GoogleCloudAiplatformV1Scalar": { - "id": "GoogleCloudAiplatformV1Scalar", - "description": "One point viewable on a scalar metric plot.", - "type": "object", - "properties": { - "value": { - "description": "Value of the point at this step / timestamp.", - "type": "number", - "format": "double" + "meanTrackingAveragePrecision": { + "description": "The mean average precision over all confidence thresholds.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TensorboardTensor": { - "id": "GoogleCloudAiplatformV1TensorboardTensor", - "description": "One point viewable on a tensor metric plot.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics": { + "description": "Metrics for a single confidence threshold.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics", "properties": { - "value": { - "description": "Required. Serialized form of https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto", - "type": "string", - "format": "byte" + "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" }, - "versionNumber": { - "description": "Optional. Version number of TensorProto used to serialize value.", - "type": "integer", - "format": "int32" + "confidenceThreshold": { + "description": "The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "mismatchRate": { + "description": "Mismatch rate, which measures the tracking consistency, i.e. correctness of instance ID continuity.", + "format": "float", + "type": "number" + }, + "trackingPrecision": { + "description": "Tracking precision.", + "format": "float", + "type": "number" + }, + "trackingRecall": { + "description": "Tracking recall.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TensorboardBlobSequence": { - "id": "GoogleCloudAiplatformV1TensorboardBlobSequence", - "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.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics": { + "description": "The Evaluation metrics given a specific precision_window_length.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics", "properties": { - "values": { - "description": "List of blobs contained within the sequence.", - "type": "array", + "confidenceMetrics": { + "description": "Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", "items": { - "$ref": "GoogleCloudAiplatformV1TensorboardBlob" - } - } - } - }, - "GoogleCloudAiplatformV1TensorboardBlob": { - "id": "GoogleCloudAiplatformV1TensorboardBlob", - "description": "One blob (e.g, image, graph) viewable on a blob metric plot.", - "type": "object", - "properties": { - "id": { - "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.", - "readOnly": true, - "type": "string" + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics" + }, + "type": "array" }, - "data": { - "description": "Optional. The bytes of the blob is not present unless it's returned by the ReadTensorboardBlobData endpoint.", - "type": "string", - "format": "byte" + "meanAveragePrecision": { + "description": "The mean average precision.", + "format": "float", + "type": "number" + }, + "precisionWindowLength": { + "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.", + "format": "google-duration", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse": { - "id": "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse", - "description": "Response message for TensorboardService.ReadTensorboardTimeSeriesData.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics": { + "description": "Metrics for a single confidence threshold.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics", "properties": { - "timeSeriesData": { - "description": "The returned time series data.", - "$ref": "GoogleCloudAiplatformV1TimeSeriesData" + "confidenceThreshold": { + "description": "Output only. The confidence threshold value used to compute the metrics.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "Output only. The harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Output only. Precision for the given confidence threshold.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Output only. Recall for the given confidence threshold.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse": { - "id": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse", - "description": "Response message for TensorboardService.ReadTensorboardBlobData.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics": { + "description": "Model evaluation metrics for video action recognition.", + "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics", "properties": { - "blobs": { - "description": "Blob messages containing blob bytes.", - "type": "array", + "evaluatedActionCount": { + "description": "The number of ground truth actions used to create this evaluation.", + "format": "int32", + "type": "integer" + }, + "videoActionMetrics": { + "description": "The metric entries for precision window lengths: 1s,2s,3s.", "items": { - "$ref": "GoogleCloudAiplatformV1TensorboardBlob" - } + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest": { - "id": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest", - "description": "Request message for TensorboardService.WriteTensorboardExperimentData.", - "type": "object", + "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics": { + "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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics", "properties": { - "writeRunDataRequests": { - "description": "Required. Requests containing per-run TensorboardTimeSeries data to write.", - "type": "array", + "boundingBoxMeanAveragePrecision": { + "description": "The single metric for bounding boxes evaluation: the `meanAveragePrecision` averaged over all `boundingBoxMetrics`.", + "format": "float", + "type": "number" + }, + "boundingBoxMetrics": { + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest" - } - } - } - }, - "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest": { - "id": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest", - "description": "Request message for TensorboardService.WriteTensorboardRunData.", - "type": "object", - "properties": { - "tensorboardRun": { - "description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "type": "string" + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics" + }, + "type": "array" }, - "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", + "evaluatedBoundingBoxCount": { + "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", + "type": "integer" + }, + "evaluatedFrameCount": { + "description": "UNIMPLEMENTED. The number of video frames used to create this evaluation.", + "format": "int32", + "type": "integer" + }, + "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" + }, + "trackMeanAveragePrecision": { + "description": "UNIMPLEMENTED. The single metric for tracks accuracy evaluation: the `meanAveragePrecision` averaged over all `trackMetrics`.", + "format": "float", + "type": "number" + }, + "trackMeanBoundingBoxIou": { + "description": "UNIMPLEMENTED. The single metric for tracks bounding box iou evaluation: the `meanBoundingBoxIou` averaged over all `trackMetrics`.", + "format": "float", + "type": "number" + }, + "trackMeanMismatchRate": { + "description": "UNIMPLEMENTED. The single metric for tracking consistency evaluation: the `meanMismatchRate` averaged over all `trackMetrics`.", + "format": "float", + "type": "number" + }, + "trackMetrics": { + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1TimeSeriesData" - } + "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics" + }, + "type": "array" } - } - }, - "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse": { - "id": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse", - "description": "Response message for TensorboardService.WriteTensorboardExperimentData.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1WriteTensorboardRunDataResponse": { - "id": "GoogleCloudAiplatformV1WriteTensorboardRunDataResponse", - "description": "Response message for TensorboardService.WriteTensorboardRunData.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest": { - "id": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest", - "description": "Request message for TensorboardService.ExportTensorboardTimeSeriesData.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance": { + "description": "Prediction input format for Image Classification.", + "id": "GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance", "properties": { - "filter": { - "description": "Exports the TensorboardTimeSeries' data that match the filter expression.", - "type": "string" - }, - "pageSize": { - "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.", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "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.", + "content": { + "description": "The image bytes or Cloud Storage URI to make the prediction on.", "type": "string" }, - "orderBy": { - "description": "Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data is returned in a pseudo random order.", + "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" }, - "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse": { - "id": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse", - "description": "Response message for TensorboardService.ExportTensorboardTimeSeriesData.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance": { + "description": "Prediction input format for Image Object Detection.", + "id": "GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance", "properties": { - "timeSeriesDataPoints": { - "description": "The returned time series data points.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TimeSeriesDataPoint" - } + "content": { + "description": "The image bytes or Cloud Storage URI to make the prediction on.", + "type": "string" }, - "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.", + "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" }, - "GoogleCloudAiplatformV1Study": { - "id": "GoogleCloudAiplatformV1Study", - "description": "A message representing a Study.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance": { + "description": "Prediction input format for Image Segmentation.", + "id": "GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance", "properties": { - "name": { - "description": "Output only. The name of a study. The study's globally unique identifier. Format: `projects/{project}/locations/{location}/studies/{study}`", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "Required. Describes the Study, default value is empty string.", + "content": { + "description": "The image bytes to make the predictions on.", "type": "string" }, - "studySpec": { - "description": "Required. Configuration of the Study.", - "$ref": "GoogleCloudAiplatformV1StudySpec" - }, - "state": { - "description": "Output only. The detailed state of a Study.", - "readOnly": true, - "type": "string", - "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" - ] - }, - "createTime": { - "description": "Output only. Time at which the study was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "inactiveReason": { - "description": "Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.", - "readOnly": true, + "mimeType": { + "description": "The MIME type of the content of the image. Only the images in below listed MIME types are supported. - image/jpeg - image/png", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListStudiesResponse": { - "id": "GoogleCloudAiplatformV1ListStudiesResponse", - "description": "Response message for VizierService.ListStudies.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance": { + "description": "Prediction input format for Text Classification.", + "id": "GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance", "properties": { - "studies": { - "description": "The studies associated with the project.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Study" - } + "content": { + "description": "The text snippet to make the predictions on.", + "type": "string" }, - "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.", + "mimeType": { + "description": "The MIME type of the text snippet. The supported MIME types are listed below. - text/plain", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1LookupStudyRequest": { - "id": "GoogleCloudAiplatformV1LookupStudyRequest", - "description": "Request message for VizierService.LookupStudy.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance": { + "description": "Prediction input format for Text Extraction.", + "id": "GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance", "properties": { - "displayName": { - "description": "Required. The user-defined display name of the Study", + "content": { + "description": "The text snippet to make the predictions on.", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1SuggestTrialsRequest": { - "id": "GoogleCloudAiplatformV1SuggestTrialsRequest", - "description": "Request message for VizierService.SuggestTrials.", - "type": "object", - "properties": { - "suggestionCount": { - "description": "Required. The number of suggestions requested. It must be positive.", - "type": "integer", - "format": "int32" }, - "clientId": { - "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.", + "key": { + "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": "string" }, - "contexts": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1TrialContext" - } + "mimeType": { + "description": "The MIME type of the text snippet. The supported MIME types are listed below. - text/plain", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1TrialContext": { - "id": "GoogleCloudAiplatformV1TrialContext", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance": { + "description": "Prediction input format for Text Sentiment.", + "id": "GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance", "properties": { - "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.", + "content": { + "description": "The text snippet to make the predictions on.", "type": "string" }, - "parameters": { - "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", - "items": { - "$ref": "GoogleCloudAiplatformV1TrialParameter" - } + "mimeType": { + "description": "The MIME type of the text snippet. The supported MIME types are listed below. - text/plain", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListTrialsResponse": { - "id": "GoogleCloudAiplatformV1ListTrialsResponse", - "description": "Response message for VizierService.ListTrials.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance": { + "description": "Prediction input format for Video Action Recognition.", + "id": "GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance", "properties": { - "trials": { - "description": "The Trials associated with the Study.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Trial" - } + "content": { + "description": "The Google Cloud Storage location of the video on which to perform the prediction.", + "type": "string" }, - "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.", + "mimeType": { + "description": "The MIME type of the content of the video. Only the following are supported: video/mp4 video/avi video/quicktime", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1AddTrialMeasurementRequest": { - "id": "GoogleCloudAiplatformV1AddTrialMeasurementRequest", - "description": "Request message for VizierService.AddTrialMeasurement.", - "type": "object", - "properties": { - "measurement": { - "description": "Required. The measurement to be added to a Trial.", - "$ref": "GoogleCloudAiplatformV1Measurement" - } - } - }, - "GoogleCloudAiplatformV1CompleteTrialRequest": { - "id": "GoogleCloudAiplatformV1CompleteTrialRequest", - "description": "Request message for VizierService.CompleteTrial.", - "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": "GoogleCloudAiplatformV1Measurement" }, - "trialInfeasible": { - "description": "Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored.", - "type": "boolean" + "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" }, - "infeasibleReason": { - "description": "Optional. A human readable reason why the trial was infeasible. This should only be provided if `trial_infeasible` is true.", + "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" } - } - }, - "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest": { - "id": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest", - "description": "Request message for VizierService.CheckTrialEarlyStoppingState.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1StopTrialRequest": { - "id": "GoogleCloudAiplatformV1StopTrialRequest", - "description": "Request message for VizierService.StopTrial.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1ListOptimalTrialsRequest": { - "id": "GoogleCloudAiplatformV1ListOptimalTrialsRequest", - "description": "Request message for VizierService.ListOptimalTrials.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1ListOptimalTrialsResponse": { - "id": "GoogleCloudAiplatformV1ListOptimalTrialsResponse", - "description": "Response message for VizierService.ListOptimalTrials.", - "type": "object", - "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", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Trial" - } - } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PublisherModel": { - "id": "GoogleCloudAiplatformV1PublisherModel", - "description": "A Model Garden Publisher Model.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance": { + "description": "Prediction input format for Video Classification.", + "id": "GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance", "properties": { - "name": { - "description": "Output only. The resource name of the PublisherModel.", - "readOnly": true, + "content": { + "description": "The Google Cloud Storage location of the video on which to perform the prediction.", "type": "string" }, - "versionId": { - "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.", - "readOnly": true, + "mimeType": { + "description": "The MIME type of the content of the video. Only the following are supported: video/mp4 video/avi video/quicktime", "type": "string" }, - "openSourceCategory": { - "description": "Required. Indicates the open source category of the publisher model.", - "type": "string", - "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." - ], - "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" - ] - }, - "supportedActions": { - "description": "Optional. Supported call-to-action options.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToAction" - }, - "frameworks": { - "description": "Optional. Additional information about the model's Frameworks.", - "type": "array", - "items": { - "type": "string" - } - }, - "launchStage": { - "description": "Optional. Indicates the launch stage of the model.", - "type": "string", - "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." - ], - "enum": [ - "LAUNCH_STAGE_UNSPECIFIED", - "EXPERIMENTAL", - "PRIVATE_PREVIEW", - "PUBLIC_PREVIEW", - "GA" - ] - }, - "versionState": { - "description": "Optional. Indicates the state of the model version.", - "type": "string", - "enumDescriptions": [ - "The version state is unspecified.", - "Used to indicate the version is stable.", - "Used to indicate the version is unstable." - ], - "enum": [ - "VERSION_STATE_UNSPECIFIED", - "VERSION_STATE_STABLE", - "VERSION_STATE_UNSTABLE" - ] + "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" }, - "publisherModelTemplate": { - "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, + "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" - }, - "predictSchemata": { - "description": "Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.", - "$ref": "GoogleCloudAiplatformV1PredictSchemata" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PublisherModelCallToAction": { - "id": "GoogleCloudAiplatformV1PublisherModelCallToAction", - "description": "Actions could take on this Publisher Model.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance": { + "description": "Prediction input format for Video Object Tracking.", + "id": "GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance", "properties": { - "viewRestApi": { - "description": "Optional. To view Rest API docs.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi" - }, - "openNotebook": { - "description": "Optional. Open notebook of the PublisherModel.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" - }, - "openNotebooks": { - "description": "Optional. Open notebooks of the PublisherModel.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks" - }, - "createApplication": { - "description": "Optional. Create application using the PublisherModel.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" - }, - "openFineTuningPipeline": { - "description": "Optional. Open fine-tuning pipeline of the PublisherModel.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" - }, - "openFineTuningPipelines": { - "description": "Optional. Open fine-tuning pipelines of the PublisherModel.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines" - }, - "openPromptTuningPipeline": { - "description": "Optional. Open prompt-tuning pipeline of the PublisherModel.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" + "content": { + "description": "The Google Cloud Storage location of the video on which to perform the prediction.", + "type": "string" }, - "openGenie": { - "description": "Optional. Open Genie / Playground.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" + "mimeType": { + "description": "The MIME type of the content of the video. Only the following are supported: video/mp4 video/avi video/quicktime", + "type": "string" }, - "deploy": { - "description": "Optional. Deploy the PublisherModel to Vertex Endpoint.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy" + "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" }, - "multiDeployVertex": { - "description": "Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex" + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig": { + "description": "The configuration for grounding checking.", + "id": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig", + "properties": { + "disableAttribution": { + "deprecated": true, + "description": "If set, skip finding claim attributions (i.e not generate grounding citation).", + "type": "boolean" }, - "deployGke": { - "description": "Optional. Deploy PublisherModel to Google Kubernetes Engine.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke" + "sources": { + "description": "The sources for the grounding checking.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry": { + "description": "Single source entry for the grounding checking.", + "id": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry", + "properties": { + "enterpriseDatastore": { + "deprecated": true, + "description": "The uri of the Vertex AI Search data source. Deprecated. Use vertex_ai_search_datastore instead.", + "type": "string" }, - "openGenerationAiStudio": { - "description": "Optional. Open in Generation AI Studio.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" + "inlineContext": { + "description": "The grounding text passed inline with the Predict API. It can support up to 1 million bytes.", + "type": "string" }, - "requestAccess": { - "description": "Optional. Request for access.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" + "type": { + "description": "The type of the grounding checking source.", + "enum": [ + "UNSPECIFIED", + "WEB", + "ENTERPRISE", + "VERTEX_AI_SEARCH", + "INLINE" + ], + "enumDeprecated": [ + false, + false, + true, + false, + false + ], + "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." + ], + "type": "string" }, - "openEvaluationPipeline": { - "description": "Optional. Open evaluation pipeline of the PublisherModel.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" + "vertexAiSearchDatastore": { + "description": "The uri of the Vertex AI Search data source.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi": { - "id": "GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi", - "description": "Rest API docs.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams": { + "description": "Prediction model parameters for Image Classification.", + "id": "GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams", "properties": { - "documentations": { - "description": "Required.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1PublisherModelDocumentation" - } + "confidenceThreshold": { + "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", + "format": "float", + "type": "number" }, - "title": { - "description": "Required. The title of the view rest API.", - "type": "string" + "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.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PublisherModelDocumentation": { - "id": "GoogleCloudAiplatformV1PublisherModelDocumentation", - "description": "A named piece of documentation.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams": { + "description": "Prediction model parameters for Image Object Detection.", + "id": "GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams", "properties": { - "title": { - "description": "Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA, NODE.JS, etc..", - "type": "string" + "confidenceThreshold": { + "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", + "format": "float", + "type": "number" }, - "content": { - "description": "Required. Content of this piece of document (in Markdown format).", - "type": "string" + "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" }, - "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences": { - "id": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", - "description": "The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc..", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams": { + "description": "Prediction model parameters for Image Segmentation.", + "id": "GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams", "properties": { - "references": { - "description": "Required.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1PublisherModelResourceReference" - } - }, - "title": { - "description": "Required. ", - "type": "string" + "confidenceThreshold": { + "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.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams": { + "description": "Prediction model parameters for Video Action Recognition.", + "id": "GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams", + "properties": { + "confidenceThreshold": { + "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", + "format": "float", + "type": "number" }, - "resourceTitle": { - "description": "Optional. Title of the resource.", - "type": "string" + "maxPredictions": { + "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.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams": { + "description": "Prediction model parameters for Video Classification.", + "id": "GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams", + "properties": { + "confidenceThreshold": { + "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", + "format": "float", + "type": "number" }, - "resourceUseCase": { - "description": "Optional. Use case (CUJ) of the resource.", - "type": "string" + "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" }, - "resourceDescription": { - "description": "Optional. Description of the resource.", - "type": "string" + "oneSecIntervalClassification": { + "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", + "type": "boolean" }, - "supportsWorkbench": { - "description": "Optional. For notebook resource, whether the notebook supports Workbench.", + "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" }, - "colabNotebookDisabled": { - "description": "Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the \"open notebook\" dialog in UI.", + "shotClassification": { + "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": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PublisherModelResourceReference": { - "id": "GoogleCloudAiplatformV1PublisherModelResourceReference", - "description": "Reference to a resource.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams": { + "description": "Prediction model parameters for Video Object Tracking.", + "id": "GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams", "properties": { - "uri": { - "description": "The URI of the resource.", - "type": "string" - }, - "resourceName": { - "description": "The resource name of the Google Cloud resource.", - "type": "string" + "confidenceThreshold": { + "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", + "format": "float", + "type": "number" }, - "useCase": { - "description": "Use case (CUJ) of the resource.", - "deprecated": true, - "type": "string" + "maxPredictions": { + "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.", + "format": "int32", + "type": "integer" }, - "description": { - "description": "Description of the resource.", - "deprecated": true, - "type": "string" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks": { - "id": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks", - "description": "Open notebooks.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult": { + "description": "Prediction output format for Image and Text Classification.", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult", "properties": { - "notebooks": { - "description": "Required. Regional resource references to notebooks.", - "type": "array", + "confidences": { + "description": "The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.", "items": { - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" - } + "format": "float", + "type": "number" + }, + "type": "array" + }, + "displayNames": { + "description": "The display names of the AnnotationSpecs that had been identified, order matches the IDs.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ids": { + "description": "The resource IDs of the AnnotationSpecs that had been identified.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines": { - "id": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines", - "description": "Open fine tuning pipelines.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult": { + "description": "Prediction output format for Image Object Detection.", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult", "properties": { - "fineTuningPipelines": { - "description": "Required. Regional resource references to fine tuning pipelines.", - "type": "array", + "bboxes": { + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences" - } + "items": { + "type": "any" + }, + "type": "array" + }, + "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" + }, + "displayNames": { + "description": "The display names of the AnnotationSpecs that had been identified, order matches the IDs.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ids": { + "description": "The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy": { - "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy", - "description": "Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult": { + "description": "Prediction output format for Image Segmentation.", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult", "properties": { - "dedicatedResources": { - "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.", - "$ref": "GoogleCloudAiplatformV1DedicatedResources" - }, - "automaticResources": { - "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.", - "$ref": "GoogleCloudAiplatformV1AutomaticResources" - }, - "sharedResources": { - "description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "categoryMask": { + "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.", "type": "string" }, - "modelDisplayName": { - "description": "Optional. Default model display name.", + "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" + }, + "GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult": { + "description": "Prediction output format for Tabular Classification.", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult", + "properties": { + "classes": { + "description": "The name of the classes being classified, contains all possible values of the target column.", + "items": { + "type": "string" + }, + "type": "array" }, - "largeModelReference": { - "description": "Optional. Large model reference. When this is set, model_artifact_spec is not needed.", - "$ref": "GoogleCloudAiplatformV1LargeModelReference" + "scores": { + "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.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult": { + "description": "Prediction output format for Tabular Regression.", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult", + "properties": { + "lowerBound": { + "description": "The lower bound of the prediction interval.", + "format": "float", + "type": "number" }, - "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": "GoogleCloudAiplatformV1ModelContainerSpec" + "quantilePredictions": { + "description": "Quantile predictions, in 1-1 correspondence with quantile_values.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" }, - "artifactUri": { - "description": "Optional. The path to the directory containing the Model artifact and any of its supporting files.", - "type": "string" + "quantileValues": { + "description": "Quantile values.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" }, - "deployTaskName": { - "description": "Optional. The name of the deploy task (e.g., \"text to image generation\").", - "type": "string" + "upperBound": { + "description": "The upper bound of the prediction interval.", + "format": "float", + "type": "number" }, - "deployMetadata": { - "description": "Optional. Metadata information about this deployment config.", - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata" + "value": { + "description": "The regression value.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult": { + "description": "Prediction output format for Text Extraction.", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult", + "properties": { + "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" }, - "title": { - "description": "Required. The title of the regional resource reference.", - "type": "string" + "displayNames": { + "description": "The display names of the AnnotationSpecs that had been identified, order matches the IDs.", + "items": { + "type": "string" + }, + "type": "array" }, - "publicArtifactUri": { - "description": "Optional. The signed URI for ephemeral Cloud Storage access to model artifact.", - "type": "string" + "ids": { + "description": "The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "textSegmentEndOffsets": { + "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.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "textSegmentStartOffsets": { + "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.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1LargeModelReference": { - "id": "GoogleCloudAiplatformV1LargeModelReference", - "description": "Contains information about the Large Model.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult": { + "description": "Prediction output format for Text Sentiment", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult", "properties": { - "name": { - "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.", - "type": "string" + "sentiment": { + "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).", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata": { - "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata", - "description": "Metadata information about the deployment for managing deployment config.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance": { + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance", "properties": { - "labels": { - "description": "Optional. Labels for the deployment config. For managing deployment config like verifying, source of deployment config, etc.", - "type": "object", - "additionalProperties": { + "attributeColumns": { + "items": { "type": "string" - } + }, + "type": "array" }, - "sampleRequest": { - "description": "Optional. Sample request for deployed endpoint.", - "type": "string" + "attributeWeights": { + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + }, + "contextColumns": { + "items": { + "type": "string" + }, + "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.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + }, + "horizonColumns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "horizonWeights": { + "items": { + "format": "float", + "type": "number" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex": { - "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex", - "description": "Multiple setups to deploy the PublisherModel.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult": { + "description": "Prediction output format for Time Series Forecasting.", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult", "properties": { - "multiDeployVertex": { - "description": "Optional. One click deployment configurations.", - "type": "array", + "quantilePredictions": { + "description": "Quantile predictions, in 1-1 correspondence with quantile_values.", "items": { - "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy" - } + "format": "float", + "type": "number" + }, + "type": "array" + }, + "quantileValues": { + "description": "Quantile values.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + }, + "tftFeatureImportance": { + "$ref": "GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance", + "description": "Only use these if TFt is enabled." + }, + "value": { + "description": "The regression value.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke": { - "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke", - "description": "Configurations for PublisherModel GKE deployment", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult": { + "description": "Prediction output format for Video Action Recognition.", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult", "properties": { - "gkeYamlConfigs": { - "description": "Optional. GKE deployment configuration in yaml format.", - "type": "array", - "items": { - "type": "string" - } + "confidence": { + "description": "The Model's confidence in correction of this prediction, higher value means higher confidence.", + "format": "float", + "type": "number" + }, + "displayName": { + "description": "The display name of the AnnotationSpec that had been identified.", + "type": "string" + }, + "id": { + "description": "The resource ID of the AnnotationSpec that had been identified.", + "type": "string" + }, + "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.", + "format": "google-duration", + "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.", + "format": "google-duration", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployRequest": { - "id": "GoogleCloudAiplatformV1DeployRequest", - "description": "Request message for ModelGardenService.Deploy.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult": { + "description": "Prediction output format for Video Classification.", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult", "properties": { - "publisherModelName": { - "description": "The Model Garden model to deploy. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.", + "confidence": { + "description": "The Model's confidence in correction of this prediction, higher value means higher confidence.", + "format": "float", + "type": "number" + }, + "displayName": { + "description": "The display name of the AnnotationSpec that had been identified.", "type": "string" }, - "huggingFaceModelId": { - "description": "The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`.", + "id": { + "description": "The resource ID of the AnnotationSpec that had been identified.", "type": "string" }, - "modelConfig": { - "description": "Optional. The model config to use for the deployment. If not specified, the default model config will be used.", - "$ref": "GoogleCloudAiplatformV1DeployRequestModelConfig" + "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" }, - "endpointConfig": { - "description": "Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used.", - "$ref": "GoogleCloudAiplatformV1DeployRequestEndpointConfig" + "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. 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", + "type": "string" }, - "deployConfig": { - "description": "Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.", - "$ref": "GoogleCloudAiplatformV1DeployRequestDeployConfig" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployRequestModelConfig": { - "id": "GoogleCloudAiplatformV1DeployRequestModelConfig", - "description": "The model config to use for the deployment.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult": { + "description": "Prediction output format for Video Object Tracking.", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult", "properties": { - "acceptEula": { - "description": "Optional. Whether the user accepts the End User License Agreement (EULA) for the model.", - "type": "boolean" + "confidence": { + "description": "The Model's confidence in correction of this prediction, higher value means higher confidence.", + "format": "float", + "type": "number" }, - "huggingFaceAccessToken": { - "description": "Optional. The Hugging Face read access token used to access the model artifacts of gated models.", + "displayName": { + "description": "The display name of the AnnotationSpec that had been identified.", "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" + "frames": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame" + }, + "type": "array" }, - "modelDisplayName": { - "description": "Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.", + "id": { + "description": "The resource ID of the AnnotationSpec that had been identified.", "type": "string" }, - "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": "GoogleCloudAiplatformV1ModelContainerSpec" + "timeSegmentEnd": { + "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", + "type": "string" }, - "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.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployRequestEndpointConfig": { - "id": "GoogleCloudAiplatformV1DeployRequestEndpointConfig", - "description": "The endpoint config to use for the deployment.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame", "properties": { - "endpointDisplayName": { - "description": "Optional. The user-specified display name of the endpoint. If not set, a default name will be used.", + "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" }, - "dedicatedEndpointEnabled": { - "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": "boolean" - }, - "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" + "xMax": { + "description": "The rightmost coordinate of the bounding box.", + "format": "float", + "type": "number" }, - "privateServiceConnectConfig": { - "description": "Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect.", - "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig" + "xMin": { + "description": "The leftmost coordinate of the bounding box.", + "format": "float", + "type": "number" }, - "labels": { - "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", - "additionalProperties": { - "type": "string" - } + "yMax": { + "description": "The bottommost coordinate of the bounding box.", + "format": "float", + "type": "number" }, - "endpointUserId": { - "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.", - "type": "string" + "yMin": { + "description": "The topmost coordinate of the bounding box.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployRequestDeployConfig": { - "id": "GoogleCloudAiplatformV1DeployRequestDeployConfig", - "description": "The deploy config to use for the deployment.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictionResult": { + "description": "Represents a line of JSONL in the batch prediction output file.", + "id": "GoogleCloudAiplatformV1SchemaPredictionResult", "properties": { - "dedicatedResources": { - "description": "Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.", - "$ref": "GoogleCloudAiplatformV1DedicatedResources" - }, - "fastTryoutEnabled": { - "description": "Optional. If true, enable the QMT fast tryout feature for this model if possible.", - "type": "boolean" + "error": { + "$ref": "GoogleCloudAiplatformV1SchemaPredictionResultError", + "description": "The error result. Do not set prediction if this is set." }, - "systemLabels": { - "description": "Optional. System labels for Model Garden deployments. These labels are managed by Google and for tracking purposes only.", - "type": "object", + "instance": { "additionalProperties": { - "type": "string" - } + "description": "Properties of the object.", + "type": "any" + }, + "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.", + "type": "object" + }, + "key": { + "description": "Optional user-provided key from the input instance.", + "type": "string" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagCorpus": { - "id": "GoogleCloudAiplatformV1RagCorpus", - "description": "A RagCorpus is a RagFile container and a project can have multiple RagCorpora.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPredictionResultError": { + "id": "GoogleCloudAiplatformV1SchemaPredictionResultError", "properties": { - "vectorDbConfig": { - "description": "Optional. Immutable. The config for the Vector DBs.", - "$ref": "GoogleCloudAiplatformV1RagVectorDbConfig" - }, - "vertexAiSearchConfig": { - "description": "Optional. Immutable. The config for the Vertex AI Search.", - "$ref": "GoogleCloudAiplatformV1VertexAiSearchConfig" - }, - "name": { - "description": "Output only. The resource name of the RagCorpus.", - "readOnly": true, + "message": { + "description": "Error message with additional details.", "type": "string" }, - "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.", + "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" - }, - "description": { - "description": "Optional. The description of the RagCorpus.", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPromptApiSchema": { + "description": "The A2 schema of a prompt.", + "id": "GoogleCloudAiplatformV1SchemaPromptApiSchema", + "properties": { + "apiSchemaVersion": { + "description": "The Schema version that represents changes to the API behavior.", "type": "string" }, - "createTime": { - "description": "Output only. Timestamp when this RagCorpus was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this RagCorpus was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "corpusStatus": { - "description": "Output only. RagCorpus state.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1CorpusStatus" + "executions": { + "description": "A list of execution instances for constructing a ready-to-use prompt.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution" + }, + "type": "array" }, - "encryptionSpec": { - "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.", - "$ref": "GoogleCloudAiplatformV1EncryptionSpec" + "multimodalPrompt": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt", + "description": "Multimodal prompt which embeds preambles to prompt string." }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "structuredPrompt": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt", + "description": "The prompt variation that stores preambles in separate fields." }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "translationPrompt": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt", + "description": "The prompt variation for Translation use case." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagVectorDbConfig": { - "id": "GoogleCloudAiplatformV1RagVectorDbConfig", - "description": "Config for the Vector DB to use for RAG.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution": { + "description": "A prompt instance's parameters set that contains a set of variable values.", + "id": "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution", "properties": { - "ragManagedDb": { - "description": "The config for the RAG-managed Vector DB.", - "$ref": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb" + "arguments": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue" + }, + "description": "Maps variable names to their value.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue": { + "description": "The value of a variable in prompt.", + "id": "GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue", + "properties": { + "partList": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPartList", + "description": "The parts of the variable value." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderData": { + "description": "Defines data for an application builder.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderData", + "properties": { + "codeRepositoryState": { + "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.", + "type": "string" }, - "pinecone": { - "description": "The config for the Pinecone.", - "$ref": "GoogleCloudAiplatformV1RagVectorDbConfigPinecone" + "framework": { + "description": "Optional. Framework used to build the application.", + "enum": [ + "FRAMEWORK_UNSPECIFIED", + "REACT", + "ANGULAR" + ], + "enumDescriptions": [ + "Unspecified framework.", + "React framework.", + "Angular framework." + ], + "type": "string" }, - "vertexVectorSearch": { - "description": "The config for the Vertex Vector Search.", - "$ref": "GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch" + "linkedResources": { + "description": "Linked resources attached to the application by the user.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderDataLinkedResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderDataLinkedResource": { + "description": "A linked resource attached to the application by the user.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderDataLinkedResource", + "properties": { + "displayName": { + "description": "A user-friendly name for the data source shown in the UI.", + "type": "string" }, - "apiAuth": { - "description": "Authentication config for the chosen Vector DB.", - "$ref": "GoogleCloudAiplatformV1ApiAuth" + "name": { + "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}", + "type": "string" }, - "ragEmbeddingModelConfig": { - "description": "Optional. Immutable. The embedding model config of the Vector DB.", - "$ref": "GoogleCloudAiplatformV1RagEmbeddingModelConfig" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb": { - "id": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb", - "description": "The config for the default RAG-managed Vector DB.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPromptSpecInteractionData": { + "description": "Defines data for an interaction prompt.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecInteractionData", "properties": { - "knn": { - "description": "Performs a KNN search on RagCorpus. Default choice if not specified.", - "$ref": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN" - }, - "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": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN": { - "id": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN", - "description": "Config for KNN search.", - "type": "object", - "properties": {} + "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt": { + "description": "Prompt variation that embeds preambles to prompt string.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt", + "properties": { + "promptMessage": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage", + "description": "The prompt message." + } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN": { - "id": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN", - "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", + "GoogleCloudAiplatformV1SchemaPromptSpecPartList": { + "description": "A list of elements and information that make up a portion of prompt.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecPartList", "properties": { - "treeDepth": { - "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.", - "type": "integer", - "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.", - "type": "integer", - "format": "int32" + "parts": { + "description": "A list of elements that can be part of a prompt.", + "items": { + "$ref": "GoogleCloudAiplatformV1Part" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagVectorDbConfigPinecone": { - "id": "GoogleCloudAiplatformV1RagVectorDbConfigPinecone", - "description": "The config for the Pinecone.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage": { + "description": "The prompt message that aligns with the prompt message in google.cloud.aiplatform.master.GenerateContentRequest.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage", "properties": { - "indexName": { - "description": "Pinecone index name. This value cannot be changed after it's set.", + "contents": { + "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": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + }, + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "Generation config." + }, + "model": { + "description": "The model name.", "type": "string" + }, + "safetySettings": { + "description": "Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", + "items": { + "$ref": "GoogleCloudAiplatformV1SafetySetting" + }, + "type": "array" + }, + "systemInstruction": { + "$ref": "GoogleCloudAiplatformV1Content", + "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." + }, + "toolConfig": { + "$ref": "GoogleCloudAiplatformV1ToolConfig", + "description": "Tool config. This config is shared for all tools provided in the request." + }, + "tools": { + "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": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch": { - "id": "GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch", - "description": "The config for the Vertex Vector Search.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair": { + "description": "A pair of sentences used as reference in source and target languages.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair", "properties": { - "indexEndpoint": { - "description": "The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "sourceSentence": { + "description": "Source sentence in the sentence pair.", "type": "string" }, - "index": { - "description": "The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}`", + "targetSentence": { + "description": "Target sentence in the sentence pair.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagEmbeddingModelConfig": { - "id": "GoogleCloudAiplatformV1RagEmbeddingModelConfig", - "description": "Config for the embedding model to use for RAG.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList": { + "description": "A list of reference sentence pairs.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList", "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": "GoogleCloudAiplatformV1RagEmbeddingModelConfigVertexPredictionEndpoint" + "referenceSentencePairs": { + "description": "Reference sentence pairs.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagEmbeddingModelConfigVertexPredictionEndpoint": { - "id": "GoogleCloudAiplatformV1RagEmbeddingModelConfigVertexPredictionEndpoint", - "description": "Config representing a model hosted on Vertex Prediction Endpoint.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt": { + "description": "Prompt variation that stores preambles in separate fields.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt", "properties": { - "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" + "appBuilderData": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderData", + "description": "Data for app builder use case." }, - "model": { - "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, + "context": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Preamble: The context of the prompt." + }, + "examples": { + "description": "Preamble: A set of examples for expected model response.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPartList" + }, + "type": "array" + }, + "infillPrefix": { + "description": "Preamble: For infill prompt, the prefix before expected model response.", "type": "string" }, - "modelVersionId": { - "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, + "infillSuffix": { + "description": "Preamble: For infill prompt, the suffix after expected model response.", "type": "string" + }, + "inputPrefixes": { + "description": "Preamble: The input prefixes before each example input.", + "items": { + "type": "string" + }, + "type": "array" + }, + "interactionData": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecInteractionData", + "description": "Data for interaction use case." + }, + "outputPrefixes": { + "description": "Preamble: The output prefixes before each example output.", + "items": { + "type": "string" + }, + "type": "array" + }, + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPartList" + }, + "type": "array" + }, + "promptMessage": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage", + "description": "The prompt message." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1VertexAiSearchConfig": { - "id": "GoogleCloudAiplatformV1VertexAiSearchConfig", - "description": "Config for the Vertex AI Search.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample": { + "description": "The translation example that contains reference sentences from various sources.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample", "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" + "referenceSentencePairLists": { + "description": "The reference sentences from inline text.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList" + }, + "type": "array" + }, + "referenceSentencesFileInputs": { + "description": "The reference sentences from file.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CorpusStatus": { - "id": "GoogleCloudAiplatformV1CorpusStatus", - "description": "RagCorpus status.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource": { + "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource", "properties": { - "state": { - "description": "Output only. RagCorpus life 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." - ], - "enum": [ - "UNKNOWN", - "INITIALIZED", - "ACTIVE", - "ERROR" - ] + "content": { + "description": "The file's contents.", + "type": "string" }, - "errorStatus": { - "description": "Output only. Only when the `state` field is ERROR.", - "readOnly": true, + "displayName": { + "description": "The file's display name.", + "type": "string" + }, + "mimeType": { + "description": "The file's mime type.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ListRagCorporaResponse": { - "id": "GoogleCloudAiplatformV1ListRagCorporaResponse", - "description": "Response message for VertexRagDataService.ListRagCorpora.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource": { + "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource", "properties": { - "ragCorpora": { - "description": "List of RagCorpora in the requested page.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1RagCorpus" - } - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page.", + "inputUri": { + "description": "Source data URI. For example, `gs://my_bucket/my_object`.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UploadRagFileRequest": { - "id": "GoogleCloudAiplatformV1UploadRagFileRequest", - "description": "Request message for VertexRagDataService.UploadRagFile.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption": { + "description": "Optional settings for translation prompt.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption", "properties": { - "ragFile": { - "description": "Required. The RagFile to upload.", - "$ref": "GoogleCloudAiplatformV1RagFile" - }, - "uploadRagFileConfig": { - "description": "Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile.", - "$ref": "GoogleCloudAiplatformV1UploadRagFileConfig" + "numberOfShots": { + "description": "How many shots to use.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagFile": { - "id": "GoogleCloudAiplatformV1RagFile", - "description": "A RagFile contains user data for chunking, embedding and indexing.", - "type": "object", + "GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt": { + "description": "Prompt variation for Translation use case.", + "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt", "properties": { - "gcsSource": { - "description": "Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1GcsSource" - }, - "googleDriveSource": { - "description": "Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1GoogleDriveSource" - }, - "directUploadSource": { - "description": "Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1DirectUploadSource" - }, - "slackSource": { - "description": "The RagFile is imported from a Slack channel.", - "$ref": "GoogleCloudAiplatformV1SlackSource" - }, - "jiraSource": { - "description": "The RagFile is imported from a Jira query.", - "$ref": "GoogleCloudAiplatformV1JiraSource" + "example": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample", + "description": "The translation example." }, - "sharePointSources": { - "description": "The RagFile is imported from a SharePoint source.", - "$ref": "GoogleCloudAiplatformV1SharePointSources" + "option": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption", + "description": "The translation option." }, - "name": { - "description": "Output only. The resource name of the RagFile.", - "readOnly": true, - "type": "string" + "promptMessage": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage", + "description": "The prompt message." }, - "displayName": { - "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.", + "sourceLanguageCode": { + "description": "The source language code.", "type": "string" }, - "description": { - "description": "Optional. The description of the RagFile.", + "targetLanguageCode": { + "description": "The target language code.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput": { + "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput", + "properties": { + "fileInputSource": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource", + "description": "Inlined file source." }, - "createTime": { - "description": "Output only. Timestamp when this RagFile was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "Output only. Timestamp when this RagFile was last updated.", - "readOnly": true, - "type": "string", - "format": "google-datetime" - }, - "fileStatus": { - "description": "Output only. State of the RagFile.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1FileStatus" - }, - "userMetadata": { - "description": "Output only. The metadata for metadata search. The user_metadata Needs to be in JSON format.", - "readOnly": true, - "type": "string" + "gcsInputSource": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource", + "description": "Cloud Storage file source." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GoogleDriveSource": { - "id": "GoogleCloudAiplatformV1GoogleDriveSource", - "description": "The Google Drive location for the input content.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTablesDatasetMetadata": { + "description": "The metadata of Datasets that contain tables data.", + "id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadata", "properties": { - "resourceIds": { - "description": "Required. Google Drive resource IDs.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1GoogleDriveSourceResourceId" - } + "inputConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GoogleDriveSourceResourceId": { - "id": "GoogleCloudAiplatformV1GoogleDriveSourceResourceId", - "description": "The type and ID of the Google Drive resource.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource": { + "id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource", "properties": { - "resourceType": { - "description": "Required. The type of the Google Drive resource.", - "type": "string", - "enumDescriptions": [ - "Unspecified resource type.", - "File resource type.", - "Folder resource type." - ], - "enum": [ - "RESOURCE_TYPE_UNSPECIFIED", - "RESOURCE_TYPE_FILE", - "RESOURCE_TYPE_FOLDER" - ] - }, - "resourceId": { - "description": "Required. The ID of the Google Drive resource.", + "uri": { + "description": "The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId", "type": "string" } - } - }, - "GoogleCloudAiplatformV1DirectUploadSource": { - "id": "GoogleCloudAiplatformV1DirectUploadSource", - "description": "The input content is encapsulated and uploaded in the request.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1SlackSource": { - "id": "GoogleCloudAiplatformV1SlackSource", - "description": "The Slack source for the ImportRagFilesRequest.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource": { + "id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource", "properties": { - "channels": { - "description": "Required. The Slack channels.", - "type": "array", + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1SlackSourceSlackChannels" - } + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SlackSourceSlackChannels": { - "id": "GoogleCloudAiplatformV1SlackSourceSlackChannels", - "description": "SlackChannels contains the Slack channels and corresponding access token.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig": { + "description": "The tables Dataset's data source. The Dataset doesn't store the data directly, but only pointer(s) to its data.", + "id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig", "properties": { - "channels": { - "description": "Required. The Slack channel IDs.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel" - } + "bigquerySource": { + "$ref": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource" }, - "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": "GoogleCloudAiplatformV1ApiAuthApiKeyConfig" + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel": { - "id": "GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel", - "description": "SlackChannel contains the Slack channel ID and the time range to import.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTextClassificationAnnotation": { + "description": "Annotation details specific to text classification.", + "id": "GoogleCloudAiplatformV1SchemaTextClassificationAnnotation", "properties": { - "channelId": { - "description": "Required. The Slack channel ID.", + "annotationSpecId": { + "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, - "startTime": { - "description": "Optional. The starting timestamp for messages to import.", - "type": "string", - "format": "google-datetime" - }, - "endTime": { - "description": "Optional. The ending timestamp for messages to import.", - "type": "string", - "format": "google-datetime" + "displayName": { + "description": "The display name of the AnnotationSpec that this Annotation pertains to.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1JiraSource": { - "id": "GoogleCloudAiplatformV1JiraSource", - "description": "The Jira source for the ImportRagFilesRequest.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTextDataItem": { + "description": "Payload of Text DataItem.", + "id": "GoogleCloudAiplatformV1SchemaTextDataItem", "properties": { - "jiraQueries": { - "description": "Required. The Jira queries.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1JiraSourceJiraQueries" - } + "gcsUri": { + "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, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1JiraSourceJiraQueries": { - "id": "GoogleCloudAiplatformV1JiraSourceJiraQueries", - "description": "JiraQueries contains the Jira queries and corresponding authentication.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTextDatasetMetadata": { + "description": "The metadata of Datasets that contain Text DataItems.", + "id": "GoogleCloudAiplatformV1SchemaTextDatasetMetadata", "properties": { - "projects": { - "description": "A list of Jira projects to import in their entirety.", - "type": "array", - "items": { - "type": "string" - } - }, - "customQueries": { - "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/", - "type": "array", - "items": { - "type": "string" - } - }, - "email": { - "description": "Required. The Jira email address.", + "dataItemSchemaUri": { + "description": "Points to a YAML file stored on Google Cloud Storage describing payload of the Text DataItems that belong to this Dataset.", "type": "string" }, - "serverUri": { - "description": "Required. The Jira server URI.", + "gcsBucket": { + "description": "Google Cloud Storage Bucket name that contains the blob data of this Dataset.", "type": "string" - }, - "apiKeyConfig": { - "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/).", - "$ref": "GoogleCloudAiplatformV1ApiAuthApiKeyConfig" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SharePointSources": { - "id": "GoogleCloudAiplatformV1SharePointSources", - "description": "The SharePointSources to pass to ImportRagFiles.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTextExtractionAnnotation": { + "description": "Annotation details specific to text extraction.", + "id": "GoogleCloudAiplatformV1SchemaTextExtractionAnnotation", "properties": { - "sharePointSources": { - "description": "The SharePoint sources.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SharePointSourcesSharePointSource" - } + "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" + }, + "textSegment": { + "$ref": "GoogleCloudAiplatformV1SchemaTextSegment", + "description": "The segment of the text content." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SharePointSourcesSharePointSource": { - "id": "GoogleCloudAiplatformV1SharePointSourcesSharePointSource", - "description": "An individual SharePointSource.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata": { + "description": "The metadata of Datasets that contain Text Prompt data.", + "id": "GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata", "properties": { - "sharepointFolderPath": { - "description": "The path of the SharePoint folder to download from.", + "candidateCount": { + "description": "Number of candidates.", + "format": "int64", "type": "string" }, - "sharepointFolderId": { - "description": "The ID of the SharePoint folder to download from.", + "gcsUri": { + "description": "The Google Cloud Storage URI that stores the prompt data.", "type": "string" }, - "driveName": { - "description": "The name of the drive to download from.", + "groundingConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig", + "description": "Grounding checking configuration." + }, + "hasPromptVariable": { + "description": "Whether the prompt dataset has prompt variable.", + "type": "boolean" + }, + "logprobs": { + "description": "Whether or not the user has enabled logit probabilities in the model parameters.", + "type": "boolean" + }, + "maxOutputTokens": { + "description": "Value of the maximum number of tokens generated set when the dataset was saved.", + "format": "int64", "type": "string" }, - "driveId": { - "description": "The ID of the drive to download from.", + "note": { + "description": "User-created prompt note. Note size limit is 2KB.", "type": "string" }, - "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.", + "promptApiSchema": { + "$ref": "GoogleCloudAiplatformV1SchemaPromptApiSchema", + "description": "The API schema of the prompt to support both UI and SDK usages." + }, + "promptType": { + "description": "Type of the prompt dataset.", "type": "string" }, - "clientSecret": { - "description": "The application secret for the app registered in Azure.", - "$ref": "GoogleCloudAiplatformV1ApiAuthApiKeyConfig" + "seedEnabled": { + "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.", + "type": "boolean" }, - "tenantId": { - "description": "Unique identifier of the Azure Active Directory Instance.", + "seedValue": { + "description": "The actual value of the seed.", + "format": "int64", "type": "string" }, - "sharepointSiteName": { - "description": "The name of the SharePoint site to download from. This can be the site name or the site id.", + "stopSequences": { + "description": "Customized stop sequences.", + "items": { + "type": "string" + }, + "type": "array" + }, + "systemInstruction": { + "description": "The content of the prompt dataset system instruction.", "type": "string" }, - "fileId": { - "description": "Output only. The SharePoint file id. Output only.", - "readOnly": true, + "systemInstructionGcsUri": { + "description": "The Google Cloud Storage URI that stores the system instruction, starting with gs://.", + "type": "string" + }, + "temperature": { + "description": "Temperature value used for sampling set when the dataset was saved. This value is used to tune the degree of randomness.", + "format": "float", + "type": "number" + }, + "text": { + "description": "The content of the prompt dataset.", + "type": "string" + }, + "topK": { + "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.", + "format": "int64", "type": "string" + }, + "topP": { + "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.", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1FileStatus": { - "id": "GoogleCloudAiplatformV1FileStatus", - "description": "RagFile status.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTextSegment": { + "description": "The text segment inside of DataItem.", + "id": "GoogleCloudAiplatformV1SchemaTextSegment", "properties": { - "state": { - "description": "Output only. RagFile state.", - "readOnly": true, - "type": "string", - "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" - ] + "content": { + "description": "The text content in the segment for output only.", + "type": "string" }, - "errorStatus": { - "description": "Output only. Only when the `state` field is ERROR.", - "readOnly": true, + "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.", + "format": "uint64", + "type": "string" + }, + "startOffset": { + "description": "Zero-based character index of the first character of the text segment (counting characters from the beginning of the text).", + "format": "uint64", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UploadRagFileConfig": { - "id": "GoogleCloudAiplatformV1UploadRagFileConfig", - "description": "Config for uploading RagFile.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTextSentimentAnnotation": { + "description": "Annotation details specific to text sentiment.", + "id": "GoogleCloudAiplatformV1SchemaTextSentimentAnnotation", "properties": { - "ragFileTransformationConfig": { - "description": "Specifies the transformation config for RagFiles.", - "$ref": "GoogleCloudAiplatformV1RagFileTransformationConfig" + "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" + }, + "sentiment": { + "description": "The sentiment score for text.", + "format": "int32", + "type": "integer" + }, + "sentimentMax": { + "description": "The sentiment max score for text.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagFileTransformationConfig": { - "id": "GoogleCloudAiplatformV1RagFileTransformationConfig", - "description": "Specifies the transformation config for RagFiles.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata": { + "description": "The metadata of SavedQuery contains TextSentiment Annotations.", + "id": "GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata", "properties": { - "ragFileChunkingConfig": { - "description": "Specifies the chunking config for RagFiles.", - "$ref": "GoogleCloudAiplatformV1RagFileChunkingConfig" + "sentimentMax": { + "description": "The maximum sentiment of sentiment Anntoation in this SavedQuery.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagFileChunkingConfig": { - "id": "GoogleCloudAiplatformV1RagFileChunkingConfig", - "description": "Specifies the size and overlap of chunks for RagFiles.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTimeSegment": { + "description": "A time period inside of a DataItem that has a time dimension (e.g. video).", + "id": "GoogleCloudAiplatformV1SchemaTimeSegment", "properties": { - "fixedLengthChunking": { - "description": "Specifies the fixed length chunking config.", - "$ref": "GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking" + "endTimeOffset": { + "description": "End of the time segment (exclusive), represented as the duration since the start of the DataItem.", + "format": "google-duration", + "type": "string" + }, + "startTimeOffset": { + "description": "Start of the time segment (inclusive), represented as the duration since the start of the DataItem.", + "format": "google-duration", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking": { - "id": "GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking", - "description": "Specifies the fixed length chunking config.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata": { + "description": "The metadata of Datasets that contain time series data.", + "id": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata", "properties": { - "chunkSize": { - "description": "The size of the chunks.", - "type": "integer", - "format": "int32" + "inputConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig" }, - "chunkOverlap": { - "description": "The overlap between chunks.", - "type": "integer", - "format": "int32" + "timeColumn": { + "description": "The column name of the time column that identifies time order in the time series.", + "type": "string" + }, + "timeSeriesIdentifierColumn": { + "description": "The column name of the time series identifier column that identifies the time series.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UploadRagFileResponse": { - "id": "GoogleCloudAiplatformV1UploadRagFileResponse", - "description": "Response message for VertexRagDataService.UploadRagFile.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource": { + "id": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource", "properties": { - "ragFile": { - "description": "The RagFile that had been uploaded into the RagCorpus.", - "$ref": "GoogleCloudAiplatformV1RagFile" - }, - "error": { - "description": "The error that occurred while processing the RagFile.", - "$ref": "GoogleRpcStatus" + "uri": { + "description": "The URI of a BigQuery table.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ImportRagFilesRequest": { - "id": "GoogleCloudAiplatformV1ImportRagFilesRequest", - "description": "Request message for VertexRagDataService.ImportRagFiles.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource": { + "id": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource", "properties": { - "importRagFilesConfig": { - "description": "Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles.", - "$ref": "GoogleCloudAiplatformV1ImportRagFilesConfig" + "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.", + "items": { + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ImportRagFilesConfig": { - "id": "GoogleCloudAiplatformV1ImportRagFilesConfig", - "description": "Config for importing RagFiles.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig": { + "description": "The time series Dataset's data source. The Dataset doesn't store the data directly, but only pointer(s) to its data.", + "id": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig", "properties": { + "bigquerySource": { + "$ref": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource" + }, "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": "GoogleCloudAiplatformV1GcsSource" + "$ref": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting": { + "description": "A TrainingJob that trains and uploads an AutoML Forecasting Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting", + "properties": { + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs", + "description": "The input parameters of this TrainingJob." }, - "googleDriveSource": { - "description": "Google Drive location. Supports importing individual files as well as Google Drive folders.", - "$ref": "GoogleCloudAiplatformV1GoogleDriveSource" + "metadata": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata", + "description": "The metadata information." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs", + "properties": { + "additionalExperiments": { + "description": "Additional experiment flags for the time series forcasting training.", + "items": { + "type": "string" + }, + "type": "array" }, - "slackSource": { - "description": "Slack channels with their corresponding access tokens.", - "$ref": "GoogleCloudAiplatformV1SlackSource" + "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" }, - "jiraSource": { - "description": "Jira queries with their corresponding authentication.", - "$ref": "GoogleCloudAiplatformV1JiraSource" + "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" }, - "sharePointSources": { - "description": "SharePoint sources.", - "$ref": "GoogleCloudAiplatformV1SharePointSources" + "dataGranularity": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity", + "description": "Expected difference in time granularity between rows in the data." }, - "partialFailureGcsSink": { - "description": "The Cloud Storage path to write partial failures to. Deprecated. Prefer to use `import_result_gcs_sink`.", - "deprecated": true, - "$ref": "GoogleCloudAiplatformV1GcsDestination" + "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" }, - "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": "GoogleCloudAiplatformV1BigQueryDestination" + "exportEvaluatedDataItemsConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig", + "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed." }, - "importResultGcsSink": { - "description": "The Cloud Storage path to write import result to.", - "$ref": "GoogleCloudAiplatformV1GcsDestination" + "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" + }, + "hierarchyConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig", + "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies." + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "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": "GoogleCloudAiplatformV1BigQueryDestination" + "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" }, - "ragFileTransformationConfig": { - "description": "Specifies the transformation config for RagFiles.", - "$ref": "GoogleCloudAiplatformV1RagFileTransformationConfig" + "quantiles": { + "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.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" }, - "ragFileParsingConfig": { - "description": "Optional. Specifies the parsing config for RagFiles. RAG will use the default parser if this field is not set.", - "$ref": "GoogleCloudAiplatformV1RagFileParsingConfig" + "targetColumn": { + "description": "The name of the column that the Model is to predict values for. This column must be unavailable at forecast.", + "type": "string" }, - "maxEmbeddingRequestsPerMin": { - "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.", - "type": "integer", - "format": "int32" + "timeColumn": { + "description": "The name of the column that identifies time order in the time series. This column must be available at forecast.", + "type": "string" }, - "rebuildAnnIndex": { - "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.", - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1RagFileParsingConfig": { - "id": "GoogleCloudAiplatformV1RagFileParsingConfig", - "description": "Specifies the parsing config for RagFiles.", - "type": "object", - "properties": { - "layoutParser": { - "description": "The Layout Parser to use for RagFiles.", - "$ref": "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser" + "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" }, - "llmParser": { - "description": "The LLM Parser to use for RagFiles.", - "$ref": "GoogleCloudAiplatformV1RagFileParsingConfigLlmParser" - } - } - }, - "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser": { - "id": "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser", - "description": "Document AI Layout Parser config.", - "type": "object", - "properties": { - "processorName": { - "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}`", + "timeSeriesIdentifierColumn": { + "description": "The name of the column that identifies the time series.", "type": "string" }, - "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.", - "type": "integer", - "format": "int32" - } - } - }, - "GoogleCloudAiplatformV1RagFileParsingConfigLlmParser": { - "id": "GoogleCloudAiplatformV1RagFileParsingConfigLlmParser", - "description": "Specifies the LLM parsing for RagFiles.", - "type": "object", - "properties": { - "modelName": { - "description": "The name of a LLM model used for parsing. Format: * `projects/{project_id}/locations/{location}/publishers/{publisher}/models/{model}`", + "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" }, - "maxParsingRequestsPerMin": { - "description": "The maximum number of requests the job is allowed to make to the LLM model per minute. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If unspecified, a default value of 5000 QPM would be used.", - "type": "integer", - "format": "int32" + "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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation" + }, + "type": "array" }, - "customParsingPrompt": { - "description": "The prompt to use for parsing. If not specified, a default prompt will be used.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1ListRagFilesResponse": { - "id": "GoogleCloudAiplatformV1ListRagFilesResponse", - "description": "Response message for VertexRagDataService.ListRagFiles.", - "type": "object", - "properties": { - "ragFiles": { - "description": "List of RagFiles in the requested page.", - "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": { - "$ref": "GoogleCloudAiplatformV1RagFile" - } + "type": "string" + }, + "type": "array" }, - "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page.", + "validationOptions": { + "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", + "type": "string" + }, + "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.", "type": "string" + }, + "windowConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig", + "description": "Config containing strategy for generating sliding windows." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagEngineConfig": { - "id": "GoogleCloudAiplatformV1RagEngineConfig", - "description": "Config for RagEngine.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity": { + "description": "A duration of time expressed in time granularity units.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity", "properties": { - "name": { - "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "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" }, - "ragManagedDbConfig": { - "description": "The config of the RagManagedDb used by RagEngine.", - "$ref": "GoogleCloudAiplatformV1RagManagedDbConfig" + "unit": { + "description": "The time granularity unit of this time period. The supported units are: * \"minute\" * \"hour\" * \"day\" * \"week\" * \"month\" * \"year\"", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagManagedDbConfig": { - "id": "GoogleCloudAiplatformV1RagManagedDbConfig", - "description": "Configuration message for RagManagedDb used by RagEngine.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation", "properties": { - "scaled": { - "description": "Sets the RagManagedDb to the Scaled tier. This is the default tier if not explicitly chosen.", - "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigScaled" + "auto": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation" }, - "basic": { - "description": "Sets the RagManagedDb to the Basic tier.", - "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigBasic" + "categorical": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation" }, - "unprovisioned": { - "description": "Sets the RagManagedDb to the Unprovisioned tier.", - "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned" - } - } - }, - "GoogleCloudAiplatformV1RagManagedDbConfigScaled": { - "id": "GoogleCloudAiplatformV1RagManagedDbConfigScaled", - "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.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1RagManagedDbConfigBasic": { - "id": "GoogleCloudAiplatformV1RagManagedDbConfigBasic", - "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 if not explicitly chosen.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned": { - "id": "GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned", - "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.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1RetrieveContextsRequest": { - "id": "GoogleCloudAiplatformV1RetrieveContextsRequest", - "description": "Request message for VertexRagService.RetrieveContexts.", - "type": "object", - "properties": { - "vertexRagStore": { - "description": "The data source for Vertex RagStore.", - "$ref": "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStore" + "numeric": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation" }, - "query": { - "description": "Required. Single RAG retrieve query.", - "$ref": "GoogleCloudAiplatformV1RagQuery" - } - } - }, - "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStore": { - "id": "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStore", - "description": "The data source for Vertex RagStore.", - "type": "object", - "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": "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStoreRagResource" - } + "text": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation" }, - "vectorDistanceThreshold": { - "description": "Optional. Only return contexts with vector distance smaller than the threshold.", - "deprecated": true, - "type": "number", - "format": "double" + "timestamp": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStoreRagResource": { - "id": "GoogleCloudAiplatformV1RetrieveContextsRequestVertexRagStoreRagResource", - "description": "The definition of the Rag resource.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation": { + "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation", "properties": { - "ragCorpus": { - "description": "Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "columnName": { "type": "string" - }, - "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" - } } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagQuery": { - "id": "GoogleCloudAiplatformV1RagQuery", - "description": "A query to retrieve relevant contexts.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation", "properties": { - "text": { - "description": "Optional. The query in text format to get relevant contexts.", + "columnName": { "type": "string" - }, - "ragRetrievalConfig": { - "description": "Optional. The retrieval config for the query.", - "$ref": "GoogleCloudAiplatformV1RagRetrievalConfig" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RetrieveContextsResponse": { - "id": "GoogleCloudAiplatformV1RetrieveContextsResponse", - "description": "Response message for VertexRagService.RetrieveContexts.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation": { + "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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation", "properties": { - "contexts": { - "description": "The contexts of the query.", - "$ref": "GoogleCloudAiplatformV1RagContexts" + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagContexts": { - "id": "GoogleCloudAiplatformV1RagContexts", - "description": "Relevant contexts for one query.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation", "properties": { - "contexts": { - "description": "All its contexts.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1RagContextsContext" - } + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RagContextsContext": { - "id": "GoogleCloudAiplatformV1RagContextsContext", - "description": "A context of the query.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation": { + "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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation", "properties": { - "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" - }, - "sourceDisplayName": { - "description": "The file display name.", + "columnName": { "type": "string" }, - "text": { - "description": "The text chunk.", + "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" - }, - "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.", - "type": "number", - "format": "double" - }, - "chunk": { - "description": "Context of the retrieved chunk.", - "$ref": "GoogleCloudAiplatformV1RagChunk" - } - } - }, - "GoogleCloudAiplatformV1AugmentPromptRequest": { - "id": "GoogleCloudAiplatformV1AugmentPromptRequest", - "description": "Request message for AugmentPrompt.", - "type": "object", - "properties": { - "vertexRagStore": { - "description": "Optional. Retrieves contexts from the Vertex RagStore.", - "$ref": "GoogleCloudAiplatformV1VertexRagStore" - }, - "contents": { - "description": "Optional. Input content to augment, only text format is supported for now.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Content" - } - }, - "model": { - "description": "Optional. Metadata of the backend deployed model.", - "$ref": "GoogleCloudAiplatformV1AugmentPromptRequestModel" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AugmentPromptRequestModel": { - "id": "GoogleCloudAiplatformV1AugmentPromptRequestModel", - "description": "Metadata of the backend deployed model.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata": { + "description": "Model metadata specific to AutoML Forecasting.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata", "properties": { - "model": { - "description": "Optional. The model that the user will send the augmented prompt for content generation.", + "evaluatedDataItemsBigqueryUri": { + "description": "BigQuery destination uri for exported evaluated examples.", "type": "string" }, - "modelVersion": { - "description": "Optional. The model version of the backend deployed model.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1AugmentPromptResponse": { - "id": "GoogleCloudAiplatformV1AugmentPromptResponse", - "description": "Response message for AugmentPrompt.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification": { + "description": "A TrainingJob that trains and uploads an AutoML Image Classification Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification", "properties": { - "augmentedPrompt": { - "description": "Augmented prompt, only text format is supported for now.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Content" - } + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs", + "description": "The input parameters of this TrainingJob." }, - "facts": { - "description": "Retrieved facts from RAG data sources.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Fact" - } + "metadata": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata", + "description": "The metadata information." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Fact": { - "id": "GoogleCloudAiplatformV1Fact", - "description": "The fact used in grounding.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs", "properties": { - "query": { - "description": "Query that is used to retrieve this fact.", + "baseModelId": { + "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.", "type": "string" }, - "title": { - "description": "If present, it refers to the title of this fact.", + "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" }, - "uri": { - "description": "If present, this uri links to the source of the fact.", - "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" }, - "summary": { - "description": "If present, the summary/snippet of the fact.", + "modelType": { + "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" + ], + "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." + ], "type": "string" }, - "vectorDistance": { - "description": "If present, the distance between the query vector and this fact vector.", - "deprecated": true, - "type": "number", - "format": "double" + "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" }, - "score": { - "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.", - "type": "number", - "format": "double" + "tunableParameter": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter", + "description": "Trainer type for Vision TrainRequest." }, - "chunk": { - "description": "If present, chunk properties.", - "$ref": "GoogleCloudAiplatformV1RagChunk" + "uptrainBaseModelId": { + "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.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CorroborateContentRequest": { - "id": "GoogleCloudAiplatformV1CorroborateContentRequest", - "description": "Request message for CorroborateContent.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata", "properties": { - "content": { - "description": "Optional. Input content to corroborate, only text format is supported for now.", - "$ref": "GoogleCloudAiplatformV1Content" - }, - "facts": { - "description": "Optional. Facts used to generate the text can also be used to corroborate the text.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Fact" - } + "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" }, - "parameters": { - "description": "Optional. Parameters that can be set to override default settings per request.", - "$ref": "GoogleCloudAiplatformV1CorroborateContentRequestParameters" - } - } - }, - "GoogleCloudAiplatformV1CorroborateContentRequestParameters": { - "id": "GoogleCloudAiplatformV1CorroborateContentRequestParameters", - "description": "Parameters that can be overrided per request.", - "type": "object", - "properties": { - "citationThreshold": { - "description": "Optional. Only return claims with citation score larger than the threshold.", - "type": "number", - "format": "double" + "successfulStopReason": { + "description": "For successful job completions, this is the reason why the job has finished.", + "enum": [ + "SUCCESSFUL_STOP_REASON_UNSPECIFIED", + "BUDGET_REACHED", + "MODEL_CONVERGED" + ], + "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": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CorroborateContentResponse": { - "id": "GoogleCloudAiplatformV1CorroborateContentResponse", - "description": "Response message for CorroborateContent.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection": { + "description": "A TrainingJob that trains and uploads an AutoML Image Object Detection Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection", "properties": { - "corroborationScore": { - "description": "Confidence score of corroborating content. Value is [0,1] with 1 is the most confidence.", - "type": "number", - "format": "float" + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs", + "description": "The input parameters of this TrainingJob." }, - "claims": { - "description": "Claims that are extracted from the input content and facts that support the claims.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Claim" - } + "metadata": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata", + "description": "The metadata information" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1Claim": { - "id": "GoogleCloudAiplatformV1Claim", - "description": "Claim that is extracted from the input text and facts that support it.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs", "properties": { - "startIndex": { - "description": "Index in the input text where the claim starts (inclusive).", - "type": "integer", - "format": "int32" + "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 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.", + "format": "int64", + "type": "string" }, - "endIndex": { - "description": "Index in the input text where the claim ends (exclusive).", - "type": "integer", - "format": "int32" + "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" }, - "factIndexes": { - "description": "Indexes of the facts supporting this claim.", - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } + "modelType": { + "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" + ], + "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." + ], + "type": "string" }, - "score": { - "description": "Confidence score of this corroboration.", - "type": "number", - "format": "float" - } - } - }, - "GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata": { - "id": "GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata", - "description": "Metadata information for NotebookService.AssignNotebookRuntime.", - "type": "object", - "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "tunableParameter": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter", + "description": "Trainer type for Vision TrainRequest." }, - "progressMessage": { - "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", + "uptrainBaseModelId": { + "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.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenericOperationMetadata": { - "id": "GoogleCloudAiplatformV1GenericOperationMetadata", - "description": "Generic Metadata shared by all operations.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata", "properties": { - "partialFailures": { - "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.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "GoogleRpcStatus" - } - }, - "createTime": { - "description": "Output only. Time when the operation was created.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "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" }, - "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.", - "readOnly": true, - "type": "string", - "format": "google-datetime" + "successfulStopReason": { + "description": "For successful job completions, this is the reason why the job has finished.", + "enum": [ + "SUCCESSFUL_STOP_REASON_UNSPECIFIED", + "BUDGET_REACHED", + "MODEL_CONVERGED" + ], + "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": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata": { - "id": "GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata", - "description": "Runtime operation information for MigrationService.BatchMigrateResources.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation": { + "description": "A TrainingJob that trains and uploads an AutoML Image Segmentation Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation", "properties": { - "genericMetadata": { - "description": "The common part of the operation metadata.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs", + "description": "The input parameters of this TrainingJob." }, - "partialResults": { - "description": "Partial results that reflect the latest migration operation progress.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult" - } + "metadata": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata", + "description": "The metadata information." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult": { - "id": "GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult", - "description": "Represents a partial result in batch migration operation for one MigrateResourceRequest.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs", "properties": { - "error": { - "description": "The error result of the migration request in case of failure.", - "$ref": "GoogleRpcStatus" - }, - "model": { - "description": "Migrated model resource name.", + "baseModelId": { + "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.", "type": "string" }, - "dataset": { - "description": "Migrated dataset resource name.", + "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" }, - "request": { - "description": "It's the same as the value in BatchMigrateResourcesRequest.migrate_resource_requests.", - "$ref": "GoogleCloudAiplatformV1MigrateResourceRequest" - } - } - }, - "GoogleCloudAiplatformV1BatchMigrateResourcesResponse": { - "id": "GoogleCloudAiplatformV1BatchMigrateResourcesResponse", - "description": "Response message for MigrationService.BatchMigrateResources.", - "type": "object", - "properties": { - "migrateResourceResponses": { - "description": "Successfully migrated resources.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1MigrateResourceResponse" - } + "modelType": { + "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." + ], + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MigrateResourceResponse": { - "id": "GoogleCloudAiplatformV1MigrateResourceResponse", - "description": "Describes a successfully migrated resource.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata", "properties": { - "dataset": { - "description": "Migrated Dataset's resource name.", + "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" }, - "model": { - "description": "Migrated Model's resource name.", + "successfulStopReason": { + "description": "For successful job completions, this is the reason why the job has finished.", + "enum": [ + "SUCCESSFUL_STOP_REASON_UNSPECIFIED", + "BUDGET_REACHED", + "MODEL_CONVERGED" + ], + "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": "string" - }, - "migratableResource": { - "description": "Before migration, the identifier in ml.googleapis.com, automl.googleapis.com or datalabeling.googleapis.com.", - "$ref": "GoogleCloudAiplatformV1MigratableResource" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata": { - "id": "GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata", - "description": "Details of operations that batch reads Feature values.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables": { + "description": "A TrainingJob that trains and uploads an AutoML Tables Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables", "properties": { - "genericMetadata": { - "description": "Operation metadata for Featurestore batch read Features values.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs", + "description": "The input parameters of this TrainingJob." + }, + "metadata": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata", + "description": "The metadata information." } - } - }, - "GoogleCloudAiplatformV1BatchReadFeatureValuesResponse": { - "id": "GoogleCloudAiplatformV1BatchReadFeatureValuesResponse", - "description": "Response message for FeaturestoreService.BatchReadFeatureValues.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata": { - "id": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata", - "description": "This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs", "properties": { - "genericMetadata": { - "description": "Operation metadata for suggesting Trials.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "additionalExperiments": { + "description": "Additional experiment flags for the Tables training pipeline.", + "items": { + "type": "string" + }, + "type": "array" }, - "study": { - "description": "The name of the Study that the Trial belongs to.", + "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" + }, + "exportEvaluatedDataItemsConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig", + "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed." + }, + "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" }, - "trial": { - "description": "The Trial name.", + "optimizationObjectivePrecisionValue": { + "description": "Required when optimization_objective is \"maximize-recall-at-precision\". Must be between 0 and 1, inclusive.", + "format": "float", + "type": "number" + }, + "optimizationObjectiveRecallValue": { + "description": "Required when optimization_objective is \"maximize-precision-at-recall\". Must be between 0 and 1, inclusive.", + "format": "float", + "type": "number" + }, + "predictionType": { + "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.", + "type": "string" + }, + "targetColumn": { + "description": "The column name of the target column that the model is to predict.", + "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" + }, + "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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation" + }, + "type": "array" + }, + "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" } - } - }, - "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse": { - "id": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse", - "description": "Response message for VizierService.CheckTrialEarlyStoppingState.", - "type": "object", - "properties": { - "shouldStop": { - "description": "True if the Trial should stop.", - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata", - "description": "Runtime operation information for CreateDeploymentResourcePool method.", - "type": "object", - "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" - } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateFeatureOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateFeatureOperationMetadata", - "description": "Details of operations that perform create Feature.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation", "properties": { - "genericMetadata": { - "description": "Operation metadata for Feature.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "auto": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation" + }, + "categorical": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation" + }, + "numeric": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation" + }, + "repeatedCategorical": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation" + }, + "repeatedNumeric": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation" + }, + "repeatedText": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation" + }, + "text": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation" + }, + "timestamp": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata", - "description": "Details of operations that perform create Featurestore.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation": { + "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation", "properties": { - "genericMetadata": { - "description": "Operation metadata for Featurestore.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata", - "description": "Details of operations that perform create FeatureGroup.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation", "properties": { - "genericMetadata": { - "description": "Operation metadata for FeatureGroup.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata", - "description": "Details of operations that perform create FeatureGroup.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation", "properties": { - "genericMetadata": { - "description": "Operation metadata for Feature.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata", - "description": "Details of operations that perform create FeatureOnlineStore.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation": { + "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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation", "properties": { - "genericMetadata": { - "description": "Operation metadata for FeatureOnlineStore.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata", - "description": "Details of operations that perform create FeatureView.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation": { + "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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation", "properties": { - "genericMetadata": { - "description": "Operation metadata for FeatureView Create.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata", - "description": "Details of operations that perform update FeatureOnlineStore.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation", "properties": { - "genericMetadata": { - "description": "Operation metadata for FeatureOnlineStore.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata", - "description": "Details of operations that perform update FeatureView.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation", "properties": { - "genericMetadata": { - "description": "Operation metadata for FeatureView Update.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateEndpointOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateEndpointOperationMetadata", - "description": "Runtime operation information for EndpointService.CreateEndpoint.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation": { + "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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "type": "string" }, - "deploymentStage": { - "description": "Output only. The deployment stage of the model. Only populated if this CreateEndpoint request deploys a model at the same time.", - "readOnly": true, - "type": "string", - "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" - ] - } - } - }, - "GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata", - "description": "Details of operations that perform MetadataService.CreateMetadataStore.", - "type": "object", - "properties": { - "genericMetadata": { - "description": "Operation metadata for creating a MetadataStore.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "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" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata", - "description": "Metadata information for NotebookService.CreateNotebookExecutionJob.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata": { + "description": "Model metadata specific to AutoML Tables.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "evaluatedDataItemsBigqueryUri": { + "description": "BigQuery destination uri for exported evaluated examples.", + "type": "string" }, - "progressMessage": { - "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata", - "description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification": { + "description": "A TrainingJob that trains and uploads an AutoML Text Classification Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs", + "description": "The input parameters of this TrainingJob." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata", - "description": "Runtime operation information for SpecialistPoolService.CreateSpecialistPool.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "multiLabel": { + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateIndexOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateIndexOperationMetadata", - "description": "Runtime operation information for IndexService.CreateIndex.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction": { + "description": "A TrainingJob that trains and uploads an AutoML Text Extraction Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" - }, - "nearestNeighborSearchOperationMetadata": { - "description": "The operation metadata with regard to Matching Engine Index operation.", - "$ref": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata" + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs", + "description": "The input parameters of this TrainingJob." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata": { - "id": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata", - "description": "Runtime operation metadata with regard to Matching Engine Index.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment": { + "description": "A TrainingJob that trains and uploads an AutoML Text Sentiment Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment", "properties": { - "contentValidationStats": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats" - } - }, - "dataBytesCount": { - "description": "The ingested data size in bytes.", - "type": "string", - "format": "int64" + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs", + "description": "The input parameters of this TrainingJob." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats": { - "id": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs", "properties": { - "sourceGcsUri": { - "description": "Cloud Storage URI pointing to the original file in user's bucket.", - "type": "string" - }, - "validRecordCount": { - "description": "Number of records in this file that were successfully processed.", - "type": "string", - "format": "int64" - }, - "invalidRecordCount": { - "description": "Number of records in this file we skipped due to validate errors.", - "type": "string", - "format": "int64" - }, - "partialErrors": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError" - } - }, - "validSparseRecordCount": { - "description": "Number of sparse records in this file that were successfully processed.", - "type": "string", - "format": "int64" - }, - "invalidSparseRecordCount": { - "description": "Number of sparse records in this file we skipped due to validate errors.", - "type": "string", - "format": "int64" + "sentimentMax": { + "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).", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError": { - "id": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition": { + "description": "A TrainingJob that trains and uploads an AutoML Video Action Recognition Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition", "properties": { - "errorType": { - "description": "The error type of this record.", - "type": "string", - "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." - ], - "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" - ] - }, - "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" - }, - "sourceGcsUri": { - "description": "Cloud Storage URI pointing to the original file in user's bucket.", - "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" + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs", + "description": "The input parameters of this TrainingJob." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata", - "description": "Runtime operation information for IndexEndpointService.CreateIndexEndpoint.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "modelType": { + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "CLOUD", + "MOBILE_VERSATILE_1", + "MOBILE_JETSON_VERSATILE_1", + "MOBILE_CORAL_VERSATILE_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 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": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata", - "description": "Details of operations that perform create EntityType.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification": { + "description": "A TrainingJob that trains and uploads an AutoML Video Classification Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification", "properties": { - "genericMetadata": { - "description": "Operation metadata for EntityType.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs", + "description": "The input parameters of this TrainingJob." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreateTensorboardOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateTensorboardOperationMetadata", - "description": "Details of operations that perform create Tensorboard.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs", "properties": { - "genericMetadata": { - "description": "Operation metadata for Tensorboard.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "modelType": { + "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": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata": { - "id": "GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata", - "description": "Details of operations that perform batch create Features.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking": { + "description": "A TrainingJob that trains and uploads an AutoML Video ObjectTracking Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking", "properties": { - "genericMetadata": { - "description": "Operation metadata for Feature.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs", + "description": "The input parameters of this TrainingJob." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1BatchCreateFeaturesResponse": { - "id": "GoogleCloudAiplatformV1BatchCreateFeaturesResponse", - "description": "Response message for FeaturestoreService.BatchCreateFeatures.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs", "properties": { - "features": { - "description": "The Features created.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Feature" - } + "modelType": { + "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": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata", - "description": "Details of operations that perform create PersistentResource.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter": { + "description": "A wrapper class which contains the tunable parameters in an AutoML Image training job.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter", "properties": { - "genericMetadata": { - "description": "Operation metadata for PersistentResource.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "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" }, - "progressMessage": { - "description": "Progress Message for Create LRO", + "datasetConfig": { + "additionalProperties": { + "type": "string" + }, + "description": "Customizable dataset settings, used in the `model_garden_trainer`.", + "type": "object" + }, + "studySpec": { + "$ref": "GoogleCloudAiplatformV1StudySpec", + "description": "Optioinal. StudySpec of hyperparameter tuning job. Required for `model_garden_trainer`." + }, + "trainerConfig": { + "additionalProperties": { + "type": "string" + }, + "description": "Customizable trainer settings, used in the `model_garden_trainer`.", + "type": "object" + }, + "trainerType": { + "enum": [ + "TRAINER_TYPE_UNSPECIFIED", + "AUTOML_TRAINER", + "MODEL_GARDEN_TRAINER" + ], + "enumDescriptions": [ + "Default value.", + "", + "" + ], "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata": { - "id": "GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata", - "description": "Details of operations that delete Feature values.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata", "properties": { - "genericMetadata": { - "description": "Operation metadata for Featurestore delete Features values.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "backingCustomJob": { + "description": "The resource name of the CustomJob that has been created to carry out this custom task.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeleteFeatureValuesResponse": { - "id": "GoogleCloudAiplatformV1DeleteFeatureValuesResponse", - "description": "Response message for FeaturestoreService.DeleteFeatureValues.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask": { + "description": "A TrainingJob that trains a custom code Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask", "properties": { - "selectEntity": { - "description": "Response for request specifying the entities to delete", - "$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity" + "inputs": { + "$ref": "GoogleCloudAiplatformV1CustomJobSpec", + "description": "The input parameters of this CustomTask." }, - "selectTimeRangeAndFeature": { - "description": "Response for request specifying time range and feature", - "$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature" + "metadata": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata", + "description": "The metadata information." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity": { - "id": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity", - "description": "Response message if the request uses the SelectEntity option.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig": { + "description": "Configuration for exporting test set predictions to a BigQuery table.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig", "properties": { - "offlineStorageDeletedEntityRowCount": { - "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", - "format": "int64" + "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" }, - "onlineStorageDeletedEntityCount": { - "description": "The count of deleted entities in the online storage. Each entity ID corresponds to one entity.", - "type": "string", - "format": "int64" + "overrideExistingTable": { + "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.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature": { - "id": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature", - "description": "Response message if the request uses the SelectTimeRangeAndFeature option.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig": { + "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig", "properties": { - "impactedFeatureCount": { - "description": "The count of the features or columns impacted. This is the same as the feature count in the request.", - "type": "string", - "format": "int64" + "groupColumns": { + "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.", + "items": { + "type": "string" + }, + "type": "array" }, - "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" + "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" }, - "onlineStorageModifiedEntityCount": { - "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", - "format": "int64" + "groupTotalWeight": { + "description": "The weight of the loss for predictions aggregated over time series in the same group.", + "format": "double", + "type": "number" + }, + "temporalTotalWeight": { + "description": "The weight of the loss for predictions aggregated over the horizon for a single time series.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeleteOperationMetadata": { - "id": "GoogleCloudAiplatformV1DeleteOperationMetadata", - "description": "Details of operations that perform deletes of any entities.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata", "properties": { - "genericMetadata": { - "description": "The common part of the operation metadata.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "backingHyperparameterTuningJob": { + "description": "The resource name of the HyperparameterTuningJob that has been created to carry out this HyperparameterTuning task.", + "type": "string" + }, + "bestTrialBackingCustomJob": { + "description": "The resource name of the CustomJob that has been created to run the best Trial of this HyperparameterTuning task.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata": { - "id": "GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata", - "description": "Details of operations that perform MetadataService.DeleteMetadataStore.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec", "properties": { - "genericMetadata": { - "description": "Operation metadata for deleting a MetadataStore.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "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": { + "description": "The desired total number of Trials.", + "format": "int32", + "type": "integer" + }, + "parallelTrialCount": { + "description": "The desired number of Trials to run in parallel.", + "format": "int32", + "type": "integer" + }, + "studySpec": { + "$ref": "GoogleCloudAiplatformV1StudySpec", + "description": "Study configuration of the HyperparameterTuningJob." + }, + "trialJobSpec": { + "$ref": "GoogleCloudAiplatformV1CustomJobSpec", + "description": "The spec of a trial job. The same spec applies to the CustomJobs created in all the trials." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployModelOperationMetadata": { - "id": "GoogleCloudAiplatformV1DeployModelOperationMetadata", - "description": "Runtime operation information for EndpointService.DeployModel.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask": { + "description": "A TrainingJob that tunes Hypererparameters of a custom code Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec", + "description": "The input parameters of this HyperparameterTuningTask." }, - "deploymentStage": { - "description": "Output only. The deployment stage of the model.", - "readOnly": true, - "type": "string", - "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" - ] + "metadata": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata", + "description": "The metadata information." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployModelResponse": { - "id": "GoogleCloudAiplatformV1DeployModelResponse", - "description": "Response message for EndpointService.DeployModel.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting": { + "description": "A TrainingJob that trains and uploads an AutoML Forecasting Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting", "properties": { - "deployedModel": { - "description": "The DeployedModel that had been deployed in the Endpoint.", - "$ref": "GoogleCloudAiplatformV1DeployedModel" + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs", + "description": "The input parameters of this TrainingJob." + }, + "metadata": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata", + "description": "The metadata information." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployIndexOperationMetadata": { - "id": "GoogleCloudAiplatformV1DeployIndexOperationMetadata", - "description": "Runtime operation information for IndexEndpointService.DeployIndex.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "additionalExperiments": { + "description": "Additional experiment flags for the time series forcasting training.", + "items": { + "type": "string" + }, + "type": "array" }, - "deployedIndexId": { - "description": "The unique index id specified by user", + "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" + }, + "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" + }, + "dataGranularity": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity", + "description": "Expected difference in time granularity between rows in the data." + }, + "exportEvaluatedDataItemsConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig", + "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed." + }, + "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" + }, + "hierarchyConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig", + "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies." + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "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" + }, + "quantiles": { + "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" + }, + "type": "array" + }, + "targetColumn": { + "description": "The name of the column that the Model is to predict values for. This column must be unavailable at forecast.", + "type": "string" + }, + "timeColumn": { + "description": "The name of the column that identifies time order in the time series. This column must be available 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" + }, + "timeSeriesIdentifierColumn": { + "description": "The name of the column that identifies the time series.", + "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" + }, + "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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation" + }, + "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" + }, + "validationOptions": { + "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", + "type": "string" + }, + "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" + }, + "windowConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig", + "description": "Config containing strategy for generating sliding windows." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployIndexResponse": { - "id": "GoogleCloudAiplatformV1DeployIndexResponse", - "description": "Response message for IndexEndpointService.DeployIndex.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity": { + "description": "A duration of time expressed in time granularity units.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity", "properties": { - "deployedIndex": { - "description": "The DeployedIndex that had been deployed in the IndexEndpoint.", - "$ref": "GoogleCloudAiplatformV1DeployedIndex" + "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" + }, + "unit": { + "description": "The time granularity unit of this time period. The supported units are: * \"minute\" * \"hour\" * \"day\" * \"week\" * \"month\" * \"year\"", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExportDataOperationMetadata": { - "id": "GoogleCloudAiplatformV1ExportDataOperationMetadata", - "description": "Runtime operation information for DatasetService.ExportData.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation", "properties": { - "genericMetadata": { - "description": "The common part of the operation metadata.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "auto": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation" }, - "gcsOutputDirectory": { - "description": "A Google Cloud Storage directory which path ends with '/'. The exported data is stored in the directory.", + "categorical": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation" + }, + "numeric": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation" + }, + "text": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation" + }, + "timestamp": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation": { + "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation", + "properties": { + "columnName": { "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExportDataResponse": { - "id": "GoogleCloudAiplatformV1ExportDataResponse", - "description": "Response message for DatasetService.ExportData.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation", "properties": { - "exportedFiles": { - "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-*).", - "type": "array", - "items": { - "type": "string" - } - }, - "dataStats": { - "description": "Only present for custom code training export use case. Records data stats, i.e., train/validation/test item/annotation counts calculated during the export operation.", - "$ref": "GoogleCloudAiplatformV1ModelDataStats" + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata": { - "id": "GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata", - "description": "Details of operations that exports Features values.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation", "properties": { - "genericMetadata": { - "description": "Operation metadata for Featurestore export Feature values.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExportFeatureValuesResponse": { - "id": "GoogleCloudAiplatformV1ExportFeatureValuesResponse", - "description": "Response message for FeaturestoreService.ExportFeatureValues.", - "type": "object", - "properties": {} + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation", + "properties": { + "columnName": { + "type": "string" + } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExportModelOperationMetadata": { - "id": "GoogleCloudAiplatformV1ExportModelOperationMetadata", - "description": "Details of ModelService.ExportModel operation.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation": { + "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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation", "properties": { - "genericMetadata": { - "description": "The common part of the operation metadata.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "type": "string" }, - "outputInfo": { - "description": "Output only. Information further describing the output of this Model export.", - "readOnly": true, - "$ref": "GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo": { - "id": "GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo", - "description": "Further describes the output of the ExportModel. Supplements ExportModelRequest.OutputConfig.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata": { + "description": "Model metadata specific to Seq2Seq Plus Forecasting.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata", "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.", - "readOnly": true, + "evaluatedDataItemsBigqueryUri": { + "description": "BigQuery destination uri for exported evaluated examples.", + "type": "string" + }, + "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" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting": { + "description": "A TrainingJob that trains and uploads an AutoML Forecasting Model.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting", + "properties": { + "inputs": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs", + "description": "The input parameters of this TrainingJob." }, - "imageOutputUri": { - "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.", - "readOnly": true, - "type": "string" + "metadata": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata", + "description": "The metadata information." } - } - }, - "GoogleCloudAiplatformV1ExportModelResponse": { - "id": "GoogleCloudAiplatformV1ExportModelResponse", - "description": "Response message of ModelService.ExportModel operation.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1GenerateVideoResponse": { - "id": "GoogleCloudAiplatformV1GenerateVideoResponse", - "description": "Generate video response.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs", "properties": { - "generatedSamples": { - "description": "The cloud storage uris of the generated videos.", - "deprecated": true, - "type": "array", + "additionalExperiments": { + "description": "Additional experiment flags for the time series forcasting training.", "items": { "type": "string" - } - }, - "raiMediaFilteredCount": { - "description": "Returns if any videos were filtered due to RAI policies.", - "type": "integer", - "format": "int32" + }, + "type": "array" }, - "raiMediaFilteredReasons": { - "description": "Returns rai failure reasons if any.", - "type": "array", + "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" }, - "videos": { - "description": "List of video bytes or Cloud Storage URIs of the generated videos.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1GenerateVideoResponseVideo" - } - } - } - }, - "GoogleCloudAiplatformV1GenerateVideoResponseVideo": { - "id": "GoogleCloudAiplatformV1GenerateVideoResponseVideo", - "description": "A generated video.", - "type": "object", - "properties": { - "gcsUri": { - "description": "Cloud Storage URI where the generated video is written.", + "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" }, - "bytesBase64Encoded": { - "description": "Base64 encoded bytes string representing the video.", + "dataGranularity": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity", + "description": "Expected difference in time granularity between rows in the data." + }, + "exportEvaluatedDataItemsConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig", + "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed." + }, + "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" }, - "mimeType": { - "description": "The MIME type of the content of the video. - video/mp4", + "hierarchyConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig", + "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies." + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "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" - } - } - }, - "GoogleCloudAiplatformV1ImportDataOperationMetadata": { - "id": "GoogleCloudAiplatformV1ImportDataOperationMetadata", - "description": "Runtime operation information for DatasetService.ImportData.", - "type": "object", - "properties": { - "genericMetadata": { - "description": "The common part of the operation metadata.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" - } - } - }, - "GoogleCloudAiplatformV1ImportDataResponse": { - "id": "GoogleCloudAiplatformV1ImportDataResponse", - "description": "Response message for DatasetService.ImportData.", - "type": "object", - "properties": {} - }, - "GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata": { - "id": "GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata", - "description": "Details of operations that perform import Feature values.", - "type": "object", - "properties": { - "genericMetadata": { - "description": "Operation metadata for Featurestore import Feature values.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" }, - "importedEntityCount": { - "description": "Number of entities that have been imported by the operation.", - "type": "string", - "format": "int64" + "quantiles": { + "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" + }, + "type": "array" }, - "importedFeatureValueCount": { - "description": "Number of Feature values that have been imported by the operation.", - "type": "string", - "format": "int64" + "targetColumn": { + "description": "The name of the column that the Model is to predict values for. This column must be unavailable at forecast.", + "type": "string" }, - "sourceUris": { - "description": "The source URI from where Feature values are imported.", - "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" + }, + "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" }, - "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).", - "type": "string", - "format": "int64" + "timeSeriesIdentifierColumn": { + "description": "The name of the column that identifies the time series.", + "type": "string" }, - "timestampOutsideRetentionRowsCount": { - "description": "The number rows that weren't ingested due to having timestamps outside the retention boundary.", - "type": "string", - "format": "int64" + "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" }, - "blockingOperationIds": { - "description": "List of ImportFeatureValues operations running under a single EntityType that are blocking this operation.", - "type": "array", + "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": { - "type": "string", - "format": "int64" - } - } - } - }, - "GoogleCloudAiplatformV1ImportFeatureValuesResponse": { - "id": "GoogleCloudAiplatformV1ImportFeatureValuesResponse", - "description": "Response message for FeaturestoreService.ImportFeatureValues.", - "type": "object", - "properties": { - "importedEntityCount": { - "description": "Number of entities that have been imported by the operation.", - "type": "string", - "format": "int64" + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation" + }, + "type": "array" }, - "importedFeatureValueCount": { - "description": "Number of Feature values that have been imported by the operation.", - "type": "string", - "format": "int64" + "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" }, - "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).", - "type": "string", - "format": "int64" + "validationOptions": { + "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", + "type": "string" }, - "timestampOutsideRetentionRowsCount": { - "description": "The number rows that weren't ingested due to having feature timestamps outside the retention boundary.", - "type": "string", - "format": "int64" + "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" + }, + "windowConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig", + "description": "Config containing strategy for generating sliding windows." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata": { - "id": "GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata", - "description": "Runtime operation information for IndexEndpointService.MutateDeployedIndex.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity": { + "description": "A duration of time expressed in time granularity units.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "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" }, - "deployedIndexId": { - "description": "The unique index id specified by user", + "unit": { + "description": "The time granularity unit of this time period. The supported units are: * \"minute\" * \"hour\" * \"day\" * \"week\" * \"month\" * \"year\"", "type": "string" } - } - }, - "GoogleCloudAiplatformV1MutateDeployedIndexResponse": { - "id": "GoogleCloudAiplatformV1MutateDeployedIndexResponse", - "description": "Response message for IndexEndpointService.MutateDeployedIndex.", - "type": "object", - "properties": { - "deployedIndex": { - "description": "The DeployedIndex that had been updated in the IndexEndpoint.", - "$ref": "GoogleCloudAiplatformV1DeployedIndex" - } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata": { - "id": "GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata", - "description": "Runtime operation information for EndpointService.MutateDeployedModel.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation": { + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "auto": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation" + }, + "categorical": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation" + }, + "numeric": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation" + }, + "text": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation" + }, + "timestamp": { + "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1MutateDeployedModelResponse": { - "id": "GoogleCloudAiplatformV1MutateDeployedModelResponse", - "description": "Response message for EndpointService.MutateDeployedModel.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation": { + "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation", "properties": { - "deployedModel": { - "description": "The DeployedModel that's being mutated.", - "$ref": "GoogleCloudAiplatformV1DeployedModel" + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PurgeArtifactsResponse": { - "id": "GoogleCloudAiplatformV1PurgeArtifactsResponse", - "description": "Response message for MetadataService.PurgeArtifacts.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation", "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.", - "type": "string", - "format": "int64" - }, - "purgeSample": { - "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).", - "type": "array", - "items": { - "type": "string" - } + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PurgeArtifactsMetadata": { - "id": "GoogleCloudAiplatformV1PurgeArtifactsMetadata", - "description": "Details of operations that perform MetadataService.PurgeArtifacts.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation", "properties": { - "genericMetadata": { - "description": "Operation metadata for purging Artifacts.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PurgeContextsMetadata": { - "id": "GoogleCloudAiplatformV1PurgeContextsMetadata", - "description": "Details of operations that perform MetadataService.PurgeContexts.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation", "properties": { - "genericMetadata": { - "description": "Operation metadata for purging Contexts.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "columnName": { + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PurgeContextsResponse": { - "id": "GoogleCloudAiplatformV1PurgeContextsResponse", - "description": "Response message for MetadataService.PurgeContexts.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation": { + "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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation", "properties": { - "purgeCount": { - "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.", - "type": "string", - "format": "int64" + "columnName": { + "type": "string" }, - "purgeSample": { - "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).", - "type": "array", - "items": { - "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1PurgeExecutionsResponse": { - "id": "GoogleCloudAiplatformV1PurgeExecutionsResponse", - "description": "Response message for MetadataService.PurgeExecutions.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata": { + "description": "Model metadata specific to TFT Forecasting.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata", "properties": { - "purgeCount": { - "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.", - "type": "string", - "format": "int64" + "evaluatedDataItemsBigqueryUri": { + "description": "BigQuery destination uri for exported evaluated examples.", + "type": "string" }, - "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).", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1PurgeExecutionsMetadata": { - "id": "GoogleCloudAiplatformV1PurgeExecutionsMetadata", - "description": "Details of operations that perform MetadataService.PurgeExecutions.", - "type": "object", - "properties": { - "genericMetadata": { - "description": "Operation metadata for purging Executions.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata": { - "id": "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata", - "description": "Details of operations that perform reboot PersistentResource.", - "type": "object", + "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig": { + "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.", + "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig", "properties": { - "genericMetadata": { - "description": "Operation metadata for PersistentResource.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "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" }, - "progressMessage": { - "description": "Progress Message for Reboot LRO", + "maxCount": { + "description": "Maximum number of windows that should be generated across all time series.", + "format": "int64", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata": { - "id": "GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata", - "description": "Metadata information for NotebookService.StartNotebookRuntime.", - "type": "object", - "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" }, - "progressMessage": { - "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SuggestTrialsMetadata": { - "id": "GoogleCloudAiplatformV1SuggestTrialsMetadata", - "description": "Details of operations that perform Trials suggestion.", - "type": "object", + "GoogleCloudAiplatformV1SchemaVertex": { + "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": "GoogleCloudAiplatformV1SchemaVertex", "properties": { - "genericMetadata": { - "description": "Operation metadata for suggesting Trials.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "x": { + "description": "X coordinate of the vertex, normalized to [0.0, 1.0].", + "format": "double", + "type": "number" }, - "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" + "y": { + "description": "Y coordinate of the vertex, normalized to [0.0, 1.0].", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SuggestTrialsResponse": { - "id": "GoogleCloudAiplatformV1SuggestTrialsResponse", - "description": "Response message for VizierService.SuggestTrials.", - "type": "object", + "GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation": { + "description": "Annotation details specific to video action recognition.", + "id": "GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation", "properties": { - "trials": { - "description": "A list of Trials.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Trial" - } - }, - "studyState": { - "description": "The state of the Study.", - "type": "string", - "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" - ] + "annotationSpecId": { + "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", + "type": "string" }, - "startTime": { - "description": "The time at which the operation was started.", - "type": "string", - "format": "google-datetime" + "displayName": { + "description": "The display name of the AnnotationSpec that this Annotation pertains to.", + "type": "string" }, - "endTime": { - "description": "The time at which operation processing completed.", - "type": "string", - "format": "google-datetime" + "timeSegment": { + "$ref": "GoogleCloudAiplatformV1SchemaTimeSegment", + "description": "This Annotation applies to the time period represented by the TimeSegment. If it's not set, the Annotation applies to the whole video." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UndeployModelOperationMetadata": { - "id": "GoogleCloudAiplatformV1UndeployModelOperationMetadata", - "description": "Runtime operation information for EndpointService.UndeployModel.", - "type": "object", + "GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation": { + "description": "Annotation details specific to video classification.", + "id": "GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "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" + }, + "timeSegment": { + "$ref": "GoogleCloudAiplatformV1SchemaTimeSegment", + "description": "This Annotation applies to the time period represented by the TimeSegment. If it's not set, the Annotation applies to the whole video." } - } - }, - "GoogleCloudAiplatformV1UndeployModelResponse": { - "id": "GoogleCloudAiplatformV1UndeployModelResponse", - "description": "Response message for EndpointService.UndeployModel.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1UndeployIndexOperationMetadata": { - "id": "GoogleCloudAiplatformV1UndeployIndexOperationMetadata", - "description": "Runtime operation information for IndexEndpointService.UndeployIndex.", - "type": "object", + "GoogleCloudAiplatformV1SchemaVideoDataItem": { + "description": "Payload of Video DataItem.", + "id": "GoogleCloudAiplatformV1SchemaVideoDataItem", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "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" + }, + "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" } - } - }, - "GoogleCloudAiplatformV1UndeployIndexResponse": { - "id": "GoogleCloudAiplatformV1UndeployIndexResponse", - "description": "Response message for IndexEndpointService.UndeployIndex.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata", - "description": "Runtime operation information for UpdateDeploymentResourcePool method.", - "type": "object", + "GoogleCloudAiplatformV1SchemaVideoDatasetMetadata": { + "description": "The metadata of Datasets that contain Video DataItems.", + "id": "GoogleCloudAiplatformV1SchemaVideoDatasetMetadata", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "dataItemSchemaUri": { + "description": "Points to a YAML file stored on Google Cloud Storage describing payload of the Video DataItems that belong to this Dataset.", + "type": "string" + }, + "gcsBucket": { + "description": "Google Cloud Storage Bucket name that contains the blob data of this Dataset.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata", - "description": "Runtime operation information for ModelService.UpdateExplanationDataset.", - "type": "object", + "GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation": { + "description": "Annotation details specific to video object tracking.", + "id": "GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation", "properties": { - "genericMetadata": { - "description": "The common part of the operation metadata.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "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" + }, + "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": { + "description": "A time (frame) of a video to which this annotation pertains. Represented as the duration since the video's start.", + "format": "google-duration", + "type": "string" + }, + "xMax": { + "description": "The rightmost coordinate of the bounding box.", + "format": "double", + "type": "number" + }, + "xMin": { + "description": "The leftmost coordinate of the bounding box.", + "format": "double", + "type": "number" + }, + "yMax": { + "description": "The bottommost coordinate of the bounding box.", + "format": "double", + "type": "number" + }, + "yMin": { + "description": "The topmost coordinate of the bounding box.", + "format": "double", + "type": "number" } - } - }, - "GoogleCloudAiplatformV1UpdateExplanationDatasetResponse": { - "id": "GoogleCloudAiplatformV1UpdateExplanationDatasetResponse", - "description": "Response message of ModelService.UpdateExplanationDataset operation.", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata", - "description": "Runtime operation information for JobService.UpdateModelDeploymentMonitoringJob.", - "type": "object", + "GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata": { + "id": "GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "multiLabel": { + "description": "Whether or not the classification label is multi_label.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata", - "description": "Details of operations that perform update FeatureGroup.", - "type": "object", - "properties": { - "genericMetadata": { - "description": "Operation metadata for FeatureGroup.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" - } - } + "GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata": { + "id": "GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateFeatureOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdateFeatureOperationMetadata", - "description": "Details of operations that perform update Feature.", - "type": "object", + "GoogleCloudAiplatformV1SearchDataItemsResponse": { + "description": "Response message for DatasetService.SearchDataItems.", + "id": "GoogleCloudAiplatformV1SearchDataItemsResponse", "properties": { - "genericMetadata": { - "description": "Operation metadata for Feature Update.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "dataItemViews": { + "description": "The DataItemViews read.", + "items": { + "$ref": "GoogleCloudAiplatformV1DataItemView" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to SearchDataItemsRequest.page_token to obtain that page.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata", - "description": "Details of operations that perform update Featurestore.", - "type": "object", + "GoogleCloudAiplatformV1SearchEntryPoint": { + "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": "GoogleCloudAiplatformV1SearchEntryPoint", "properties": { - "genericMetadata": { - "description": "Operation metadata for Featurestore.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "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.", + "format": "byte", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata", - "description": "Details of operations that perform update PersistentResource.", - "type": "object", + "GoogleCloudAiplatformV1SearchFeaturesResponse": { + "description": "Response message for FeaturestoreService.SearchFeatures.", + "id": "GoogleCloudAiplatformV1SearchFeaturesResponse", "properties": { - "genericMetadata": { - "description": "Operation metadata for PersistentResource.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "features": { + "description": "The Features matching the request. Fields returned: * `name` * `description` * `labels` * `create_time` * `update_time`", + "items": { + "$ref": "GoogleCloudAiplatformV1Feature" + }, + "type": "array" }, - "progressMessage": { - "description": "Progress Message for Update LRO", + "nextPageToken": { + "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.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata", - "description": "Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool.", - "type": "object", + "GoogleCloudAiplatformV1SearchMigratableResourcesRequest": { + "description": "Request message for MigrationService.SearchMigratableResources.", + "id": "GoogleCloudAiplatformV1SearchMigratableResourcesRequest", "properties": { - "specialistPool": { - "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}`", - "readOnly": true, + "filter": { + "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.", "type": "string" }, - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "pageSize": { + "description": "The standard page size. The default and maximum value is 100.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "The standard page token.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata", - "description": "Details of operations that perform update Tensorboard.", - "type": "object", + "GoogleCloudAiplatformV1SearchMigratableResourcesResponse": { + "description": "Response message for MigrationService.SearchMigratableResources.", + "id": "GoogleCloudAiplatformV1SearchMigratableResourcesResponse", "properties": { - "genericMetadata": { - "description": "Operation metadata for Tensorboard.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "migratableResources": { + "description": "All migratable resources that can be migrated to the location specified in the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1MigratableResource" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard next-page token. The migratable_resources may not fill page_size in SearchMigratableResourcesRequest even when there are subsequent pages.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpdateIndexOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpdateIndexOperationMetadata", - "description": "Runtime operation information for IndexService.UpdateIndex.", - "type": "object", + "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest": { + "description": "Request message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.", + "id": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "deployedModelId": { + "description": "Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].", + "type": "string" }, - "nearestNeighborSearchOperationMetadata": { - "description": "The operation metadata with regard to Matching Engine Index operation.", - "$ref": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata" + "endTime": { + "description": "The latest timestamp of stats being generated. If not set, indicates feching stats till the latest possible one.", + "format": "google-datetime", + "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" + }, + "objectives": { + "description": "Required. Objectives of the stats to retrieve.", + "items": { + "$ref": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective" + }, + "type": "array" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from a previous JobService.SearchModelDeploymentMonitoringStatsAnomalies call.", + "type": "string" + }, + "startTime": { + "description": "The earliest timestamp of stats being generated. If not set, indicates fetching stats till the earliest possible one.", + "format": "google-datetime", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata": { - "id": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata", - "description": "Metadata information for NotebookService.UpgradeNotebookRuntime.", - "type": "object", + "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective": { + "description": "Stats requested for specific objective.", + "id": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "topFeatureCount": { + "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": "integer" }, - "progressMessage": { - "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", + "type": { + "enum": [ + "MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED", + "RAW_FEATURE_SKEW", + "RAW_FEATURE_DRIFT", + "FEATURE_ATTRIBUTION_SKEW", + "FEATURE_ATTRIBUTION_DRIFT" + ], + "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." + ], "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UploadModelOperationMetadata": { - "id": "GoogleCloudAiplatformV1UploadModelOperationMetadata", - "description": "Details of ModelService.UploadModel operation.", - "type": "object", + "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse": { + "description": "Response message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.", + "id": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse", "properties": { - "genericMetadata": { - "description": "The common part of the operation metadata.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "monitoringStats": { + "description": "Stats retrieved for requested objectives. There are at most 1000 ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats in the response.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The page token that can be used by the next JobService.SearchModelDeploymentMonitoringStatsAnomalies call.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1UploadModelResponse": { - "id": "GoogleCloudAiplatformV1UploadModelResponse", - "description": "Response message of ModelService.UploadModel operation.", - "type": "object", + "GoogleCloudAiplatformV1SearchNearestEntitiesRequest": { + "description": "The request message for FeatureOnlineStoreService.SearchNearestEntities.", + "id": "GoogleCloudAiplatformV1SearchNearestEntitiesRequest", "properties": { - "model": { - "description": "The name of the uploaded Model resource. Format: `projects/{project}/locations/{location}/models/{model}`", - "type": "string" + "query": { + "$ref": "GoogleCloudAiplatformV1NearestNeighborQuery", + "description": "Required. The query." }, - "modelVersionId": { - "description": "Output only. The version ID of the model that is uploaded.", - "readOnly": true, - "type": "string" + "returnFullEntity": { + "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.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CopyModelOperationMetadata": { - "id": "GoogleCloudAiplatformV1CopyModelOperationMetadata", - "description": "Details of ModelService.CopyModel operation.", - "type": "object", + "GoogleCloudAiplatformV1SearchNearestEntitiesResponse": { + "description": "Response message for FeatureOnlineStoreService.SearchNearestEntities", + "id": "GoogleCloudAiplatformV1SearchNearestEntitiesResponse", "properties": { - "genericMetadata": { - "description": "The common part of the operation metadata.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "nearestNeighbors": { + "$ref": "GoogleCloudAiplatformV1NearestNeighbors", + "description": "The nearest neighbors of the query entity." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1CopyModelResponse": { - "id": "GoogleCloudAiplatformV1CopyModelResponse", - "description": "Response message of ModelService.CopyModel operation.", - "type": "object", + "GoogleCloudAiplatformV1SecretEnvVar": { + "description": "Represents an environment variable where the value is a secret in Cloud Secret Manager.", + "id": "GoogleCloudAiplatformV1SecretEnvVar", "properties": { - "model": { - "description": "The name of the copied Model resource. Format: `projects/{project}/locations/{location}/models/{model}`", + "name": { + "description": "Required. Name of the secret environment variable.", "type": "string" }, - "modelVersionId": { - "description": "Output only. The version ID of the model that is copied.", - "readOnly": true, - "type": "string" + "secretRef": { + "$ref": "GoogleCloudAiplatformV1SecretRef", + "description": "Required. Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics", - "description": "Bounding box matching model metrics for a single intersection-over-union threshold and multiple label match confidence thresholds.", - "type": "object", + "GoogleCloudAiplatformV1SecretRef": { + "description": "Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.", + "id": "GoogleCloudAiplatformV1SecretRef", "properties": { - "iouThreshold": { - "description": "The intersection-over-union threshold value used to compute this metrics entry.", - "type": "number", - "format": "float" - }, - "meanAveragePrecision": { - "description": "The mean average precision, most often close to `auPrc`.", - "type": "number", - "format": "float" + "secret": { + "description": "Required. The name of the secret in Cloud Secret Manager. Format: {secret_name}.", + "type": "string" }, - "confidenceMetrics": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics" - } + "version": { + "description": "The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics", - "description": "Metrics for a single confidence threshold.", - "type": "object", + "GoogleCloudAiplatformV1Segment": { + "description": "A segment of the content.", + "id": "GoogleCloudAiplatformV1Segment", "properties": { - "confidenceThreshold": { - "description": "The confidence threshold value used to compute the metrics.", - "type": "number", - "format": "float" + "endIndex": { + "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", + "readOnly": true, + "type": "integer" }, - "recall": { - "description": "Recall under the given confidence threshold.", - "type": "number", - "format": "float" + "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", + "readOnly": true, + "type": "integer" }, - "precision": { - "description": "Precision under the given confidence threshold.", - "type": "number", - "format": "float" + "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.", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "f1Score": { - "description": "The harmonic mean of recall and precision.", - "type": "number", - "format": "float" + "text": { + "description": "Output only. The text of the segment.", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics", - "description": "Metrics for classification evaluation results.", - "type": "object", + "GoogleCloudAiplatformV1ServiceAccountSpec": { + "description": "Configuration for the use of custom service account to run the workloads.", + "id": "GoogleCloudAiplatformV1ServiceAccountSpec", "properties": { - "auPrc": { - "description": "The Area Under Precision-Recall Curve metric. Micro-averaged for the overall evaluation.", - "type": "number", - "format": "float" - }, - "auRoc": { - "description": "The Area Under Receiver Operating Characteristic curve metric. Micro-averaged for the overall evaluation.", - "type": "number", - "format": "float" - }, - "logLoss": { - "description": "The Log Loss metric.", - "type": "number", - "format": "float" - }, - "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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics" - } + "enableCustomServiceAccount": { + "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": "boolean" }, - "confusionMatrix": { - "description": "Confusion matrix of the evaluation.", - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics", - "type": "object", + "GoogleCloudAiplatformV1Session": { + "description": "A session contains a set of actions between users and Vertex agents.", + "id": "GoogleCloudAiplatformV1Session", "properties": { - "confidenceThreshold": { - "description": "Metrics are computed with an assumption that the Model never returns predictions with score lower than this value.", - "type": "number", - "format": "float" + "createTime": { + "description": "Output only. Timestamp when the session was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "maxPredictions": { - "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", - "format": "int32" + "displayName": { + "description": "Optional. The display name of the session.", + "type": "string" }, - "recall": { - "description": "Recall (True Positive Rate) for the given confidence threshold.", - "type": "number", - "format": "float" + "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.", + "format": "google-datetime", + "type": "string" }, - "precision": { - "description": "Precision for the given confidence threshold.", - "type": "number", - "format": "float" + "labels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" }, - "falsePositiveRate": { - "description": "False Positive Rate for the given confidence threshold.", - "type": "number", - "format": "float" + "name": { + "description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", + "type": "string" }, - "f1Score": { - "description": "The harmonic mean of recall and precision. For summary metrics, it computes the micro-averaged F1 score.", - "type": "number", - "format": "float" + "sessionState": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Session specific memory which stores key conversation points.", + "type": "object" }, - "f1ScoreMicro": { - "description": "Micro-averaged F1 Score.", - "type": "number", - "format": "float" + "ttl": { + "description": "Optional. Input only. The TTL for this session. The minimum value is 24 hours.", + "format": "google-duration", + "type": "string" }, - "f1ScoreMacro": { - "description": "Macro-averaged F1 Score.", - "type": "number", - "format": "float" + "updateTime": { + "description": "Output only. Timestamp when the session was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "recallAt1": { - "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.", - "type": "number", - "format": "float" + "userId": { + "description": "Required. Immutable. String id provided by the user", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SessionEvent": { + "description": "An event represents a message from either the user or agent.", + "id": "GoogleCloudAiplatformV1SessionEvent", + "properties": { + "actions": { + "$ref": "GoogleCloudAiplatformV1EventActions", + "description": "Optional. Actions executed by the agent." }, - "precisionAt1": { - "description": "The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each DataItem.", - "type": "number", - "format": "float" + "author": { + "description": "Required. The name of the agent that sent the event, or user.", + "type": "string" }, - "falsePositiveRateAt1": { - "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.", - "type": "number", - "format": "float" + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Optional. Content of the event provided by the author." }, - "f1ScoreAt1": { - "description": "The harmonic mean of recallAt1 and precisionAt1.", - "type": "number", - "format": "float" + "errorCode": { + "description": "Optional. Error code if the response is an error. Code varies by model.", + "type": "string" }, - "truePositiveCount": { - "description": "The number of Model created labels that match a ground truth label.", - "type": "string", - "format": "int64" + "errorMessage": { + "description": "Optional. Error message if the response is an error.", + "type": "string" }, - "falsePositiveCount": { - "description": "The number of Model created labels that do not match a ground truth label.", - "type": "string", - "format": "int64" + "eventMetadata": { + "$ref": "GoogleCloudAiplatformV1EventMetadata", + "description": "Optional. Metadata relating to this event." }, - "falseNegativeCount": { - "description": "The number of ground truth labels that are not matched by a Model created label.", - "type": "string", - "format": "int64" + "invocationId": { + "description": "Required. The invocation id of the event, multiple events can have the same invocation id.", + "type": "string" }, - "trueNegativeCount": { - "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", - "format": "int64" + "name": { + "description": "Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`.", + "type": "string" }, - "confusionMatrix": { - "description": "Confusion matrix of the evaluation for this confidence_threshold.", - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix" + "rawEvent": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Weakly typed raw event data in proto struct format.", + "type": "object" + }, + "timestamp": { + "description": "Required. Timestamp when the event was created on client side.", + "format": "google-datetime", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix", - "type": "object", + "GoogleCloudAiplatformV1SharePointSources": { + "description": "The SharePointSources to pass to ImportRagFiles.", + "id": "GoogleCloudAiplatformV1SharePointSources", "properties": { - "annotationSpecs": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef" - } - }, - "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", + "sharePointSources": { + "description": "The SharePoint sources.", "items": { - "type": "array", - "items": { - "type": "any" - } - } + "$ref": "GoogleCloudAiplatformV1SharePointSourcesSharePointSource" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef", - "type": "object", + "GoogleCloudAiplatformV1SharePointSourcesSharePointSource": { + "description": "An individual SharePointSource.", + "id": "GoogleCloudAiplatformV1SharePointSourcesSharePointSource", "properties": { - "id": { - "description": "ID of the AnnotationSpec.", + "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" }, - "displayName": { - "description": "Display name of the AnnotationSpec.", - "type": "string" - } - } - }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics", - "description": "Metrics for forecasting evaluation results.", - "type": "object", - "properties": { - "rootMeanSquaredError": { - "description": "Root Mean Squared Error (RMSE).", - "type": "number", - "format": "float" + "clientSecret": { + "$ref": "GoogleCloudAiplatformV1ApiAuthApiKeyConfig", + "description": "The application secret for the app registered in Azure." }, - "meanAbsoluteError": { - "description": "Mean Absolute Error (MAE).", - "type": "number", - "format": "float" + "driveId": { + "description": "The ID of the drive to download from.", + "type": "string" }, - "meanAbsolutePercentageError": { - "description": "Mean absolute percentage error. Infinity when there are zeros in the ground truth.", - "type": "number", - "format": "float" + "driveName": { + "description": "The name of the drive to download from.", + "type": "string" }, - "rSquared": { - "description": "Coefficient of determination as Pearson correlation coefficient. Undefined when ground truth or predictions are constant or near constant.", - "type": "number", - "format": "float" + "fileId": { + "description": "Output only. The SharePoint file id. Output only.", + "readOnly": true, + "type": "string" }, - "rootMeanSquaredLogError": { - "description": "Root mean squared log error. Undefined when there are negative ground truth values or predictions.", - "type": "number", - "format": "float" + "sharepointFolderId": { + "description": "The ID of the SharePoint folder to download from.", + "type": "string" }, - "quantileMetrics": { - "description": "The quantile metrics entries for each quantile.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry" - } + "sharepointFolderPath": { + "description": "The path of the SharePoint folder to download from.", + "type": "string" }, - "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" + "sharepointSiteName": { + "description": "The name of the SharePoint site to download from. This can be the site name or the site id.", + "type": "string" }, - "rootMeanSquaredPercentageError": { - "description": "Root Mean Square Percentage Error. Square root of MSPE. Undefined/imaginary when MSPE is negative.", - "type": "number", - "format": "float" + "tenantId": { + "description": "Unique identifier of the Azure Active Directory Instance.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry", - "description": "Entry for the Quantiles loss type optimization objective.", - "type": "object", + "GoogleCloudAiplatformV1ShieldedVmConfig": { + "description": "A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).", + "id": "GoogleCloudAiplatformV1ShieldedVmConfig", "properties": { - "quantile": { - "description": "The quantile for this entry.", - "type": "number", - "format": "double" - }, - "scaledPinballLoss": { - "description": "The scaled pinball loss of this quantile.", - "type": "number", - "format": "float" + "enableSecureBoot": { + "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": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SlackSource": { + "description": "The Slack source for the ImportRagFilesRequest.", + "id": "GoogleCloudAiplatformV1SlackSource", + "properties": { + "channels": { + "description": "Required. The Slack channels.", + "items": { + "$ref": "GoogleCloudAiplatformV1SlackSourceSlackChannels" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SlackSourceSlackChannels": { + "description": "SlackChannels contains the Slack channels and corresponding access token.", + "id": "GoogleCloudAiplatformV1SlackSourceSlackChannels", + "properties": { + "apiKeyConfig": { + "$ref": "GoogleCloudAiplatformV1ApiAuthApiKeyConfig", + "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." }, - "observedQuantile": { - "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.", - "type": "number", - "format": "double" + "channels": { + "description": "Required. The Slack channel IDs.", + "items": { + "$ref": "GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics", - "type": "object", + "GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel": { + "description": "SlackChannel contains the Slack channel ID and the time range to import.", + "id": "GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel", "properties": { - "bleu": { - "description": "BLEU (bilingual evaluation understudy) scores based on sacrebleu implementation.", - "type": "number", - "format": "float" + "channelId": { + "description": "Required. The Slack channel ID.", + "type": "string" }, - "rougeLSum": { - "description": "ROUGE-L (Longest Common Subsequence) scoring at summary level.", - "type": "number", - "format": "float" + "endTime": { + "description": "Optional. The ending timestamp for messages to import.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Optional. The starting timestamp for messages to import.", + "format": "google-datetime", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics", - "description": "Metrics for image object detection evaluation results.", - "type": "object", + "GoogleCloudAiplatformV1SmoothGradConfig": { + "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", + "id": "GoogleCloudAiplatformV1SmoothGradConfig", "properties": { - "evaluatedBoundingBoxCount": { - "description": "The total number of bounding boxes (i.e. summed over all images) the ground truth used to create this evaluation had.", - "type": "integer", - "format": "int32" + "featureNoiseSigma": { + "$ref": "GoogleCloudAiplatformV1FeatureNoiseSigma", + "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." }, - "boundingBoxMetrics": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics" - } + "noiseSigma": { + "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.", + "format": "float", + "type": "number" }, - "boundingBoxMeanAveragePrecision": { - "description": "The single metric for bounding boxes evaluation: the `meanAveragePrecision` averaged over all `boundingBoxMetricsEntries`.", - "type": "number", - "format": "float" + "noisySampleCount": { + "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.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics", - "description": "Metrics for image segmentation evaluation results.", - "type": "object", + "GoogleCloudAiplatformV1SpeakerVoiceConfig": { + "description": "Configuration for a single speaker in a multi-speaker setup.", + "id": "GoogleCloudAiplatformV1SpeakerVoiceConfig", "properties": { - "confidenceMetricsEntries": { - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry" - } + "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": "GoogleCloudAiplatformV1VoiceConfig", + "description": "Required. The configuration for the voice of this speaker." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry", - "type": "object", + "GoogleCloudAiplatformV1SpecialistPool": { + "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.", + "id": "GoogleCloudAiplatformV1SpecialistPool", "properties": { - "confidenceThreshold": { - "description": "Metrics are computed with an assumption that the model never returns predictions with score lower than this value.", - "type": "number", - "format": "float" + "displayName": { + "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.", + "type": "string" }, - "recall": { - "description": "Recall (True Positive Rate) for the given confidence threshold.", - "type": "number", - "format": "float" + "name": { + "description": "Required. The resource name of the SpecialistPool.", + "type": "string" }, - "precision": { - "description": "Precision for the given confidence threshold.", - "type": "number", - "format": "float" + "pendingDataLabelingJobs": { + "description": "Output only. The resource name of the pending data labeling jobs.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" }, - "diceScoreCoefficient": { - "description": "DSC or the F1 score, The harmonic mean of recall and precision.", - "type": "number", - "format": "float" + "specialistManagerEmails": { + "description": "The email addresses of the managers in the SpecialistPool.", + "items": { + "type": "string" + }, + "type": "array" }, - "iouScore": { - "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", - "format": "float" + "specialistManagersCount": { + "description": "Output only. The number of managers in this SpecialistPool.", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "confusionMatrix": { - "description": "Confusion matrix for the given confidence threshold.", - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix" - } - } - }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics", - "type": "object", - "properties": { - "exactMatch": { - "description": "The rate at which the input predicted strings exactly match their references.", - "type": "number", - "format": "float" + "specialistWorkerEmails": { + "description": "The email addresses of workers in the SpecialistPool.", + "items": { + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics", - "description": "Metrics for regression evaluation results.", - "type": "object", + "GoogleCloudAiplatformV1SpeculativeDecodingSpec": { + "description": "Configuration for Speculative Decoding.", + "id": "GoogleCloudAiplatformV1SpeculativeDecodingSpec", "properties": { - "rootMeanSquaredError": { - "description": "Root Mean Squared Error (RMSE).", - "type": "number", - "format": "float" - }, - "meanAbsoluteError": { - "description": "Mean Absolute Error (MAE).", - "type": "number", - "format": "float" - }, - "meanAbsolutePercentageError": { - "description": "Mean absolute percentage error. Infinity when there are zeros in the ground truth.", - "type": "number", - "format": "float" + "draftModelSpeculation": { + "$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation", + "description": "draft model speculation." }, - "rSquared": { - "description": "Coefficient of determination as Pearson correlation coefficient. Undefined when ground truth or predictions are constant or near constant.", - "type": "number", - "format": "float" + "ngramSpeculation": { + "$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation", + "description": "N-Gram speculation." }, - "rootMeanSquaredLogError": { - "description": "Root mean squared log error. Undefined when there are negative ground truth values or predictions.", - "type": "number", - "format": "float" + "speculativeTokenCount": { + "description": "The number of speculative tokens to generate at each step.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics", - "type": "object", + "GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation": { + "description": "Draft model speculation works by using the smaller model to generate candidate tokens for speculative decoding.", + "id": "GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation", "properties": { - "rougeLSum": { - "description": "ROUGE-L (Longest Common Subsequence) scoring at summary level.", - "type": "number", - "format": "float" + "draftModel": { + "description": "Required. The resource name of the draft model.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics", - "description": "Metrics for text extraction evaluation results.", - "type": "object", + "GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation": { + "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.", + "id": "GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation", "properties": { - "confidenceMetrics": { - "description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from them.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics" - } - }, - "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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix" + "ngramSize": { + "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", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics", - "type": "object", + "GoogleCloudAiplatformV1SpeechConfig": { + "description": "Configuration for speech generation.", + "id": "GoogleCloudAiplatformV1SpeechConfig", "properties": { - "confidenceThreshold": { - "description": "Metrics are computed with an assumption that the Model never returns predictions with score lower than this value.", - "type": "number", - "format": "float" - }, - "recall": { - "description": "Recall (True Positive Rate) for the given confidence threshold.", - "type": "number", - "format": "float" + "languageCode": { + "description": "Optional. The language code (ISO 639-1) for the speech synthesis.", + "type": "string" }, - "precision": { - "description": "Precision for the given confidence threshold.", - "type": "number", - "format": "float" + "multiSpeakerVoiceConfig": { + "$ref": "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig", + "description": "The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`." }, - "f1Score": { - "description": "The harmonic mean of recall and precision.", - "type": "number", - "format": "float" + "voiceConfig": { + "$ref": "GoogleCloudAiplatformV1VoiceConfig", + "description": "The configuration for the voice to use." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics", - "description": "Model evaluation metrics for text sentiment problems.", - "type": "object", + "GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata": { + "description": "Metadata information for NotebookService.StartNotebookRuntime.", + "id": "GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata", "properties": { - "precision": { - "description": "Precision.", - "type": "number", - "format": "float" - }, - "recall": { - "description": "Recall.", - "type": "number", - "format": "float" - }, - "f1Score": { - "description": "The harmonic mean of recall and precision.", - "type": "number", - "format": "float" - }, - "meanAbsoluteError": { - "description": "Mean absolute error. Only set for ModelEvaluations, not for ModelEvaluationSlices.", - "type": "number", - "format": "float" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." }, - "meanSquaredError": { - "description": "Mean squared error. Only set for ModelEvaluations, not for ModelEvaluationSlices.", - "type": "number", - "format": "float" + "progressMessage": { + "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1StartNotebookRuntimeRequest": { + "description": "Request message for NotebookService.StartNotebookRuntime.", + "id": "GoogleCloudAiplatformV1StartNotebookRuntimeRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1StopNotebookRuntimeRequest": { + "description": "Request message for NotebookService.StopNotebookRuntime.", + "id": "GoogleCloudAiplatformV1StopNotebookRuntimeRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1StopTrialRequest": { + "description": "Request message for VizierService.StopTrial.", + "id": "GoogleCloudAiplatformV1StopTrialRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1StratifiedSplit": { + "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.", + "id": "GoogleCloudAiplatformV1StratifiedSplit", + "properties": { + "key": { + "description": "Required. The key is a name of one of the Dataset's data columns. The key provided must be for a categorical column.", + "type": "string" }, - "linearKappa": { - "description": "Linear weighted kappa. Only set for ModelEvaluations, not for ModelEvaluationSlices.", - "type": "number", - "format": "float" + "testFraction": { + "description": "The fraction of the input data that is to be used to evaluate the Model.", + "format": "double", + "type": "number" }, - "quadraticKappa": { - "description": "Quadratic weighted kappa. Only set for ModelEvaluations, not for ModelEvaluationSlices.", - "type": "number", - "format": "float" + "trainingFraction": { + "description": "The fraction of the input data that is to be used to train the Model.", + "format": "double", + "type": "number" }, - "confusionMatrix": { - "description": "Confusion matrix of the evaluation. Only set for ModelEvaluations, not for ModelEvaluationSlices.", - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix" + "validationFraction": { + "description": "The fraction of the input data that is to be used to validate the Model.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics", - "description": "Model evaluation metrics for video action recognition.", - "type": "object", + "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest": { + "description": "Request message for ReasoningEngineExecutionService.StreamQuery.", + "id": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest", "properties": { - "evaluatedActionCount": { - "description": "The number of ground truth actions used to create this evaluation.", - "type": "integer", - "format": "int32" + "classMethod": { + "description": "Optional. Class method to be used for the stream query. It is optional and defaults to \"stream_query\" if unspecified.", + "type": "string" }, - "videoActionMetrics": { - "description": "The metric entries for precision window lengths: 1s,2s,3s.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics" - } + "input": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics", - "description": "The Evaluation metrics given a specific precision_window_length.", - "type": "object", + "GoogleCloudAiplatformV1StreamRawPredictRequest": { + "description": "Request message for PredictionService.StreamRawPredict.", + "id": "GoogleCloudAiplatformV1StreamRawPredictRequest", "properties": { - "precisionWindowLength": { - "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.", - "type": "string", - "format": "google-duration" - }, - "meanAveragePrecision": { - "description": "The mean average precision.", - "type": "number", - "format": "float" - }, - "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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics" - } + "httpBody": { + "$ref": "GoogleApiHttpBody", + "description": "The prediction input. Supports HTTP headers and arbitrary data payload." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics", - "description": "Metrics for a single confidence threshold.", - "type": "object", + "GoogleCloudAiplatformV1StreamingPredictRequest": { + "description": "Request message for PredictionService.StreamingPredict. The first message must contain endpoint field and optionally input. The subsequent messages must contain input.", + "id": "GoogleCloudAiplatformV1StreamingPredictRequest", "properties": { - "confidenceThreshold": { - "description": "Output only. The confidence threshold value used to compute the metrics.", - "type": "number", - "format": "float" - }, - "recall": { - "description": "Output only. Recall for the given confidence threshold.", - "type": "number", - "format": "float" - }, - "precision": { - "description": "Output only. Precision for the given confidence threshold.", - "type": "number", - "format": "float" + "inputs": { + "description": "The prediction input.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tensor" + }, + "type": "array" }, - "f1Score": { - "description": "Output only. The harmonic mean of recall and precision.", - "type": "number", - "format": "float" + "parameters": { + "$ref": "GoogleCloudAiplatformV1Tensor", + "description": "The parameters that govern the prediction." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics", - "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).", - "type": "object", + "GoogleCloudAiplatformV1StreamingPredictResponse": { + "description": "Response message for PredictionService.StreamingPredict.", + "id": "GoogleCloudAiplatformV1StreamingPredictResponse", "properties": { - "evaluatedFrameCount": { - "description": "UNIMPLEMENTED. The number of video frames used to create this evaluation.", - "type": "integer", - "format": "int32" - }, - "evaluatedBoundingBoxCount": { - "description": "UNIMPLEMENTED. The total number of bounding boxes (i.e. summed over all frames) the ground truth used to create this evaluation had.", - "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.", - "type": "integer", - "format": "int32" - }, - "boundingBoxMetrics": { - "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.", - "type": "array", + "outputs": { + "description": "The prediction output.", "items": { - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics" - } + "$ref": "GoogleCloudAiplatformV1Tensor" + }, + "type": "array" }, - "trackMetrics": { - "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", + "parameters": { + "$ref": "GoogleCloudAiplatformV1Tensor", + "description": "The parameters that govern the prediction." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest": { + "description": "Request message for FeaturestoreOnlineServingService.StreamingReadFeatureValues.", + "id": "GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest", + "properties": { + "entityIds": { + "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`.", "items": { - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics" - } - }, - "boundingBoxMeanAveragePrecision": { - "description": "The single metric for bounding boxes evaluation: the `meanAveragePrecision` averaged over all `boundingBoxMetrics`.", - "type": "number", - "format": "float" - }, - "trackMeanAveragePrecision": { - "description": "UNIMPLEMENTED. The single metric for tracks accuracy evaluation: the `meanAveragePrecision` averaged over all `trackMetrics`.", - "type": "number", - "format": "float" - }, - "trackMeanBoundingBoxIou": { - "description": "UNIMPLEMENTED. The single metric for tracks bounding box iou evaluation: the `meanBoundingBoxIou` averaged over all `trackMetrics`.", - "type": "number", - "format": "float" + "type": "string" + }, + "type": "array" }, - "trackMeanMismatchRate": { - "description": "UNIMPLEMENTED. The single metric for tracking consistency evaluation: the `meanMismatchRate` averaged over all `trackMetrics`.", - "type": "number", - "format": "float" + "featureSelector": { + "$ref": "GoogleCloudAiplatformV1FeatureSelector", + "description": "Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics", - "description": "UNIMPLEMENTED. Track matching model metrics for a single track match threshold and multiple label match confidence thresholds.", - "type": "object", + "GoogleCloudAiplatformV1StringArray": { + "description": "A list of string values.", + "id": "GoogleCloudAiplatformV1StringArray", "properties": { - "iouThreshold": { - "description": "The intersection-over-union threshold value between bounding boxes across frames used to compute this metric entry.", - "type": "number", - "format": "float" - }, - "meanTrackingAveragePrecision": { - "description": "The mean average precision over all confidence thresholds.", - "type": "number", - "format": "float" - }, - "meanBoundingBoxIou": { - "description": "The mean bounding box iou over all confidence thresholds.", - "type": "number", - "format": "float" - }, - "meanMismatchRate": { - "description": "The mean mismatch rate over all confidence thresholds.", - "type": "number", - "format": "float" - }, - "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.", - "type": "array", + "values": { + "description": "A list of string values.", "items": { - "$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics" - } + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics", - "description": "Metrics for a single confidence threshold.", - "type": "object", + "GoogleCloudAiplatformV1StructFieldValue": { + "description": "One field of a Struct (or object) type feature value.", + "id": "GoogleCloudAiplatformV1StructFieldValue", "properties": { - "confidenceThreshold": { - "description": "The confidence threshold value used to compute the metrics.", - "type": "number", - "format": "float" - }, - "trackingPrecision": { - "description": "Tracking precision.", - "type": "number", - "format": "float" - }, - "trackingRecall": { - "description": "Tracking recall.", - "type": "number", - "format": "float" - }, - "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).", - "type": "number", - "format": "float" + "name": { + "description": "Name of the field in the struct feature.", + "type": "string" }, - "mismatchRate": { - "description": "Mismatch rate, which measures the tracking consistency, i.e. correctness of instance ID continuity.", - "type": "number", - "format": "float" + "value": { + "$ref": "GoogleCloudAiplatformV1FeatureValue", + "description": "The value for this field." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics": { - "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics", - "description": "Metrics for general pairwise text generation evaluation results.", - "type": "object", + "GoogleCloudAiplatformV1StructValue": { + "description": "Struct (or object) type feature value.", + "id": "GoogleCloudAiplatformV1StructValue", "properties": { - "modelWinRate": { - "description": "Percentage of time the autorater decided the model had the better response.", - "type": "number", - "format": "float" + "values": { + "description": "A list of field values.", + "items": { + "$ref": "GoogleCloudAiplatformV1StructFieldValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Study": { + "description": "A message representing a Study.", + "id": "GoogleCloudAiplatformV1Study", + "properties": { + "createTime": { + "description": "Output only. Time at which the study was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "baselineModelWinRate": { - "description": "Percentage of time the autorater decided the baseline model had the better response.", - "type": "number", - "format": "float" + "displayName": { + "description": "Required. Describes the Study, default value is empty string.", + "type": "string" }, - "humanPreferenceModelWinRate": { - "description": "Percentage of time humans decided the model had the better response.", - "type": "number", - "format": "float" + "inactiveReason": { + "description": "Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.", + "readOnly": true, + "type": "string" }, - "humanPreferenceBaselineModelWinRate": { - "description": "Percentage of time humans decided the baseline model had the better response.", - "type": "number", - "format": "float" + "name": { + "description": "Output only. The name of a study. The study's globally unique identifier. Format: `projects/{project}/locations/{location}/studies/{study}`", + "readOnly": true, + "type": "string" }, - "truePositiveCount": { - "description": "Number of examples where both the autorater and humans decided that the model had the better response.", - "type": "string", - "format": "int64" + "state": { + "description": "Output only. The detailed state of a Study.", + "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." + ], + "readOnly": true, + "type": "string" }, - "falsePositiveCount": { - "description": "Number of examples where the autorater chose the model, but humans preferred the baseline model.", - "type": "string", - "format": "int64" + "studySpec": { + "$ref": "GoogleCloudAiplatformV1StudySpec", + "description": "Required. Configuration of the Study." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1StudySpec": { + "description": "Represents specification of a Study.", + "id": "GoogleCloudAiplatformV1StudySpec", + "properties": { + "algorithm": { + "description": "The search algorithm specified for the Study.", + "enum": [ + "ALGORITHM_UNSPECIFIED", + "GRID_SEARCH", + "RANDOM_SEARCH" + ], + "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." + ], + "type": "string" }, - "falseNegativeCount": { - "description": "Number of examples where the autorater chose the baseline model, but humans preferred the model.", - "type": "string", - "format": "int64" + "convexAutomatedStoppingSpec": { + "$ref": "GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec", + "description": "The automated early stopping spec using convex stopping rule." }, - "trueNegativeCount": { - "description": "Number of examples where both the autorater and humans decided that the model had the worse response.", - "type": "string", - "format": "int64" + "decayCurveStoppingSpec": { + "$ref": "GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec", + "description": "The automated early stopping spec using decay curve rule." }, - "accuracy": { - "description": "Fraction of cases where the autorater agreed with the human raters.", - "type": "number", - "format": "float" + "measurementSelectionType": { + "description": "Describe which measurement selection type will be used", + "enum": [ + "MEASUREMENT_SELECTION_TYPE_UNSPECIFIED", + "LAST_MEASUREMENT", + "BEST_MEASUREMENT" + ], + "enumDescriptions": [ + "Will be treated as LAST_MEASUREMENT.", + "Use the last measurement reported.", + "Use the best measurement reported." + ], + "type": "string" }, - "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.", - "type": "number", - "format": "float" + "medianAutomatedStoppingSpec": { + "$ref": "GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec", + "description": "The automated early stopping spec using median rule." + }, + "metrics": { + "description": "Required. Metric specs for the Study.", + "items": { + "$ref": "GoogleCloudAiplatformV1StudySpecMetricSpec" + }, + "type": "array" }, - "recall": { - "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.", - "type": "number", - "format": "float" + "observationNoise": { + "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" + ], + "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" }, - "f1Score": { - "description": "Harmonic mean of precision and recall.", - "type": "number", - "format": "float" + "parameters": { + "description": "Required. The set of parameters to tune.", + "items": { + "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpec" + }, + "type": "array" }, - "cohensKappa": { - "description": "A measurement of agreement between the autorater and human raters that takes the likelihood of random agreement into account.", - "type": "number", - "format": "float" + "studyStoppingConfig": { + "$ref": "GoogleCloudAiplatformV1StudySpecStudyStoppingConfig", + "description": "Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance": { - "id": "GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance", - "description": "Prediction input format for Image Classification.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec": { + "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": "GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec", "properties": { - "content": { - "description": "The image bytes or Cloud Storage URI to make the prediction on.", + "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" }, - "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", + "maxStepCount": { + "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", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance": { - "id": "GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance", - "description": "Prediction input format for Image Object Detection.", - "type": "object", - "properties": { - "content": { - "description": "The image bytes or Cloud Storage URI to make the prediction on.", + }, + "minMeasurementCount": { + "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": "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", + "minStepCount": { + "description": "Minimum number of steps for a trial to complete. Trials which do not have a measurement with step_count > 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" + }, + "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" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance": { - "id": "GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance", - "description": "Prediction input format for Image Segmentation.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec": { + "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": "GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec", "properties": { - "content": { - "description": "The image bytes to make the predictions 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/png", - "type": "string" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance": { - "id": "GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance", - "description": "Prediction input format for Text Classification.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec": { + "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.", + "id": "GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec", "properties": { - "content": { - "description": "The text snippet to make the predictions on.", - "type": "string" - }, - "mimeType": { - "description": "The MIME type of the text snippet. The supported MIME types are listed below. - text/plain", - "type": "string" + "useElapsedDuration": { + "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.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance": { - "id": "GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance", - "description": "Prediction input format for Text Extraction.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecMetricSpec": { + "description": "Represents a metric to optimize.", + "id": "GoogleCloudAiplatformV1StudySpecMetricSpec", "properties": { - "content": { - "description": "The text snippet to make the predictions on.", + "goal": { + "description": "Required. The optimization goal of the metric.", + "enum": [ + "GOAL_TYPE_UNSPECIFIED", + "MAXIMIZE", + "MINIMIZE" + ], + "enumDescriptions": [ + "Goal Type will default to maximize.", + "Maximize the goal metric.", + "Minimize the goal metric." + ], "type": "string" }, - "mimeType": { - "description": "The MIME type of the text snippet. The supported MIME types are listed below. - text/plain", + "metricId": { + "description": "Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.", "type": "string" }, - "key": { - "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": "string" + "safetyConfig": { + "$ref": "GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig", + "description": "Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance": { - "id": "GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance", - "description": "Prediction input format for Text Sentiment.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig": { + "description": "Used in safe optimization to specify threshold levels and risk tolerance.", + "id": "GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig", "properties": { - "content": { - "description": "The text snippet to make the predictions on.", - "type": "string" + "desiredMinSafeTrialsFraction": { + "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", + "type": "number" }, - "mimeType": { - "description": "The MIME type of the text snippet. The supported MIME types are listed below. - text/plain", - "type": "string" + "safetyThreshold": { + "description": "Safety threshold (boundary value between safe and unsafe). NOTE that if you leave SafetyMetricConfig unset, a default value of 0 will be used.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance": { - "id": "GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance", - "description": "Prediction input format for Video Action Recognition.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecParameterSpec": { + "description": "Represents a single parameter to optimize.", + "id": "GoogleCloudAiplatformV1StudySpecParameterSpec", "properties": { - "content": { - "description": "The Google Cloud Storage location of the video on which to perform the prediction.", - "type": "string" + "categoricalValueSpec": { + "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec", + "description": "The value spec for a 'CATEGORICAL' parameter." }, - "mimeType": { - "description": "The MIME type of the content of the video. Only the following are supported: video/mp4 video/avi video/quicktime", - "type": "string" + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec" + }, + "type": "array" }, - "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.", + "discreteValueSpec": { + "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec", + "description": "The value spec for a 'DISCRETE' parameter." + }, + "doubleValueSpec": { + "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec", + "description": "The value spec for a 'DOUBLE' parameter." + }, + "integerValueSpec": { + "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec", + "description": "The value spec for an 'INTEGER' parameter." + }, + "parameterId": { + "description": "Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.", "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.", + "scaleType": { + "description": "How the parameter should be scaled. Leave unset for `CATEGORICAL` parameters.", + "enum": [ + "SCALE_TYPE_UNSPECIFIED", + "UNIT_LINEAR_SCALE", + "UNIT_LOG_SCALE", + "UNIT_REVERSE_LOG_SCALE" + ], + "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." + ], "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance": { - "id": "GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance", - "description": "Prediction input format for Video Classification.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec": { + "description": "Value specification for a parameter in `CATEGORICAL` type.", + "id": "GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec", "properties": { - "content": { - "description": "The Google Cloud Storage location of the video on which to perform the prediction.", - "type": "string" - }, - "mimeType": { - "description": "The MIME type of the content of the video. Only the following are supported: video/mp4 video/avi video/quicktime", - "type": "string" - }, - "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.", + "defaultValue": { + "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.", "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" + "values": { + "description": "Required. The list of possible categories.", + "items": { + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance": { - "id": "GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance", - "description": "Prediction input format for Video Object Tracking.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec": { + "description": "Represents a parameter spec with condition from its parent parameter.", + "id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec", "properties": { - "content": { - "description": "The Google Cloud Storage location of the video on which to perform the prediction.", - "type": "string" + "parameterSpec": { + "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpec", + "description": "Required. The spec for a conditional parameter." }, - "mimeType": { - "description": "The MIME type of the content of the video. Only the following are supported: video/mp4 video/avi video/quicktime", - "type": "string" + "parentCategoricalValues": { + "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition", + "description": "The spec for matching values from a parent parameter of `CATEGORICAL` type." }, - "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" + "parentDiscreteValues": { + "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition", + "description": "The spec for matching values from a parent parameter of `DISCRETE` type." }, - "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" + "parentIntValues": { + "$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition", + "description": "The spec for matching values from a parent parameter of `INTEGER` type." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams": { - "id": "GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams", - "description": "Prediction model parameters for Image Classification.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition": { + "description": "Represents the spec to match categorical values from parent parameter.", + "id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition", "properties": { - "confidenceThreshold": { - "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", - "type": "number", - "format": "float" - }, - "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.", - "type": "integer", - "format": "int32" + "values": { + "description": "Required. Matches values of the parent parameter of 'CATEGORICAL' type. All values must exist in `categorical_value_spec` of parent parameter.", + "items": { + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams": { - "id": "GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams", - "description": "Prediction model parameters for Image Object Detection.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition": { + "description": "Represents the spec to match discrete values from parent parameter.", + "id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition", "properties": { - "confidenceThreshold": { - "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", - "type": "number", - "format": "float" - }, - "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.", - "type": "integer", - "format": "int32" + "values": { + "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.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams": { - "id": "GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams", - "description": "Prediction model parameters for Image Segmentation.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition": { + "description": "Represents the spec to match integer values from parent parameter.", + "id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition", "properties": { - "confidenceThreshold": { - "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", - "format": "float" + "values": { + "description": "Required. Matches values of the parent parameter of 'INTEGER' type. All values must lie in `integer_value_spec` of parent parameter.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams": { - "id": "GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams", - "description": "Prediction model parameters for Video Action Recognition.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec": { + "description": "Value specification for a parameter in `DISCRETE` type.", + "id": "GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec", "properties": { - "confidenceThreshold": { - "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", - "type": "number", - "format": "float" + "defaultValue": { + "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.", + "format": "double", + "type": "number" }, - "maxPredictions": { - "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.", - "type": "integer", - "format": "int32" + "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.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams": { - "id": "GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams", - "description": "Prediction model parameters for Video Classification.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec": { + "description": "Value specification for a parameter in `DOUBLE` type.", + "id": "GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec", "properties": { - "confidenceThreshold": { - "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", - "type": "number", - "format": "float" + "defaultValue": { + "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.", + "format": "double", + "type": "number" }, - "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.", - "type": "integer", - "format": "int32" + "maxValue": { + "description": "Required. Inclusive maximum value of the parameter.", + "format": "double", + "type": "number" }, - "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" + "minValue": { + "description": "Required. Inclusive minimum value of the parameter.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec": { + "description": "Value specification for a parameter in `INTEGER` type.", + "id": "GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec", + "properties": { + "defaultValue": { + "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.", + "format": "int64", + "type": "string" }, - "shotClassification": { - "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": "boolean" + "maxValue": { + "description": "Required. Inclusive maximum value of the parameter.", + "format": "int64", + "type": "string" }, - "oneSecIntervalClassification": { - "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", - "type": "boolean" + "minValue": { + "description": "Required. Inclusive minimum value of the parameter.", + "format": "int64", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams": { - "id": "GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams", - "description": "Prediction model parameters for Video Object Tracking.", - "type": "object", + "GoogleCloudAiplatformV1StudySpecStudyStoppingConfig": { + "description": "The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection.", + "id": "GoogleCloudAiplatformV1StudySpecStudyStoppingConfig", "properties": { - "confidenceThreshold": { - "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", - "type": "number", - "format": "float" + "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" }, - "maxPredictions": { - "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.", - "type": "integer", - "format": "int32" + "maxNumTrials": { + "description": "If there are more than this many trials, stop the study.", + "format": "int32", + "type": "integer" }, - "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.", - "type": "number", - "format": "float" + "maxNumTrialsNoProgress": { + "description": "If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies.", + "format": "int32", + "type": "integer" + }, + "maximumRuntimeConstraint": { + "$ref": "GoogleCloudAiplatformV1StudyTimeConstraint", + "description": "If the specified time or duration has passed, stop the study." + }, + "minNumTrials": { + "description": "If there are fewer than this many COMPLETED trials, do not stop the study.", + "format": "int32", + "type": "integer" + }, + "minimumRuntimeConstraint": { + "$ref": "GoogleCloudAiplatformV1StudyTimeConstraint", + "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." + }, + "shouldStopAsap": { + "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).", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult", - "description": "Prediction output format for Image and Text Classification.", - "type": "object", + "GoogleCloudAiplatformV1StudyTimeConstraint": { + "description": "Time-based Constraint for Study", + "id": "GoogleCloudAiplatformV1StudyTimeConstraint", "properties": { - "ids": { - "description": "The resource IDs of the AnnotationSpecs that had been identified.", - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "displayNames": { - "description": "The display names of the AnnotationSpecs that had been identified, order matches the IDs.", - "type": "array", - "items": { - "type": "string" - } + "endTime": { + "description": "Compares the wallclock time to this time. Must use UTC timezone.", + "format": "google-datetime", + "type": "string" }, - "confidences": { - "description": "The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.", - "type": "array", - "items": { - "type": "number", - "format": "float" - } + "maxDuration": { + "description": "Counts the wallclock time passed since the creation of this Study.", + "format": "google-duration", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult", - "description": "Prediction output format for Image Object Detection.", - "type": "object", + "GoogleCloudAiplatformV1SuggestTrialsMetadata": { + "description": "Details of operations that perform Trials suggestion.", + "id": "GoogleCloudAiplatformV1SuggestTrialsMetadata", "properties": { - "ids": { - "description": "The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.", - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "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" }, - "displayNames": { - "description": "The display names of the AnnotationSpecs that had been identified, order matches the IDs.", - "type": "array", - "items": { - "type": "string" - } + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for suggesting Trials." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SuggestTrialsRequest": { + "description": "Request message for VizierService.SuggestTrials.", + "id": "GoogleCloudAiplatformV1SuggestTrialsRequest", + "properties": { + "clientId": { + "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.", + "type": "string" }, - "confidences": { - "description": "The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.", - "type": "array", + "contexts": { + "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.", "items": { - "type": "number", - "format": "float" - } + "$ref": "GoogleCloudAiplatformV1TrialContext" + }, + "type": "array" }, - "bboxes": { - "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.", - "type": "array", - "items": { - "type": "array", - "items": { - "type": "any" - } - } + "suggestionCount": { + "description": "Required. The number of suggestions requested. It must be positive.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult", - "description": "Prediction output format for Image Segmentation.", - "type": "object", + "GoogleCloudAiplatformV1SuggestTrialsResponse": { + "description": "Response message for VizierService.SuggestTrials.", + "id": "GoogleCloudAiplatformV1SuggestTrialsResponse", "properties": { - "categoryMask": { - "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.", + "endTime": { + "description": "The time at which operation processing completed.", + "format": "google-datetime", "type": "string" }, - "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.", + "startTime": { + "description": "The time at which the operation was started.", + "format": "google-datetime", "type": "string" - } - } - }, - "GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult", - "description": "Prediction output format for Tabular Classification.", - "type": "object", - "properties": { - "classes": { - "description": "The name of the classes being classified, contains all possible values of the target column.", - "type": "array", - "items": { - "type": "string" - } }, - "scores": { - "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", + "studyState": { + "description": "The state of the Study.", + "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." + ], + "type": "string" + }, + "trials": { + "description": "A list of Trials.", "items": { - "type": "number", - "format": "float" - } + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult", - "description": "Prediction output format for Tabular Regression.", - "type": "object", + "GoogleCloudAiplatformV1SummarizationHelpfulnessInput": { + "description": "Input for summarization helpfulness metric.", + "id": "GoogleCloudAiplatformV1SummarizationHelpfulnessInput", "properties": { - "value": { - "description": "The regression value.", - "type": "number", - "format": "float" + "instance": { + "$ref": "GoogleCloudAiplatformV1SummarizationHelpfulnessInstance", + "description": "Required. Summarization helpfulness instance." }, - "lowerBound": { - "description": "The lower bound of the prediction interval.", - "type": "number", - "format": "float" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1SummarizationHelpfulnessSpec", + "description": "Required. Spec for summarization helpfulness score metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SummarizationHelpfulnessInstance": { + "description": "Spec for summarization helpfulness instance.", + "id": "GoogleCloudAiplatformV1SummarizationHelpfulnessInstance", + "properties": { + "context": { + "description": "Required. Text to be summarized.", + "type": "string" }, - "upperBound": { - "description": "The upper bound of the prediction interval.", - "type": "number", - "format": "float" + "instruction": { + "description": "Optional. Summarization prompt for LLM.", + "type": "string" }, - "quantileValues": { - "description": "Quantile values.", - "type": "array", - "items": { - "type": "number", - "format": "float" - } + "prediction": { + "description": "Required. Output of the evaluated model.", + "type": "string" }, - "quantilePredictions": { - "description": "Quantile predictions, in 1-1 correspondence with quantile_values.", - "type": "array", - "items": { - "type": "number", - "format": "float" - } + "reference": { + "description": "Optional. Ground truth used to compare against the prediction.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult", - "description": "Prediction output format for Text Extraction.", - "type": "object", + "GoogleCloudAiplatformV1SummarizationHelpfulnessResult": { + "description": "Spec for summarization helpfulness result.", + "id": "GoogleCloudAiplatformV1SummarizationHelpfulnessResult", "properties": { - "ids": { - "description": "The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.", - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "displayNames": { - "description": "The display names of the AnnotationSpecs that had been identified, order matches the IDs.", - "type": "array", - "items": { - "type": "string" - } - }, - "textSegmentStartOffsets": { - "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", - "items": { - "type": "string", - "format": "int64" - } + "confidence": { + "description": "Output only. Confidence for summarization helpfulness score.", + "format": "float", + "readOnly": true, + "type": "number" }, - "textSegmentEndOffsets": { - "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.", - "type": "array", - "items": { - "type": "string", - "format": "int64" - } + "explanation": { + "description": "Output only. Explanation for summarization helpfulness score.", + "readOnly": true, + "type": "string" }, - "confidences": { - "description": "The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.", - "type": "array", - "items": { - "type": "number", - "format": "float" - } + "score": { + "description": "Output only. Summarization Helpfulness score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult", - "description": "Prediction output format for Text Sentiment", - "type": "object", + "GoogleCloudAiplatformV1SummarizationHelpfulnessSpec": { + "description": "Spec for summarization helpfulness score metric.", + "id": "GoogleCloudAiplatformV1SummarizationHelpfulnessSpec", "properties": { - "sentiment": { - "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", - "format": "int32" + "useReference": { + "description": "Optional. Whether to use instance.reference to compute summarization helpfulness.", + "type": "boolean" + }, + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult", - "description": "Prediction output format for Time Series Forecasting.", - "type": "object", + "GoogleCloudAiplatformV1SummarizationQualityInput": { + "description": "Input for summarization quality metric.", + "id": "GoogleCloudAiplatformV1SummarizationQualityInput", "properties": { - "value": { - "description": "The regression value.", - "type": "number", - "format": "float" - }, - "quantileValues": { - "description": "Quantile values.", - "type": "array", - "items": { - "type": "number", - "format": "float" - } - }, - "quantilePredictions": { - "description": "Quantile predictions, in 1-1 correspondence with quantile_values.", - "type": "array", - "items": { - "type": "number", - "format": "float" - } + "instance": { + "$ref": "GoogleCloudAiplatformV1SummarizationQualityInstance", + "description": "Required. Summarization quality instance." }, - "tftFeatureImportance": { - "description": "Only use these if TFt is enabled.", - "$ref": "GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1SummarizationQualitySpec", + "description": "Required. Spec for summarization quality score metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance", - "type": "object", + "GoogleCloudAiplatformV1SummarizationQualityInstance": { + "description": "Spec for summarization quality instance.", + "id": "GoogleCloudAiplatformV1SummarizationQualityInstance", "properties": { - "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": { - "type": "number", - "format": "float" - } - }, - "contextColumns": { - "type": "array", - "items": { - "type": "string" - } - }, - "horizonWeights": { - "type": "array", - "items": { - "type": "number", - "format": "float" - } + "context": { + "description": "Required. Text to be summarized.", + "type": "string" }, - "horizonColumns": { - "type": "array", - "items": { - "type": "string" - } + "instruction": { + "description": "Required. Summarization prompt for LLM.", + "type": "string" }, - "attributeWeights": { - "type": "array", - "items": { - "type": "number", - "format": "float" - } + "prediction": { + "description": "Required. Output of the evaluated model.", + "type": "string" }, - "attributeColumns": { - "type": "array", - "items": { - "type": "string" - } + "reference": { + "description": "Optional. Ground truth used to compare against the prediction.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult", - "description": "Prediction output format for Video Action Recognition.", - "type": "object", + "GoogleCloudAiplatformV1SummarizationQualityResult": { + "description": "Spec for summarization quality result.", + "id": "GoogleCloudAiplatformV1SummarizationQualityResult", "properties": { - "id": { - "description": "The resource ID of the AnnotationSpec that had been identified.", - "type": "string" + "confidence": { + "description": "Output only. Confidence for summarization quality score.", + "format": "float", + "readOnly": true, + "type": "number" }, - "displayName": { - "description": "The display name of the AnnotationSpec that had been identified.", + "explanation": { + "description": "Output only. Explanation for summarization quality score.", + "readOnly": true, "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" + "score": { + "description": "Output only. Summarization Quality score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SummarizationQualitySpec": { + "description": "Spec for summarization quality score metric.", + "id": "GoogleCloudAiplatformV1SummarizationQualitySpec", + "properties": { + "useReference": { + "description": "Optional. Whether to use instance.reference to compute summarization quality.", + "type": "boolean" }, - "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.", - "type": "string", - "format": "google-duration" + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SummarizationVerbosityInput": { + "description": "Input for summarization verbosity metric.", + "id": "GoogleCloudAiplatformV1SummarizationVerbosityInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1SummarizationVerbosityInstance", + "description": "Required. Summarization verbosity instance." }, - "confidence": { - "description": "The Model's confidence in correction of this prediction, higher value means higher confidence.", - "type": "number", - "format": "float" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1SummarizationVerbositySpec", + "description": "Required. Spec for summarization verbosity score metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult", - "description": "Prediction output format for Video Classification.", - "type": "object", + "GoogleCloudAiplatformV1SummarizationVerbosityInstance": { + "description": "Spec for summarization verbosity instance.", + "id": "GoogleCloudAiplatformV1SummarizationVerbosityInstance", "properties": { - "id": { - "description": "The resource ID of the AnnotationSpec that had been identified.", + "context": { + "description": "Required. Text to be summarized.", "type": "string" }, - "displayName": { - "description": "The display name of the AnnotationSpec that had been identified.", + "instruction": { + "description": "Optional. Summarization prompt for LLM.", "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", + "prediction": { + "description": "Required. Output of the evaluated model.", "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. 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.", - "type": "string", - "format": "google-duration" - }, - "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.", - "type": "string", - "format": "google-duration" - }, - "confidence": { - "description": "The Model's confidence in correction of this prediction, higher value means higher confidence.", - "type": "number", - "format": "float" + "reference": { + "description": "Optional. Ground truth used to compare against the prediction.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult", - "description": "Prediction output format for Video Object Tracking.", - "type": "object", + "GoogleCloudAiplatformV1SummarizationVerbosityResult": { + "description": "Spec for summarization verbosity result.", + "id": "GoogleCloudAiplatformV1SummarizationVerbosityResult", "properties": { - "id": { - "description": "The resource ID of the AnnotationSpec that had been identified.", - "type": "string" + "confidence": { + "description": "Output only. Confidence for summarization verbosity score.", + "format": "float", + "readOnly": true, + "type": "number" }, - "displayName": { - "description": "The display name of the AnnotationSpec that had been identified.", + "explanation": { + "description": "Output only. Explanation for summarization verbosity score.", + "readOnly": true, "type": "string" }, - "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.", - "type": "string", - "format": "google-duration" - }, - "timeSegmentEnd": { - "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.", - "type": "string", - "format": "google-duration" - }, - "confidence": { - "description": "The Model's confidence in correction of this prediction, higher value means higher confidence.", - "type": "number", - "format": "float" - }, - "frames": { - "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", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame" - } + "score": { + "description": "Output only. Summarization Verbosity score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame": { - "id": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame", - "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.", - "type": "object", + "GoogleCloudAiplatformV1SummarizationVerbositySpec": { + "description": "Spec for summarization verbosity score metric.", + "id": "GoogleCloudAiplatformV1SummarizationVerbositySpec", "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.", - "type": "string", - "format": "google-duration" - }, - "xMin": { - "description": "The leftmost coordinate of the bounding box.", - "type": "number", - "format": "float" + "useReference": { + "description": "Optional. Whether to use instance.reference to compute summarization verbosity.", + "type": "boolean" }, - "xMax": { - "description": "The rightmost coordinate of the bounding box.", - "type": "number", - "format": "float" + "version": { + "description": "Optional. Which version to use for evaluation.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SummaryMetrics": { + "description": "The summary metrics for the evaluation run.", + "id": "GoogleCloudAiplatformV1SummaryMetrics", + "properties": { + "failedItems": { + "description": "Optional. The number of items that failed to be evaluated.", + "format": "int32", + "type": "integer" }, - "yMin": { - "description": "The topmost coordinate of the bounding box.", - "type": "number", - "format": "float" + "metrics": { + "additionalProperties": { + "type": "any" + }, + "description": "Optional. Map of metric name to metric value.", + "type": "object" }, - "yMax": { - "description": "The bottommost coordinate of the bounding box.", - "type": "number", - "format": "float" + "totalItems": { + "description": "Optional. The total number of items that were evaluated.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting", - "description": "A TrainingJob that trains and uploads an AutoML Forecasting Model.", - "type": "object", + "GoogleCloudAiplatformV1SupervisedHyperParameters": { + "description": "Hyperparameters for SFT.", + "id": "GoogleCloudAiplatformV1SupervisedHyperParameters", "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs" + "adapterSize": { + "description": "Optional. Adapter size for tuning.", + "enum": [ + "ADAPTER_SIZE_UNSPECIFIED", + "ADAPTER_SIZE_ONE", + "ADAPTER_SIZE_TWO", + "ADAPTER_SIZE_FOUR", + "ADAPTER_SIZE_EIGHT", + "ADAPTER_SIZE_SIXTEEN", + "ADAPTER_SIZE_THIRTY_TWO" + ], + "enumDescriptions": [ + "Adapter size is unspecified.", + "Adapter size 1.", + "Adapter size 2.", + "Adapter size 4.", + "Adapter size 8.", + "Adapter size 16.", + "Adapter size 32." + ], + "type": "string" }, - "metadata": { - "description": "The metadata information.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata" + "epochCount": { + "description": "Optional. Number of complete passes the model makes over the entire training dataset during training.", + "format": "int64", + "type": "string" + }, + "learningRateMultiplier": { + "description": "Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs", - "type": "object", + "GoogleCloudAiplatformV1SupervisedTuningDataStats": { + "description": "Tuning data statistics for Supervised Tuning.", + "id": "GoogleCloudAiplatformV1SupervisedTuningDataStats", "properties": { - "targetColumn": { - "description": "The name of the column that the Model is to predict values for. This column must be unavailable at forecast.", + "droppedExampleReasons": { + "description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "totalBillableCharacterCount": { + "deprecated": true, + "description": "Output only. Number of billable characters in the tuning dataset.", + "format": "int64", + "readOnly": true, "type": "string" }, - "timeSeriesIdentifierColumn": { - "description": "The name of the column that identifies the time series.", + "totalBillableTokenCount": { + "description": "Output only. Number of billable tokens in the tuning dataset.", + "format": "int64", + "readOnly": true, "type": "string" }, - "timeColumn": { - "description": "The name of the column that identifies time order in the time series. This column must be available at forecast.", + "totalTruncatedExampleCount": { + "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", + "readOnly": true, "type": "string" }, - "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.", - "type": "array", + "totalTuningCharacterCount": { + "description": "Output only. Number of tuning characters in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "truncatedExampleIndices": { + "description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.", "items": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation" - } + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" }, - "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.", + "tuningDatasetExampleCount": { + "description": "Output only. Number of examples in the tuning dataset.", + "format": "int64", + "readOnly": true, "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.", - "type": "string", - "format": "int64" - }, - "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.", + "tuningStepCount": { + "description": "Output only. Number of tuning steps for this Tuning Job.", + "format": "int64", + "readOnly": true, "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.", - "type": "array", + "userDatasetExamples": { + "description": "Output only. Sample user messages in the training dataset uri.", "items": { - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1Content" + }, + "readOnly": true, + "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.", - "type": "array", - "items": { - "type": "string" - } + "userInputTokenDistribution": { + "$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution", + "description": "Output only. Dataset distributions for the user input tokens.", + "readOnly": true }, - "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" - } + "userMessagePerExampleDistribution": { + "$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution", + "description": "Output only. Dataset distributions for the messages per example.", + "readOnly": true }, - "dataGranularity": { - "description": "Expected difference in time granularity between rows in the data.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity" + "userOutputTokenDistribution": { + "$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution", + "description": "Output only. Dataset distributions for the user output tokens.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution": { + "description": "Dataset distribution for Supervised Tuning.", + "id": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution", + "properties": { + "billableSum": { + "description": "Output only. Sum of a given population of values that are billable.", + "format": "int64", + "readOnly": true, + "type": "string" }, - "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.", - "type": "string", - "format": "int64" + "buckets": { + "description": "Output only. Defines the histogram bucket.", + "items": { + "$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket" + }, + "readOnly": true, + "type": "array" }, - "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" + "max": { + "description": "Output only. The maximum of the population values.", + "format": "double", + "readOnly": true, + "type": "number" }, - "exportEvaluatedDataItemsConfig": { - "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig" + "mean": { + "description": "Output only. The arithmetic mean of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" }, - "quantiles": { - "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.", - "type": "array", - "items": { - "type": "number", - "format": "double" - } + "median": { + "description": "Output only. The median of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" }, - "hierarchyConfig": { - "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig" + "min": { + "description": "Output only. The minimum of the population values.", + "format": "double", + "readOnly": true, + "type": "number" }, - "windowConfig": { - "description": "Config containing strategy for generating sliding windows.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig" + "p5": { + "description": "Output only. The 5th percentile of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" }, - "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" - } + "p95": { + "description": "Output only. The 95th percentile of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" }, - "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" + "sum": { + "description": "Output only. Sum of a given population of values.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket": { + "description": "Dataset bucket used to create a histogram for the distribution given a population of values.", + "id": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket", + "properties": { + "count": { + "description": "Output only. Number of values in the bucket.", + "format": "double", + "readOnly": true, + "type": "number" }, - "validationOptions": { - "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", - "type": "string" + "left": { + "description": "Output only. Left bound of the bucket.", + "format": "double", + "readOnly": true, + "type": "number" }, - "additionalExperiments": { - "description": "Additional experiment flags for the time series forcasting training.", - "type": "array", - "items": { - "type": "string" - } + "right": { + "description": "Output only. Right bound of the bucket.", + "format": "double", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation", - "type": "object", + "GoogleCloudAiplatformV1SupervisedTuningSpec": { + "description": "Tuning Spec for Supervised Tuning for first party models.", + "id": "GoogleCloudAiplatformV1SupervisedTuningSpec", "properties": { - "auto": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation" + "evaluationConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationConfig", + "description": "Optional. Evaluation Config for Tuning Job." }, - "numeric": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation" + "exportLastCheckpointOnly": { + "description": "Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.", + "type": "boolean" }, - "categorical": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation" + "hyperParameters": { + "$ref": "GoogleCloudAiplatformV1SupervisedHyperParameters", + "description": "Optional. Hyperparameters for SFT." }, - "timestamp": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation" + "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" }, - "text": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation" - } - } - }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation", - "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", - "type": "object", - "properties": { - "columnName": { + "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" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation", - "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.", - "type": "object", + "GoogleCloudAiplatformV1SyncFeatureViewRequest": { + "description": "Request message for FeatureOnlineStoreAdminService.SyncFeatureView.", + "id": "GoogleCloudAiplatformV1SyncFeatureViewRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1SyncFeatureViewResponse": { + "description": "Response message for FeatureOnlineStoreAdminService.SyncFeatureView.", + "id": "GoogleCloudAiplatformV1SyncFeatureViewResponse", "properties": { - "columnName": { + "featureViewSync": { + "description": "Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation", - "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", + "GoogleCloudAiplatformV1SyntheticExample": { + "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": "GoogleCloudAiplatformV1SyntheticExample", "properties": { - "columnName": { - "type": "string" + "fields": { + "description": "Required. A list of fields that constitute an example.", + "items": { + "$ref": "GoogleCloudAiplatformV1SyntheticField" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation", - "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", + "GoogleCloudAiplatformV1SyntheticField": { + "description": "Represents a single named field within a synthetic example, consisting of a name and the actual content.", + "id": "GoogleCloudAiplatformV1SyntheticField", "properties": { - "columnName": { - "type": "string" + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Required. The actual content or value for this field. This can be text, images, or other types of data." }, - "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)", + "fieldName": { + "description": "Optional. The name of the specific field, such as \"product_name\" or \"review_text\".", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation", - "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", + "GoogleCloudAiplatformV1TFRecordDestination": { + "description": "The storage details for TFRecord output content.", + "id": "GoogleCloudAiplatformV1TFRecordDestination", "properties": { - "columnName": { - "type": "string" + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "Required. Google Cloud Storage location." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity", - "description": "A duration of time expressed in time granularity units.", - "type": "object", + "GoogleCloudAiplatformV1TaskDescriptionStrategy": { + "description": "Defines a generation strategy based on a general task description.", + "id": "GoogleCloudAiplatformV1TaskDescriptionStrategy", "properties": { - "unit": { - "description": "The time granularity unit of this time period. The supported units are: * \"minute\" * \"hour\" * \"day\" * \"week\" * \"month\" * \"year\"", + "taskDescription": { + "description": "Required. A general description of the type of synthetic data you want to generate. For example, \"Generate customer reviews for a new smartphone.\"", "type": "string" - }, - "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.", - "type": "string", - "format": "int64" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig", - "description": "Configuration for exporting test set predictions to a BigQuery table.", - "type": "object", + "GoogleCloudAiplatformV1Tensor": { + "description": "A tensor value type.", + "id": "GoogleCloudAiplatformV1Tensor", "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`", + "boolVal": { + "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", + "items": { + "type": "boolean" + }, + "type": "array" + }, + "bytesVal": { + "description": "STRING", + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "doubleVal": { + "description": "DOUBLE", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "dtype": { + "description": "The data type of tensor.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "BOOL", + "STRING", + "FLOAT", + "DOUBLE", + "INT8", + "INT16", + "INT32", + "INT64", + "UINT8", + "UINT16", + "UINT32", + "UINT64" + ], + "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.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], "type": "string" }, - "overrideExistingTable": { - "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.", - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig", - "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies.", - "type": "object", - "properties": { - "groupColumns": { - "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", + "floatVal": { + "description": "FLOAT", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + }, + "int64Val": { + "description": "INT64", "items": { + "format": "int64", "type": "string" - } + }, + "type": "array" }, - "groupTotalWeight": { - "description": "The weight of the loss for predictions aggregated over time series in the same group.", - "type": "number", - "format": "double" + "intVal": { + "description": "INT_8 INT_16 INT_32", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" }, - "temporalTotalWeight": { - "description": "The weight of the loss for predictions aggregated over the horizon for a single time series.", - "type": "number", - "format": "double" + "listVal": { + "description": "A list of tensor values.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tensor" + }, + "type": "array" }, - "groupTemporalTotalWeight": { - "description": "The weight of the loss for predictions aggregated over both the horizon and time series in the same hierarchy group.", - "type": "number", - "format": "double" - } - } - }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig", - "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.", - "type": "object", - "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.", + "shape": { + "description": "Shape of the tensor.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "stringVal": { + "description": "STRING", + "items": { + "type": "string" + }, + "type": "array" + }, + "structVal": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1Tensor" + }, + "description": "A map of string to tensor.", + "type": "object" + }, + "tensorVal": { + "description": "Serialized raw tensor content.", + "format": "byte", "type": "string" }, - "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.", - "type": "string", - "format": "int64" + "uint64Val": { + "description": "UINT64", + "items": { + "format": "uint64", + "type": "string" + }, + "type": "array" }, - "maxCount": { - "description": "Maximum number of windows that should be generated across all time series.", - "type": "string", - "format": "int64" + "uintVal": { + "description": "UINT8 UINT16 UINT32", + "items": { + "format": "uint32", + "type": "integer" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata", - "description": "Model metadata specific to AutoML Forecasting.", - "type": "object", + "GoogleCloudAiplatformV1Tensorboard": { + "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.", + "id": "GoogleCloudAiplatformV1Tensorboard", "properties": { - "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.", - "type": "string", - "format": "int64" + "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 '/'.", + "readOnly": true, + "type": "string" }, - "evaluatedDataItemsBigqueryUri": { - "description": "BigQuery destination uri for exported evaluated examples.", + "createTime": { + "description": "Output only. Timestamp when this Tensorboard was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" - } - } - }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification", - "description": "A TrainingJob that trains and uploads an AutoML Image Classification Model.", - "type": "object", - "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs" }, - "metadata": { - "description": "The metadata information.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata" - } - } - }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs", - "type": "object", - "properties": { - "modelType": { - "type": "string", - "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" - ] + "description": { + "description": "Description of this Tensorboard.", + "type": "string" }, - "baseModelId": { - "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.", + "displayName": { + "description": "Required. User provided name of this Tensorboard.", "type": "string" }, - "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.", - "type": "string", - "format": "int64" + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "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.", + "etag": { + "description": "Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" + }, + "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" }, - "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).", + "labels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" + }, + "name": { + "description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "readOnly": true, + "type": "string" + }, + "runCount": { + "description": "Output only. The number of Runs stored in this Tensorboard.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, "type": "boolean" }, - "uptrainBaseModelId": { - "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.", + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "updateTime": { + "description": "Output only. Timestamp when this Tensorboard was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1TensorboardBlob": { + "description": "One blob (e.g, image, graph) viewable on a blob metric plot.", + "id": "GoogleCloudAiplatformV1TensorboardBlob", + "properties": { + "data": { + "description": "Optional. The bytes of the blob is not present unless it's returned by the ReadTensorboardBlobData endpoint.", + "format": "byte", "type": "string" }, - "tunableParameter": { - "description": "Trainer type for Vision TrainRequest.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter" + "id": { + "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.", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter", - "description": "A wrapper class which contains the tunable parameters in an AutoML Image training job.", - "type": "object", + "GoogleCloudAiplatformV1TensorboardBlobSequence": { + "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.", + "id": "GoogleCloudAiplatformV1TensorboardBlobSequence", "properties": { - "trainerType": { - "type": "string", - "enumDescriptions": [ - "Default value.", - "", - "" - ], - "enum": [ - "TRAINER_TYPE_UNSPECIFIED", - "AUTOML_TRAINER", - "MODEL_GARDEN_TRAINER" - ] + "values": { + "description": "List of blobs contained within the sequence.", + "items": { + "$ref": "GoogleCloudAiplatformV1TensorboardBlob" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1TensorboardExperiment": { + "description": "A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.", + "id": "GoogleCloudAiplatformV1TensorboardExperiment", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this TensorboardExperiment was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "checkpointName": { - "description": "Optional. An unique name of pretrained model checkpoint provided in model garden, it will be mapped to a GCS location internally.", + "description": { + "description": "Description of this TensorboardExperiment.", "type": "string" }, - "studySpec": { - "description": "Optioinal. StudySpec of hyperparameter tuning job. Required for `model_garden_trainer`.", - "$ref": "GoogleCloudAiplatformV1StudySpec" + "displayName": { + "description": "User provided name of this TensorboardExperiment.", + "type": "string" }, - "trainerConfig": { - "description": "Customizable trainer settings, used in the `model_garden_trainer`.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "etag": { + "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" }, - "datasetConfig": { - "description": "Customizable dataset settings, used in the `model_garden_trainer`.", - "type": "object", + "labels": { "additionalProperties": { "type": "string" - } - } - } - }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata", - "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" + }, + "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" }, - "successfulStopReason": { - "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." - ], - "enum": [ - "SUCCESSFUL_STOP_REASON_UNSPECIFIED", - "BUDGET_REACHED", - "MODEL_CONVERGED" - ] - } - } - }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection", - "description": "A TrainingJob that trains and uploads an AutoML Image Object Detection Model.", - "type": "object", - "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs" + "name": { + "description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "readOnly": true, + "type": "string" }, - "metadata": { - "description": "The metadata information", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata" + "source": { + "description": "Immutable. Source of the TensorboardExperiment. Example: a custom training job.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this TensorboardExperiment was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs", - "type": "object", + "GoogleCloudAiplatformV1TensorboardRun": { + "description": "TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc", + "id": "GoogleCloudAiplatformV1TensorboardRun", "properties": { - "modelType": { - "type": "string", - "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" - ] + "createTime": { + "description": "Output only. Timestamp when this TensorboardRun was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of this TensorboardRun.", + "type": "string" }, - "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 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.", - "type": "string", - "format": "int64" + "displayName": { + "description": "Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.", + "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 Object Detection might stop training before the entire training budget has been used.", - "type": "boolean" + "etag": { + "description": "Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" }, - "uptrainBaseModelId": { - "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.", + "labels": { + "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.", + "type": "object" + }, + "name": { + "description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "readOnly": true, "type": "string" }, - "tunableParameter": { - "description": "Trainer type for Vision TrainRequest.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter" + "updateTime": { + "description": "Output only. Timestamp when this TensorboardRun was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata", - "type": "object", + "GoogleCloudAiplatformV1TensorboardTensor": { + "description": "One point viewable on a tensor metric plot.", + "id": "GoogleCloudAiplatformV1TensorboardTensor", "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" + "value": { + "description": "Required. Serialized form of https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto", + "format": "byte", + "type": "string" }, - "successfulStopReason": { - "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." - ], - "enum": [ - "SUCCESSFUL_STOP_REASON_UNSPECIFIED", - "BUDGET_REACHED", - "MODEL_CONVERGED" - ] + "versionNumber": { + "description": "Optional. Version number of TensorProto used to serialize value.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation", - "description": "A TrainingJob that trains and uploads an AutoML Image Segmentation Model.", - "type": "object", + "GoogleCloudAiplatformV1TensorboardTimeSeries": { + "description": "TensorboardTimeSeries maps to times series produced in training runs", + "id": "GoogleCloudAiplatformV1TensorboardTimeSeries", "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs" + "createTime": { + "description": "Output only. Timestamp when this TensorboardTimeSeries was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of this TensorboardTimeSeries.", + "type": "string" + }, + "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" }, "metadata": { - "description": "The metadata information.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata" + "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata", + "description": "Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.", + "readOnly": true + }, + "name": { + "description": "Output only. Name of the TensorboardTimeSeries.", + "readOnly": true, + "type": "string" + }, + "pluginData": { + "description": "Data of the current plugin, with the size limited to 65KB.", + "format": "byte", + "type": "string" + }, + "pluginName": { + "description": "Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this TensorboardTimeSeries was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "valueType": { + "description": "Required. Immutable. Type of TensorboardTimeSeries value.", + "enum": [ + "VALUE_TYPE_UNSPECIFIED", + "SCALAR", + "TENSOR", + "BLOB_SEQUENCE" + ], + "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." + ], + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs", - "type": "object", + "GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata": { + "description": "Describes metadata for a TensorboardTimeSeries.", + "id": "GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata", "properties": { - "modelType": { - "type": "string", - "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." - ], - "enum": [ - "MODEL_TYPE_UNSPECIFIED", - "CLOUD_HIGH_ACCURACY_1", - "CLOUD_LOW_ACCURACY_1", - "MOBILE_TF_LOW_LATENCY_1" - ] + "maxBlobSequenceLength": { + "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.", + "format": "int64", + "readOnly": true, + "type": "string" }, - "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).", - "type": "string", - "format": "int64" + "maxStep": { + "description": "Output only. Max step index of all data points within a TensorboardTimeSeries.", + "format": "int64", + "readOnly": true, + "type": "string" }, - "baseModelId": { - "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.", + "maxWallTime": { + "description": "Output only. Max wall clock timestamp of all data points within a TensorboardTimeSeries.", + "format": "google-datetime", + "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata", - "type": "object", + "GoogleCloudAiplatformV1ThresholdConfig": { + "description": "The config for feature monitoring threshold.", + "id": "GoogleCloudAiplatformV1ThresholdConfig", "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": { - "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." - ], - "enum": [ - "SUCCESSFUL_STOP_REASON_UNSPECIFIED", - "BUDGET_REACHED", - "MODEL_CONVERGED" - ] + "value": { + "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.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables", - "description": "A TrainingJob that trains and uploads an AutoML Tables Model.", - "type": "object", + "GoogleCloudAiplatformV1TimeSeriesData": { + "description": "All the data stored in a TensorboardTimeSeries.", + "id": "GoogleCloudAiplatformV1TimeSeriesData", "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs" + "tensorboardTimeSeriesId": { + "description": "Required. The ID of the TensorboardTimeSeries, which will become the final component of the TensorboardTimeSeries' resource name", + "type": "string" }, - "metadata": { - "description": "The metadata information.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata" + "valueType": { + "description": "Required. Immutable. The value type of this time series. All the values in this time series data must match this value type.", + "enum": [ + "VALUE_TYPE_UNSPECIFIED", + "SCALAR", + "TENSOR", + "BLOB_SEQUENCE" + ], + "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." + ], + "type": "string" + }, + "values": { + "description": "Required. Data points in this time series.", + "items": { + "$ref": "GoogleCloudAiplatformV1TimeSeriesDataPoint" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs", - "type": "object", + "GoogleCloudAiplatformV1TimeSeriesDataPoint": { + "description": "A TensorboardTimeSeries data point.", + "id": "GoogleCloudAiplatformV1TimeSeriesDataPoint", "properties": { - "optimizationObjectiveRecallValue": { - "description": "Required when optimization_objective is \"maximize-precision-at-recall\". Must be between 0 and 1, inclusive.", - "type": "number", - "format": "float" - }, - "optimizationObjectivePrecisionValue": { - "description": "Required when optimization_objective is \"maximize-recall-at-precision\". Must be between 0 and 1, inclusive.", - "type": "number", - "format": "float" + "blobs": { + "$ref": "GoogleCloudAiplatformV1TensorboardBlobSequence", + "description": "A blob sequence value." }, - "predictionType": { - "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.", - "type": "string" + "scalar": { + "$ref": "GoogleCloudAiplatformV1Scalar", + "description": "A scalar value." }, - "targetColumn": { - "description": "The column name of the target column that the model is to predict.", + "step": { + "description": "Step index of this data point within the run.", + "format": "int64", "type": "string" }, - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation" - } + "tensor": { + "$ref": "GoogleCloudAiplatformV1TensorboardTensor", + "description": "A tensor value." }, - "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).", + "wallTime": { + "description": "Wall clock timestamp when this data point is generated by the end user.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1TimestampSplit": { + "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.", + "id": "GoogleCloudAiplatformV1TimestampSplit", + "properties": { + "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" }, - "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.", - "type": "string", - "format": "int64" + "testFraction": { + "description": "The fraction of the input data that is to be used to evaluate the Model.", + "format": "double", + "type": "number" }, - "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" + "trainingFraction": { + "description": "The fraction of the input data that is to be used to train the Model.", + "format": "double", + "type": "number" }, - "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.", + "validationFraction": { + "description": "The fraction of the input data that is to be used to validate the Model.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1TokensInfo": { + "description": "Tokens info with a list of tokens and the corresponding list of token ids.", + "id": "GoogleCloudAiplatformV1TokensInfo", + "properties": { + "role": { + "description": "Optional. Optional fields for the role from the corresponding Content.", "type": "string" }, - "exportEvaluatedDataItemsConfig": { - "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig" + "tokenIds": { + "description": "A list of token ids from the input.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" }, - "additionalExperiments": { - "description": "Additional experiment flags for the Tables training pipeline.", - "type": "array", + "tokens": { + "description": "A list of tokens from the input.", "items": { + "format": "byte", "type": "string" - } + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation", - "type": "object", + "GoogleCloudAiplatformV1Tool": { + "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).", + "id": "GoogleCloudAiplatformV1Tool", "properties": { - "auto": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation" + "codeExecution": { + "$ref": "GoogleCloudAiplatformV1ToolCodeExecution", + "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation." }, - "numeric": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation" + "computerUse": { + "$ref": "GoogleCloudAiplatformV1ToolComputerUse", + "description": "Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations." }, - "categorical": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation" + "enterpriseWebSearch": { + "$ref": "GoogleCloudAiplatformV1EnterpriseWebSearch", + "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." }, - "timestamp": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation" + "functionDeclarations": { + "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.", + "items": { + "$ref": "GoogleCloudAiplatformV1FunctionDeclaration" + }, + "type": "array" }, - "text": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation" + "googleMaps": { + "$ref": "GoogleCloudAiplatformV1GoogleMaps", + "description": "Optional. GoogleMaps tool type. Tool to support Google Maps in Model." }, - "repeatedNumeric": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation" + "googleSearch": { + "$ref": "GoogleCloudAiplatformV1ToolGoogleSearch", + "description": "Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google." }, - "repeatedCategorical": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation" + "googleSearchRetrieval": { + "$ref": "GoogleCloudAiplatformV1GoogleSearchRetrieval", + "deprecated": true, + "description": "Optional. Specialized retrieval tool that is powered by Google Search." }, - "repeatedText": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation" - } - } - }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation", - "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", - "type": "object", - "properties": { - "columnName": { - "type": "string" + "parallelAiSearch": { + "$ref": "GoogleCloudAiplatformV1ToolParallelAiSearch", + "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" + }, + "retrieval": { + "$ref": "GoogleCloudAiplatformV1Retrieval", + "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." + }, + "urlContext": { + "$ref": "GoogleCloudAiplatformV1UrlContext", + "description": "Optional. Tool to support URL context retrieval." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ToolCall": { + "description": "Spec for tool call.", + "id": "GoogleCloudAiplatformV1ToolCall", "properties": { - "columnName": { + "toolInput": { + "description": "Optional. Spec for tool input", "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" + "toolName": { + "description": "Required. Spec for tool name", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation", - "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", + "GoogleCloudAiplatformV1ToolCallValidInput": { + "description": "Input for tool call valid metric.", + "id": "GoogleCloudAiplatformV1ToolCallValidInput", "properties": { - "columnName": { - "type": "string" + "instances": { + "description": "Required. Repeated tool call valid instances.", + "items": { + "$ref": "GoogleCloudAiplatformV1ToolCallValidInstance" + }, + "type": "array" + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1ToolCallValidSpec", + "description": "Required. Spec for tool call valid metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation", - "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", + "GoogleCloudAiplatformV1ToolCallValidInstance": { + "description": "Spec for tool call valid instance.", + "id": "GoogleCloudAiplatformV1ToolCallValidInstance", "properties": { - "columnName": { + "prediction": { + "description": "Required. Output of the evaluated model.", "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)", + "reference": { + "description": "Required. Ground truth used to compare against the prediction.", "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation", - "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", + "GoogleCloudAiplatformV1ToolCallValidMetricValue": { + "description": "Tool call valid metric value for an instance.", + "id": "GoogleCloudAiplatformV1ToolCallValidMetricValue", "properties": { - "columnName": { - "type": "string" + "score": { + "description": "Output only. Tool call valid score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation", - "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.", - "type": "object", + "GoogleCloudAiplatformV1ToolCallValidResults": { + "description": "Results for tool call valid metric.", + "id": "GoogleCloudAiplatformV1ToolCallValidResults", "properties": { - "columnName": { - "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" + "toolCallValidMetricValues": { + "description": "Output only. Tool call valid metric values.", + "items": { + "$ref": "GoogleCloudAiplatformV1ToolCallValidMetricValue" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation", - "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" - } - } + "GoogleCloudAiplatformV1ToolCallValidSpec": { + "description": "Spec for tool call valid metric.", + "id": "GoogleCloudAiplatformV1ToolCallValidSpec", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation", - "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.", - "type": "object", - "properties": { - "columnName": { - "type": "string" - } - } + "GoogleCloudAiplatformV1ToolCodeExecution": { + "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": "GoogleCloudAiplatformV1ToolCodeExecution", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata", - "description": "Model metadata specific to AutoML Tables.", - "type": "object", + "GoogleCloudAiplatformV1ToolComputerUse": { + "description": "Tool to support computer use.", + "id": "GoogleCloudAiplatformV1ToolComputerUse", "properties": { - "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.", - "type": "string", - "format": "int64" - }, - "evaluatedDataItemsBigqueryUri": { - "description": "BigQuery destination uri for exported evaluated examples.", + "environment": { + "description": "Required. The environment being operated.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "ENVIRONMENT_BROWSER" + ], + "enumDescriptions": [ + "Defaults to browser.", + "Operates in a web browser." + ], "type": "string" + }, + "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.", + "items": { + "type": "string" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification", - "description": "A TrainingJob that trains and uploads an AutoML Text Classification Model.", - "type": "object", + "GoogleCloudAiplatformV1ToolConfig": { + "description": "Tool config. This config is shared for all tools provided in the request.", + "id": "GoogleCloudAiplatformV1ToolConfig", "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs" + "functionCallingConfig": { + "$ref": "GoogleCloudAiplatformV1FunctionCallingConfig", + "description": "Optional. Function calling config." + }, + "retrievalConfig": { + "$ref": "GoogleCloudAiplatformV1RetrievalConfig", + "description": "Optional. Retrieval config." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs", - "type": "object", + "GoogleCloudAiplatformV1ToolGoogleSearch": { + "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", + "id": "GoogleCloudAiplatformV1ToolGoogleSearch", "properties": { - "multiLabel": { - "type": "boolean" + "blockingConfidence": { + "description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", + "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" + ], + "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." + ], + "type": "string" + }, + "excludeDomains": { + "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" + }, + "type": "array" + }, + "searchTypes": { + "$ref": "GoogleCloudAiplatformV1ToolGoogleSearchSearchTypes", + "description": "Optional. The set of search types to enable. If not set, web search is enabled by default." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction", - "description": "A TrainingJob that trains and uploads an AutoML Text Extraction Model.", - "type": "object", + "GoogleCloudAiplatformV1ToolGoogleSearchImageSearch": { + "description": "Image search for grounding and related configurations.", + "id": "GoogleCloudAiplatformV1ToolGoogleSearchImageSearch", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1ToolGoogleSearchSearchTypes": { + "description": "Different types of search that can be enabled on the GoogleSearch tool.", + "id": "GoogleCloudAiplatformV1ToolGoogleSearchSearchTypes", "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs" + "imageSearch": { + "$ref": "GoogleCloudAiplatformV1ToolGoogleSearchImageSearch", + "description": "Optional. Setting this field enables image search. Image bytes are returned." + }, + "webSearch": { + "$ref": "GoogleCloudAiplatformV1ToolGoogleSearchWebSearch", + "description": "Optional. Setting this field enables web search. Only text results are returned." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs", - "type": "object", - "properties": {} + "GoogleCloudAiplatformV1ToolGoogleSearchWebSearch": { + "description": "Standard web search for grounding and related configurations. Only text results are returned.", + "id": "GoogleCloudAiplatformV1ToolGoogleSearchWebSearch", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment", - "description": "A TrainingJob that trains and uploads an AutoML Text Sentiment Model.", - "type": "object", + "GoogleCloudAiplatformV1ToolNameMatchInput": { + "description": "Input for tool name match metric.", + "id": "GoogleCloudAiplatformV1ToolNameMatchInput", "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs" + "instances": { + "description": "Required. Repeated tool name match instances.", + "items": { + "$ref": "GoogleCloudAiplatformV1ToolNameMatchInstance" + }, + "type": "array" + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1ToolNameMatchSpec", + "description": "Required. Spec for tool name match metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs", - "type": "object", + "GoogleCloudAiplatformV1ToolNameMatchInstance": { + "description": "Spec for tool name match instance.", + "id": "GoogleCloudAiplatformV1ToolNameMatchInstance", "properties": { - "sentimentMax": { - "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", - "format": "int32" + "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" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition", - "description": "A TrainingJob that trains and uploads an AutoML Video Action Recognition Model.", - "type": "object", + "GoogleCloudAiplatformV1ToolNameMatchMetricValue": { + "description": "Tool name match metric value for an instance.", + "id": "GoogleCloudAiplatformV1ToolNameMatchMetricValue", "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs" + "score": { + "description": "Output only. Tool name match score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs", - "type": "object", + "GoogleCloudAiplatformV1ToolNameMatchResults": { + "description": "Results for tool name match metric.", + "id": "GoogleCloudAiplatformV1ToolNameMatchResults", "properties": { - "modelType": { - "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." - ], - "enum": [ - "MODEL_TYPE_UNSPECIFIED", - "CLOUD", - "MOBILE_VERSATILE_1", - "MOBILE_JETSON_VERSATILE_1", - "MOBILE_CORAL_VERSATILE_1" - ] + "toolNameMatchMetricValues": { + "description": "Output only. Tool name match metric values.", + "items": { + "$ref": "GoogleCloudAiplatformV1ToolNameMatchMetricValue" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification", - "description": "A TrainingJob that trains and uploads an AutoML Video Classification Model.", - "type": "object", - "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs" - } - } + "GoogleCloudAiplatformV1ToolNameMatchSpec": { + "description": "Spec for tool name match metric.", + "id": "GoogleCloudAiplatformV1ToolNameMatchSpec", + "properties": {}, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs", - "type": "object", + "GoogleCloudAiplatformV1ToolParallelAiSearch": { + "description": "ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding.", + "id": "GoogleCloudAiplatformV1ToolParallelAiSearch", "properties": { - "modelType": { - "type": "string", - "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." - ], - "enum": [ - "MODEL_TYPE_UNSPECIFIED", - "CLOUD", - "MOBILE_VERSATILE_1", - "MOBILE_JETSON_VERSATILE_1" - ] + "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" + }, + "customConfigs": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "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 } }", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking", - "description": "A TrainingJob that trains and uploads an AutoML Video ObjectTracking Model.", - "type": "object", + "GoogleCloudAiplatformV1ToolParameterKVMatchInput": { + "description": "Input for tool parameter key value match metric.", + "id": "GoogleCloudAiplatformV1ToolParameterKVMatchInput", "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs" + "instances": { + "description": "Required. Repeated tool parameter key value match instances.", + "items": { + "$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchInstance" + }, + "type": "array" + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchSpec", + "description": "Required. Spec for tool parameter key value match metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs", - "type": "object", + "GoogleCloudAiplatformV1ToolParameterKVMatchInstance": { + "description": "Spec for tool parameter key value match instance.", + "id": "GoogleCloudAiplatformV1ToolParameterKVMatchInstance", "properties": { - "modelType": { - "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 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." - ], - "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" - ] + "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" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask", - "description": "A TrainingJob that trains a custom code Model.", - "type": "object", + "GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue": { + "description": "Tool parameter key value match metric value for an instance.", + "id": "GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue", "properties": { - "inputs": { - "description": "The input parameters of this CustomTask.", - "$ref": "GoogleCloudAiplatformV1CustomJobSpec" - }, - "metadata": { - "description": "The metadata information.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata" + "score": { + "description": "Output only. Tool parameter key value match score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata", - "type": "object", + "GoogleCloudAiplatformV1ToolParameterKVMatchResults": { + "description": "Results for tool parameter key value match metric.", + "id": "GoogleCloudAiplatformV1ToolParameterKVMatchResults", "properties": { - "backingCustomJob": { - "description": "The resource name of the CustomJob that has been created to carry out this custom task.", - "type": "string" + "toolParameterKvMatchMetricValues": { + "description": "Output only. Tool parameter key value match metric values.", + "items": { + "$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask", - "description": "A TrainingJob that tunes Hypererparameters of a custom code Model.", - "type": "object", + "GoogleCloudAiplatformV1ToolParameterKVMatchSpec": { + "description": "Spec for tool parameter key value match metric.", + "id": "GoogleCloudAiplatformV1ToolParameterKVMatchSpec", "properties": { - "inputs": { - "description": "The input parameters of this HyperparameterTuningTask.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec" - }, - "metadata": { - "description": "The metadata information.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata" + "useStrictStringMatch": { + "description": "Optional. Whether to use STRICT string match on parameter values.", + "type": "boolean" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec", - "type": "object", + "GoogleCloudAiplatformV1ToolParameterKeyMatchInput": { + "description": "Input for tool parameter key match metric.", + "id": "GoogleCloudAiplatformV1ToolParameterKeyMatchInput", "properties": { - "studySpec": { - "description": "Study configuration of the HyperparameterTuningJob.", - "$ref": "GoogleCloudAiplatformV1StudySpec" - }, - "trialJobSpec": { - "description": "The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.", - "$ref": "GoogleCloudAiplatformV1CustomJobSpec" - }, - "maxTrialCount": { - "description": "The desired total number of Trials.", - "type": "integer", - "format": "int32" - }, - "parallelTrialCount": { - "description": "The desired number of Trials to run in parallel.", - "type": "integer", - "format": "int32" + "instances": { + "description": "Required. Repeated tool parameter key match instances.", + "items": { + "$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchInstance" + }, + "type": "array" }, - "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.", - "type": "integer", - "format": "int32" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchSpec", + "description": "Required. Spec for tool parameter key match metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata", - "type": "object", + "GoogleCloudAiplatformV1ToolParameterKeyMatchInstance": { + "description": "Spec for tool parameter key match instance.", + "id": "GoogleCloudAiplatformV1ToolParameterKeyMatchInstance", "properties": { - "backingHyperparameterTuningJob": { - "description": "The resource name of the HyperparameterTuningJob that has been created to carry out this HyperparameterTuning task.", + "prediction": { + "description": "Required. Output of the evaluated model.", "type": "string" }, - "bestTrialBackingCustomJob": { - "description": "The resource name of the CustomJob that has been created to run the best Trial of this HyperparameterTuning task.", + "reference": { + "description": "Required. Ground truth used to compare against the prediction.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting", - "description": "A TrainingJob that trains and uploads an AutoML Forecasting Model.", - "type": "object", + "GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue": { + "description": "Tool parameter key match metric value for an instance.", + "id": "GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue", "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs" - }, - "metadata": { - "description": "The metadata information.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata" + "score": { + "description": "Output only. Tool parameter key match score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs", - "type": "object", + "GoogleCloudAiplatformV1ToolParameterKeyMatchResults": { + "description": "Results for tool parameter key match metric.", + "id": "GoogleCloudAiplatformV1ToolParameterKeyMatchResults", "properties": { - "targetColumn": { - "description": "The name of the column that the Model is to predict values for. This column must be unavailable at forecast.", + "toolParameterKeyMatchMetricValues": { + "description": "Output only. Tool parameter key match metric values.", + "items": { + "$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ToolParameterKeyMatchSpec": { + "description": "Spec for tool parameter key match metric.", + "id": "GoogleCloudAiplatformV1ToolParameterKeyMatchSpec", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1TrainingConfig": { + "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.", + "id": "GoogleCloudAiplatformV1TrainingConfig", + "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" - }, - "timeSeriesIdentifierColumn": { - "description": "The name of the column that identifies the time series.", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1TrainingPipeline": { + "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.", + "id": "GoogleCloudAiplatformV1TrainingPipeline", + "properties": { + "createTime": { + "description": "Output only. Time when the TrainingPipeline was created.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "timeColumn": { - "description": "The name of the column that identifies time order in the time series. This column must be available at forecast.", + "displayName": { + "description": "Required. The user-defined name of this TrainingPipeline.", "type": "string" }, - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation" - } + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "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.", + "endTime": { + "description": "Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`.", + "format": "google-datetime", + "readOnly": true, "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.", - "type": "string", - "format": "int64" + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when the pipeline's state is `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.", + "readOnly": true }, - "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" + "inputDataConfig": { + "$ref": "GoogleCloudAiplatformV1InputDataConfig", + "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." }, - "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": { + "labels": { + "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.", + "type": "object" }, - "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.", - "type": "array", - "items": { - "type": "string" - } + "modelId": { + "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.", + "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" - } + "modelToUpload": { + "$ref": "GoogleCloudAiplatformV1Model", + "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." }, - "dataGranularity": { - "description": "Expected difference in time granularity between rows in the data.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity" + "name": { + "description": "Output only. Resource name of the TrainingPipeline.", + "readOnly": true, + "type": "string" }, - "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.", - "type": "string", - "format": "int64" + "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" }, - "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" + "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" }, - "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" - } + "state": { + "description": "Output only. The detailed state of the pipeline.", + "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" + ], + "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, + "type": "string" }, - "exportEvaluatedDataItemsConfig": { - "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig" + "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" }, - "windowConfig": { - "description": "Config containing strategy for generating sliding windows.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig" + "trainingTaskInputs": { + "description": "Required. The training task's parameter(s), as specified in the training_task_definition's `inputs`.", + "type": "any" }, - "quantiles": { - "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", - "items": { - "type": "number", - "format": "double" - } + "trainingTaskMetadata": { + "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.", + "readOnly": true, + "type": "any" }, - "validationOptions": { - "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", + "updateTime": { + "description": "Output only. Time when the TrainingPipeline was most recently updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" - }, - "additionalExperiments": { - "description": "Additional experiment flags for the time series forcasting training.", - "type": "array", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1Trajectory": { + "description": "Spec for trajectory.", + "id": "GoogleCloudAiplatformV1Trajectory", + "properties": { + "toolCalls": { + "description": "Required. Tool calls in the trajectory.", "items": { - "type": "string" - } - }, - "hierarchyConfig": { - "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig" + "$ref": "GoogleCloudAiplatformV1ToolCall" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation", - "type": "object", + "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput": { + "description": "Instances and metric spec for TrajectoryAnyOrderMatch metric.", + "id": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput", "properties": { - "auto": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation" + "instances": { + "description": "Required. Repeated TrajectoryAnyOrderMatch instance.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInstance" + }, + "type": "array" }, - "numeric": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchSpec", + "description": "Required. Spec for TrajectoryAnyOrderMatch metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInstance": { + "description": "Spec for TrajectoryAnyOrderMatch instance.", + "id": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInstance", + "properties": { + "predictedTrajectory": { + "$ref": "GoogleCloudAiplatformV1Trajectory", + "description": "Required. Spec for predicted tool call trajectory." }, - "categorical": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation" + "referenceTrajectory": { + "$ref": "GoogleCloudAiplatformV1Trajectory", + "description": "Required. Spec for reference tool call trajectory." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchMetricValue": { + "description": "TrajectoryAnyOrderMatch metric value for an instance.", + "id": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchMetricValue", + "properties": { + "score": { + "description": "Output only. TrajectoryAnyOrderMatch score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchResults": { + "description": "Results for TrajectoryAnyOrderMatch metric.", + "id": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchResults", + "properties": { + "trajectoryAnyOrderMatchMetricValues": { + "description": "Output only. TrajectoryAnyOrderMatch metric values.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchMetricValue" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchSpec": { + "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.", + "id": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchSpec", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1TrajectoryExactMatchInput": { + "description": "Instances and metric spec for TrajectoryExactMatch metric.", + "id": "GoogleCloudAiplatformV1TrajectoryExactMatchInput", + "properties": { + "instances": { + "description": "Required. Repeated TrajectoryExactMatch instance.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchInstance" + }, + "type": "array" }, - "timestamp": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchSpec", + "description": "Required. Spec for TrajectoryExactMatch metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1TrajectoryExactMatchInstance": { + "description": "Spec for TrajectoryExactMatch instance.", + "id": "GoogleCloudAiplatformV1TrajectoryExactMatchInstance", + "properties": { + "predictedTrajectory": { + "$ref": "GoogleCloudAiplatformV1Trajectory", + "description": "Required. Spec for predicted tool call trajectory." }, - "text": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation" + "referenceTrajectory": { + "$ref": "GoogleCloudAiplatformV1Trajectory", + "description": "Required. Spec for reference tool call trajectory." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation", - "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", - "type": "object", + "GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue": { + "description": "TrajectoryExactMatch metric value for an instance.", + "id": "GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue", "properties": { - "columnName": { - "type": "string" + "score": { + "description": "Output only. TrajectoryExactMatch score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation", - "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", + "GoogleCloudAiplatformV1TrajectoryExactMatchResults": { + "description": "Results for TrajectoryExactMatch metric.", + "id": "GoogleCloudAiplatformV1TrajectoryExactMatchResults", "properties": { - "columnName": { - "type": "string" + "trajectoryExactMatchMetricValues": { + "description": "Output only. TrajectoryExactMatch metric values.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation", - "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", + "GoogleCloudAiplatformV1TrajectoryExactMatchSpec": { + "description": "Spec for TrajectoryExactMatch metric - returns 1 if tool calls in the reference trajectory exactly match the predicted trajectory, else 0.", + "id": "GoogleCloudAiplatformV1TrajectoryExactMatchSpec", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1TrajectoryInOrderMatchInput": { + "description": "Instances and metric spec for TrajectoryInOrderMatch metric.", + "id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchInput", "properties": { - "columnName": { - "type": "string" + "instances": { + "description": "Required. Repeated TrajectoryInOrderMatch instance.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance" + }, + "type": "array" + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchSpec", + "description": "Required. Spec for TrajectoryInOrderMatch metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation", - "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", + "GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance": { + "description": "Spec for TrajectoryInOrderMatch instance.", + "id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance", "properties": { - "columnName": { - "type": "string" + "predictedTrajectory": { + "$ref": "GoogleCloudAiplatformV1Trajectory", + "description": "Required. Spec for predicted tool call trajectory." }, - "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" + "referenceTrajectory": { + "$ref": "GoogleCloudAiplatformV1Trajectory", + "description": "Required. Spec for reference tool call trajectory." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation", - "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", + "GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue": { + "description": "TrajectoryInOrderMatch metric value for an instance.", + "id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue", "properties": { - "columnName": { - "type": "string" + "score": { + "description": "Output only. TrajectoryInOrderMatch score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity", - "description": "A duration of time expressed in time granularity units.", - "type": "object", + "GoogleCloudAiplatformV1TrajectoryInOrderMatchResults": { + "description": "Results for TrajectoryInOrderMatch metric.", + "id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchResults", "properties": { - "unit": { - "description": "The time granularity unit of this time period. The supported units are: * \"minute\" * \"hour\" * \"day\" * \"week\" * \"month\" * \"year\"", - "type": "string" - }, - "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.", - "type": "string", - "format": "int64" + "trajectoryInOrderMatchMetricValues": { + "description": "Output only. TrajectoryInOrderMatch metric values.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata", - "description": "Model metadata specific to Seq2Seq Plus Forecasting.", - "type": "object", + "GoogleCloudAiplatformV1TrajectoryInOrderMatchSpec": { + "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.", + "id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchSpec", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1TrajectoryPrecisionInput": { + "description": "Instances and metric spec for TrajectoryPrecision metric.", + "id": "GoogleCloudAiplatformV1TrajectoryPrecisionInput", "properties": { - "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.", - "type": "string", - "format": "int64" + "instances": { + "description": "Required. Repeated TrajectoryPrecision instance.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionInstance" + }, + "type": "array" }, - "evaluatedDataItemsBigqueryUri": { - "description": "BigQuery destination uri for exported evaluated examples.", - "type": "string" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionSpec", + "description": "Required. Spec for TrajectoryPrecision metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting", - "description": "A TrainingJob that trains and uploads an AutoML Forecasting Model.", - "type": "object", + "GoogleCloudAiplatformV1TrajectoryPrecisionInstance": { + "description": "Spec for TrajectoryPrecision instance.", + "id": "GoogleCloudAiplatformV1TrajectoryPrecisionInstance", "properties": { - "inputs": { - "description": "The input parameters of this TrainingJob.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs" + "predictedTrajectory": { + "$ref": "GoogleCloudAiplatformV1Trajectory", + "description": "Required. Spec for predicted tool call trajectory." }, - "metadata": { - "description": "The metadata information.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata" + "referenceTrajectory": { + "$ref": "GoogleCloudAiplatformV1Trajectory", + "description": "Required. Spec for reference tool call trajectory." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs", - "type": "object", + "GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue": { + "description": "TrajectoryPrecision metric value for an instance.", + "id": "GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue", "properties": { - "targetColumn": { - "description": "The name of the column that the Model is to predict values for. This column must be unavailable at forecast.", - "type": "string" - }, - "timeSeriesIdentifierColumn": { - "description": "The name of the column that identifies the time series.", - "type": "string" - }, - "timeColumn": { - "description": "The name of the column that identifies time order in the time series. This column must be available at forecast.", - "type": "string" - }, - "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.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation" - } - }, - "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" - }, - "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.", - "type": "string", - "format": "int64" - }, - "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" - }, - "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" - } - }, - "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.", - "type": "array", - "items": { - "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" - } - }, - "dataGranularity": { - "description": "Expected difference in time granularity between rows in the data.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity" - }, - "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.", - "type": "string", - "format": "int64" - }, - "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" - }, - "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" - } - }, - "exportEvaluatedDataItemsConfig": { - "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig" - }, - "windowConfig": { - "description": "Config containing strategy for generating sliding windows.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig" - }, - "quantiles": { - "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", - "items": { - "type": "number", - "format": "double" - } - }, - "validationOptions": { - "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", - "type": "string" - }, - "additionalExperiments": { - "description": "Additional experiment flags for the time series forcasting training.", - "type": "array", + "score": { + "description": "Output only. TrajectoryPrecision score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1TrajectoryPrecisionResults": { + "description": "Results for TrajectoryPrecision metric.", + "id": "GoogleCloudAiplatformV1TrajectoryPrecisionResults", + "properties": { + "trajectoryPrecisionMetricValues": { + "description": "Output only. TrajectoryPrecision metric values.", "items": { - "type": "string" - } - }, - "hierarchyConfig": { - "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies.", - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig" + "$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation", - "type": "object", + "GoogleCloudAiplatformV1TrajectoryPrecisionSpec": { + "description": "Spec for TrajectoryPrecision metric - returns a float score based on average precision of individual tool calls.", + "id": "GoogleCloudAiplatformV1TrajectoryPrecisionSpec", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1TrajectoryRecallInput": { + "description": "Instances and metric spec for TrajectoryRecall metric.", + "id": "GoogleCloudAiplatformV1TrajectoryRecallInput", "properties": { - "auto": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation" - }, - "numeric": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation" - }, - "categorical": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation" - }, - "timestamp": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation" + "instances": { + "description": "Required. Repeated TrajectoryRecall instance.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrajectoryRecallInstance" + }, + "type": "array" }, - "text": { - "$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1TrajectoryRecallSpec", + "description": "Required. Spec for TrajectoryRecall metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation", - "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", - "type": "object", + "GoogleCloudAiplatformV1TrajectoryRecallInstance": { + "description": "Spec for TrajectoryRecall instance.", + "id": "GoogleCloudAiplatformV1TrajectoryRecallInstance", "properties": { - "columnName": { - "type": "string" + "predictedTrajectory": { + "$ref": "GoogleCloudAiplatformV1Trajectory", + "description": "Required. Spec for predicted tool call trajectory." + }, + "referenceTrajectory": { + "$ref": "GoogleCloudAiplatformV1Trajectory", + "description": "Required. Spec for reference tool call trajectory." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation", - "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", + "GoogleCloudAiplatformV1TrajectoryRecallMetricValue": { + "description": "TrajectoryRecall metric value for an instance.", + "id": "GoogleCloudAiplatformV1TrajectoryRecallMetricValue", "properties": { - "columnName": { - "type": "string" + "score": { + "description": "Output only. TrajectoryRecall score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation", - "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", + "GoogleCloudAiplatformV1TrajectoryRecallResults": { + "description": "Results for TrajectoryRecall metric.", + "id": "GoogleCloudAiplatformV1TrajectoryRecallResults", "properties": { - "columnName": { - "type": "string" + "trajectoryRecallMetricValues": { + "description": "Output only. TrajectoryRecall metric values.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrajectoryRecallMetricValue" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation", - "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", + "GoogleCloudAiplatformV1TrajectoryRecallSpec": { + "description": "Spec for TrajectoryRecall metric - returns a float score based on average recall of individual tool calls.", + "id": "GoogleCloudAiplatformV1TrajectoryRecallSpec", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1TrajectorySingleToolUseInput": { + "description": "Instances and metric spec for TrajectorySingleToolUse metric.", + "id": "GoogleCloudAiplatformV1TrajectorySingleToolUseInput", "properties": { - "columnName": { - "type": "string" + "instances": { + "description": "Required. Repeated TrajectorySingleToolUse instance.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseInstance" + }, + "type": "array" }, - "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" + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseSpec", + "description": "Required. Spec for TrajectorySingleToolUse metric." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation", - "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", + "GoogleCloudAiplatformV1TrajectorySingleToolUseInstance": { + "description": "Spec for TrajectorySingleToolUse instance.", + "id": "GoogleCloudAiplatformV1TrajectorySingleToolUseInstance", "properties": { - "columnName": { - "type": "string" + "predictedTrajectory": { + "$ref": "GoogleCloudAiplatformV1Trajectory", + "description": "Required. Spec for predicted tool call trajectory." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity", - "description": "A duration of time expressed in time granularity units.", - "type": "object", + "GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue": { + "description": "TrajectorySingleToolUse metric value for an instance.", + "id": "GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue", "properties": { - "unit": { - "description": "The time granularity unit of this time period. The supported units are: * \"minute\" * \"hour\" * \"day\" * \"week\" * \"month\" * \"year\"", - "type": "string" - }, - "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.", - "type": "string", - "format": "int64" + "score": { + "description": "Output only. TrajectorySingleToolUse score.", + "format": "float", + "readOnly": true, + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata", - "description": "Model metadata specific to TFT Forecasting.", - "type": "object", + "GoogleCloudAiplatformV1TrajectorySingleToolUseResults": { + "description": "Results for TrajectorySingleToolUse metric.", + "id": "GoogleCloudAiplatformV1TrajectorySingleToolUseResults", "properties": { - "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.", - "type": "string", - "format": "int64" - }, - "evaluatedDataItemsBigqueryUri": { - "description": "BigQuery destination uri for exported evaluated examples.", - "type": "string" + "trajectorySingleToolUseMetricValues": { + "description": "Output only. TrajectorySingleToolUse metric values.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue" + }, + "readOnly": true, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictionResult": { - "id": "GoogleCloudAiplatformV1SchemaPredictionResult", - "description": "Represents a line of JSONL in the batch prediction output file.", - "type": "object", + "GoogleCloudAiplatformV1TrajectorySingleToolUseSpec": { + "description": "Spec for TrajectorySingleToolUse metric - returns 1 if tool is present in the predicted trajectory, else 0.", + "id": "GoogleCloudAiplatformV1TrajectorySingleToolUseSpec", "properties": { - "instance": { - "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.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } - }, - "key": { - "description": "Optional user-provided key from the input instance.", + "toolName": { + "description": "Required. Spec for tool name to be checked for in the predicted trajectory.", "type": "string" - }, - "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": "GoogleCloudAiplatformV1SchemaPredictionResultError" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictionResultError": { - "id": "GoogleCloudAiplatformV1SchemaPredictionResultError", - "type": "object", + "GoogleCloudAiplatformV1Transcription": { + "description": "Audio transcription in Server Content.", + "id": "GoogleCloudAiplatformV1Transcription", "properties": { - "status": { - "description": "Error status. This will be serialized into the enum name e.g. \"NOT_FOUND\".", - "type": "string", - "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" - ], - "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" - ] + "finished": { + "description": "Optional. The bool indicates the end of the transcription.", + "type": "boolean" }, - "message": { - "description": "Error message with additional details.", + "text": { + "description": "Optional. Transcription text.", "type": "string" } - } + }, + "type": "object" }, - "CloudAiLargeModelsVisionGenerateVideoResponse": { - "id": "CloudAiLargeModelsVisionGenerateVideoResponse", - "description": "Generate video response.", - "type": "object", + "GoogleCloudAiplatformV1Trial": { + "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.", + "id": "GoogleCloudAiplatformV1Trial", "properties": { - "generatedSamples": { - "description": "The generates samples.", - "type": "array", - "items": { - "$ref": "CloudAiLargeModelsVisionMedia" - } - }, - "raiMediaFilteredCount": { - "description": "Returns if any videos were filtered due to RAI policies.", - "type": "integer", - "format": "int32" + "clientId": { + "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, + "type": "string" }, - "raiMediaFilteredReasons": { - "description": "Returns rai failure reasons if any.", - "type": "array", - "items": { - "type": "string" - } + "customJob": { + "description": "Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.", + "readOnly": true, + "type": "string" }, - "videos": { - "description": "List of videos, used to align naming with the external response.", - "type": "array", - "items": { - "$ref": "CloudAiLargeModelsVisionGenerateVideoResponseVideo" - } - } - } - }, - "CloudAiLargeModelsVisionMedia": { - "id": "CloudAiLargeModelsVisionMedia", - "description": "Media.", - "type": "object", - "properties": { - "image": { - "description": "Image.", - "$ref": "CloudAiLargeModelsVisionImage" + "endTime": { + "description": "Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "video": { - "description": "Video", - "$ref": "CloudAiLargeModelsVisionVideo" - } - } - }, - "CloudAiLargeModelsVisionImage": { - "id": "CloudAiLargeModelsVisionImage", - "description": "Image.", - "type": "object", - "properties": { - "image": { - "description": "Raw bytes.", - "type": "string", - "format": "byte" + "finalMeasurement": { + "$ref": "GoogleCloudAiplatformV1Measurement", + "description": "Output only. The final measurement containing the objective value.", + "readOnly": true }, - "uri": { - "description": "Path to another storage (typically Google Cloud Storage).", + "id": { + "description": "Output only. The identifier of the Trial assigned by the service.", + "readOnly": true, "type": "string" }, - "encoding": { - "description": "Image encoding, encoded as \"image/png\" or \"image/jpg\".", + "infeasibleReason": { + "description": "Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is `INFEASIBLE`.", + "readOnly": true, "type": "string" }, - "imageRaiScores": { - "description": "RAI scores for generated image.", - "$ref": "CloudAiLargeModelsVisionImageRAIScores" + "measurements": { + "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": "GoogleCloudAiplatformV1Measurement" + }, + "readOnly": true, + "type": "array" }, - "raiInfo": { - "description": "RAI info for image.", - "$ref": "CloudAiLargeModelsVisionRaiInfo" + "name": { + "description": "Output only. Resource name of the Trial assigned by the service.", + "readOnly": true, + "type": "string" }, - "semanticFilterResponse": { - "description": "Semantic filter info for image.", - "$ref": "CloudAiLargeModelsVisionSemanticFilterResponse" + "parameters": { + "description": "Output only. The parameters of the Trial.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrialParameter" + }, + "readOnly": true, + "type": "array" }, - "text": { - "description": "Text/Expanded text input for imagen.", + "startTime": { + "description": "Output only. Time when the Trial was started.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "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" + "state": { + "description": "Output only. The detailed state of the Trial.", + "enum": [ + "STATE_UNSPECIFIED", + "REQUESTED", + "ACTIVE", + "STOPPING", + "SUCCEEDED", + "INFEASIBLE" + ], + "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." + ], + "readOnly": true, + "type": "string" }, - "imageSize": { - "description": "Image size. The size of the image. Can be self reported, or computed from the image bytes.", - "$ref": "CloudAiLargeModelsVisionImageImageSize" + "webAccessUris": { + "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.", + "readOnly": true, + "type": "object" } - } + }, + "type": "object" }, - "CloudAiLargeModelsVisionImageRAIScores": { - "id": "CloudAiLargeModelsVisionImageRAIScores", - "description": "RAI scores for generated image returned.", - "type": "object", + "GoogleCloudAiplatformV1TrialContext": { + "id": "GoogleCloudAiplatformV1TrialContext", "properties": { - "agileWatermarkDetectionScore": { - "description": "Agile watermark score for image.", - "type": "number", - "format": "double" + "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" + }, + "parameters": { + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1TrialParameter" + }, + "type": "array" } - } + }, + "type": "object" }, - "CloudAiLargeModelsVisionRaiInfo": { - "id": "CloudAiLargeModelsVisionRaiInfo", - "description": "Next ID: 6", - "type": "object", + "GoogleCloudAiplatformV1TrialParameter": { + "description": "A message representing a parameter to be tuned.", + "id": "GoogleCloudAiplatformV1TrialParameter", "properties": { - "raiCategories": { - "description": "List of rai categories' information to return", - "type": "array", - "items": { - "type": "string" - } - }, - "scores": { - "description": "List of rai scores mapping to the rai categories. Rounded to 1 decimal place.", - "type": "array", - "items": { - "type": "number", - "format": "float" - } - }, - "blockedEntities": { - "description": "List of blocked entities from the blocklist if it is detected.", - "type": "array", - "items": { - "type": "string" - } - }, - "detectedLabels": { - "description": "The list of detected labels for different rai categories.", - "type": "array", - "items": { - "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabels" - } - }, - "modelName": { - "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.", + "parameterId": { + "description": "Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters.", + "readOnly": true, "type": "string" + }, + "value": { + "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'.", + "readOnly": true, + "type": "any" } - } + }, + "type": "object" }, - "CloudAiLargeModelsVisionRaiInfoDetectedLabels": { - "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabels", - "description": "Filters returning list of deteceted labels, scores, and bounding boxes.", - "type": "object", + "GoogleCloudAiplatformV1TunedModel": { + "description": "The Model Registry Model and Online Prediction Endpoint associated with this TuningJob.", + "id": "GoogleCloudAiplatformV1TunedModel", "properties": { - "raiCategory": { - "description": "The RAI category for the deteceted labels.", + "checkpoints": { + "description": "Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.", + "items": { + "$ref": "GoogleCloudAiplatformV1TunedModelCheckpoint" + }, + "readOnly": true, + "type": "array" + }, + "endpoint": { + "description": "Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.", + "readOnly": true, "type": "string" }, - "entities": { - "description": "The list of detected entities for the rai signal.", - "type": "array", - "items": { - "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity" - } + "model": { + "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, + "type": "string" } - } + }, + "type": "object" }, - "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity": { - "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity", - "description": "The properties for a detected entity from the rai signal.", - "type": "object", + "GoogleCloudAiplatformV1TunedModelCheckpoint": { + "description": "TunedModelCheckpoint for the Tuned Model of a Tuning Job.", + "id": "GoogleCloudAiplatformV1TunedModelCheckpoint", "properties": { - "mid": { - "description": "MID of the label", + "checkpointId": { + "description": "The ID of the checkpoint.", "type": "string" }, - "description": { - "description": "Description of the label", + "endpoint": { + "description": "The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.", "type": "string" }, - "score": { - "description": "Confidence score of the label", - "type": "number", - "format": "float" - }, - "boundingBox": { - "description": "Bounding box of the label", - "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox" + "epoch": { + "description": "The epoch of the checkpoint.", + "format": "int64", + "type": "string" }, - "iouScore": { - "description": "The intersection ratio between the detection bounding box and the mask.", - "type": "number", - "format": "float" + "step": { + "description": "The step of the checkpoint.", + "format": "int64", + "type": "string" } - } + }, + "type": "object" }, - "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox": { - "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox", - "description": "An integer bounding box of original pixels of the image for the detected labels.", - "type": "object", + "GoogleCloudAiplatformV1TunedModelRef": { + "description": "TunedModel Reference for legacy model migration.", + "id": "GoogleCloudAiplatformV1TunedModelRef", "properties": { - "x1": { - "description": "The X coordinate of the top-left corner, in pixels.", - "type": "integer", - "format": "int32" - }, - "y1": { - "description": "The Y coordinate of the top-left corner, in pixels.", - "type": "integer", - "format": "int32" + "pipelineJob": { + "description": "Support migration from tuning job list page, from bison model to gemini model.", + "type": "string" }, - "x2": { - "description": "The X coordinate of the bottom-right corner, in pixels.", - "type": "integer", - "format": "int32" + "tunedModel": { + "description": "Support migration from model registry.", + "type": "string" }, - "y2": { - "description": "The Y coordinate of the bottom-right corner, in pixels.", - "type": "integer", - "format": "int32" + "tuningJob": { + "description": "Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above.", + "type": "string" } - } + }, + "type": "object" }, - "CloudAiLargeModelsVisionSemanticFilterResponse": { - "id": "CloudAiLargeModelsVisionSemanticFilterResponse", - "type": "object", + "GoogleCloudAiplatformV1TuningDataStats": { + "description": "The tuning data statistic values for TuningJob.", + "id": "GoogleCloudAiplatformV1TuningDataStats", "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" + "preferenceOptimizationDataStats": { + "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationDataStats", + "description": "Output only. Statistics for preference optimization.", + "readOnly": true }, - "namedBoundingBoxes": { - "description": "Class labels of the bounding boxes that failed the semantic filtering. Bounding box coordinates.", - "type": "array", - "items": { - "$ref": "CloudAiLargeModelsVisionNamedBoundingBox" - } + "supervisedTuningDataStats": { + "$ref": "GoogleCloudAiplatformV1SupervisedTuningDataStats", + "description": "The SFT Tuning data stats." } - } + }, + "type": "object" }, - "CloudAiLargeModelsVisionNamedBoundingBox": { - "id": "CloudAiLargeModelsVisionNamedBoundingBox", - "type": "object", + "GoogleCloudAiplatformV1TuningJob": { + "description": "Represents a TuningJob that runs with Google owned models.", + "id": "GoogleCloudAiplatformV1TuningJob", "properties": { - "x1": { - "type": "number", - "format": "float" + "baseModel": { + "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).", + "type": "string" }, - "x2": { - "type": "number", - "format": "float" + "createTime": { + "description": "Output only. Time when the TuningJob was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "y1": { - "type": "number", - "format": "float" + "description": { + "description": "Optional. The description of the TuningJob.", + "type": "string" }, - "y2": { - "type": "number", - "format": "float" + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "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." }, - "classes": { - "type": "array", - "items": { - "type": "string" - } + "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`.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "entities": { - "type": "array", - "items": { - "type": "string" - } + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", + "readOnly": true }, - "scores": { - "type": "array", + "evaluateDatasetRuns": { + "description": "Output only. Evaluation runs for the Tuning Job.", "items": { - "type": "number", - "format": "float" - } - } - } - }, - "CloudAiLargeModelsVisionImageImageSize": { - "id": "CloudAiLargeModelsVisionImageImageSize", - "description": "Image size.", - "type": "object", - "properties": { - "width": { - "type": "integer", - "format": "int32" + "$ref": "GoogleCloudAiplatformV1EvaluateDatasetRun" + }, + "readOnly": true, + "type": "array" }, - "height": { - "type": "integer", - "format": "int32" + "experiment": { + "description": "Output only. The Experiment associated with this TuningJob.", + "readOnly": true, + "type": "string" }, - "channels": { - "type": "integer", - "format": "int32" - } - } - }, - "CloudAiLargeModelsVisionVideo": { - "id": "CloudAiLargeModelsVisionVideo", - "description": "Video", - "type": "object", - "properties": { - "video": { - "description": "Raw bytes.", - "type": "string", - "format": "byte" + "labels": { + "additionalProperties": { + "type": "string" + }, + "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.", + "type": "object" }, - "uri": { - "description": "Path to another storage (typically Google Cloud Storage).", + "name": { + "description": "Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", + "readOnly": true, "type": "string" }, - "encodedVideo": { - "description": "Base 64 encoded video bytes.", - "type": "string" + "preTunedModel": { + "$ref": "GoogleCloudAiplatformV1PreTunedModel", + "description": "The pre-tuned model for continuous tuning." }, - "encoding": { - "description": "Video encoding, for example \"video/mp4\".", - "type": "string" + "preferenceOptimizationSpec": { + "$ref": "GoogleCloudAiplatformV1PreferenceOptimizationSpec", + "description": "Tuning Spec for Preference Optimization." }, - "text": { - "description": "Text/Expanded text input for Help Me Write.", - "type": "string" - } - } - }, - "CloudAiLargeModelsVisionGenerateVideoResponseVideo": { - "id": "CloudAiLargeModelsVisionGenerateVideoResponseVideo", - "type": "object", - "properties": { - "gcsUri": { - "description": "Cloud Storage URI where the generated video is written.", + "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" }, - "bytesBase64Encoded": { - "description": "Base64 encoded bytes string representing the video.", + "startTime": { + "description": "Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "mimeType": { - "description": "The MIME type of the content of the video. - video/mp4", - "type": "string" - } - } - }, - "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail": { - "id": "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail", - "description": "Create API error message for Vertex Pipeline.", - "type": "object", - "properties": { - "errorCause": { - "description": "The error root cause returned by CreatePipelineJob API.", - "type": "string", + "state": { + "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" + ], "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." + "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": [ - "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" - ] + "readOnly": true, + "type": "string" }, - "publicMessage": { - "description": "Public messages contains actionable items for the error cause.", + "supervisedTuningSpec": { + "$ref": "GoogleCloudAiplatformV1SupervisedTuningSpec", + "description": "Tuning Spec for Supervised Fine Tuning." + }, + "tunedModel": { + "$ref": "GoogleCloudAiplatformV1TunedModel", + "description": "Output only. The tuned model resources associated with this TuningJob.", + "readOnly": true + }, + "tunedModelDisplayName": { + "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.", + "type": "string" + }, + "tuningDataStats": { + "$ref": "GoogleCloudAiplatformV1TuningDataStats", + "description": "Output only. The tuning data statistics associated with this TuningJob.", + "readOnly": true + }, + "updateTime": { + "description": "Output only. Time when the TuningJob was most recently updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } - } - }, - "GoogleCloudAiplatformV1CreateDatasetOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateDatasetOperationMetadata", - "description": "Runtime operation information for DatasetService.CreateDataset.", - "type": "object", - "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" - } - } - }, - "GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata": { - "id": "GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata", - "description": "Runtime operation information for DatasetService.CreateDatasetVersion.", - "type": "object", - "properties": { - "genericMetadata": { - "description": "The common part of the operation metadata.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" - } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata": { - "id": "GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata", - "description": "Runtime operation information for DatasetService.RestoreDatasetVersion.", - "type": "object", + "GoogleCloudAiplatformV1UndeployIndexOperationMetadata": { + "description": "Runtime operation information for IndexEndpointService.UndeployIndex.", + "id": "GoogleCloudAiplatformV1UndeployIndexOperationMetadata", "properties": { "genericMetadata": { - "description": "The common part of the operation metadata.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation", - "description": "Annotation details specific to image object detection.", - "type": "object", + "GoogleCloudAiplatformV1UndeployIndexRequest": { + "description": "Request message for IndexEndpointService.UndeployIndex.", + "id": "GoogleCloudAiplatformV1UndeployIndexRequest", "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.", + "deployedIndexId": { + "description": "Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.", "type": "string" - }, - "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" - }, - "yMin": { - "description": "The topmost coordinate of the bounding box.", - "type": "number", - "format": "double" - }, - "yMax": { - "description": "The bottommost coordinate of the bounding box.", - "type": "number", - "format": "double" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaImageClassificationAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaImageClassificationAnnotation", - "description": "Annotation details specific to image classification.", - "type": "object", + "GoogleCloudAiplatformV1UndeployIndexResponse": { + "description": "Response message for IndexEndpointService.UndeployIndex.", + "id": "GoogleCloudAiplatformV1UndeployIndexResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1UndeployModelOperationMetadata": { + "description": "Runtime operation information for EndpointService.UndeployModel.", + "id": "GoogleCloudAiplatformV1UndeployModelOperationMetadata", "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" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaImageDataItem": { - "id": "GoogleCloudAiplatformV1SchemaImageDataItem", - "description": "Payload of Image DataItem.", - "type": "object", + "GoogleCloudAiplatformV1UndeployModelRequest": { + "description": "Request message for EndpointService.UndeployModel.", + "id": "GoogleCloudAiplatformV1UndeployModelRequest", "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.", + "deployedModelId": { + "description": "Required. The ID of the DeployedModel to be undeployed from the Endpoint.", "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", - "readOnly": true, - "type": "string" + "trafficSplit": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "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.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaImageDatasetMetadata": { - "id": "GoogleCloudAiplatformV1SchemaImageDatasetMetadata", - "description": "The metadata of Datasets that contain Image DataItems.", - "type": "object", + "GoogleCloudAiplatformV1UndeployModelResponse": { + "description": "Response message for EndpointService.UndeployModel.", + "id": "GoogleCloudAiplatformV1UndeployModelResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1UnmanagedContainerModel": { + "description": "Contains model information necessary to perform batch prediction without requiring a full model import.", + "id": "GoogleCloudAiplatformV1UnmanagedContainerModel", "properties": { - "dataItemSchemaUri": { - "description": "Points to a YAML file stored on Google Cloud Storage describing payload of the Image DataItems that belong to this Dataset.", + "artifactUri": { + "description": "The path to the directory containing the Model artifact and any of its supporting files.", "type": "string" }, - "gcsBucket": { - "description": "Google Cloud Storage Bucket name that contains the blob data of this Dataset.", - "type": "string" + "containerSpec": { + "$ref": "GoogleCloudAiplatformV1ModelContainerSpec", + "description": "Input only. The specification of the container that is to be used when deploying this Model." + }, + "predictSchemata": { + "$ref": "GoogleCloudAiplatformV1PredictSchemata", + "description": "Contains the schemata used in Model's predictions and explanations" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation", - "description": "Annotation details specific to image segmentation.", - "type": "object", + "GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata": { + "description": "Runtime operation information for UpdateDeploymentResourcePool method.", + "id": "GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata", "properties": { - "maskAnnotation": { - "description": "Mask based segmentation annotation. Only one mask annotation can exist for one image.", - "$ref": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation" - }, - "polygonAnnotation": { - "description": "Polygon annotation.", - "$ref": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation" - }, - "polylineAnnotation": { - "description": "Polyline annotation.", - "$ref": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation", - "description": "The mask based segmentation annotation.", - "type": "object", + "GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest": { + "description": "Request message for EndpointService.UpdateEndpointLongRunning.", + "id": "GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest", "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": { - "description": "The mapping between color and AnnotationSpec for this Annotation.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaAnnotationSpecColor" - } + "endpoint": { + "$ref": "GoogleCloudAiplatformV1Endpoint", + "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." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaAnnotationSpecColor": { - "id": "GoogleCloudAiplatformV1SchemaAnnotationSpecColor", - "description": "An entry of mapping between color and AnnotationSpec. The mapping is used in segmentation mask.", - "type": "object", + "GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata": { + "description": "Runtime operation information for ModelService.UpdateExplanationDataset.", + "id": "GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata", "properties": { - "color": { - "description": "The color of the AnnotationSpec in a segmentation mask.", - "$ref": "GoogleTypeColor" - }, - "displayName": { - "description": "The display name of the AnnotationSpec represented by the color in the segmentation mask.", - "type": "string" - }, - "id": { - "description": "The ID of the AnnotationSpec represented by the color in the segmentation mask.", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The common part of the operation metadata." } - } + }, + "type": "object" }, - "GoogleTypeColor": { - "id": "GoogleTypeColor", - "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(''); }; // ...", - "type": "object", + "GoogleCloudAiplatformV1UpdateExplanationDatasetRequest": { + "description": "Request message for ModelService.UpdateExplanationDataset.", + "id": "GoogleCloudAiplatformV1UpdateExplanationDatasetRequest", "properties": { - "red": { - "description": "The amount of red in the color as a value in the interval [0, 1].", - "type": "number", - "format": "float" - }, - "green": { - "description": "The amount of green in the color as a value in the interval [0, 1].", - "type": "number", - "format": "float" - }, - "blue": { - "description": "The amount of blue in the color as a value in the interval [0, 1].", - "type": "number", - "format": "float" - }, - "alpha": { - "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).", - "type": "number", - "format": "float" + "examples": { + "$ref": "GoogleCloudAiplatformV1Examples", + "description": "The example config containing the location of the dataset." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation", - "description": "Represents a polygon in image.", - "type": "object", + "GoogleCloudAiplatformV1UpdateExplanationDatasetResponse": { + "description": "Response message of ModelService.UpdateExplanationDataset operation.", + "id": "GoogleCloudAiplatformV1UpdateExplanationDatasetResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata": { + "description": "Details of operations that perform update FeatureGroup.", + "id": "GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata", "properties": { - "vertexes": { - "description": "The vertexes are connected one by one and the last vertex is connected to the first one to represent a polygon.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaVertex" - } - }, - "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" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for FeatureGroup." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaVertex": { - "id": "GoogleCloudAiplatformV1SchemaVertex", - "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", - "type": "object", + "GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata": { + "description": "Details of operations that perform update FeatureOnlineStore.", + "id": "GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata", "properties": { - "x": { - "description": "X coordinate.", - "type": "number", - "format": "double" - }, - "y": { - "description": "Y coordinate.", - "type": "number", - "format": "double" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for FeatureOnlineStore." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation", - "description": "Represents a polyline in image.", - "type": "object", + "GoogleCloudAiplatformV1UpdateFeatureOperationMetadata": { + "description": "Details of operations that perform update Feature.", + "id": "GoogleCloudAiplatformV1UpdateFeatureOperationMetadata", "properties": { - "vertexes": { - "description": "The vertexes are connected one by one and the last vertex in not connected to the first one.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaVertex" - } - }, - "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" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Feature Update." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTablesDatasetMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadata", - "description": "The metadata of Datasets that contain tables data.", - "type": "object", + "GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata": { + "description": "Details of operations that perform update FeatureView.", + "id": "GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata", "properties": { - "inputConfig": { - "$ref": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for FeatureView Update." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig": { - "id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig", - "description": "The tables Dataset's data source. The Dataset doesn't store the data directly, but only pointer(s) to its data.", - "type": "object", + "GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata": { + "description": "Details of operations that perform update Featurestore.", + "id": "GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata", "properties": { - "gcsSource": { - "$ref": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource" - }, - "bigquerySource": { - "$ref": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Featurestore." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource": { - "id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource", - "type": "object", + "GoogleCloudAiplatformV1UpdateIndexOperationMetadata": { + "description": "Runtime operation information for IndexService.UpdateIndex.", + "id": "GoogleCloudAiplatformV1UpdateIndexOperationMetadata", "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" - } + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + }, + "nearestNeighborSearchOperationMetadata": { + "$ref": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata", + "description": "The operation metadata with regard to Matching Engine Index operation." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource": { - "id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource", - "type": "object", + "GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata": { + "description": "Runtime operation information for JobService.UpdateModelDeploymentMonitoringJob.", + "id": "GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata", "properties": { - "uri": { - "description": "The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTextClassificationAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaTextClassificationAnnotation", - "description": "Annotation details specific to text classification.", - "type": "object", + "GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata": { + "description": "Details of operations that perform update PersistentResource.", + "id": "GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata", "properties": { - "annotationSpecId": { - "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for PersistentResource." }, - "displayName": { - "description": "The display name of the AnnotationSpec that this Annotation pertains to.", + "progressMessage": { + "description": "Progress Message for Update LRO", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTextDataItem": { - "id": "GoogleCloudAiplatformV1SchemaTextDataItem", - "description": "Payload of Text DataItem.", - "type": "object", + "GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata": { + "description": "Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool.", + "id": "GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata", "properties": { - "gcsUri": { - "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.", + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + }, + "specialistPool": { + "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}`", "readOnly": true, "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTextDatasetMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTextDatasetMetadata", - "description": "The metadata of Datasets that contain Text DataItems.", - "type": "object", + "GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata": { + "description": "Details of operations that perform update Tensorboard.", + "id": "GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata", "properties": { - "dataItemSchemaUri": { - "description": "Points to a YAML file stored on Google Cloud Storage describing payload of the Text DataItems that belong to this Dataset.", - "type": "string" - }, - "gcsBucket": { - "description": "Google Cloud Storage Bucket name that contains the blob data of this Dataset.", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Operation metadata for Tensorboard." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTextExtractionAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaTextExtractionAnnotation", - "description": "Annotation details specific to text extraction.", - "type": "object", + "GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata": { + "description": "Metadata information for NotebookService.UpgradeNotebookRuntime.", + "id": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata", "properties": { - "textSegment": { - "description": "The segment of the text content.", - "$ref": "GoogleCloudAiplatformV1SchemaTextSegment" - }, - "annotationSpecId": { - "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." }, - "displayName": { - "description": "The display name of the AnnotationSpec that this Annotation pertains to.", + "progressMessage": { + "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTextSegment": { - "id": "GoogleCloudAiplatformV1SchemaTextSegment", - "description": "The text segment inside of DataItem.", - "type": "object", + "GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest": { + "description": "Request message for NotebookService.UpgradeNotebookRuntime.", + "id": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1UploadModelOperationMetadata": { + "description": "Details of ModelService.UploadModel operation.", + "id": "GoogleCloudAiplatformV1UploadModelOperationMetadata", "properties": { - "startOffset": { - "description": "Zero-based character index of the first character of the text segment (counting characters from the beginning of the text).", - "type": "string", - "format": "uint64" - }, - "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" - }, - "content": { - "description": "The text content in the segment for output only.", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The common part of the operation metadata." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata", - "description": "The metadata of Datasets that contain Text Prompt data.", - "type": "object", + "GoogleCloudAiplatformV1UploadModelRequest": { + "description": "Request message for ModelService.UploadModel.", + "id": "GoogleCloudAiplatformV1UploadModelRequest", "properties": { - "text": { - "description": "The content of the prompt dataset.", - "type": "string" + "model": { + "$ref": "GoogleCloudAiplatformV1Model", + "description": "Required. The Model to create." }, - "gcsUri": { - "description": "The Google Cloud Storage URI that stores the prompt data.", + "modelId": { + "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.", "type": "string" }, - "temperature": { - "description": "Temperature value used for sampling set when the dataset was saved. This value is used to tune the degree of randomness.", - "type": "number", - "format": "float" - }, - "maxOutputTokens": { - "description": "Value of the maximum number of tokens generated set when the dataset was saved.", - "type": "string", - "format": "int64" - }, - "topK": { - "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.", - "type": "string", - "format": "int64" - }, - "topP": { - "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.", - "type": "number", - "format": "float" - }, - "promptType": { - "description": "Type of the prompt dataset.", + "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" }, - "groundingConfig": { - "description": "Grounding checking configuration.", - "$ref": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig" - }, - "stopSequences": { - "description": "Customized stop sequences.", - "type": "array", - "items": { - "type": "string" - } - }, - "candidateCount": { - "description": "Number of candidates.", - "type": "string", - "format": "int64" - }, - "note": { - "description": "User-created prompt note. Note size limit is 2KB.", + "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" - }, - "systemInstructionGcsUri": { - "description": "The Google Cloud Storage URI that stores the system instruction, starting with gs://.", + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1UploadModelResponse": { + "description": "Response message of ModelService.UploadModel operation.", + "id": "GoogleCloudAiplatformV1UploadModelResponse", + "properties": { + "model": { + "description": "The name of the uploaded Model resource. Format: `projects/{project}/locations/{location}/models/{model}`", "type": "string" }, - "hasPromptVariable": { - "description": "Whether the prompt dataset has prompt variable.", - "type": "boolean" - }, - "systemInstruction": { - "description": "The content of the prompt dataset system instruction.", + "modelVersionId": { + "description": "Output only. The version ID of the model that is uploaded.", + "readOnly": true, "type": "string" - }, - "seedEnabled": { - "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.", - "type": "boolean" - }, - "seedValue": { - "description": "The actual value of the seed.", - "type": "string", - "format": "int64" - }, - "logprobs": { - "description": "Whether or not the user has enabled logit probabilities in the model parameters.", - "type": "boolean" - }, - "promptApiSchema": { - "description": "The API schema of the prompt to support both UI and SDK usages.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptApiSchema" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig": { - "id": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig", - "description": "The configuration for grounding checking.", - "type": "object", + "GoogleCloudAiplatformV1UploadRagFileConfig": { + "description": "Config for uploading RagFile.", + "id": "GoogleCloudAiplatformV1UploadRagFileConfig", "properties": { - "sources": { - "description": "The sources for the grounding checking.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry" - } - }, - "disableAttribution": { - "description": "If set, skip finding claim attributions (i.e not generate grounding citation).", - "deprecated": true, - "type": "boolean" + "ragFileTransformationConfig": { + "$ref": "GoogleCloudAiplatformV1RagFileTransformationConfig", + "description": "Specifies the transformation config for RagFiles." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry": { - "id": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry", - "description": "Single source entry for the grounding checking.", - "type": "object", + "GoogleCloudAiplatformV1UploadRagFileRequest": { + "description": "Request message for VertexRagDataService.UploadRagFile.", + "id": "GoogleCloudAiplatformV1UploadRagFileRequest", "properties": { - "type": { - "description": "The type of the grounding checking source.", - "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." - ], - "enumDeprecated": [ - false, - false, - true, - false, - false - ], - "enum": [ - "UNSPECIFIED", - "WEB", - "ENTERPRISE", - "VERTEX_AI_SEARCH", - "INLINE" - ] + "ragFile": { + "$ref": "GoogleCloudAiplatformV1RagFile", + "description": "Required. The RagFile to upload." }, - "enterpriseDatastore": { - "description": "The uri of the Vertex AI Search data source. Deprecated. Use vertex_ai_search_datastore instead.", - "deprecated": true, - "type": "string" + "uploadRagFileConfig": { + "$ref": "GoogleCloudAiplatformV1UploadRagFileConfig", + "description": "Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1UploadRagFileResponse": { + "description": "Response message for VertexRagDataService.UploadRagFile.", + "id": "GoogleCloudAiplatformV1UploadRagFileResponse", + "properties": { + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error that occurred while processing the RagFile." }, - "vertexAiSearchDatastore": { - "description": "The uri of the Vertex AI Search data source.", - "type": "string" + "ragFile": { + "$ref": "GoogleCloudAiplatformV1RagFile", + "description": "The RagFile that had been uploaded into the RagCorpus." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1UpsertDatapointsRequest": { + "description": "Request message for IndexService.UpsertDatapoints", + "id": "GoogleCloudAiplatformV1UpsertDatapointsRequest", + "properties": { + "datapoints": { + "description": "A list of datapoints to be created/updated.", + "items": { + "$ref": "GoogleCloudAiplatformV1IndexDatapoint" + }, + "type": "array" }, - "inlineContext": { - "description": "The grounding text passed inline with the Predict API. It can support up to 1 million bytes.", + "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.", + "format": "google-fieldmask", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptApiSchema": { - "id": "GoogleCloudAiplatformV1SchemaPromptApiSchema", - "description": "The A2 schema of a prompt.", - "type": "object", + "GoogleCloudAiplatformV1UpsertDatapointsResponse": { + "description": "Response message for IndexService.UpsertDatapoints", + "id": "GoogleCloudAiplatformV1UpsertDatapointsResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1UrlContext": { + "description": "Tool to support URL context.", + "id": "GoogleCloudAiplatformV1UrlContext", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1UrlContextMetadata": { + "description": "Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", + "id": "GoogleCloudAiplatformV1UrlContextMetadata", "properties": { - "multimodalPrompt": { - "description": "Multimodal prompt which embeds preambles to prompt string.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt" - }, - "structuredPrompt": { - "description": "The prompt variation that stores preambles in separate fields.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt" - }, - "translationPrompt": { - "description": "The prompt variation for Translation use case.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt" - }, - "executions": { - "description": "A list of execution instances for constructing a ready-to-use prompt.", - "type": "array", + "urlMetadata": { + "description": "Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.", "items": { - "$ref": "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution" - } + "$ref": "GoogleCloudAiplatformV1UrlMetadata" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1UrlMetadata": { + "description": "The metadata for a single URL retrieval.", + "id": "GoogleCloudAiplatformV1UrlMetadata", + "properties": { + "retrievedUrl": { + "description": "The URL retrieved by the tool.", + "type": "string" }, - "apiSchemaVersion": { - "description": "The Schema version that represents changes to the API behavior.", + "urlRetrievalStatus": { + "description": "The status of the URL retrieval.", + "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" } - } - }, - "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt", - "description": "Prompt variation that embeds preambles to prompt string.", - "type": "object", - "properties": { - "promptMessage": { - "description": "The prompt message.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage" - } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage", - "description": "The prompt message that aligns with the prompt message in google.cloud.aiplatform.master.GenerateContentRequest.", - "type": "object", + "GoogleCloudAiplatformV1UsageMetadata": { + "description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", + "id": "GoogleCloudAiplatformV1UsageMetadata", "properties": { - "model": { - "description": "The model name.", - "type": "string" + "cacheTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" }, - "contents": { - "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.", - "type": "array", + "cachedContentTokenCount": { + "description": "Output only. The number of tokens in the cached content that was used for this request.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "candidatesTokenCount": { + "description": "The total number of tokens in the generated candidates.", + "format": "int32", + "type": "integer" + }, + "candidatesTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", "items": { - "$ref": "GoogleCloudAiplatformV1Content" - } + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" }, - "systemInstruction": { - "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.", - "$ref": "GoogleCloudAiplatformV1Content" + "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" }, - "tools": { - "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.", - "type": "array", + "promptTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", "items": { - "$ref": "GoogleCloudAiplatformV1Tool" - } + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" }, - "toolConfig": { - "description": "Tool config. This config is shared for all tools provided in the request.", - "$ref": "GoogleCloudAiplatformV1ToolConfig" + "thoughtsTokenCount": { + "description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "safetySettings": { - "description": "Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", - "type": "array", + "toolUsePromptTokenCount": { + "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", + "readOnly": true, + "type": "integer" + }, + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1SafetySetting" - } + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" }, - "generationConfig": { - "description": "Generation config.", - "$ref": "GoogleCloudAiplatformV1GenerationConfig" + "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" + }, + "trafficType": { + "description": "Output only. The traffic type for this request.", + "enum": [ + "TRAFFIC_TYPE_UNSPECIFIED", + "ON_DEMAND", + "ON_DEMAND_PRIORITY", + "ON_DEMAND_FLEX", + "PROVISIONED_THROUGHPUT" + ], + "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 Provisioned Throughput traffic." + ], + "readOnly": true, + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt", - "description": "Prompt variation that stores preambles in separate fields.", - "type": "object", + "GoogleCloudAiplatformV1UserActionReference": { + "description": "References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.", + "id": "GoogleCloudAiplatformV1UserActionReference", "properties": { - "promptMessage": { - "description": "The prompt message.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage" + "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" }, - "context": { - "description": "Preamble: The context of the prompt.", - "$ref": "GoogleCloudAiplatformV1Content" + "method": { + "description": "The method name of the API RPC call. For example, \"/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset\"", + "type": "string" }, - "inputPrefixes": { - "description": "Preamble: The input prefixes before each example input.", - "type": "array", - "items": { - "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" + }, + "GoogleCloudAiplatformV1Value": { + "description": "Value is the value of the field.", + "id": "GoogleCloudAiplatformV1Value", + "properties": { + "doubleValue": { + "description": "A double value.", + "format": "double", + "type": "number" }, - "outputPrefixes": { - "description": "Preamble: The output prefixes before each example output.", - "type": "array", - "items": { - "type": "string" - } + "intValue": { + "description": "An integer value.", + "format": "int64", + "type": "string" }, - "examples": { - "description": "Preamble: A set of examples for expected model response.", - "type": "array", + "stringValue": { + "description": "A string value.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1VertexAISearch": { + "description": "Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder", + "id": "GoogleCloudAiplatformV1VertexAISearch", + "properties": { + "dataStoreSpecs": { + "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.", "items": { - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPartList" - } + "$ref": "GoogleCloudAiplatformV1VertexAISearchDataStoreSpec" + }, + "type": "array" }, - "infillPrefix": { - "description": "Preamble: For infill prompt, the prefix before expected model response.", + "datastore": { + "description": "Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" }, - "infillSuffix": { - "description": "Preamble: For infill prompt, the suffix after expected model response.", + "engine": { + "description": "Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string" }, - "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": "GoogleCloudAiplatformV1SchemaPromptSpecPartList" - } + "filter": { + "description": "Optional. Filter strings to be passed to the search API.", + "type": "string" }, - "appBuilderData": { - "description": "Data for app builder use case.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderData" + "maxResults": { + "description": "Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecPartList": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecPartList", - "description": "A list of elements and information that make up a portion of prompt.", - "type": "object", + "GoogleCloudAiplatformV1VertexAISearchDataStoreSpec": { + "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": "GoogleCloudAiplatformV1VertexAISearchDataStoreSpec", "properties": { - "parts": { - "description": "A list of elements that can be part of a prompt.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1Part" - } + "dataStore": { + "description": "Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", + "type": "string" + }, + "filter": { + "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)", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderData": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderData", - "description": "Defines data for an application builder.", - "type": "object", + "GoogleCloudAiplatformV1VertexAiSearchConfig": { + "description": "Config for the Vertex AI Search.", + "id": "GoogleCloudAiplatformV1VertexAiSearchConfig", "properties": { - "codeRepositoryState": { - "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.", + "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" - }, - "linkedResources": { - "description": "Linked resources attached to the application by the user.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderDataLinkedResource" - } } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderDataLinkedResource": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderDataLinkedResource", - "description": "A linked resource attached to the application by the user.", - "type": "object", + "GoogleCloudAiplatformV1VertexMultimodalDatasetDestination": { + "description": "The details for a Vertex Multimodal Dataset output.", + "id": "GoogleCloudAiplatformV1VertexMultimodalDatasetDestination", "properties": { - "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" + "bigqueryDestination": { + "$ref": "GoogleCloudAiplatformV1BigQueryDestination", + "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": "A user-friendly name for the data source shown in the UI.", - "type": "string" - }, - "name": { - "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}", + "description": "Optional. Display name of the output dataset.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt", - "description": "Prompt variation for Translation use case.", - "type": "object", + "GoogleCloudAiplatformV1VertexMultimodalDatasetSource": { + "description": "The Vertex Multimodal Dataset for the input content.", + "id": "GoogleCloudAiplatformV1VertexMultimodalDatasetSource", "properties": { - "promptMessage": { - "description": "The prompt message.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage" - }, - "sourceLanguageCode": { - "description": "The source language code.", + "datasetName": { + "description": "Required. The resource name of the Vertex Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1VertexRagStore": { + "description": "Retrieve from Vertex RAG Store for grounding.", + "id": "GoogleCloudAiplatformV1VertexRagStore", + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1VertexRagStoreRagResource" + }, + "type": "array" }, - "targetLanguageCode": { - "description": "The target language code.", - "type": "string" + "ragRetrievalConfig": { + "$ref": "GoogleCloudAiplatformV1RagRetrievalConfig", + "description": "Optional. The retrieval config for the Rag query." }, - "option": { - "description": "The translation option.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption" + "similarityTopK": { + "deprecated": true, + "description": "Optional. Number of top k results to return from the selected corpora.", + "format": "int32", + "type": "integer" }, - "example": { - "description": "The translation example.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample" + "vectorDistanceThreshold": { + "deprecated": true, + "description": "Optional. Only return results with vector distance smaller than the threshold.", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption", - "description": "Optional settings for translation prompt.", - "type": "object", + "GoogleCloudAiplatformV1VertexRagStoreRagResource": { + "description": "The definition of the Rag resource.", + "id": "GoogleCloudAiplatformV1VertexRagStoreRagResource", "properties": { - "numberOfShots": { - "description": "How many shots to use.", - "type": "integer", - "format": "int32" + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample", - "description": "The translation example that contains reference sentences from various sources.", - "type": "object", + "GoogleCloudAiplatformV1VideoMetadata": { + "description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.", + "id": "GoogleCloudAiplatformV1VideoMetadata", "properties": { - "referenceSentencesFileInputs": { - "description": "The reference sentences from file.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput" - } + "endOffset": { + "description": "Optional. The end offset of the video.", + "format": "google-duration", + "type": "string" }, - "referenceSentencePairLists": { - "description": "The reference sentences from inline text.", - "type": "array", - "items": { - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList" - } + "fps": { + "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].", + "format": "double", + "type": "number" + }, + "startOffset": { + "description": "Optional. The start offset of the video.", + "format": "google-duration", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput", - "type": "object", + "GoogleCloudAiplatformV1VoiceConfig": { + "description": "Configuration for a voice.", + "id": "GoogleCloudAiplatformV1VoiceConfig", "properties": { - "fileInputSource": { - "description": "Inlined file source.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource" + "prebuiltVoiceConfig": { + "$ref": "GoogleCloudAiplatformV1PrebuiltVoiceConfig", + "description": "The configuration for a prebuilt voice." }, - "gcsInputSource": { - "description": "Cloud Storage file source.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource" + "replicatedVoiceConfig": { + "$ref": "GoogleCloudAiplatformV1ReplicatedVoiceConfig", + "description": "Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource", - "type": "object", + "GoogleCloudAiplatformV1WorkerPoolSpec": { + "description": "Represents the spec of a worker pool in a job.", + "id": "GoogleCloudAiplatformV1WorkerPoolSpec", "properties": { - "mimeType": { - "description": "The file's mime type.", - "type": "string" + "containerSpec": { + "$ref": "GoogleCloudAiplatformV1ContainerSpec", + "description": "The custom container task." }, - "content": { - "description": "The file's contents.", - "type": "string" + "diskSpec": { + "$ref": "GoogleCloudAiplatformV1DiskSpec", + "description": "Disk spec." }, - "displayName": { - "description": "The file's display name.", + "lustreMounts": { + "description": "Optional. List of Lustre mounts.", + "items": { + "$ref": "GoogleCloudAiplatformV1LustreMount" + }, + "type": "array" + }, + "machineSpec": { + "$ref": "GoogleCloudAiplatformV1MachineSpec", + "description": "Optional. Immutable. The specification of a single machine." + }, + "nfsMounts": { + "description": "Optional. List of NFS mount spec.", + "items": { + "$ref": "GoogleCloudAiplatformV1NfsMount" + }, + "type": "array" + }, + "pythonPackageSpec": { + "$ref": "GoogleCloudAiplatformV1PythonPackageSpec", + "description": "The Python packaged task." + }, + "replicaCount": { + "description": "Optional. The number of worker replicas to use for this worker pool.", + "format": "int64", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource", - "type": "object", + "GoogleCloudAiplatformV1WriteFeatureValuesPayload": { + "description": "Contains Feature values to be written for a specific entity.", + "id": "GoogleCloudAiplatformV1WriteFeatureValuesPayload", "properties": { - "inputUri": { - "description": "Source data URI. For example, `gs://my_bucket/my_object`.", + "entityId": { + "description": "Required. The ID of the entity.", "type": "string" + }, + "featureValues": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1FeatureValue" + }, + "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" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList", - "description": "A list of reference sentence pairs.", - "type": "object", + "GoogleCloudAiplatformV1WriteFeatureValuesRequest": { + "description": "Request message for FeaturestoreOnlineServingService.WriteFeatureValues.", + "id": "GoogleCloudAiplatformV1WriteFeatureValuesRequest", "properties": { - "referenceSentencePairs": { - "description": "Reference sentence pairs.", - "type": "array", + "payloads": { + "description": "Required. The entities to be written. Up to 100,000 feature values can be written across all `payloads`.", "items": { - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair" - } + "$ref": "GoogleCloudAiplatformV1WriteFeatureValuesPayload" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair": { - "id": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair", - "description": "A pair of sentences used as reference in source and target languages.", - "type": "object", + "GoogleCloudAiplatformV1WriteFeatureValuesResponse": { + "description": "Response message for FeaturestoreOnlineServingService.WriteFeatureValues.", + "id": "GoogleCloudAiplatformV1WriteFeatureValuesResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest": { + "description": "Request message for TensorboardService.WriteTensorboardExperimentData.", + "id": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest", "properties": { - "sourceSentence": { - "description": "Source sentence in the sentence pair.", + "writeRunDataRequests": { + "description": "Required. Requests containing per-run TensorboardTimeSeries data to write.", + "items": { + "$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse": { + "description": "Response message for TensorboardService.WriteTensorboardExperimentData.", + "id": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest": { + "description": "Request message for TensorboardService.WriteTensorboardRunData.", + "id": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest", + "properties": { + "tensorboardRun": { + "description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "type": "string" }, - "targetSentence": { - "description": "Target sentence in the sentence pair.", - "type": "string" + "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.", + "items": { + "$ref": "GoogleCloudAiplatformV1TimeSeriesData" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution": { - "id": "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution", - "description": "A prompt instance's parameters set that contains a set of variable values.", - "type": "object", + "GoogleCloudAiplatformV1WriteTensorboardRunDataResponse": { + "description": "Response message for TensorboardService.WriteTensorboardRunData.", + "id": "GoogleCloudAiplatformV1WriteTensorboardRunDataResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1XraiAttribution": { + "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.", + "id": "GoogleCloudAiplatformV1XraiAttribution", "properties": { - "arguments": { - "description": "Maps variable names to their value.", - "type": "object", - "additionalProperties": { - "$ref": "GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue" - } + "blurBaselineConfig": { + "$ref": "GoogleCloudAiplatformV1BlurBaselineConfig", + "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" + }, + "smoothGradConfig": { + "$ref": "GoogleCloudAiplatformV1SmoothGradConfig", + "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" + }, + "stepCount": { + "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.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue": { - "id": "GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue", - "description": "The value of a variable in prompt.", - "type": "object", + "GoogleCloudLocationListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "GoogleCloudLocationListLocationsResponse", "properties": { - "partList": { - "description": "The parts of the variable value.", - "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPartList" + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleCloudLocationLocation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTextSentimentAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaTextSentimentAnnotation", - "description": "Annotation details specific to text sentiment.", - "type": "object", + "GoogleCloudLocationLocation": { + "description": "A resource that represents a Google Cloud location.", + "id": "GoogleCloudLocationLocation", "properties": { - "sentiment": { - "description": "The sentiment score for text.", - "type": "integer", - "format": "int32" + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" }, - "sentimentMax": { - "description": "The sentiment max score for text.", - "type": "integer", - "format": "int32" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" }, - "annotationSpecId": { - "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, - "displayName": { - "description": "The display name of the AnnotationSpec that this Annotation pertains to.", + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata", - "description": "The metadata of SavedQuery contains TextSentiment Annotations.", - "type": "object", + "GoogleIamV1Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "id": "GoogleIamV1Binding", "properties": { - "sentimentMax": { - "description": "The maximum sentiment of sentiment Anntoation in this SavedQuery.", - "type": "integer", - "format": "int32" + "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)." + }, + "members": { + "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`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "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).", + "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata": { - "id": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata", - "description": "The metadata of Datasets that contain time series data.", - "type": "object", + "GoogleIamV1Policy": { + "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 < 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 < 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/).", + "id": "GoogleIamV1Policy", "properties": { - "inputConfig": { - "$ref": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig" + "bindings": { + "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`.", + "items": { + "$ref": "GoogleIamV1Binding" + }, + "type": "array" }, - "timeSeriesIdentifierColumn": { - "description": "The column name of the time series identifier column that identifies the time series.", + "etag": { + "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.", + "format": "byte", "type": "string" }, - "timeColumn": { - "description": "The column name of the time column that identifies time order in the time series.", - "type": "string" + "version": { + "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).", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig": { - "id": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig", - "description": "The time series Dataset's data source. The Dataset doesn't store the data directly, but only pointer(s) to its data.", - "type": "object", + "GoogleIamV1SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "GoogleIamV1SetIamPolicyRequest", "properties": { - "gcsSource": { - "$ref": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource" - }, - "bigquerySource": { - "$ref": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource" + "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." } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource": { - "id": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource", - "type": "object", + "GoogleIamV1TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "GoogleIamV1TestIamPermissionsResponse", "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", + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "items": { "type": "string" - } + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource": { - "id": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource", - "type": "object", + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "GoogleLongrunningListOperationsResponse", "properties": { - "uri": { - "description": "The URI of a BigQuery table.", + "nextPageToken": { + "description": "The standard List next-page token.", "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleLongrunningOperation" + }, + "type": "array" + }, + "unreachable": { + "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" + }, + "type": "array" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation", - "description": "Annotation details specific to video action recognition.", - "type": "object", + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", "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": "GoogleCloudAiplatformV1SchemaTimeSegment" + "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" }, - "annotationSpecId": { - "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", - "type": "string" + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." }, - "displayName": { - "description": "The display name of the AnnotationSpec that this Annotation pertains to.", + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "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" + }, + "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" - } - } - }, - "GoogleCloudAiplatformV1SchemaTimeSegment": { - "id": "GoogleCloudAiplatformV1SchemaTimeSegment", - "description": "A time period inside of a DataItem that has a time dimension (e.g. video).", - "type": "object", - "properties": { - "startTimeOffset": { - "description": "Start of the time segment (inclusive), represented as the duration since the start of the DataItem.", - "type": "string", - "format": "google-duration" }, - "endTimeOffset": { - "description": "End of the time segment (exclusive), represented as the duration since the start of the DataItem.", - "type": "string", - "format": "google-duration" + "response": { + "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`.", + "type": "object" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation", - "description": "Annotation details specific to video classification.", - "type": "object", + "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); }", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + }, + "GoogleRpcStatus": { + "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": { - "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": "GoogleCloudAiplatformV1SchemaTimeSegment" + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" }, - "annotationSpecId": { - "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", - "type": "string" + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" }, - "displayName": { - "description": "The display name of the AnnotationSpec that this Annotation pertains to.", + "message": { + "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.", "type": "string" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaVideoDataItem": { - "id": "GoogleCloudAiplatformV1SchemaVideoDataItem", - "description": "Payload of Video DataItem.", - "type": "object", + "GoogleTypeColor": { + "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 <= 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 << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", + "id": "GoogleTypeColor", "properties": { - "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" + "alpha": { + "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", + "type": "number" }, - "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" + "blue": { + "description": "The amount of blue in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "green": { + "description": "The amount of green in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "red": { + "description": "The amount of red in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaVideoDatasetMetadata": { - "id": "GoogleCloudAiplatformV1SchemaVideoDatasetMetadata", - "description": "The metadata of Datasets that contain Video DataItems.", - "type": "object", + "GoogleTypeDate": { + "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", + "id": "GoogleTypeDate", "properties": { - "dataItemSchemaUri": { - "description": "Points to a YAML file stored on Google Cloud Storage describing payload of the Video DataItems that belong to this Dataset.", - "type": "string" + "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.", + "format": "int32", + "type": "integer" }, - "gcsBucket": { - "description": "Google Cloud Storage Bucket name that contains the blob data of this Dataset.", - "type": "string" + "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" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation": { - "id": "GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation", - "description": "Annotation details specific to video object tracking.", - "type": "object", + "GoogleTypeExpr": { + "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() < 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.", + "id": "GoogleTypeExpr", "properties": { - "timeOffset": { - "description": "A time (frame) of a video to which this annotation pertains. Represented as the duration since the video's start.", - "type": "string", - "format": "google-duration" - }, - "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" - }, - "yMin": { - "description": "The topmost coordinate of the bounding box.", - "type": "number", - "format": "double" - }, - "yMax": { - "description": "The bottommost coordinate of the bounding box.", - "type": "number", - "format": "double" + "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" }, - "instanceId": { - "description": "The instance of the object, expressed as a positive integer. Used to track the same object across different frames.", - "type": "string", - "format": "int64" + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" }, - "annotationSpecId": { - "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", + "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" }, - "displayName": { - "description": "The display name of the AnnotationSpec that this Annotation pertains to.", + "title": { + "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.", "type": "string" } - } - }, - "GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata": { - "id": "GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata", - "type": "object", - "properties": { - "multiLabel": { - "description": "Whether or not the classification label is multi_label.", - "type": "boolean" - } - } - }, - "GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata": { - "id": "GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata", - "type": "object", - "properties": {} + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployOperationMetadata": { - "id": "GoogleCloudAiplatformV1DeployOperationMetadata", - "description": "Runtime operation information for ModelGardenService.Deploy.", - "type": "object", + "GoogleTypeInterval": { + "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.", + "id": "GoogleTypeInterval", "properties": { - "genericMetadata": { - "description": "The operation generic information.", - "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata" - }, - "publisherModel": { - "description": "Output only. The name of the model resource.", - "readOnly": true, + "endTime": { + "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", + "format": "google-datetime", "type": "string" }, - "destination": { - "description": "Output only. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", - "readOnly": true, + "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" + } + }, + "type": "object" + }, + "GoogleTypeLatLng": { + "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.", + "id": "GoogleTypeLatLng", + "properties": { + "latitude": { + "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", + "format": "double", + "type": "number" }, - "projectNumber": { - "description": "Output only. The project number where the deploy model request is sent.", - "readOnly": true, - "type": "string", - "format": "int64" - }, - "modelId": { - "description": "Output only. The model id to be used at query time.", - "readOnly": true, - "type": "string" + "longitude": { + "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", + "format": "double", + "type": "number" } - } + }, + "type": "object" }, - "GoogleCloudAiplatformV1DeployResponse": { - "id": "GoogleCloudAiplatformV1DeployResponse", - "description": "Response message for ModelGardenService.Deploy.", - "type": "object", + "GoogleTypeMoney": { + "description": "Represents an amount of money with its currency type.", + "id": "GoogleTypeMoney", "properties": { - "publisherModel": { - "description": "Output only. 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`", - "readOnly": true, + "currencyCode": { + "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, - "endpoint": { - "description": "Output only. The name of the Endpoint created. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "readOnly": true, - "type": "string" + "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" }, - "model": { - "description": "Output only. The name of the Model created. Format: `projects/{project}/locations/{location}/models/{model}`", - "readOnly": true, + "units": { + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", "type": "string" } - } - } - }, - "version_module": true, - "rootUrl": "https://aiplatform.googleapis.com/", - "parameters": { - "access_token": { - "type": "string", - "description": "OAuth access token.", - "location": "query" - }, - "alt": { - "type": "string", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "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" - }, - "callback": { - "type": "string", - "description": "JSONP", - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "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.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "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.", - "location": "query" - }, - "upload_protocol": { - "type": "string", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query" - }, - "uploadType": { - "type": "string", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query" - }, - "$.xgafv": { - "type": "string", - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" + }, + "type": "object" } }, - "name": "aiplatform", - "protocol": "rest", - "ownerName": "Google", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "endpoints": [ - { - "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/", - "location": "africa-south1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", - "location": "asia-east1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", - "location": "asia-east2", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", - "location": "asia-northeast1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", - "location": "asia-northeast2", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", - "location": "asia-northeast3", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", - "location": "asia-south1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://asia-south2-aiplatform.googleapis.com/", - "location": "asia-south2", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", - "location": "asia-southeast1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", - "location": "asia-southeast2", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", - "location": "australia-southeast1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", - "location": "australia-southeast2", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", - "location": "europe-central2", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", - "location": "europe-north1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", - "location": "europe-southwest1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", - "location": "europe-west1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-west10-aiplatform.googleapis.com/", - "location": "europe-west10", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-west15-aiplatform.googleapis.com/", - "location": "europe-west15", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", - "location": "europe-west2", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", - "location": "europe-west3", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", - "location": "europe-west4", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", - "location": "europe-west6", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", - "location": "europe-west8", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "location": "europe-west9", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/", - "location": "europe-west12", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://me-central1-aiplatform.googleapis.com/", - "location": "me-central1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://me-central2-aiplatform.googleapis.com/", - "location": "me-central2", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", - "location": "me-west1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", - "location": "northamerica-northeast1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", - "location": "northamerica-northeast2", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", - "location": "southamerica-east1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", - "location": "southamerica-west1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", - "location": "us-central1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", - "location": "us-central2", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", - "location": "us-east1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", - "location": "us-east4", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://us-east7-aiplatform.googleapis.com/", - "location": "us-east7", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", - "location": "us-south1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", - "location": "us-west1", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", - "location": "us-west2", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", - "location": "us-west3", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", - "location": "us-west4", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", - "location": "us-east5", - "description": "Locational Endpoint" - }, - { - "endpointUrl": "https://aiplatform.us.rep.googleapis.com/", - "location": "us", - "description": "Regional Endpoint" - }, - { - "endpointUrl": "https://aiplatform.eu.rep.googleapis.com/", - "location": "eu", - "description": "Regional Endpoint" - }, - { - "endpointUrl": "https://staging-aiplatform.us.rep.sandbox.googleapis.com/", - "location": "us", - "description": "Regional Endpoint" - } - ], - "baseUrl": "https://aiplatform.googleapis.com/", - "id": "aiplatform:v1" + "servicePath": "", + "title": "Agent Platform API", + "version": "v1", + "version_module": true } From e3eaa14f3f44ce2a9a7425d21455073eb47a38d1 Mon Sep 17 00:00:00 2001 From: Roman Langolf Date: Sun, 31 May 2026 14:43:06 +0700 Subject: [PATCH 2/2] update sbt and scala native --- project/build.properties | 2 +- project/plugins.sbt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/project/build.properties b/project/build.properties index 01a16ed..dabdb15 100644 --- a/project/build.properties +++ b/project/build.properties @@ -1 +1 @@ -sbt.version=1.11.7 +sbt.version=1.12.11 diff --git a/project/plugins.sbt b/project/plugins.sbt index 42d75da..0895661 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -1,4 +1,4 @@ -addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.5.9") +addSbtPlugin("org.scala-native" % "sbt-scala-native" % "0.5.12") addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.6")