{
"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": "Train high-quality custom machine learning models with minimal machine learning expertise and effort.",
"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-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-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"
}
],
"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": {
"batchPredictionJobs": {
"methods": {
"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": {
"parent": {
"description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`",
"location": "query",
"type": "string"
}
},
"path": "v1/batchPredictionJobs",
"request": {
"$ref": "GoogleCloudAiplatformV1BatchPredictionJob"
},
"response": {
"$ref": "GoogleCloudAiplatformV1BatchPredictionJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a BatchPredictionJob",
"flatPath": "v1/batchPredictionJobs/{batchPredictionJobsId}",
"httpMethod": "GET",
"id": "aiplatform.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": "^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/batchPredictionJobs",
"httpMethod": "GET",
"id": "aiplatform.batchPredictionJobs.list",
"parameterOrder": [],
"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 `=`, `!=`,`<`, `<=`,`>`, `>=` 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 ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.",
"location": "query",
"type": "string"
},
"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"
}
},
"path": "v1/batchPredictionJobs",
"response": {
"$ref": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"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"
]
},
"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": {
"datasetVersions": {
"methods": {
"create": {
"description": "Create a version from a Dataset.",
"flatPath": "v1/datasets/{datasetsId}/datasetVersions",
"httpMethod": "POST",
"id": "aiplatform.datasets.datasetVersions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
"location": "path",
"pattern": "^datasets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/datasetVersions",
"request": {
"$ref": "GoogleCloudAiplatformV1DatasetVersion"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a Dataset version.",
"flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
"httpMethod": "DELETE",
"id": "aiplatform.datasets.datasetVersions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"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": "^datasets/[^/]+/datasetVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a Dataset version.",
"flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
"httpMethod": "GET",
"id": "aiplatform.datasets.datasetVersions.get",
"parameterOrder": [
"name"
],
"parameters": {
"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": "^datasets/[^/]+/datasetVersions/[^/]+$",
"required": true,
"type": "string"
},
"readMask": {
"description": "Mask specifying which fields to read.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1DatasetVersion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists DatasetVersions in a Dataset.",
"flatPath": "v1/datasets/{datasetsId}/datasetVersions",
"httpMethod": "GET",
"id": "aiplatform.datasets.datasetVersions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. The standard list filter.",
"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.",
"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 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": "string"
}
},
"path": "v1/{+parent}/datasetVersions",
"response": {
"$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a DatasetVersion.",
"flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
"httpMethod": "PATCH",
"id": "aiplatform.datasets.datasetVersions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1DatasetVersion"
},
"response": {
"$ref": "GoogleCloudAiplatformV1DatasetVersion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "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"
}
},
"path": "v1/{+name}:restore",
"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/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"
]
},
"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": "Perform an online prediction.",
"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"
]
},
"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": {
"chat": {
"methods": {
"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": {
"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}/chat/completions",
"request": {
"$ref": "GoogleApiHttpBody"
},
"response": {
"$ref": "GoogleApiHttpBody"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
}
}
},
"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
}
}
},
"projects": {
"methods": {
"getCacheConfig": {
"description": "Gets a GenAI cache config.",
"flatPath": "v1/projects/{projectsId}/cacheConfig",
"httpMethod": "GET",
"id": "aiplatform.projects.getCacheConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
"location": "path",
"pattern": "^projects/[^/]+/cacheConfig$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1CacheConfig"
},
"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"
],
"parameters": {
"name": {
"description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
"location": "path",
"pattern": "^projects/[^/]+/cacheConfig$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1CacheConfig"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"locations": {
"methods": {
"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": {
"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"
}
},
"path": "v1/{+parent}:augmentPrompt",
"request": {
"$ref": "GoogleCloudAiplatformV1AugmentPromptRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1AugmentPromptResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
]
},
"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": {
"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"
}
},
"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": [
"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": "GoogleCloudAiplatformV1EvaluateInstancesResponse"
},
"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"
]
},
"list": {
"description": "Lists information about the supported locations for this service.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"extraLocationTypes": {
"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.",
"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"
]
}
},
"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": "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. 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"
},
"pageToken": {
"description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.",
"location": "query",
"type": "string"
},
"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": "string"
}
},
"path": "v1/{+parent}/batchPredictionJobs",
"response": {
"$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"
],
"parameters": {
"parent": {
"description": "Required. The parent resource where the cached content will be created",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/cachedContents",
"request": {
"$ref": "GoogleCloudAiplatformV1CachedContent"
},
"response": {
"$ref": "GoogleCloudAiplatformV1CachedContent"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"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": "Required. The resource name referring to the cached content",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "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": [
"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": "GoogleCloudAiplatformV1ListCachedContentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "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"
},
"updateMask": {
"description": "Required. The list of fields to update.",
"format": "google-fieldmask",
"location": "query",
"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": "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"
],
"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"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/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}/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/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}/customJobs/{customJobsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.customJobs.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"dataLabelingJobs": {
"methods": {
"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": "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"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "GoogleCloudAiplatformV1CancelDataLabelingJobRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a DataLabelingJob.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.dataLabelingJobs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/dataLabelingJobs",
"request": {
"$ref": "GoogleCloudAiplatformV1DataLabelingJob"
},
"response": {
"$ref": "GoogleCloudAiplatformV1DataLabelingJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a DataLabelingJob.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.dataLabelingJobs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1DataLabelingJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists DataLabelingJobs in a Location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.dataLabelingJobs.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"
},
"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"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent of the DataLabelingJob. 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 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"
}
},
"path": "v1/{+parent}/dataLabelingJobs",
"response": {
"$ref": "GoogleCloudAiplatformV1ListDataLabelingJobsResponse"
},
"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}/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"
}
},
"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": {
"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"
}
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"patch": {
"description": "Updates a Dataset.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
"httpMethod": "PATCH",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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"
]
},
"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": {
"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"
},
"annotationsFilter": {
"deprecated": true,
"description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.",
"location": "query",
"type": "string"
},
"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"
},
"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"
},
"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"
},
"fieldMask": {
"description": "Mask specifying which fields of DataItemView to read.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"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": "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"
},
"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"
},
"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"
},
"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"
},
"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": "string"
}
},
"path": "v1/{+dataset}:searchDataItems",
"response": {
"$ref": "GoogleCloudAiplatformV1SearchDataItemsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"annotationSpecs": {
"methods": {
"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": [
"name"
],
"parameters": {
"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"
},
"readMask": {
"description": "Mask specifying which fields to read.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$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"
}
},
"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"
],
"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 DataItems 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}/dataItems",
"response": {
"$ref": "GoogleCloudAiplatformV1ListDataItemsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"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"
]
}
},
"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"
}
},
"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"
]
}
}
}
}
},
"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"
}
},
"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": [
"parent"
],
"parameters": {
"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"
}
},
"path": "v1/{+parent}/datasetVersions",
"request": {
"$ref": "GoogleCloudAiplatformV1DatasetVersion"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"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 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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1DatasetVersion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"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": {
"filter": {
"description": "Optional. The standard list filter.",
"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.",
"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 Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
"required": true,
"type": "string"
},
"readMask": {
"description": "Optional. Mask specifying which fields to read.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/datasetVersions",
"response": {
"$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"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": "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": "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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1DatasetVersion"
},
"response": {
"$ref": "GoogleCloudAiplatformV1DatasetVersion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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 DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
"required": true,
"type": "string"
}
},
"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": "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}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.datasets.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"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": [
"name"
],
"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"
]
},
"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": {
"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"
}
},
"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": [
"name"
],
"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"
],
"parameters": {
"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": [
"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 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": "GoogleCloudAiplatformV1ListSavedQueriesResponse"
},
"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}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.datasets.savedQueries.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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"
}
},
"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}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to wait on.",
"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.",
"format": "google-duration",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
},
"deploymentResourcePools": {
"methods": {
"create": {
"description": "Create a DeploymentResourcePool.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.deploymentResourcePools.create",
"parameterOrder": [
"parent"
],
"parameters": {
"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"
}
},
"path": "v1/{+parent}/deploymentResourcePools",
"request": {
"$ref": "GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete a DeploymentResourcePool.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.deploymentResourcePools.delete",
"parameterOrder": [
"name"
],
"parameters": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Get a DeploymentResourcePool.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.deploymentResourcePools.get",
"parameterOrder": [
"name"
],
"parameters": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1DeploymentResourcePool"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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 parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/deploymentResourcePools",
"response": {
"$ref": "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1DeploymentResourcePool"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
},
"pageSize": {
"description": "The maximum number of DeployedModels 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 `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"
}
},
"path": "v1/{+deploymentResourcePool}:queryDeployedModels",
"response": {
"$ref": "GoogleCloudAiplatformV1QueryDeployedModelsResponse"
},
"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}/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"
]
},
"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"
]
},
"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"
]
},
"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"
}
},
"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}/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": [
"endpoint"
],
"parameters": {
"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"
}
},
"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/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+endpoint}:countTokens",
"request": {
"$ref": "GoogleCloudAiplatformV1CountTokensRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1CountTokensResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates an Endpoint.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.endpoints.create",
"parameterOrder": [
"parent"
],
"parameters": {
"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"
}
},
"path": "v1/{+parent}/endpoints",
"request": {
"$ref": "GoogleCloudAiplatformV1Endpoint"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"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 Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+endpoint}:deployModel",
"request": {
"$ref": "GoogleCloudAiplatformV1DeployModelRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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": [
"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": "GoogleCloudAiplatformV1DirectRawPredictRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1DirectRawPredictResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"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": {
"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": [
"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": "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/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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"
]
},
"get": {
"description": "Gets an Endpoint.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.endpoints.get",
"parameterOrder": [
"name"
],
"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"
},
"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": "Optional. The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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"
]
},
"mutateDeployedModel": {
"description": "Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_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": "Output only. 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": "Perform an online prediction.",
"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}`",
"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": "Output only. 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": {
"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": {
"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}/chat/completions",
"request": {
"$ref": "GoogleApiHttpBody"
},
"response": {
"$ref": "GoogleApiHttpBody"
},
"scopes": [
"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/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 resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/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}/endpoints/{endpointsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.endpoints.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/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}/endpoints/{endpointsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.endpoints.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/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}/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'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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"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"
},
"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"
},
"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": {
"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"
}
},
"path": "v1/{+parent}/features:batchCreate",
"request": {
"$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+parent}/features",
"request": {
"$ref": "GoogleCloudAiplatformV1Feature"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1Feature"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"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}/featureGroups/{featureGroupsId}/features/{featuresId}",
"httpMethod": "PATCH",
"id": "aiplatform.projects.locations.featureGroups.features.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.",
"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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1Feature"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"operations": {
"methods": {
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"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 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"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"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}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.featureGroups.features.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to wait on.",
"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.",
"format": "google-duration",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"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}/featureGroups/{featureGroupsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.featureGroups.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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'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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"featureOnlineStores": {
"methods": {
"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": {
"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"
}
},
"path": "v1/{+parent}/featureOnlineStores",
"request": {
"$ref": "GoogleCloudAiplatformV1FeatureOnlineStore"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"name": {
"description": "Required. The name of the FeatureOnlineStore resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1FeatureOnlineStore"
},
"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}:getIamPolicy",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.featureOnlineStores.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/[^/]+/featureOnlineStores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"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": {
"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"
},
"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 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"
},
"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.",
"location": "query",
"type": "string"
},
"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"
}
},
"path": "v1/{+parent}/featureOnlineStores",
"response": {
"$ref": "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"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 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 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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1FeatureOnlineStore"
},
"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}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.featureOnlineStores.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/[^/]+/featureOnlineStores/[^/]+$",
"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}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.featureOnlineStores.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/[^/]+/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": {
"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"
},
"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"
},
"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"
}
},
"path": "v1/{+parent}/featureViews",
"request": {
"$ref": "GoogleCloudAiplatformV1FeatureView"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"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": "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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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}:fetchFeatureValues",
"request": {
"$ref": "GoogleCloudAiplatformV1FetchFeatureValuesRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"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 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": [
"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": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"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": {
"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"
},
"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 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"
},
"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"
},
"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"
}
},
"path": "v1/{+parent}/featureViews",
"response": {
"$ref": "GoogleCloudAiplatformV1ListFeatureViewsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"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": "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 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"
}
},
"path": "v1/{+name}",
"request": {
"$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"
],
"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"
]
},
"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": {
"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": [
"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": "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"
],
"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": {
"featureViewSyncs": {
"methods": {
"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": "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": "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 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"
},
"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"
},
"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"
}
},
"path": "v1/{+parent}/featureViewSyncs",
"response": {
"$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"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/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}/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.",
"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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"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}/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"
}
},
"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"
]
}
}
}
}
},
"featurestores": {
"methods": {
"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": {
"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"
}
},
"path": "v1/{+featurestore}:batchReadFeatureValues",
"request": {
"$ref": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+parent}/featurestores",
"request": {
"$ref": "GoogleCloudAiplatformV1Featurestore"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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": [
"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/[^/]+/featurestores/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+parent}/featurestores",
"response": {
"$ref": "GoogleCloudAiplatformV1ListFeaturestoresResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"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. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
"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`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1Featurestore"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
},
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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",
"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` --> 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"
}
},
"path": "v1/{+location}/featurestores:searchFeatures",
"response": {
"$ref": "GoogleCloudAiplatformV1SearchFeaturesResponse"
},
"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}:setIamPolicy",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.featurestores.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/[^/]+$",
"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}/featurestores/{featurestoresId}:testIamPermissions",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.featurestores.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/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"entityTypes": {
"methods": {
"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": {
"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"
},
"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"
}
},
"path": "v1/{+parent}/entityTypes",
"request": {
"$ref": "GoogleCloudAiplatformV1EntityType"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"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",
"id": "aiplatform.projects.locations.featurestores.entityTypes.delete",
"parameterOrder": [
"name"
],
"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": "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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+entityType}:deleteFeatureValues",
"request": {
"$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+entityType}:exportFeatureValues",
"request": {
"$ref": "GoogleCloudAiplatformV1ExportFeatureValuesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1EntityType"
},
"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}/entityTypes/{entityTypesId}:getIamPolicy",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.featurestores.entityTypes.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/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+entityType}:importFeatureValues",
"request": {
"$ref": "GoogleCloudAiplatformV1ImportFeatureValuesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"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": {
"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"
},
"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": "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"
},
"pageToken": {
"description": "A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"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"
},
"readMask": {
"description": "Mask specifying which fields to read.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/entityTypes",
"response": {
"$ref": "GoogleCloudAiplatformV1ListEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1EntityType"
},
"response": {
"$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"
],
"parameters": {
"entityType": {
"description": "Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"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": "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"
],
"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": {
"features": {
"methods": {
"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": {
"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"
}
},
"path": "v1/{+parent}/features:batchCreate",
"request": {
"$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+parent}/features",
"request": {
"$ref": "GoogleCloudAiplatformV1Feature"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a single Feature.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.featurestores.entityTypes.features.delete",
"parameterOrder": [
"name"
],
"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}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
"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 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": "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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1Feature"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"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": {
"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/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"readMask": {
"description": "Mask specifying which fields to read.",
"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": [
"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": "GoogleCloudAiplatformV1Feature"
},
"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}/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 resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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 to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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'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"
}
},
"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}/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.",
"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"
}
},
"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}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/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}/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/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}/entityTypes/{entityTypesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/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}/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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"
}
},
"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}/entityTypes/{entityTypesId}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to wait on.",
"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"
}
},
"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}/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"
}
},
"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"
]
}
}
}
}
},
"hyperparameterTuningJobs": {
"methods": {
"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": "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"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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"
}
},
"path": "v1/{+parent}/hyperparameterTuningJobs",
"request": {
"$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob"
},
"response": {
"$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"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": "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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
},
"readMask": {
"description": "Mask specifying which fields to read.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/hyperparameterTuningJobs",
"response": {
"$ref": "GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse"
},
"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}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/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}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/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}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/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}/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'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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"indexEndpoints": {
"methods": {
"create": {
"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 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": [
"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": "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"
],
"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": {
"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 IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists IndexEndpoints in a Location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.indexEndpoints.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. * `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": "Optional. The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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"
},
"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"
}
},
"path": "v1/{+parent}/indexEndpoints",
"response": {
"$ref": "GoogleCloudAiplatformV1ListIndexEndpointsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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}:mutateDeployedIndex",
"request": {
"$ref": "GoogleCloudAiplatformV1DeployedIndex"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
},
"response": {
"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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}:readIndexDatapoints",
"request": {
"$ref": "GoogleCloudAiplatformV1ReadIndexDatapointsRequest"
},
"response": {
"$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"
],
"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": {
"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 resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/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}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.indexEndpoints.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/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}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.indexEndpoints.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/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}/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'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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"indexes": {
"methods": {
"create": {
"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 Index in. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/indexes",
"request": {
"$ref": "GoogleCloudAiplatformV1Index"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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 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": "GoogleCloudAiplatformV1Index"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists Indexes in a Location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.indexes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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 ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.",
"location": "query",
"type": "string"
},
"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"
},
"readMask": {
"description": "Mask specifying which fields to read.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/indexes",
"response": {
"$ref": "GoogleCloudAiplatformV1ListIndexesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"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 Index.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "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": "GoogleCloudAiplatformV1Index"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"removeDatapoints": {
"description": "Remove Datapoints from an Index.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.indexes.removeDatapoints",
"parameterOrder": [
"index"
],
"parameters": {
"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"
}
},
"path": "v1/{+index}:removeDatapoints",
"request": {
"$ref": "GoogleCloudAiplatformV1RemoveDatapointsRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1RemoveDatapointsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"upsertDatapoints": {
"description": "Add/update Datapoints into an Index.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.indexes.upsertDatapoints",
"parameterOrder": [
"index"
],
"parameters": {
"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"
}
},
"path": "v1/{+index}:upsertDatapoints",
"request": {
"$ref": "GoogleCloudAiplatformV1UpsertDatapointsRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1UpsertDatapointsResponse"
},
"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}/indexes/{indexesId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.indexes.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/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}/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/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}/indexes/{indexesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.indexes.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/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}/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's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
"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"
}
},
"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}/indexes/{indexesId}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.indexes.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to wait on.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"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"
]
},
"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"
]
},
"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-1000, 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": {
"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": {
"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"
},
"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-1000, 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": [
"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": "GoogleCloudAiplatformV1Artifact"
},
"response": {
"$ref": "GoogleCloudAiplatformV1Artifact"
},
"scopes": [
"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"
],
"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"
]
}
},
"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}/artifacts/{artifactsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"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"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"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": [
"name"
],
"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": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"contexts": {
"methods": {
"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": {
"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"
}
},
"path": "v1/{+context}:addContextArtifactsAndExecutions",
"request": {
"$ref": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse"
},
"scopes": [
"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"
],
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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-1000, 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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
}
},
"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"
}
},
"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"
]
}
}
}
}
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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-1000, 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"
]
},
"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": "Output only. The resource name of the Execution.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
"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": "GoogleCloudAiplatformV1Execution"
},
"response": {
"$ref": "GoogleCloudAiplatformV1Execution"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+parent}/executions:purge",
"request": {
"$ref": "GoogleCloudAiplatformV1PurgeExecutionsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": [
"execution"
],
"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}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+execution}:queryExecutionInputsAndOutputs",
"response": {
"$ref": "GoogleCloudAiplatformV1LineageSubgraph"
},
"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}/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"
}
},
"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"
]
}
}
}
}
},
"metadataSchemas": {
"methods": {
"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": "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": "A query to filter available MetadataSchemas for matching results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.",
"format": "int32",
"location": "query",
"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.)",
"location": "query",
"type": "string"
},
"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"
}
},
"path": "v1/{+parent}/metadataSchemas",
"response": {
"$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"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/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}/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/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}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.metadataStores.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"migratableResources": {
"methods": {
"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 location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/migratableResources:batchMigrate",
"request": {
"$ref": "GoogleCloudAiplatformV1BatchMigrateResourcesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": [
"parent"
],
"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}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/migratableResources:search",
"request": {
"$ref": "GoogleCloudAiplatformV1SearchMigratableResourcesRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1SearchMigratableResourcesResponse"
},
"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}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.migratableResources.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/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}/migratableResources/{migratableResourcesId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.migratableResources.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/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}/migratableResources/{migratableResourcesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.migratableResources.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/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}/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'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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"modelDeploymentMonitoringJobs": {
"methods": {
"create": {
"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 parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/modelDeploymentMonitoringJobs",
"request": {
"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
},
"response": {
"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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 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": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists ModelDeploymentMonitoringJobs in a Location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.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.",
"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",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/modelDeploymentMonitoringJobs",
"response": {
"$ref": "GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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 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": "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"
],
"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 resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/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}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/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}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/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}/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'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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"models": {
"methods": {
"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 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": [
"name"
],
"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": "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"
],
"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": {
"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 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": [
"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": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"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 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": "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"
},
"pageToken": {
"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.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}:listVersions",
"response": {
"$ref": "GoogleCloudAiplatformV1ListModelVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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 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": "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": "GoogleCloudAiplatformV1Model"
},
"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}/models/{modelsId}:setIamPolicy",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.models.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/[^/]+/models/[^/]+$",
"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}/models/{modelsId}:testIamPermissions",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.models.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/[^/]+/models/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"response": {
"$ref": "GoogleIamV1TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": [
"model"
],
"parameters": {
"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"
}
},
"path": "v1/{+model}:updateExplanationDataset",
"request": {
"$ref": "GoogleCloudAiplatformV1UpdateExplanationDatasetRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+parent}/models:upload",
"request": {
"$ref": "GoogleCloudAiplatformV1UploadModelRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"evaluations": {
"methods": {
"get": {
"description": "Gets a ModelEvaluation.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.models.evaluations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1ModelEvaluation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+parent}/evaluations:import",
"request": {
"$ref": "GoogleCloudAiplatformV1ImportModelEvaluationRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1ModelEvaluation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
},
"readMask": {
"description": "Mask specifying which fields to read.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/evaluations",
"response": {
"$ref": "GoogleCloudAiplatformV1ListModelEvaluationsResponse"
},
"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}/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"
}
},
"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"
]
}
}
},
"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"
]
}
}
}
}
},
"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}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.models.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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": "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"
],
"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": {
"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": {
"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"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"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": [
"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": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"nasJobs": {
"methods": {
"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": {
"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": "GoogleCloudAiplatformV1NasJob"
},
"response": {
"$ref": "GoogleCloudAiplatformV1NasJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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 NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a NasJob",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.nasJobs.get",
"parameterOrder": [
"name"
],
"parameters": {
"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. * `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 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"
}
},
"path": "v1/{+parent}/nasJobs",
"response": {
"$ref": "GoogleCloudAiplatformV1ListNasJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"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"
]
}
}
}
}
},
"notebookExecutionJobs": {
"methods": {
"create": {
"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 resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/notebookExecutionJobs",
"request": {
"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a NotebookExecutionJob.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.notebookExecutionJobs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the NotebookExecutionJob resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"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 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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists NotebookExecutionJobs in a Location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.notebookExecutionJobs.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. * `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"
},
"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 ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.",
"location": "query",
"type": "string"
},
"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"
},
"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"
}
},
"path": "v1/{+parent}/notebookExecutionJobs",
"response": {
"$ref": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse"
},
"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}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/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}/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/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}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/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}/notebookExecutionJobs/{notebookExecutionJobsId}/operations",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
"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"
}
},
"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}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to wait on.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"notebookRuntimeTemplates": {
"methods": {
"create": {
"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 to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/notebookRuntimeTemplates",
"request": {
"$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"
],
"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": {
"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 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": [
"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": "GoogleIamV1Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists NotebookRuntimeTemplates in a Location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.notebookRuntimeTemplates.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. * `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": "Optional. The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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"
},
"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"
}
},
"path": "v1/{+parent}/notebookRuntimeTemplates",
"response": {
"$ref": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "The resource name of the NotebookRuntimeTemplate.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
"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`",
"format": "google-fieldmask",
"location": "query",
"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": [
"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": "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"
],
"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": {
"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 resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/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}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/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}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/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}/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'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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"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"
]
},
"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": {
"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": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/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}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.notebookRuntimes.operations.delete",
"parameterOrder": [
"name"
],
"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": "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}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.notebookRuntimes.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/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}/notebookRuntimes/{notebookRuntimesId}/operations",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
"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"
}
},
"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}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.notebookRuntimes.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to wait on.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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"
}
},
"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"
],
"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": "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}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.persistentResources.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/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}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.persistentResources.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/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}/persistentResources/{persistentResourcesId}/operations",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
"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"
}
},
"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}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.persistentResources.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to wait on.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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": {
"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"
]
},
"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": {
"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": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/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}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.pipelineJobs.operations.delete",
"parameterOrder": [
"name"
],
"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": "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}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.pipelineJobs.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/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}/pipelineJobs/{pipelineJobsId}/operations",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.pipelineJobs.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/[^/]+/pipelineJobs/[^/]+$",
"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"
}
},
"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}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.pipelineJobs.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to wait on.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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"
]
}
}
}
}
},
"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"
],
"parameters": {
"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"
}
},
"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/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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"
]
},
"predict": {
"description": "Perform an online prediction.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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"
]
},
"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": {
"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"
}
},
"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}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.publishers.models.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/[^/]+/publishers/[^/]+/models/[^/]+$",
"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}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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"
]
},
"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",
"id": "aiplatform.projects.locations.publishers.models.streamRawPredict",
"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/[^/]+/publishers/[^/]+/models/[^/]+$",
"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"
]
}
}
}
}
},
"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"
]
},
"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.",
"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": {
"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": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.ragCorpora.operations.delete",
"parameterOrder": [
"name"
],
"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": "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}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.ragCorpora.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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"
}
},
"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}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.ragCorpora.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to wait on.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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": {
"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": {
"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"
}
},
"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": "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"
],
"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"
]
},
"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": {
"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 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"
}
},
"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": "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}/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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.",
"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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"reasoningEngines": {
"methods": {
"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 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"
]
},
"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"
]
},
"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. 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": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/reasoningEngines",
"response": {
"$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": "Identifier. The resource name of the ReasoningEngine.",
"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"
}
},
"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/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 ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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 ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:streamQuery",
"request": {
"$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest"
},
"response": {
"$ref": "GoogleApiHttpBody"
},
"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}/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"
]
},
"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"
],
"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"
]
},
"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 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"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"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}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.reasoningEngines.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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"
}
},
"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": "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"
],
"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"
]
},
"get": {
"description": "Gets a Schedule.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.schedules.get",
"parameterOrder": [
"name"
],
"parameters": {
"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 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. Default to 100 if not specified.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.",
"location": "query",
"type": "string"
},
"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"
}
},
"path": "v1/{+parent}/schedules",
"response": {
"$ref": "GoogleCloudAiplatformV1ListSchedulesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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"
],
"parameters": {
"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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1Schedule"
},
"response": {
"$ref": "GoogleCloudAiplatformV1Schedule"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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 Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:pause",
"request": {
"$ref": "GoogleCloudAiplatformV1PauseScheduleRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"resume": {
"description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.schedules.resume",
"parameterOrder": [
"name"
],
"parameters": {
"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"
}
},
"path": "v1/{+name}:resume",
"request": {
"$ref": "GoogleCloudAiplatformV1ResumeScheduleRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"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}/schedules/{schedulesId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.schedules.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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"
}
},
"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"
]
}
}
}
}
},
"specialistPools": {
"methods": {
"create": {
"description": "Creates a SpecialistPool.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.specialistPools.create",
"parameterOrder": [
"parent"
],
"parameters": {
"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"
}
},
"path": "v1/{+parent}/specialistPools",
"request": {
"$ref": "GoogleCloudAiplatformV1SpecialistPool"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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"
],
"parameters": {
"force": {
"description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)",
"location": "query",
"type": "boolean"
},
"name": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"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 SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1SpecialistPool"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists SpecialistPools in a Location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.specialistPools.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 by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.",
"location": "query",
"type": "string"
},
"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"
},
"readMask": {
"description": "Mask specifying which fields to read. FieldMask represents a set of",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/specialistPools",
"response": {
"$ref": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a SpecialistPool.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
"httpMethod": "PATCH",
"id": "aiplatform.projects.locations.specialistPools.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the SpecialistPool.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The update mask applies to the resource.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1SpecialistPool"
},
"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}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.specialistPools.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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 to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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'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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"studies": {
"methods": {
"create": {
"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 CustomJob in. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/studies",
"request": {
"$ref": "GoogleCloudAiplatformV1Study"
},
"response": {
"$ref": "GoogleCloudAiplatformV1Study"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"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 Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"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 Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1Study"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"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": {
"pageSize": {
"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"
},
"pageToken": {
"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.",
"location": "query",
"type": "string"
},
"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"
}
},
"path": "v1/{+parent}/studies",
"response": {
"$ref": "GoogleCloudAiplatformV1ListStudiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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",
"id": "aiplatform.projects.locations.studies.lookup",
"parameterOrder": [
"parent"
],
"parameters": {
"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"
}
},
"path": "v1/{+parent}/studies:lookup",
"request": {
"$ref": "GoogleCloudAiplatformV1LookupStudyRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1Study"
},
"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}/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 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"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"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}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.studies.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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"
}
},
"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"
],
"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"
]
},
"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": {
"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": "GoogleCloudAiplatformV1Trial"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
]
},
"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": "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"
},
"pageToken": {
"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.",
"location": "query",
"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": [
"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": "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"
],
"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"
}
},
"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": {
"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": "GoogleCloudAiplatformV1Tensorboard"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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 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": "GoogleCloudAiplatformV1Tensorboard"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Lists Tensorboards in a Location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.tensorboards.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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 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"
},
"pageToken": {
"description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"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.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/tensorboards",
"response": {
"$ref": "GoogleCloudAiplatformV1ListTensorboardsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"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": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
"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.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1Tensorboard"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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}: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": [
"tensorboard"
],
"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": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"experiments": {
"methods": {
"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": {
"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"
}
},
"path": "v1/{+parent}:batchCreate",
"request": {
"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+parent}/experiments",
"request": {
"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
},
"response": {
"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"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": "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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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"
],
"parameters": {
"name": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"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": {
"filter": {
"description": "Lists the TensorboardExperiments 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 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"
},
"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"
},
"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"
},
"readMask": {
"description": "Mask specifying which fields to read.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/experiments",
"response": {
"$ref": "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"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"
],
"parameters": {
"name": {
"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"
},
"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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
},
"response": {
"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"path": "v1/{+tensorboardExperiment}:write",
"request": {
"$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse"
},
"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}/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 resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.tensorboards.experiments.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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'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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"runs": {
"methods": {
"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 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"
}
},
"path": "v1/{+parent}/runs:batchCreate",
"request": {
"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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 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"
}
},
"path": "v1/{+parent}/runs",
"request": {
"$ref": "GoogleCloudAiplatformV1TensorboardRun"
},
"response": {
"$ref": "GoogleCloudAiplatformV1TensorboardRun"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a TensorboardRun.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete",
"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}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a TensorboardRun.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.tensorboards.experiments.runs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1TensorboardRun"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"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": {
"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"
},
"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"
},
"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"
}
},
"path": "v1/{+parent}/runs",
"response": {
"$ref": "GoogleCloudAiplatformV1ListTensorboardRunsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"patch": {
"description": "Updates a TensorboardRun.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
"httpMethod": "PATCH",
"id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1TensorboardRun"
},
"response": {
"$ref": "GoogleCloudAiplatformV1TensorboardRun"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+tensorboardRun}:write",
"request": {
"$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest"
},
"response": {
"$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataResponse"
},
"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}/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 resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
"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"
}
},
"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}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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'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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"timeSeries": {
"methods": {
"create": {
"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}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
"required": true,
"type": "string"
},
"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}\"",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/timeSeries",
"request": {
"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
},
"response": {
"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a TensorboardTimeSeries.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete",
"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}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
}
},
"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"
],
"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",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"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": {
"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"
},
"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"
},
"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"
}
},
"path": "v1/{+parent}/timeSeries",
"response": {
"$ref": "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"patch": {
"description": "Updates a TensorboardTimeSeries.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
"httpMethod": "PATCH",
"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
},
"response": {
"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"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": {
"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"
},
"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"
}
},
"path": "v1/{+tensorboardTimeSeries}:read",
"response": {
"$ref": "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"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": {
"blobIds": {
"description": "IDs of the blobs to read.",
"location": "query",
"repeated": true,
"type": "string"
},
"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"
}
},
"path": "v1/{+timeSeries}:readBlobData",
"response": {
"$ref": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
},
"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}/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 resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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'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"
}
},
"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}/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.",
"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"
}
},
"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}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.tensorboards.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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 to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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'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"
}
},
"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}/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.",
"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"
}
},
"path": "v1/{+name}:wait",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"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"
]
},
"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": {
"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": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "aiplatform.projects.locations.trainingPipelines.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.trainingPipelines.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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"
}
},
"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}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.trainingPipelines.operations.wait",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to wait on.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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": {
"methods": {
"cancel": {
"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`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.tuningJobs.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a TuningJob. A created TuningJob right away will be attempted to be run.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.tuningJobs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/tuningJobs",
"request": {
"$ref": "GoogleCloudAiplatformV1TuningJob"
},
"response": {
"$ref": "GoogleCloudAiplatformV1TuningJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a TuningJob.",
"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 TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleCloudAiplatformV1TuningJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists TuningJobs in a Location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.tuningJobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"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"
},
"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"
},
"parent": {
"description": "Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/tuningJobs",
"response": {
"$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"rebaseTunedModel": {
"description": "Rebase a TunedModel.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/tuningJobs:rebaseTunedModel",
"request": {
"$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest"
},
"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}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "aiplatform.projects.locations.tuningJobs.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.tuningJobs.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/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/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations",
"httpMethod": "GET",
"id": "aiplatform.projects.locations.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": "^projects/[^/]+/locations/[^/]+/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"
}
},
"path": "v1/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"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/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"
]
},
"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": "Perform an online prediction.",
"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"
]
},
"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"
]
}
}
}
}
}
},
"revision": "20250415",
"rootUrl": "https://aiplatform.googleapis.com/",
"schemas": {
"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"
},
"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"
},
"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"
},
"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"
},
"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"
}
},
"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"
},
"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"
},
"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"
},
"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"
},
"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`",
"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 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"
},
"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 and unmanaged_container_model 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"
}
},
"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"
}
},
"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"
}
},
"type": "object"
},
"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."
},
"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`."
},
"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"
},
"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"
},
"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"
},
"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"
},
"featureSelector": {
"$ref": "GoogleCloudAiplatformV1FeatureSelector",
"description": "Required. Selectors choosing which Feature values to read from the EntityType."
},
"settings": {
"description": "Per-Feature settings for the batch read.",
"items": {
"$ref": "GoogleCloudAiplatformV1DestinationFeatureSetting"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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": "Content blob.",
"id": "GoogleCloudAiplatformV1Blob",
"properties": {
"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 not currently used in the Gemini GenerateContent calls.",
"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"
},
"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"
},
"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"
},
"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"
},
"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
}
},
"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"
},
"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"
},
"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"
},
"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. Average log probability score of the candidate.",
"format": "double",
"readOnly": true,
"type": "number"
},
"citationMetadata": {
"$ref": "GoogleCloudAiplatformV1CitationMetadata",
"description": "Output only. Source attribution of the generated content.",
"readOnly": true
},
"content": {
"$ref": "GoogleCloudAiplatformV1Content",
"description": "Output only. Content parts of the candidate.",
"readOnly": true
},
"finishMessage": {
"description": "Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled 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 the tokens.",
"enum": [
"FINISH_REASON_UNSPECIFIED",
"STOP",
"MAX_TOKENS",
"SAFETY",
"RECITATION",
"OTHER",
"BLOCKLIST",
"PROHIBITED_CONTENT",
"SPII",
"MALFORMED_FUNCTION_CALL"
],
"enumDescriptions": [
"The finish reason is unspecified.",
"Token generation reached a natural stopping point or a configured stop sequence.",
"Token generation reached the configured maximum output tokens.",
"Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.",
"The token generation stopped because of potential recitation.",
"All other reasons that stopped the token generation.",
"Token generation stopped because the content contains forbidden terms.",
"Token generation stopped for potentially containing prohibited content.",
"Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).",
"The function call generated by the model is invalid."
],
"readOnly": true,
"type": "string"
},
"groundingMetadata": {
"$ref": "GoogleCloudAiplatformV1GroundingMetadata",
"description": "Output only. Metadata specifies sources used to ground generated content.",
"readOnly": true
},
"index": {
"description": "Output only. Index of the candidate.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"logprobsResult": {
"$ref": "GoogleCloudAiplatformV1LogprobsResult",
"description": "Output only. Log-likelihood scores for the response tokens and top tokens",
"readOnly": true
},
"safetyRatings": {
"description": "Output only. 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"
}
},
"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"
},
"GoogleCloudAiplatformV1Citation": {
"description": "Source attributions for content.",
"id": "GoogleCloudAiplatformV1Citation",
"properties": {
"endIndex": {
"description": "Output only. End index into the content.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"license": {
"description": "Output only. License of the attribution.",
"readOnly": true,
"type": "string"
},
"publicationDate": {
"$ref": "GoogleTypeDate",
"description": "Output only. Publication date of the attribution.",
"readOnly": true
},
"startIndex": {
"description": "Output only. Start index into the content.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"title": {
"description": "Output only. Title of the attribution.",
"readOnly": true,
"type": "string"
},
"uri": {
"description": "Output only. Url reference of the attribution.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CitationMetadata": {
"description": "A collection of source attributions for a piece of content.",
"id": "GoogleCloudAiplatformV1CitationMetadata",
"properties": {
"citations": {
"description": "Output only. List of citations.",
"items": {
"$ref": "GoogleCloudAiplatformV1Citation"
},
"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"
},
"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]. Always follows a `part` containing the [ExecutableCode].",
"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.",
"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."
],
"type": "string"
},
"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"
},
"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"
],
"enumDescriptions": [
"Comet version unspecified.",
"Comet 22 for translation + source + reference (source-reference-combined)."
],
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1ComputeTokensRequest": {
"description": "Request message for ComputeTokens RPC call.",
"id": "GoogleCloudAiplatformV1ComputeTokensRequest",
"properties": {
"contents": {
"description": "Optional. Input content.",
"items": {
"$ref": "GoogleCloudAiplatformV1Content"
},
"type": "array"
},
"instances": {
"description": "Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.",
"items": {
"type": "any"
},
"type": "array"
},
"model": {
"description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*",
"type": "string"
}
},
"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"
},
"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"
},
"type": "array"
},
"command": {
"description": "The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Environment variables to be passed to the container. Maximum limit is 100.",
"items": {
"$ref": "GoogleCloudAiplatformV1EnvVar"
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1Content": {
"description": "The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.",
"id": "GoogleCloudAiplatformV1Content",
"properties": {
"parts": {
"description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.",
"items": {
"$ref": "GoogleCloudAiplatformV1Part"
},
"type": "array"
},
"role": {
"description": "Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ContentMap": {
"description": "Map of placeholder in metric prompt template to contents of model input.",
"id": "GoogleCloudAiplatformV1ContentMap",
"properties": {
"values": {
"additionalProperties": {
"$ref": "GoogleCloudAiplatformV1ContentMapContents"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1CopyModelOperationMetadata": {
"description": "Details of ModelService.CopyModel operation.",
"id": "GoogleCloudAiplatformV1CopyModelOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The common part of the operation metadata."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CopyModelRequest": {
"description": "Request message for ModelService.CopyModel.",
"id": "GoogleCloudAiplatformV1CopyModelRequest",
"properties": {
"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"
},
"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"
}
},
"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"
},
"modelVersionId": {
"description": "Output only. The version ID of the model that is copied.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CorpusStatus": {
"description": "RagCorpus status.",
"id": "GoogleCloudAiplatformV1CorpusStatus",
"properties": {
"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"
},
"GoogleCloudAiplatformV1CorroborateContentRequest": {
"description": "Request message for CorroborateContent.",
"id": "GoogleCloudAiplatformV1CorroborateContentRequest",
"properties": {
"content": {
"$ref": "GoogleCloudAiplatformV1Content",
"description": "Optional. Input content to corroborate, only text format is supported for now."
},
"facts": {
"description": "Optional. Facts used to generate the text can also be used to corroborate the text.",
"items": {
"$ref": "GoogleCloudAiplatformV1Fact"
},
"type": "array"
},
"parameters": {
"$ref": "GoogleCloudAiplatformV1CorroborateContentRequestParameters",
"description": "Optional. Parameters that can be set to override default settings per request."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CorroborateContentRequestParameters": {
"description": "Parameters that can be overrided per request.",
"id": "GoogleCloudAiplatformV1CorroborateContentRequestParameters",
"properties": {
"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": {
"$ref": "GoogleCloudAiplatformV1Claim"
},
"type": "array"
},
"corroborationScore": {
"description": "Confidence score of corroborating content. Value is [0,1] with 1 is the most confidence.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CountTokensRequest": {
"description": "Request message for PredictionService.CountTokens.",
"id": "GoogleCloudAiplatformV1CountTokensRequest",
"properties": {
"contents": {
"description": "Optional. Input content.",
"items": {
"$ref": "GoogleCloudAiplatformV1Content"
},
"type": "array"
},
"generationConfig": {
"$ref": "GoogleCloudAiplatformV1GenerationConfig",
"description": "Optional. Generation config that the model will use to generate the response."
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1CountTokensResponse": {
"description": "Response message for PredictionService.CountTokens.",
"id": "GoogleCloudAiplatformV1CountTokensResponse",
"properties": {
"promptTokensDetails": {
"description": "Output only. List of modalities that were processed in the request input.",
"items": {
"$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"
},
"GoogleCloudAiplatformV1CreateDatasetOperationMetadata": {
"description": "Runtime operation information for DatasetService.CreateDataset.",
"id": "GoogleCloudAiplatformV1CreateDatasetOperationMetadata",
"properties": {
"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."
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CreateEndpointOperationMetadata": {
"description": "Runtime operation information for EndpointService.CreateEndpoint.",
"id": "GoogleCloudAiplatformV1CreateEndpointOperationMetadata",
"properties": {
"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."
},
"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"
},
"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."
},
"nearestNeighborSearchOperationMetadata": {
"$ref": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata",
"description": "The operation metadata with regard to Matching Engine Index operation."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata": {
"description": "Details of operations that perform MetadataService.CreateMetadataStore.",
"id": "GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata",
"properties": {
"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."
},
"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"
},
"parent": {
"description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata": {
"description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate.",
"id": "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The operation generic information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata": {
"description": "Details of operations that perform create PersistentResource.",
"id": "GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for PersistentResource."
},
"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"
},
"pipelineJob": {
"$ref": "GoogleCloudAiplatformV1PipelineJob",
"description": "Required. The PipelineJob to create."
},
"pipelineJobId": {
"description": "The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata": {
"description": "Details of operations that perform create FeatureGroup.",
"id": "GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata",
"properties": {
"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"
},
"GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest": {
"description": "Request message for TensorboardService.CreateTensorboardTimeSeries.",
"id": "GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest",
"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"
},
"tensorboardTimeSeries": {
"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries",
"description": "Required. The TensorboardTimeSeries to create."
},
"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"
},
"GoogleCloudAiplatformV1CsvDestination": {
"description": "The storage details for CSV output content.",
"id": "GoogleCloudAiplatformV1CsvDestination",
"properties": {
"gcsDestination": {
"$ref": "GoogleCloudAiplatformV1GcsDestination",
"description": "Required. Google Cloud Storage location."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CsvSource": {
"description": "The storage details for CSV input content.",
"id": "GoogleCloudAiplatformV1CsvSource",
"properties": {
"gcsSource": {
"$ref": "GoogleCloudAiplatformV1GcsSource",
"description": "Required. Google Cloud Storage location."
}
},
"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": {
"createTime": {
"description": "Output only. Time when the CustomJob 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"
},
"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."
},
"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"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.",
"readOnly": true
},
"jobSpec": {
"$ref": "GoogleCloudAiplatformV1CustomJobSpec",
"description": "Required. Job spec."
},
"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"
},
"name": {
"description": "Output only. Resource name of a CustomJob.",
"readOnly": true,
"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"
},
"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"
},
"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. 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"
},
"GoogleCloudAiplatformV1CustomJobSpec": {
"description": "Represents the spec of a CustomJob.",
"id": "GoogleCloudAiplatformV1CustomJobSpec",
"properties": {
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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": {
"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"
},
"GoogleCloudAiplatformV1CustomOutput": {
"description": "Spec for custom output.",
"id": "GoogleCloudAiplatformV1CustomOutput",
"properties": {
"rawOutputs": {
"$ref": "GoogleCloudAiplatformV1RawOutput",
"description": "Output only. List of raw output strings.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudAiplatformV1CustomOutputFormatConfig": {
"description": "Spec for custom output format configuration.",
"id": "GoogleCloudAiplatformV1CustomOutputFormatConfig",
"properties": {
"returnRawOutput": {
"description": "Optional. Whether to return raw output.",
"type": "boolean"
}
},
"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": {
"createTime": {
"description": "Output only. Timestamp when this DataItem 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 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"
},
"name": {
"description": "Output only. The resource name of the DataItem.",
"readOnly": true,
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1DataItemView": {
"description": "A container for a single DataItem and Annotations on it.",
"id": "GoogleCloudAiplatformV1DataItemView",
"properties": {
"annotations": {
"description": "The Annotations on the DataItem. If too many Annotations should be returned for the DataItem, this field will be truncated per annotations_limit in request. If it was, then the has_truncated_annotations will be set to true.",
"items": {
"$ref": "GoogleCloudAiplatformV1Annotation"
},
"type": "array"
},
"dataItem": {
"$ref": "GoogleCloudAiplatformV1DataItem",
"description": "The DataItem."
},
"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"
},
"GoogleCloudAiplatformV1DataLabelingJob": {
"description": "DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset:",
"id": "GoogleCloudAiplatformV1DataLabelingJob",
"properties": {
"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": {
"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": {
"description": "A collection of DataItems and Annotations on them.",
"id": "GoogleCloudAiplatformV1Dataset",
"properties": {
"createTime": {
"description": "Output only. Timestamp when this Dataset was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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"
},
"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"
},
"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": {
"additionalProperties": {
"type": "string"
},
"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"
},
"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"
},
"name": {
"description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
"readOnly": true,
"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"
},
"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"
},
"updateTime": {
"description": "Output only. Timestamp when this Dataset was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DatasetVersion": {
"description": "Describes the dataset version.",
"id": "GoogleCloudAiplatformV1DatasetVersion",
"properties": {
"bigQueryDatasetName": {
"description": "Output only. Name of the associated BigQuery dataset.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. Timestamp when this DatasetVersion was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"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,
"type": "any"
},
"modelReference": {
"description": "Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.",
"readOnly": true,
"type": "string"
},
"name": {
"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"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"updateTime": {
"description": "Output only. Timestamp when this DatasetVersion was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"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": {
"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": "GoogleCloudAiplatformV1AutoscalingMetricSpec"
},
"type": "array"
},
"machineSpec": {
"$ref": "GoogleCloudAiplatformV1MachineSpec",
"description": "Required. Immutable. The specification of a single machine being 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).",
"format": "int32",
"type": "integer"
},
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata": {
"description": "Details of operations that delete Feature values.",
"id": "GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for Featurestore delete Features values."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DeleteFeatureValuesRequest": {
"description": "Request message for FeaturestoreService.DeleteFeatureValues.",
"id": "GoogleCloudAiplatformV1DeleteFeatureValuesRequest",
"properties": {
"selectEntity": {
"$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity",
"description": "Select feature values to be deleted by specifying entities."
},
"selectTimeRangeAndFeature": {
"$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature",
"description": "Select feature values to be deleted by specifying time range and features."
}
},
"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": {
"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."
},
"skipOnlineStorageDelete": {
"description": "If set, data will not be deleted from online storage. When time range is older than the data in online storage, setting this to be true will make the deletion have no impact on online serving.",
"type": "boolean"
},
"timeRange": {
"$ref": "GoogleTypeInterval",
"description": "Required. Select feature generated within a half-inclusive time range. The time range is lower inclusive and upper exclusive."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DeleteFeatureValuesResponse": {
"description": "Response message for FeaturestoreService.DeleteFeatureValues.",
"id": "GoogleCloudAiplatformV1DeleteFeatureValuesResponse",
"properties": {
"selectEntity": {
"$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity",
"description": "Response for request specifying the entities to delete"
},
"selectTimeRangeAndFeature": {
"$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature",
"description": "Response for request specifying time range and feature"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity": {
"description": "Response message if the request uses the SelectEntity option.",
"id": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity",
"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.",
"format": "int64",
"type": "string"
},
"onlineStorageDeletedEntityCount": {
"description": "The count of deleted entities in the online storage. Each entity ID corresponds to one entity.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature": {
"description": "Response message if the request uses the SelectTimeRangeAndFeature option.",
"id": "GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature",
"properties": {
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata": {
"description": "Details of operations that perform MetadataService.DeleteMetadataStore.",
"id": "GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for deleting a MetadataStore."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DeleteOperationMetadata": {
"description": "Details of operations that perform deletes of any entities.",
"id": "GoogleCloudAiplatformV1DeleteOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The common part of the operation metadata."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DeployIndexOperationMetadata": {
"description": "Runtime operation information for IndexEndpointService.DeployIndex.",
"id": "GoogleCloudAiplatformV1DeployIndexOperationMetadata",
"properties": {
"deployedIndexId": {
"description": "The unique index id specified by user",
"type": "string"
},
"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": {
"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."
},
"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"
},
"GoogleCloudAiplatformV1DeployedIndex": {
"description": "A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.",
"id": "GoogleCloudAiplatformV1DeployedIndex",
"properties": {
"automaticResources": {
"$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."
},
"createTime": {
"description": "Output only. Timestamp when the DeployedIndex was created.",
"format": "google-datetime",
"readOnly": true,
"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."
},
"deployedIndexAuthConfig": {
"$ref": "GoogleCloudAiplatformV1DeployedIndexAuthConfig",
"description": "Optional. If set, the authentication is enabled for the private endpoint."
},
"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"
},
"displayName": {
"description": "The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.",
"type": "string"
},
"enableAccessLogging": {
"description": "Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.",
"type": "boolean"
},
"id": {
"description": "Required. The user specified ID of the DeployedIndex. The ID can be up to 128 characters long and must start with a letter and only contain letters, numbers, and underscores. The ID must be unique within the project it is created in.",
"type": "string"
},
"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"
},
"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,
"type": "string"
},
"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
},
"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"
},
"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"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DeployedIndexAuthConfig": {
"description": "Used to set up the auth on the DeployedIndex's private endpoint.",
"id": "GoogleCloudAiplatformV1DeployedIndexAuthConfig",
"properties": {
"authProvider": {
"$ref": "GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider",
"description": "Defines the authentication provider that the DeployedIndex uses."
}
},
"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": {
"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"
},
"audiences": {
"description": "The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DeployedIndexRef": {
"description": "Points to a DeployedIndex.",
"id": "GoogleCloudAiplatformV1DeployedIndexRef",
"properties": {
"deployedIndexId": {
"description": "Immutable. The ID of the DeployedIndex in the above IndexEndpoint.",
"type": "string"
},
"displayName": {
"description": "Output only. The display name of the DeployedIndex.",
"readOnly": true,
"type": "string"
},
"indexEndpoint": {
"description": "Immutable. A resource name of the IndexEndpoint.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DeployedModel": {
"description": "A deployment of a Model. Endpoints contain one or more DeployedModels.",
"id": "GoogleCloudAiplatformV1DeployedModel",
"properties": {
"automaticResources": {
"$ref": "GoogleCloudAiplatformV1AutomaticResources",
"description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration."
},
"createTime": {
"description": "Output only. Timestamp when the DeployedModel was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dedicatedResources": {
"$ref": "GoogleCloudAiplatformV1DedicatedResources",
"description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration."
},
"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"
},
"disableExplanations": {
"description": "If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec.",
"type": "boolean"
},
"displayName": {
"description": "The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used.",
"type": "string"
},
"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"
},
"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."
},
"fasterDeploymentConfig": {
"$ref": "GoogleCloudAiplatformV1FasterDeploymentConfig",
"description": "Configuration for faster model deployment."
},
"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"
},
"model": {
"description": "Required. 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"
},
"modelVersionId": {
"description": "Output only. The version ID of the model that is deployed.",
"readOnly": true,
"type": "string"
},
"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
},
"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"
},
"sharedResources": {
"description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
"type": "string"
},
"speculativeDecodingSpec": {
"$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpec",
"description": "Optional. Spec for configuring speculative decoding."
},
"status": {
"$ref": "GoogleCloudAiplatformV1DeployedModelStatus",
"description": "Output only. Runtime status of the deployed model.",
"readOnly": true
},
"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": {
"deployedModelId": {
"description": "Immutable. An ID of a DeployedModel in the above Endpoint.",
"type": "string"
},
"endpoint": {
"description": "Immutable. A resource name of an Endpoint.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DeployedModelStatus": {
"description": "Runtime status of the deployed model.",
"id": "GoogleCloudAiplatformV1DeployedModelStatus",
"properties": {
"availableReplicaCount": {
"description": "Output only. The number of available replicas of the deployed model.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"lastUpdateTime": {
"description": "Output only. The time at which the status was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Output only. The latest deployed model's status message (if any).",
"readOnly": true,
"type": "string"
}
},
"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": {
"createTime": {
"description": "Output only. Timestamp when this DeploymentResourcePool was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dedicatedResources": {
"$ref": "GoogleCloudAiplatformV1DedicatedResources",
"description": "Required. The underlying DedicatedResources that the DeploymentResourcePool uses."
},
"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"
},
"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"
},
"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"
},
"parameters": {
"$ref": "GoogleCloudAiplatformV1Tensor",
"description": "The parameters that govern the prediction."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DirectPredictResponse": {
"description": "Response message for PredictionService.DirectPredict.",
"id": "GoogleCloudAiplatformV1DirectPredictResponse",
"properties": {
"outputs": {
"description": "The prediction output.",
"items": {
"$ref": "GoogleCloudAiplatformV1Tensor"
},
"type": "array"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1DirectRawPredictResponse": {
"description": "Response message for PredictionService.DirectRawPredict.",
"id": "GoogleCloudAiplatformV1DirectRawPredictResponse",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1DoubleArray": {
"description": "A list of double values.",
"id": "GoogleCloudAiplatformV1DoubleArray",
"properties": {
"values": {
"description": "A list of double values.",
"items": {
"format": "double",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1DynamicRetrievalConfig": {
"description": "Describes the options to customize dynamic retrieval.",
"id": "GoogleCloudAiplatformV1DynamicRetrievalConfig",
"properties": {
"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"
},
"GoogleCloudAiplatformV1EncryptionSpec": {
"description": "Represents a customer-managed encryption key spec that can be applied to a top-level resource.",
"id": "GoogleCloudAiplatformV1EncryptionSpec",
"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"
},
"GoogleCloudAiplatformV1Endpoint": {
"description": "Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.",
"id": "GoogleCloudAiplatformV1Endpoint",
"properties": {
"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"
},
"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"
},
"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.",
"items": {
"$ref": "GoogleCloudAiplatformV1DeployedModel"
},
"readOnly": true,
"type": "array"
},
"description": {
"description": "The description of the Endpoint.",
"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.",
"type": "string"
},
"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": {
"$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."
},
"etag": {
"description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.",
"type": "string"
},
"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"
},
"name": {
"description": "Output only. The resource name of the Endpoint.",
"readOnly": true,
"type": "string"
},
"network": {
"description": "Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the 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"
},
"predictRequestResponseLoggingConfig": {
"$ref": "GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig",
"description": "Configures the request-response logging for online prediction."
},
"privateServiceConnectConfig": {
"$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig",
"description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive."
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"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"
},
"GoogleCloudAiplatformV1EnterpriseWebSearch": {
"description": "Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.",
"id": "GoogleCloudAiplatformV1EnterpriseWebSearch",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1EntityIdSelector": {
"description": "Selector for entityId. Getting ids from the given source.",
"id": "GoogleCloudAiplatformV1EntityIdSelector",
"properties": {
"csvSource": {
"$ref": "GoogleCloudAiplatformV1CsvSource",
"description": "Source of Csv"
},
"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"
},
"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": {
"createTime": {
"description": "Output only. Timestamp when this EntityType was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. Description of the EntityType.",
"type": "string"
},
"etag": {
"description": "Optional. Used to perform a 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 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": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"updateTime": {
"description": "Output only. Timestamp when this EntityType was most recently updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1EnvVar": {
"description": "Represents an environment variable present in a Container or Python Module.",
"id": "GoogleCloudAiplatformV1EnvVar",
"properties": {
"name": {
"description": "Required. Name of the environment variable. Must be a valid C identifier.",
"type": "string"
},
"value": {
"description": "Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ErrorAnalysisAnnotation": {
"description": "Model error analysis for each annotation.",
"id": "GoogleCloudAiplatformV1ErrorAnalysisAnnotation",
"properties": {
"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"
}
},
"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": {
"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"
},
"GoogleCloudAiplatformV1EvaluateDatasetRequest": {
"description": "Request message for EvaluationService.EvaluateDataset.",
"id": "GoogleCloudAiplatformV1EvaluateDatasetRequest",
"properties": {
"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}.`"
},
"dataset": {
"$ref": "GoogleCloudAiplatformV1EvaluationDataset",
"description": "Required. The dataset used for evaluation."
},
"metrics": {
"description": "Required. The metrics used for evaluation.",
"items": {
"$ref": "GoogleCloudAiplatformV1Metric"
},
"type": "array"
},
"outputConfig": {
"$ref": "GoogleCloudAiplatformV1OutputConfig",
"description": "Required. Config for evaluation output."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1EvaluateInstancesRequest": {
"description": "Request message for EvaluationService.EvaluateInstances.",
"id": "GoogleCloudAiplatformV1EvaluateInstancesRequest",
"properties": {
"autoraterConfig": {
"$ref": "GoogleCloudAiplatformV1AutoraterConfig",
"description": "Optional. Autorater config used for evaluation."
},
"bleuInput": {
"$ref": "GoogleCloudAiplatformV1BleuInput",
"description": "Instances and metric spec for bleu metric."
},
"coherenceInput": {
"$ref": "GoogleCloudAiplatformV1CoherenceInput",
"description": "Input for coherence metric."
},
"cometInput": {
"$ref": "GoogleCloudAiplatformV1CometInput",
"description": "Translation metrics. Input for Comet metric."
},
"exactMatchInput": {
"$ref": "GoogleCloudAiplatformV1ExactMatchInput",
"description": "Auto metric instances. Instances and metric spec for exact match metric."
},
"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": {
"$ref": "GoogleCloudAiplatformV1GroundednessInput",
"description": "Input for groundedness metric."
},
"metricxInput": {
"$ref": "GoogleCloudAiplatformV1MetricxInput",
"description": "Input for Metricx metric."
},
"pairwiseMetricInput": {
"$ref": "GoogleCloudAiplatformV1PairwiseMetricInput",
"description": "Input for pairwise metric."
},
"pairwiseQuestionAnsweringQualityInput": {
"$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput",
"description": "Input for pairwise question answering quality metric."
},
"pairwiseSummarizationQualityInput": {
"$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInput",
"description": "Input for pairwise summarization quality metric."
},
"pointwiseMetricInput": {
"$ref": "GoogleCloudAiplatformV1PointwiseMetricInput",
"description": "Input for pointwise metric."
},
"questionAnsweringCorrectnessInput": {
"$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput",
"description": "Input for question answering correctness metric."
},
"questionAnsweringHelpfulnessInput": {
"$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput",
"description": "Input for question answering helpfulness metric."
},
"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": {
"$ref": "GoogleCloudAiplatformV1ToolCallValidInput",
"description": "Tool call metric instances. Input for tool call valid metric."
},
"toolNameMatchInput": {
"$ref": "GoogleCloudAiplatformV1ToolNameMatchInput",
"description": "Input for tool name match metric."
},
"toolParameterKeyMatchInput": {
"$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchInput",
"description": "Input for tool parameter key match metric."
},
"toolParameterKvMatchInput": {
"$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchInput",
"description": "Input for tool parameter key value match metric."
},
"trajectoryAnyOrderMatchInput": {
"$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput",
"description": "Input for trajectory match any order metric."
},
"trajectoryExactMatchInput": {
"$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchInput",
"description": "Input for trajectory exact match metric."
},
"trajectoryInOrderMatchInput": {
"$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchInput",
"description": "Input for trajectory in order match metric."
},
"trajectoryPrecisionInput": {
"$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionInput",
"description": "Input for trajectory precision metric."
},
"trajectoryRecallInput": {
"$ref": "GoogleCloudAiplatformV1TrajectoryRecallInput",
"description": "Input for trajectory recall metric."
},
"trajectorySingleToolUseInput": {
"$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."
},
"coherenceResult": {
"$ref": "GoogleCloudAiplatformV1CoherenceResult",
"description": "Result for coherence metric."
},
"cometResult": {
"$ref": "GoogleCloudAiplatformV1CometResult",
"description": "Translation metrics. Result for Comet metric."
},
"exactMatchResults": {
"$ref": "GoogleCloudAiplatformV1ExactMatchResults",
"description": "Auto metric evaluation results. Results for exact match metric."
},
"fluencyResult": {
"$ref": "GoogleCloudAiplatformV1FluencyResult",
"description": "LLM-based metric evaluation result. General text generation metrics, applicable to other categories. Result for fluency metric."
},
"fulfillmentResult": {
"$ref": "GoogleCloudAiplatformV1FulfillmentResult",
"description": "Result for fulfillment metric."
},
"groundednessResult": {
"$ref": "GoogleCloudAiplatformV1GroundednessResult",
"description": "Result for groundedness metric."
},
"metricxResult": {
"$ref": "GoogleCloudAiplatformV1MetricxResult",
"description": "Result for Metricx metric."
},
"pairwiseMetricResult": {
"$ref": "GoogleCloudAiplatformV1PairwiseMetricResult",
"description": "Result for pairwise metric."
},
"pairwiseQuestionAnsweringQualityResult": {
"$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult",
"description": "Result for pairwise question answering quality metric."
},
"pairwiseSummarizationQualityResult": {
"$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityResult",
"description": "Result for pairwise summarization quality metric."
},
"pointwiseMetricResult": {
"$ref": "GoogleCloudAiplatformV1PointwiseMetricResult",
"description": "Generic metrics. Result for pointwise metric."
},
"questionAnsweringCorrectnessResult": {
"$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult",
"description": "Result for question answering correctness metric."
},
"questionAnsweringHelpfulnessResult": {
"$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult",
"description": "Result for question answering helpfulness metric."
},
"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."
},
"toolParameterKeyMatchResults": {
"$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchResults",
"description": "Results for tool parameter key match metric."
},
"toolParameterKvMatchResults": {
"$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchResults",
"description": "Results for tool parameter key value match metric."
},
"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"
},
"GoogleCloudAiplatformV1EvaluatedAnnotation": {
"description": "True positive, false positive, or false negative. EvaluatedAnnotation is only available under ModelEvaluationSlice with slice of `annotationSpec` dimension.",
"id": "GoogleCloudAiplatformV1EvaluatedAnnotation",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1EvaluatedAnnotationExplanation": {
"description": "Explanation result of the prediction produced by the Model.",
"id": "GoogleCloudAiplatformV1EvaluatedAnnotationExplanation",
"properties": {
"explanation": {
"$ref": "GoogleCloudAiplatformV1Explanation",
"description": "Explanation attribution response details."
},
"explanationType": {
"description": "Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1EvaluationDataset": {
"description": "The dataset used for evaluation.",
"id": "GoogleCloudAiplatformV1EvaluationDataset",
"properties": {
"bigquerySource": {
"$ref": "GoogleCloudAiplatformV1BigQuerySource",
"description": "BigQuery source holds the dataset."
},
"gcsSource": {
"$ref": "GoogleCloudAiplatformV1GcsSource",
"description": "Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1Event": {
"description": "An edge describing the relationship between an Artifact and an Execution in a lineage graph.",
"id": "GoogleCloudAiplatformV1Event",
"properties": {
"artifact": {
"description": "Required. The relative resource name of the Artifact in the Event.",
"type": "string"
},
"eventTime": {
"description": "Output only. Time the Event occurred.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1ExactMatchInput": {
"description": "Input for exact match metric.",
"id": "GoogleCloudAiplatformV1ExactMatchInput",
"properties": {
"instances": {
"description": "Required. Repeated exact match instances.",
"items": {
"$ref": "GoogleCloudAiplatformV1ExactMatchInstance"
},
"type": "array"
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1ExactMatchSpec",
"description": "Required. Spec for exact match metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExactMatchInstance": {
"description": "Spec for exact match instance.",
"id": "GoogleCloudAiplatformV1ExactMatchInstance",
"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"
},
"GoogleCloudAiplatformV1ExactMatchMetricValue": {
"description": "Exact match metric value for an instance.",
"id": "GoogleCloudAiplatformV1ExactMatchMetricValue",
"properties": {
"score": {
"description": "Output only. Exact match score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExactMatchResults": {
"description": "Results for exact match metric.",
"id": "GoogleCloudAiplatformV1ExactMatchResults",
"properties": {
"exactMatchMetricValues": {
"description": "Output only. Exact match metric values.",
"items": {
"$ref": "GoogleCloudAiplatformV1ExactMatchMetricValue"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExactMatchSpec": {
"description": "Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0.",
"id": "GoogleCloudAiplatformV1ExactMatchSpec",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1Examples": {
"description": "Example-based explainability that returns the nearest neighbors from the provided dataset.",
"id": "GoogleCloudAiplatformV1Examples",
"properties": {
"exampleGcsSource": {
"$ref": "GoogleCloudAiplatformV1ExamplesExampleGcsSource",
"description": "The Cloud Storage input instances."
},
"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"
},
"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."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExamplesExampleGcsSource": {
"description": "The Cloud Storage input instances.",
"id": "GoogleCloudAiplatformV1ExamplesExampleGcsSource",
"properties": {
"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"
},
"gcsSource": {
"$ref": "GoogleCloudAiplatformV1GcsSource",
"description": "The Cloud Storage location for the input instances."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExamplesOverride": {
"description": "Overrides for example-based explanations.",
"id": "GoogleCloudAiplatformV1ExamplesOverride",
"properties": {
"crowdingCount": {
"description": "The number of neighbors to return that have the same crowding tag.",
"format": "int32",
"type": "integer"
},
"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": "GoogleCloudAiplatformV1ExamplesRestrictionsNamespace"
},
"type": "array"
},
"returnEmbeddings": {
"description": "If true, return the embeddings instead of neighbors.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExamplesRestrictionsNamespace": {
"description": "Restrictions namespace for example-based explanations overrides.",
"id": "GoogleCloudAiplatformV1ExamplesRestrictionsNamespace",
"properties": {
"allow": {
"description": "The list of allowed tags.",
"items": {
"type": "string"
},
"type": "array"
},
"deny": {
"description": "The list of deny tags.",
"items": {
"type": "string"
},
"type": "array"
},
"namespaceName": {
"description": "The namespace name.",
"type": "string"
}
},
"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 [FunctionDeclaration] tool and [FunctionCallingConfig] mode is set to [Mode.CODE].",
"id": "GoogleCloudAiplatformV1ExecutableCode",
"properties": {
"code": {
"description": "Required. The code to be executed.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1Execution": {
"description": "Instance of a general execution.",
"id": "GoogleCloudAiplatformV1Execution",
"properties": {
"createTime": {
"description": "Output only. Timestamp when this Execution was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Description of the Execution",
"type": "string"
},
"displayName": {
"description": "User provided display name of the Execution. 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 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"
},
"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"
},
"name": {
"description": "Output only. The resource name of the Execution.",
"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_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"
},
"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"
},
"GoogleCloudAiplatformV1ExplainRequest": {
"description": "Request message for PredictionService.Explain.",
"id": "GoogleCloudAiplatformV1ExplainRequest",
"properties": {
"deployedModelId": {
"description": "If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split.",
"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."
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1ExplainResponse": {
"description": "Response message for PredictionService.Explain.",
"id": "GoogleCloudAiplatformV1ExplainResponse",
"properties": {
"deployedModelId": {
"description": "ID of the Endpoint's DeployedModel that served this explanation.",
"type": "string"
},
"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"
},
"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"
},
"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": {
"$ref": "GoogleCloudAiplatformV1Neighbor"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExplanationMetadata": {
"description": "Metadata describing the Model's input and output for explanation.",
"id": "GoogleCloudAiplatformV1ExplanationMetadata",
"properties": {
"featureAttributionsSchemaUri": {
"description": "Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.",
"type": "string"
},
"inputs": {
"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"
},
"latentSpaceSource": {
"description": "Name of the source to generate embeddings for example based explanations.",
"type": "string"
},
"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"
},
"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": {
"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"
},
"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"
},
"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"
},
"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"
},
"featureValueDomain": {
"$ref": "GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain",
"description": "The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized."
},
"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"
},
"type": "array"
},
"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"
},
"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"
},
"inputTensorName": {
"description": "Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.",
"type": "string"
},
"modality": {
"description": "Modality of the feature. Valid values are: numeric, image. Defaults to numeric.",
"type": "string"
},
"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"
},
"minValue": {
"description": "The minimum permissible value for this feature.",
"format": "float",
"type": "number"
},
"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"
},
"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"
},
"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"
},
"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": [
"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."
],
"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": [
"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."
],
"type": "string"
},
"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"
},
"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"
}
},
"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"
},
"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"
},
"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": "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."
},
"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"
},
"outputIndices": {
"description": "If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).",
"items": {
"type": "any"
},
"type": "array"
},
"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."
},
"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"
},
"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."
},
"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."
},
"metadata": {
"$ref": "GoogleCloudAiplatformV1ExplanationMetadataOverride",
"description": "The metadata to be overridden. If not specified, no metadata is overridden."
},
"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"
},
"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"
},
"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"
},
"filterSplit": {
"$ref": "GoogleCloudAiplatformV1ExportFilterSplit",
"description": "Split based on the provided filters for each set."
},
"fractionSplit": {
"$ref": "GoogleCloudAiplatformV1ExportFractionSplit",
"description": "Split based on fractions defining the size of each set."
},
"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."
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExportDataOperationMetadata": {
"description": "Runtime operation information for DatasetService.ExportData.",
"id": "GoogleCloudAiplatformV1ExportDataOperationMetadata",
"properties": {
"gcsOutputDirectory": {
"description": "A Google Cloud Storage directory which path ends with '/'. The exported data is stored in the directory.",
"type": "string"
},
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The common part of the operation metadata."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExportDataRequest": {
"description": "Request message for DatasetService.ExportData.",
"id": "GoogleCloudAiplatformV1ExportDataRequest",
"properties": {
"exportConfig": {
"$ref": "GoogleCloudAiplatformV1ExportDataConfig",
"description": "Required. The desired output location."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExportDataResponse": {
"description": "Response message for DatasetService.ExportData.",
"id": "GoogleCloudAiplatformV1ExportDataResponse",
"properties": {
"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"
},
"GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata": {
"description": "Details of operations that exports Features values.",
"id": "GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for Featurestore export Feature values."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExportFeatureValuesRequest": {
"description": "Request message for FeaturestoreService.ExportFeatureValues.",
"id": "GoogleCloudAiplatformV1ExportFeatureValuesRequest",
"properties": {
"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"
},
"GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport": {
"description": "Describes exporting all historical Feature values of all entities of the EntityType between [start_time, end_time].",
"id": "GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport",
"properties": {
"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"
},
"GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport": {
"description": "Describes exporting the latest Feature values of all entities of the EntityType between [start_time, snapshot_time].",
"id": "GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport",
"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.",
"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"
},
"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": {
"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"
},
"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"
},
"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": {
"testFraction": {
"description": "The fraction of the input data that is to be used to evaluate the Model.",
"format": "double",
"type": "number"
},
"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"
},
"GoogleCloudAiplatformV1ExportModelOperationMetadata": {
"description": "Details of ModelService.ExportModel operation.",
"id": "GoogleCloudAiplatformV1ExportModelOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The common part of the operation metadata."
},
"outputInfo": {
"$ref": "GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo",
"description": "Output only. Information further describing the output of this Model export.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo": {
"description": "Further describes the output of the ExportModel. Supplements ExportModelRequest.OutputConfig.",
"id": "GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo",
"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,
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1ExportModelRequest": {
"description": "Request message for ModelService.ExportModel.",
"id": "GoogleCloudAiplatformV1ExportModelRequest",
"properties": {
"outputConfig": {
"$ref": "GoogleCloudAiplatformV1ExportModelRequestOutputConfig",
"description": "Required. The desired output location and configuration."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ExportModelRequestOutputConfig": {
"description": "Output configuration for the Model export.",
"id": "GoogleCloudAiplatformV1ExportModelRequestOutputConfig",
"properties": {
"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`."
},
"exportFormatId": {
"description": "The ID of the format in which the Model must be exported. Each Model lists the export formats it supports. If no value is provided here, then the first from the list of the Model's supported formats is used by default.",
"type": "string"
},
"imageDestination": {
"$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"
},
"GoogleCloudAiplatformV1ExportModelResponse": {
"description": "Response message of ModelService.ExportModel operation.",
"id": "GoogleCloudAiplatformV1ExportModelResponse",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest": {
"description": "Request message for TensorboardService.ExportTensorboardTimeSeriesData.",
"id": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest",
"properties": {
"filter": {
"description": "Exports the TensorboardTimeSeries' data that match the filter expression.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse": {
"description": "Response message for TensorboardService.ExportTensorboardTimeSeriesData.",
"id": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse",
"properties": {
"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"
},
"timeSeriesDataPoints": {
"description": "The returned time series data points.",
"items": {
"$ref": "GoogleCloudAiplatformV1TimeSeriesDataPoint"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1Fact": {
"description": "The fact used in grounding.",
"id": "GoogleCloudAiplatformV1Fact",
"properties": {
"chunk": {
"$ref": "GoogleCloudAiplatformV1RagChunk",
"description": "If present, chunk properties."
},
"query": {
"description": "Query that is used to retrieve this fact.",
"type": "string"
},
"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"
},
"summary": {
"description": "If present, the summary/snippet of the fact.",
"type": "string"
},
"title": {
"description": "If present, it refers to the title of this fact.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1FasterDeploymentConfig": {
"description": "Configuration for faster model deployment.",
"id": "GoogleCloudAiplatformV1FasterDeploymentConfig",
"properties": {
"fastTryoutEnabled": {
"description": "If true, enable fast tryout feature for this deployed model.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1Feature": {
"description": "Feature Metadata information. For example, color is a feature that describes an apple.",
"id": "GoogleCloudAiplatformV1Feature",
"properties": {
"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"
},
"description": {
"description": "Description of the Feature.",
"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"
},
"etag": {
"description": "Used to perform a 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 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"
},
"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"
},
"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"
},
"pointOfContact": {
"description": "Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1FeatureGroup": {
"description": "Vertex AI Feature Group.",
"id": "GoogleCloudAiplatformV1FeatureGroup",
"properties": {
"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 of the FeatureGroup.",
"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 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"
},
"name": {
"description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1FeatureGroupBigQuery": {
"description": "Input source type for BigQuery Tables and Views.",
"id": "GoogleCloudAiplatformV1FeatureGroupBigQuery",
"properties": {
"bigQuerySource": {
"$ref": "GoogleCloudAiplatformV1BigQuerySource",
"description": "Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View."
},
"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"
},
"entityIdColumns": {
"description": "Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`.",
"items": {
"type": "string"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries": {
"id": "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries",
"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.",
"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
},
"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"
}
},
"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"
},
"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"
},
"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": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1FeatureOnlineStoreBigtable": {
"id": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtable",
"properties": {
"autoScaling": {
"$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling",
"description": "Required. Autoscaling config applied to Bigtable Instance."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling": {
"id": "GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling",
"properties": {
"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"
},
"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"
},
"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": {
"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."
},
"publicEndpointDomainName": {
"description": "Output only. This field will be populated with the domain name to use for this FeatureOnlineStore",
"readOnly": true,
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1FeatureOnlineStoreOptimized": {
"description": "Optimized storage type",
"id": "GoogleCloudAiplatformV1FeatureOnlineStoreOptimized",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1FeatureSelector": {
"description": "Selector for Features of an EntityType.",
"id": "GoogleCloudAiplatformV1FeatureSelector",
"properties": {
"idMatcher": {
"$ref": "GoogleCloudAiplatformV1IdMatcher",
"description": "Required. Matches Features based on ID."
}
},
"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": {
"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\u2013Shannon 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"
},
"GoogleCloudAiplatformV1FeatureValue": {
"description": "Value for a feature.",
"id": "GoogleCloudAiplatformV1FeatureValue",
"properties": {
"boolArrayValue": {
"$ref": "GoogleCloudAiplatformV1BoolArray",
"description": "A list of bool type feature value."
},
"boolValue": {
"description": "Bool type feature value.",
"type": "boolean"
},
"bytesValue": {
"description": "Bytes feature value.",
"format": "byte",
"type": "string"
},
"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"
},
"metadata": {
"$ref": "GoogleCloudAiplatformV1FeatureValueMetadata",
"description": "Metadata of feature value."
},
"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."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FeatureValueDestination": {
"description": "A destination location for Feature values and format.",
"id": "GoogleCloudAiplatformV1FeatureValueDestination",
"properties": {
"bigqueryDestination": {
"$ref": "GoogleCloudAiplatformV1BigQueryDestination",
"description": "Output in BigQuery format. BigQueryDestination.output_uri in FeatureValueDestination.bigquery_destination must refer to a table."
},
"csvDestination": {
"$ref": "GoogleCloudAiplatformV1CsvDestination",
"description": "Output in CSV format. Array Feature value types are not allowed in CSV format."
},
"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"
},
"GoogleCloudAiplatformV1FeatureValueList": {
"description": "Container for list of values.",
"id": "GoogleCloudAiplatformV1FeatureValueList",
"properties": {
"values": {
"description": "A list of feature values. All of them should be the same data type.",
"items": {
"$ref": "GoogleCloudAiplatformV1FeatureValue"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FeatureValueMetadata": {
"description": "Metadata of feature value.",
"id": "GoogleCloudAiplatformV1FeatureValueMetadata",
"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. 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"
},
"GoogleCloudAiplatformV1FeatureView": {
"description": "FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.",
"id": "GoogleCloudAiplatformV1FeatureView",
"properties": {
"bigQuerySource": {
"$ref": "GoogleCloudAiplatformV1FeatureViewBigQuerySource",
"description": "Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore."
},
"createTime": {
"description": "Output only. Timestamp when this FeatureView 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"
},
"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"
},
"name": {
"description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
"type": "string"
},
"optimizedConfig": {
"$ref": "GoogleCloudAiplatformV1FeatureViewOptimizedConfig",
"description": "Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore."
},
"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"
},
"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": [
"By default, the project-level Vertex AI Service Agent is enabled.",
"Indicates the project-level Vertex AI Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used during sync jobs.",
"Enable a FeatureView service account to be created by Vertex AI and output in the field `service_account_email`. This service account will be used to read from the source BigQuery table during sync."
],
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1FeatureViewBigQuerySource": {
"id": "GoogleCloudAiplatformV1FeatureViewBigQuerySource",
"properties": {
"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"
},
"GoogleCloudAiplatformV1FeatureViewDataKey": {
"description": "Lookup key for a feature view.",
"id": "GoogleCloudAiplatformV1FeatureViewDataKey",
"properties": {
"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."
},
"key": {
"description": "String key to use for lookup.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey": {
"description": "ID that is comprised from several parts (columns).",
"id": "GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey",
"properties": {
"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"
},
"GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource": {
"description": "A Feature Registry source for features that need to be synced to Online Store.",
"id": "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource",
"properties": {
"featureGroups": {
"description": "Required. List of features that need to be synced to Online Store.",
"items": {
"$ref": "GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup"
},
"type": "array"
},
"projectNumber": {
"description": "Optional. The project number of the parent project of the Feature Groups.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"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"
},
"GoogleCloudAiplatformV1FeatureViewIndexConfig": {
"description": "Configuration for vector indexing.",
"id": "GoogleCloudAiplatformV1FeatureViewIndexConfig",
"properties": {
"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": [
"Should not be set.",
"Euclidean (L_2) Distance.",
"Cosine Distance. Defined as 1 - cosine similarity. We strongly suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead of COSINE distance. Our algorithms have been more optimized for DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is mathematically equivalent to COSINE distance and results in the same ranking.",
"Dot Product Distance. Defined as a negative of the dot product."
],
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig": {
"description": "Configuration options for using brute force search.",
"id": "GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig": {
"description": "Configuration options for the tree-AH algorithm.",
"id": "GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig",
"properties": {
"leafNodeEmbeddingCount": {
"description": "Optional. Number of embeddings on each leaf node. The default value is 1000 if not set.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FeatureViewOptimizedConfig": {
"description": "Configuration for FeatureViews created in Optimized FeatureOnlineStore.",
"id": "GoogleCloudAiplatformV1FeatureViewOptimizedConfig",
"properties": {
"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"
},
"GoogleCloudAiplatformV1FeatureViewSync": {
"description": "FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store.",
"id": "GoogleCloudAiplatformV1FeatureViewSync",
"properties": {
"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"
},
"finalStatus": {
"$ref": "GoogleRpcStatus",
"description": "Output only. Final status of the FeatureViewSync.",
"readOnly": true
},
"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"
},
"runTime": {
"$ref": "GoogleTypeInterval",
"description": "Output only. Time when this FeatureViewSync is finished.",
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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."
},
"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 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"
},
"name": {
"description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
"readOnly": true,
"type": "string"
},
"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."
},
"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"
},
"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 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"
},
"updateTime": {
"description": "Output only. Timestamp when this Featurestore was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FeaturestoreMonitoringConfig": {
"description": "Configuration of how features in Featurestore are monitored.",
"id": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfig",
"properties": {
"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"
},
"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": {
"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"
},
"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": {
"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"
},
"GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig": {
"description": "The config for Featurestore Monitoring threshold.",
"id": "GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig",
"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\u2013Shannon 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"
},
"GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig": {
"description": "OnlineServingConfig specifies the details for provisioning online serving resources.",
"id": "GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig",
"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.",
"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"
},
"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": {
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1FetchFeatureValuesRequest": {
"description": "Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned.",
"id": "GoogleCloudAiplatformV1FetchFeatureValuesRequest",
"properties": {
"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"
},
"dataKey": {
"$ref": "GoogleCloudAiplatformV1FeatureViewDataKey",
"description": "Optional. The request key to fetch feature values for."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FetchFeatureValuesResponse": {
"description": "Response message for FeatureOnlineStoreService.FetchFeatureValues",
"id": "GoogleCloudAiplatformV1FetchFeatureValuesResponse",
"properties": {
"dataKey": {
"$ref": "GoogleCloudAiplatformV1FeatureViewDataKey",
"description": "The data key associated with this response. Will only be populated for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs."
},
"keyValues": {
"$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList",
"description": "Feature values in KeyValue format."
},
"protoStruct": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Feature values in proto Struct format.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList": {
"description": "Response structure in the format of key (feature name) and (feature) value pair.",
"id": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList",
"properties": {
"features": {
"description": "List of feature names and values.",
"items": {
"$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair": {
"description": "Feature name & value pair.",
"id": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair",
"properties": {
"name": {
"description": "Feature short name.",
"type": "string"
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FileData": {
"description": "URI based data.",
"id": "GoogleCloudAiplatformV1FileData",
"properties": {
"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 not currently used in the Gemini GenerateContent calls.",
"type": "string"
},
"fileUri": {
"description": "Required. URI.",
"type": "string"
},
"mimeType": {
"description": "Required. The IANA standard MIME type of the source data.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FileStatus": {
"description": "RagFile status.",
"id": "GoogleCloudAiplatformV1FileStatus",
"properties": {
"errorStatus": {
"description": "Output only. Only when the `state` field is ERROR.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. RagFile state.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"ERROR"
],
"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."
],
"readOnly": true,
"type": "string"
}
},
"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": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1FindNeighborsRequest": {
"description": "The request message for MatchService.FindNeighbors.",
"id": "GoogleCloudAiplatformV1FindNeighborsRequest",
"properties": {
"deployedIndexId": {
"description": "The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1FindNeighborsRequestQuery": {
"description": "A query to find a number of the nearest neighbors (most similar vectors) of a vector.",
"id": "GoogleCloudAiplatformV1FindNeighborsRequestQuery",
"properties": {
"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"
},
"datapoint": {
"$ref": "GoogleCloudAiplatformV1IndexDatapoint",
"description": "Required. The datapoint/vector whose nearest neighbors should be searched for."
},
"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"
},
"GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF": {
"description": "Parameters for RRF algorithm that combines search results.",
"id": "GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF",
"properties": {
"alpha": {
"description": "Required. Users can provide an alpha value to give more weight to dense vs sparse results. For example, if the alpha is 0, we only return sparse and if the alpha is 1, we only return dense.",
"format": "float",
"type": "number"
}
},
"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"
},
"neighbors": {
"description": "All its neighbors.",
"items": {
"$ref": "GoogleCloudAiplatformV1FindNeighborsResponseNeighbor"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FindNeighborsResponseNeighbor": {
"description": "A neighbor of the query vector.",
"id": "GoogleCloudAiplatformV1FindNeighborsResponseNeighbor",
"properties": {
"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."
},
"distance": {
"description": "The distance between the neighbor and the dense embedding query.",
"format": "double",
"type": "number"
},
"sparseDistance": {
"description": "The distance between the neighbor and the query sparse_embedding.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FluencyInput": {
"description": "Input for fluency metric.",
"id": "GoogleCloudAiplatformV1FluencyInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1FluencyInstance",
"description": "Required. Fluency instance."
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FluencyResult": {
"description": "Spec for fluency result.",
"id": "GoogleCloudAiplatformV1FluencyResult",
"properties": {
"confidence": {
"description": "Output only. Confidence for fluency score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"explanation": {
"description": "Output only. Explanation for fluency score.",
"readOnly": true,
"type": "string"
},
"score": {
"description": "Output only. Fluency score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FluencySpec": {
"description": "Spec for fluency score metric.",
"id": "GoogleCloudAiplatformV1FluencySpec",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1FulfillmentInput": {
"description": "Input for fulfillment metric.",
"id": "GoogleCloudAiplatformV1FulfillmentInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1FulfillmentInstance",
"description": "Required. Fulfillment instance."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1FulfillmentSpec",
"description": "Required. Spec for fulfillment score metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FulfillmentInstance": {
"description": "Spec for fulfillment instance.",
"id": "GoogleCloudAiplatformV1FulfillmentInstance",
"properties": {
"instruction": {
"description": "Required. Inference instruction prompt to compare prediction with.",
"type": "string"
},
"prediction": {
"description": "Required. Output of the evaluated model.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FulfillmentResult": {
"description": "Spec for fulfillment result.",
"id": "GoogleCloudAiplatformV1FulfillmentResult",
"properties": {
"confidence": {
"description": "Output only. Confidence for fulfillment score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"explanation": {
"description": "Output only. Explanation for fulfillment score.",
"readOnly": true,
"type": "string"
},
"score": {
"description": "Output only. Fulfillment score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FulfillmentSpec": {
"description": "Spec for fulfillment metric.",
"id": "GoogleCloudAiplatformV1FulfillmentSpec",
"properties": {
"version": {
"description": "Optional. Which version to use for evaluation.",
"format": "int32",
"type": "integer"
}
},
"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": {
"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": "Required. The name of the function to call. Matches [FunctionDeclaration.name].",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1FunctionCallingConfig": {
"description": "Function calling config.",
"id": "GoogleCloudAiplatformV1FunctionCallingConfig",
"properties": {
"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": {
"type": "string"
},
"type": "array"
},
"mode": {
"description": "Optional. Function calling mode.",
"enum": [
"MODE_UNSPECIFIED",
"AUTO",
"ANY",
"NONE"
],
"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."
],
"type": "string"
}
},
"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": {
"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 and dashes, with a maximum length of 64.",
"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"
},
"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."
}
},
"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": {
"name": {
"description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
"type": "string"
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GcsDestination": {
"description": "The Google Cloud Storage location where the output is to be written to.",
"id": "GoogleCloudAiplatformV1GcsDestination",
"properties": {
"outputUriPrefix": {
"description": "Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GcsSource": {
"description": "The Google Cloud Storage location for the input content.",
"id": "GoogleCloudAiplatformV1GcsSource",
"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.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig": {
"description": "Configuration for GenAiAdvancedFeatures.",
"id": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig",
"properties": {
"ragConfig": {
"$ref": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig",
"description": "Configuration for Retrieval Augmented Generation feature."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig": {
"description": "Configuration for Retrieval Augmented Generation feature.",
"id": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfigRagConfig",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenerateContentRequest": {
"description": "Request message for [PredictionService.GenerateContent].",
"id": "GoogleCloudAiplatformV1GenerateContentRequest",
"properties": {
"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": "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"
},
"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"
},
"GoogleCloudAiplatformV1GenerateContentResponse": {
"description": "Response message for [PredictionService.GenerateContent].",
"id": "GoogleCloudAiplatformV1GenerateContentResponse",
"properties": {
"candidates": {
"description": "Output only. Generated candidates.",
"items": {
"$ref": "GoogleCloudAiplatformV1Candidate"
},
"readOnly": true,
"type": "array"
},
"createTime": {
"description": "Output only. Timestamp when the request is made to the server.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"modelVersion": {
"description": "Output only. The model version used to generate the response.",
"readOnly": true,
"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"
},
"GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback": {
"description": "Content filter results for a prompt sent in the request.",
"id": "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback",
"properties": {
"blockReason": {
"description": "Output only. Blocked reason.",
"enum": [
"BLOCKED_REASON_UNSPECIFIED",
"SAFETY",
"OTHER",
"BLOCKLIST",
"PROHIBITED_CONTENT"
],
"enumDescriptions": [
"Unspecified blocked reason.",
"Candidates blocked due to safety.",
"Candidates blocked due to other reason.",
"Candidates blocked due to the terms which are included from the terminology blocklist.",
"Candidates blocked due to prohibited content."
],
"readOnly": true,
"type": "string"
},
"blockReasonMessage": {
"description": "Output only. A readable block reason message.",
"readOnly": true,
"type": "string"
},
"safetyRatings": {
"description": "Output only. Safety ratings.",
"items": {
"$ref": "GoogleCloudAiplatformV1SafetyRating"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata": {
"description": "Usage metadata about response(s).",
"id": "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata",
"properties": {
"cacheTokensDetails": {
"description": "Output only. List of modalities of the cached content in the request input.",
"items": {
"$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
},
"readOnly": true,
"type": "array"
},
"cachedContentTokenCount": {
"description": "Output only. Number of tokens in the cached part in the input (the cached content).",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"candidatesTokenCount": {
"description": "Number of tokens in the response(s).",
"format": "int32",
"type": "integer"
},
"candidatesTokensDetails": {
"description": "Output only. List of modalities that were returned in the response.",
"items": {
"$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
},
"readOnly": true,
"type": "array"
},
"promptTokenCount": {
"description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.",
"format": "int32",
"type": "integer"
},
"promptTokensDetails": {
"description": "Output only. List of modalities that were processed in the request input.",
"items": {
"$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
},
"readOnly": true,
"type": "array"
},
"thoughtsTokenCount": {
"description": "Output only. Number of tokens present in thoughts output.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"toolUsePromptTokenCount": {
"description": "Output only. Number of tokens present in tool-use prompt(s).",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"toolUsePromptTokensDetails": {
"description": "Output only. List of modalities that were processed for tool-use request inputs.",
"items": {
"$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
},
"readOnly": true,
"type": "array"
},
"totalTokenCount": {
"description": "Total token count for prompt, response candidates, and tool-use prompts (if present).",
"format": "int32",
"type": "integer"
},
"trafficType": {
"description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.",
"enum": [
"TRAFFIC_TYPE_UNSPECIFIED",
"ON_DEMAND",
"PROVISIONED_THROUGHPUT"
],
"enumDescriptions": [
"Unspecified request traffic type.",
"Type for Pay-As-You-Go traffic.",
"Type for Provisioned Throughput traffic."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenerateVideoResponse": {
"description": "Generate video response.",
"id": "GoogleCloudAiplatformV1GenerateVideoResponse",
"properties": {
"generatedSamples": {
"deprecated": true,
"description": "The cloud storage uris of the generated videos.",
"items": {
"type": "string"
},
"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 video bytes or Cloud Storage URIs of the generated videos.",
"items": {
"$ref": "GoogleCloudAiplatformV1GenerateVideoResponseVideo"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenerateVideoResponseVideo": {
"description": "A generated video.",
"id": "GoogleCloudAiplatformV1GenerateVideoResponseVideo",
"properties": {
"bytesBase64Encoded": {
"description": "Base64 encoded bytes string representing the video.",
"type": "string"
},
"gcsUri": {
"description": "Cloud Storage URI where the generated video is written.",
"type": "string"
},
"mimeType": {
"description": "The MIME type of the content of the video. - video/mp4",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenerationConfig": {
"description": "Generation config.",
"id": "GoogleCloudAiplatformV1GenerationConfig",
"properties": {
"audioTimestamp": {
"description": "Optional. If enabled, audio timestamp will be included in the request to the model.",
"type": "boolean"
},
"candidateCount": {
"description": "Optional. Number of candidates to generate.",
"format": "int32",
"type": "integer"
},
"frequencyPenalty": {
"description": "Optional. Frequency penalties.",
"format": "float",
"type": "number"
},
"logprobs": {
"description": "Optional. Logit probabilities.",
"format": "int32",
"type": "integer"
},
"maxOutputTokens": {
"description": "Optional. The maximum number of output tokens to generate per message.",
"format": "int32",
"type": "integer"
},
"mediaResolution": {
"description": "Optional. If specified, the media resolution specified will be used.",
"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"
},
"presencePenalty": {
"description": "Optional. Positive penalties.",
"format": "float",
"type": "number"
},
"responseLogprobs": {
"description": "Optional. If true, export the logprobs results in response.",
"type": "boolean"
},
"responseMimeType": {
"description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.",
"type": "string"
},
"responseModalities": {
"description": "Optional. The modalities of the response.",
"items": {
"enum": [
"MODALITY_UNSPECIFIED",
"TEXT",
"IMAGE",
"AUDIO"
],
"enumDescriptions": [
"Unspecified modality. Will be processed as text.",
"Text modality.",
"Image modality.",
"Audio modality."
],
"type": "string"
},
"type": "array"
},
"responseSchema": {
"$ref": "GoogleCloudAiplatformV1Schema",
"description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response."
},
"routingConfig": {
"$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig",
"description": "Optional. Routing configuration."
},
"seed": {
"description": "Optional. Seed.",
"format": "int32",
"type": "integer"
},
"speechConfig": {
"$ref": "GoogleCloudAiplatformV1SpeechConfig",
"description": "Optional. The speech generation config."
},
"stopSequences": {
"description": "Optional. Stop sequences.",
"items": {
"type": "string"
},
"type": "array"
},
"temperature": {
"description": "Optional. Controls the randomness of predictions.",
"format": "float",
"type": "number"
},
"thinkingConfig": {
"$ref": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig",
"description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking."
},
"topK": {
"description": "Optional. If specified, top-k sampling will be used.",
"format": "float",
"type": "number"
},
"topP": {
"description": "Optional. If specified, nucleus sampling will be used.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenerationConfigRoutingConfig": {
"description": "The configuration for routing the request to a specific model.",
"id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig",
"properties": {
"autoMode": {
"$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode",
"description": "Automated routing."
},
"manualMode": {
"$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode",
"description": "Manual routing."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode": {
"description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.",
"id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode",
"properties": {
"modelRoutingPreference": {
"description": "The model routing preference.",
"enum": [
"UNKNOWN",
"PRIORITIZE_QUALITY",
"BALANCED",
"PRIORITIZE_COST"
],
"enumDescriptions": [
"Unspecified model routing preference.",
"Prefer higher quality over low cost.",
"Balanced model routing preference.",
"Prefer lower cost over higher quality."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode": {
"description": "When manual routing is set, the specified model will be used directly.",
"id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode",
"properties": {
"modelName": {
"description": "The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenerationConfigThinkingConfig": {
"description": "Config for thinking features.",
"id": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig",
"properties": {
"thinkingBudget": {
"description": "Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GenericOperationMetadata": {
"description": "Generic Metadata shared by all operations.",
"id": "GoogleCloudAiplatformV1GenericOperationMetadata",
"properties": {
"createTime": {
"description": "Output only. Time when the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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": "GoogleRpcStatus"
},
"readOnly": true,
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1GenieSource": {
"description": "Contains information about the source of the models generated from Generative AI Studio.",
"id": "GoogleCloudAiplatformV1GenieSource",
"properties": {
"baseModelUri": {
"description": "Required. The public base model URI.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GoogleDriveSource": {
"description": "The Google Drive location for the input content.",
"id": "GoogleCloudAiplatformV1GoogleDriveSource",
"properties": {
"resourceIds": {
"description": "Required. Google Drive resource IDs.",
"items": {
"$ref": "GoogleCloudAiplatformV1GoogleDriveSourceResourceId"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GoogleDriveSourceResourceId": {
"description": "The type and ID of the Google Drive resource.",
"id": "GoogleCloudAiplatformV1GoogleDriveSourceResourceId",
"properties": {
"resourceId": {
"description": "Required. The ID of the Google Drive resource.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1GoogleSearchRetrieval": {
"description": "Tool to retrieve public web data for grounding, powered by Google.",
"id": "GoogleCloudAiplatformV1GoogleSearchRetrieval",
"properties": {
"dynamicRetrievalConfig": {
"$ref": "GoogleCloudAiplatformV1DynamicRetrievalConfig",
"description": "Specifies the dynamic retrieval configuration for the given source."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GroundednessInput": {
"description": "Input for groundedness metric.",
"id": "GoogleCloudAiplatformV1GroundednessInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1GroundednessInstance",
"description": "Required. Groundedness instance."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1GroundednessSpec",
"description": "Required. Spec for groundedness metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GroundednessInstance": {
"description": "Spec for groundedness instance.",
"id": "GoogleCloudAiplatformV1GroundednessInstance",
"properties": {
"context": {
"description": "Required. Background information provided in context used to compare against the prediction.",
"type": "string"
},
"prediction": {
"description": "Required. Output of the evaluated model.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GroundednessResult": {
"description": "Spec for groundedness result.",
"id": "GoogleCloudAiplatformV1GroundednessResult",
"properties": {
"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"
},
"score": {
"description": "Output only. Groundedness score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GroundednessSpec": {
"description": "Spec for groundedness metric.",
"id": "GoogleCloudAiplatformV1GroundednessSpec",
"properties": {
"version": {
"description": "Optional. Which version to use for evaluation.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GroundingChunk": {
"description": "Grounding chunk.",
"id": "GoogleCloudAiplatformV1GroundingChunk",
"properties": {
"retrievedContext": {
"$ref": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext",
"description": "Grounding chunk from context retrieved by the retrieval tools."
},
"web": {
"$ref": "GoogleCloudAiplatformV1GroundingChunkWeb",
"description": "Grounding chunk from the web."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GroundingChunkRetrievedContext": {
"description": "Chunk from context retrieved by the retrieval tools.",
"id": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext",
"properties": {
"ragChunk": {
"$ref": "GoogleCloudAiplatformV1RagChunk",
"description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool."
},
"text": {
"description": "Text of the attribution.",
"type": "string"
},
"title": {
"description": "Title of the attribution.",
"type": "string"
},
"uri": {
"description": "URI reference of the attribution.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GroundingChunkWeb": {
"description": "Chunk from the web.",
"id": "GoogleCloudAiplatformV1GroundingChunkWeb",
"properties": {
"domain": {
"description": "Domain of the (original) URI.",
"type": "string"
},
"title": {
"description": "Title of the chunk.",
"type": "string"
},
"uri": {
"description": "URI reference of the chunk.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GroundingMetadata": {
"description": "Metadata returned to client when grounding is enabled.",
"id": "GoogleCloudAiplatformV1GroundingMetadata",
"properties": {
"groundingChunks": {
"description": "List of supporting references retrieved from specified grounding source.",
"items": {
"$ref": "GoogleCloudAiplatformV1GroundingChunk"
},
"type": "array"
},
"groundingSupports": {
"description": "Optional. List of grounding support.",
"items": {
"$ref": "GoogleCloudAiplatformV1GroundingSupport"
},
"type": "array"
},
"retrievalMetadata": {
"$ref": "GoogleCloudAiplatformV1RetrievalMetadata",
"description": "Optional. Output only. Retrieval metadata.",
"readOnly": true
},
"searchEntryPoint": {
"$ref": "GoogleCloudAiplatformV1SearchEntryPoint",
"description": "Optional. Google search entry for the following-up web searches."
},
"webSearchQueries": {
"description": "Optional. Web search queries for the following-up web search.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1GroundingSupport": {
"description": "Grounding support.",
"id": "GoogleCloudAiplatformV1GroundingSupport",
"properties": {
"confidenceScores": {
"description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices.",
"items": {
"format": "float",
"type": "number"
},
"type": "array"
},
"groundingChunkIndices": {
"description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"segment": {
"$ref": "GoogleCloudAiplatformV1Segment",
"description": "Segment of the content this support belongs to."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1HyperparameterTuningJob": {
"description": "Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.",
"id": "GoogleCloudAiplatformV1HyperparameterTuningJob",
"properties": {
"createTime": {
"description": "Output only. Time when the HyperparameterTuningJob was created.",
"format": "google-datetime",
"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.",
"type": "string"
},
"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."
},
"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"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.",
"readOnly": true
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The labels with user-defined metadata to organize HyperparameterTuningJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.",
"type": "object"
},
"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": "Required. The desired total number of Trials.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Output only. Resource name of the HyperparameterTuningJob.",
"readOnly": true,
"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"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"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"
},
"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"
},
"studySpec": {
"$ref": "GoogleCloudAiplatformV1StudySpec",
"description": "Required. Study configuration of the HyperparameterTuningJob."
},
"trialJobSpec": {
"$ref": "GoogleCloudAiplatformV1CustomJobSpec",
"description": "Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials."
},
"trials": {
"description": "Output only. Trials of the HyperparameterTuningJob.",
"items": {
"$ref": "GoogleCloudAiplatformV1Trial"
},
"readOnly": true,
"type": "array"
},
"updateTime": {
"description": "Output only. Time when the HyperparameterTuningJob was most recently updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"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": {
"type": "string"
},
"type": "array"
}
},
"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"
},
"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"
},
"gcsSource": {
"$ref": "GoogleCloudAiplatformV1GcsSource",
"description": "The Google Cloud Storage location for the input content."
},
"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"
},
"GoogleCloudAiplatformV1ImportDataOperationMetadata": {
"description": "Runtime operation information for DatasetService.ImportData.",
"id": "GoogleCloudAiplatformV1ImportDataOperationMetadata",
"properties": {
"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": "GoogleCloudAiplatformV1ImportDataConfig"
},
"type": "array"
}
},
"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": {
"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"
},
"importedFeatureValueCount": {
"description": "Number of Feature values that have been imported by the operation.",
"format": "int64",
"type": "string"
},
"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"
},
"sourceUris": {
"description": "The source URI from where Feature values are imported.",
"items": {
"type": "string"
},
"type": "array"
},
"timestampOutsideRetentionRowsCount": {
"description": "The number rows that weren't ingested due to having timestamps outside the retention boundary.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ImportFeatureValuesRequest": {
"description": "Request message for FeaturestoreService.ImportFeatureValues.",
"id": "GoogleCloudAiplatformV1ImportFeatureValuesRequest",
"properties": {
"avroSource": {
"$ref": "GoogleCloudAiplatformV1AvroSource"
},
"bigquerySource": {
"$ref": "GoogleCloudAiplatformV1BigQuerySource"
},
"csvSource": {
"$ref": "GoogleCloudAiplatformV1CsvSource"
},
"disableIngestionAnalysis": {
"description": "If true, API doesn't start ingestion analysis pipeline.",
"type": "boolean"
},
"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.",
"type": "string"
},
"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.",
"items": {
"$ref": "GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec"
},
"type": "array"
},
"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.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec": {
"description": "Defines the Feature value(s) to import.",
"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.",
"type": "string"
},
"sourceField": {
"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"
},
"GoogleCloudAiplatformV1ImportFeatureValuesResponse": {
"description": "Response message for FeaturestoreService.ImportFeatureValues.",
"id": "GoogleCloudAiplatformV1ImportFeatureValuesResponse",
"properties": {
"importedEntityCount": {
"description": "Number of entities that have been imported by the operation.",
"format": "int64",
"type": "string"
},
"importedFeatureValueCount": {
"description": "Number of Feature values that have been imported by the operation.",
"format": "int64",
"type": "string"
},
"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"
},
"timestampOutsideRetentionRowsCount": {
"description": "The number rows that weren't ingested due to having feature timestamps outside the retention boundary.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ImportModelEvaluationRequest": {
"description": "Request message for ModelService.ImportModelEvaluation",
"id": "GoogleCloudAiplatformV1ImportModelEvaluationRequest",
"properties": {
"modelEvaluation": {
"$ref": "GoogleCloudAiplatformV1ModelEvaluation",
"description": "Required. Model evaluation resource to be imported."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ImportRagFilesConfig": {
"description": "Config for importing RagFiles.",
"id": "GoogleCloudAiplatformV1ImportRagFilesConfig",
"properties": {
"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`"
},
"googleDriveSource": {
"$ref": "GoogleCloudAiplatformV1GoogleDriveSource",
"description": "Google Drive location. Supports importing individual files as well as Google Drive folders."
},
"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."
},
"importResultGcsSink": {
"$ref": "GoogleCloudAiplatformV1GcsDestination",
"description": "The Cloud Storage path to write import result to."
},
"jiraSource": {
"$ref": "GoogleCloudAiplatformV1JiraSource",
"description": "Jira queries with their corresponding authentication."
},
"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"
},
"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`."
},
"partialFailureGcsSink": {
"$ref": "GoogleCloudAiplatformV1GcsDestination",
"deprecated": true,
"description": "The Cloud Storage path to write partial failures to. Deprecated. Prefer to use `import_result_gcs_sink`."
},
"ragFileParsingConfig": {
"$ref": "GoogleCloudAiplatformV1RagFileParsingConfig",
"description": "Optional. Specifies the parsing config for RagFiles. RAG will use the default parser if this field is not set."
},
"ragFileTransformationConfig": {
"$ref": "GoogleCloudAiplatformV1RagFileTransformationConfig",
"description": "Specifies the transformation config for RagFiles."
},
"sharePointSources": {
"$ref": "GoogleCloudAiplatformV1SharePointSources",
"description": "SharePoint sources."
},
"slackSource": {
"$ref": "GoogleCloudAiplatformV1SlackSource",
"description": "Slack channels with their corresponding access tokens."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ImportRagFilesRequest": {
"description": "Request message for VertexRagDataService.ImportRagFiles.",
"id": "GoogleCloudAiplatformV1ImportRagFilesRequest",
"properties": {
"importRagFilesConfig": {
"$ref": "GoogleCloudAiplatformV1ImportRagFilesConfig",
"description": "Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles."
}
},
"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": {
"createTime": {
"description": "Output only. Timestamp when this Index was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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"
},
"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"
},
"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."
},
"etag": {
"description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.",
"type": "string"
},
"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"
},
"name": {
"description": "Output only. The resource name of the Index.",
"readOnly": true,
"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"
},
"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.",
"format": "google-datetime",
"readOnly": true,
"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."
},
"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].",
"items": {
"format": "float",
"type": "number"
},
"type": "array"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1IndexDatapointNumericRestriction": {
"description": "This field allows restricts to be based on numeric comparisons rather than categorical tokens.",
"id": "GoogleCloudAiplatformV1IndexDatapointNumericRestriction",
"properties": {
"namespace": {
"description": "The namespace of this restriction. e.g.: cost.",
"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"
},
"valueDouble": {
"description": "Represents 64 bit float.",
"format": "double",
"type": "number"
},
"valueFloat": {
"description": "Represents 32 bit float.",
"format": "float",
"type": "number"
},
"valueInt": {
"description": "Represents 64 bit integer.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1IndexDatapointRestriction": {
"description": "Restriction of a datapoint which describe its attributes(tokens) from each of several attribute categories(namespaces).",
"id": "GoogleCloudAiplatformV1IndexDatapointRestriction",
"properties": {
"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"
},
"GoogleCloudAiplatformV1IndexDatapointSparseEmbedding": {
"description": "Feature embedding vector for sparse index. An array of numbers whose values are located in the specified dimensions.",
"id": "GoogleCloudAiplatformV1IndexDatapointSparseEmbedding",
"properties": {
"dimensions": {
"description": "Required. The list of indexes for the embedding values of the sparse vector.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"values": {
"description": "Required. The list of embedding values of the sparse vector.",
"items": {
"format": "float",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1IndexEndpoint": {
"description": "Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.",
"id": "GoogleCloudAiplatformV1IndexEndpoint",
"properties": {
"createTime": {
"description": "Output only. Timestamp when this IndexEndpoint was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"deployedIndexes": {
"description": "Output only. The indexes deployed in this endpoint.",
"items": {
"$ref": "GoogleCloudAiplatformV1DeployedIndex"
},
"readOnly": true,
"type": "array"
},
"description": {
"description": "The description of the IndexEndpoint.",
"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"
},
"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": "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 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"
},
"name": {
"description": "Output only. The resource name of the IndexEndpoint.",
"readOnly": true,
"type": "string"
},
"network": {
"description": "Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name.",
"type": "string"
},
"privateServiceConnectConfig": {
"$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig",
"description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive."
},
"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"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"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,
"type": "string"
}
},
"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": {
"matchGrpcAddress": {
"description": "Output only. The ip address used to send match gRPC requests.",
"readOnly": true,
"type": "string"
},
"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.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1IndexStats": {
"description": "Stats of the Index.",
"id": "GoogleCloudAiplatformV1IndexStats",
"properties": {
"shardsCount": {
"description": "Output only. The number of shards in the Index.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"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"
},
"GoogleCloudAiplatformV1InputDataConfig": {
"description": "Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.",
"id": "GoogleCloudAiplatformV1InputDataConfig",
"properties": {
"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"
},
"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"
},
"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\""
},
"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"
},
"filterSplit": {
"$ref": "GoogleCloudAiplatformV1FilterSplit",
"description": "Split based on the provided filters for each set."
},
"fractionSplit": {
"$ref": "GoogleCloudAiplatformV1FractionSplit",
"description": "Split based on fractions defining the size of each set."
},
"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}\""
},
"persistMlUseAssignment": {
"description": "Whether to persist the ML use assignment to data item system labels.",
"type": "boolean"
},
"predefinedSplit": {
"$ref": "GoogleCloudAiplatformV1PredefinedSplit",
"description": "Supported only for tabular Datasets. Split based on a predefined key."
},
"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"
},
"stratifiedSplit": {
"$ref": "GoogleCloudAiplatformV1StratifiedSplit",
"description": "Supported only for tabular Datasets. Split based on the distribution of the specified column."
},
"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"
},
"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 within the desired error range. Valid range of its value is [1, 100], inclusively.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1JiraSource": {
"description": "The Jira source for the ImportRagFilesRequest.",
"id": "GoogleCloudAiplatformV1JiraSource",
"properties": {
"jiraQueries": {
"description": "Required. The Jira queries.",
"items": {
"$ref": "GoogleCloudAiplatformV1JiraSourceJiraQueries"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1JiraSourceJiraQueries": {
"description": "JiraQueries contains the Jira queries and corresponding authentication.",
"id": "GoogleCloudAiplatformV1JiraSourceJiraQueries",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1LargeModelReference": {
"description": "Contains information about the Large Model.",
"id": "GoogleCloudAiplatformV1LargeModelReference",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1LineageSubgraph": {
"description": "A subgraph of the overall lineage graph. Event edges connect Artifact and Execution nodes.",
"id": "GoogleCloudAiplatformV1LineageSubgraph",
"properties": {
"artifacts": {
"description": "The Artifact nodes in the subgraph.",
"items": {
"$ref": "GoogleCloudAiplatformV1Artifact"
},
"type": "array"
},
"events": {
"description": "The Event edges between Artifacts and Executions in the subgraph.",
"items": {
"$ref": "GoogleCloudAiplatformV1Event"
},
"type": "array"
},
"executions": {
"description": "The Execution nodes in the subgraph.",
"items": {
"$ref": "GoogleCloudAiplatformV1Execution"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListAnnotationsResponse": {
"description": "Response message for DatasetService.ListAnnotations.",
"id": "GoogleCloudAiplatformV1ListAnnotationsResponse",
"properties": {
"annotations": {
"description": "A list of Annotations that matches the specified filter in the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1Annotation"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListArtifactsResponse": {
"description": "Response message for MetadataService.ListArtifacts.",
"id": "GoogleCloudAiplatformV1ListArtifactsResponse",
"properties": {
"artifacts": {
"description": "The Artifacts retrieved from the MetadataStore.",
"items": {
"$ref": "GoogleCloudAiplatformV1Artifact"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListBatchPredictionJobsResponse": {
"description": "Response message for JobService.ListBatchPredictionJobs",
"id": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse",
"properties": {
"batchPredictionJobs": {
"description": "List of BatchPredictionJobs in the requested page.",
"items": {
"$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"
},
"GoogleCloudAiplatformV1ListCachedContentsResponse": {
"description": "Response with a list of CachedContents.",
"id": "GoogleCloudAiplatformV1ListCachedContentsResponse",
"properties": {
"cachedContents": {
"description": "List of cached contents.",
"items": {
"$ref": "GoogleCloudAiplatformV1CachedContent"
},
"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"
},
"GoogleCloudAiplatformV1ListContextsResponse": {
"description": "Response message for MetadataService.ListContexts.",
"id": "GoogleCloudAiplatformV1ListContextsResponse",
"properties": {
"contexts": {
"description": "The Contexts retrieved from the MetadataStore.",
"items": {
"$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"
},
"GoogleCloudAiplatformV1ListCustomJobsResponse": {
"description": "Response message for JobService.ListCustomJobs",
"id": "GoogleCloudAiplatformV1ListCustomJobsResponse",
"properties": {
"customJobs": {
"description": "List of CustomJobs in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1CustomJob"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. Pass to ListCustomJobsRequest.page_token to obtain that page.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListDataItemsResponse": {
"description": "Response message for DatasetService.ListDataItems.",
"id": "GoogleCloudAiplatformV1ListDataItemsResponse",
"properties": {
"dataItems": {
"description": "A list of DataItems that matches the specified filter in the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1DataItem"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListDataLabelingJobsResponse": {
"description": "Response message for JobService.ListDataLabelingJobs.",
"id": "GoogleCloudAiplatformV1ListDataLabelingJobsResponse",
"properties": {
"dataLabelingJobs": {
"description": "A list of DataLabelingJobs that matches the specified filter in the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1DataLabelingJob"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListDatasetVersionsResponse": {
"description": "Response message for DatasetService.ListDatasetVersions.",
"id": "GoogleCloudAiplatformV1ListDatasetVersionsResponse",
"properties": {
"datasetVersions": {
"description": "A list of DatasetVersions that matches the specified filter in the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1DatasetVersion"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListDatasetsResponse": {
"description": "Response message for DatasetService.ListDatasets.",
"id": "GoogleCloudAiplatformV1ListDatasetsResponse",
"properties": {
"datasets": {
"description": "A list of Datasets that matches the specified filter in the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1Dataset"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse": {
"description": "Response message for ListDeploymentResourcePools method.",
"id": "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse",
"properties": {
"deploymentResourcePools": {
"description": "The DeploymentResourcePools from the specified location.",
"items": {
"$ref": "GoogleCloudAiplatformV1DeploymentResourcePool"
},
"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"
},
"GoogleCloudAiplatformV1ListEndpointsResponse": {
"description": "Response message for EndpointService.ListEndpoints.",
"id": "GoogleCloudAiplatformV1ListEndpointsResponse",
"properties": {
"endpoints": {
"description": "List of Endpoints in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1Endpoint"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. Pass to ListEndpointsRequest.page_token to obtain that page.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListEntityTypesResponse": {
"description": "Response message for FeaturestoreService.ListEntityTypes.",
"id": "GoogleCloudAiplatformV1ListEntityTypesResponse",
"properties": {
"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"
},
"GoogleCloudAiplatformV1ListExecutionsResponse": {
"description": "Response message for MetadataService.ListExecutions.",
"id": "GoogleCloudAiplatformV1ListExecutionsResponse",
"properties": {
"executions": {
"description": "The Executions retrieved from the MetadataStore.",
"items": {
"$ref": "GoogleCloudAiplatformV1Execution"
},
"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.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListFeatureGroupsResponse": {
"description": "Response message for FeatureRegistryService.ListFeatureGroups.",
"id": "GoogleCloudAiplatformV1ListFeatureGroupsResponse",
"properties": {
"featureGroups": {
"description": "The FeatureGroups matching the request.",
"items": {
"$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"
},
"GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse": {
"description": "Response message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores.",
"id": "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse",
"properties": {
"featureOnlineStores": {
"description": "The FeatureOnlineStores matching the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1FeatureOnlineStore"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListFeatureViewSyncsResponse": {
"description": "Response message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs.",
"id": "GoogleCloudAiplatformV1ListFeatureViewSyncsResponse",
"properties": {
"featureViewSyncs": {
"description": "The FeatureViewSyncs matching the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1FeatureViewSync"
},
"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.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListFeatureViewsResponse": {
"description": "Response message for FeatureOnlineStoreAdminService.ListFeatureViews.",
"id": "GoogleCloudAiplatformV1ListFeatureViewsResponse",
"properties": {
"featureViews": {
"description": "The FeatureViews matching the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1FeatureView"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1ListFeaturesResponse": {
"description": "Response message for FeaturestoreService.ListFeatures. Response message for FeatureRegistryService.ListFeatures.",
"id": "GoogleCloudAiplatformV1ListFeaturesResponse",
"properties": {
"features": {
"description": "The Features matching the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1Feature"
},
"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.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListFeaturestoresResponse": {
"description": "Response message for FeaturestoreService.ListFeaturestores.",
"id": "GoogleCloudAiplatformV1ListFeaturestoresResponse",
"properties": {
"featurestores": {
"description": "The Featurestores matching the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1Featurestore"
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse": {
"description": "Response message for JobService.ListHyperparameterTuningJobs",
"id": "GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse",
"properties": {
"hyperparameterTuningJobs": {
"description": "List of HyperparameterTuningJobs in the requested page. HyperparameterTuningJob.trials of the jobs will be not be returned.",
"items": {
"$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"
},
"GoogleCloudAiplatformV1ListIndexEndpointsResponse": {
"description": "Response message for IndexEndpointService.ListIndexEndpoints.",
"id": "GoogleCloudAiplatformV1ListIndexEndpointsResponse",
"properties": {
"indexEndpoints": {
"description": "List of IndexEndpoints in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass to ListIndexEndpointsRequest.page_token to obtain that page.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListIndexesResponse": {
"description": "Response message for IndexService.ListIndexes.",
"id": "GoogleCloudAiplatformV1ListIndexesResponse",
"properties": {
"indexes": {
"description": "List of indexes in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1Index"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass to ListIndexesRequest.page_token to obtain that page.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListMetadataSchemasResponse": {
"description": "Response message for MetadataService.ListMetadataSchemas.",
"id": "GoogleCloudAiplatformV1ListMetadataSchemasResponse",
"properties": {
"metadataSchemas": {
"description": "The MetadataSchemas found for the MetadataStore.",
"items": {
"$ref": "GoogleCloudAiplatformV1MetadataSchema"
},
"type": "array"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. Pass to ListModelVersionsRequest.page_token to obtain that page.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListModelsResponse": {
"description": "Response message for ModelService.ListModels",
"id": "GoogleCloudAiplatformV1ListModelsResponse",
"properties": {
"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"
},
"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"
},
"nextPageToken": {
"description": "A token to retrieve the next page of results. Pass to ListNasTrialDetailsRequest.page_token to obtain that page.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse": {
"description": "Response message for [NotebookService.CreateNotebookExecutionJob]",
"id": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse",
"properties": {
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass to ListNotebookExecutionJobsRequest.page_token to obtain that page.",
"type": "string"
},
"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"
},
"notebookRuntimeTemplates": {
"description": "List of NotebookRuntimeTemplates in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListNotebookRuntimesResponse": {
"description": "Response message for NotebookService.ListNotebookRuntimes.",
"id": "GoogleCloudAiplatformV1ListNotebookRuntimesResponse",
"properties": {
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass to ListNotebookRuntimesRequest.page_token to obtain that page.",
"type": "string"
},
"notebookRuntimes": {
"description": "List of NotebookRuntimes in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1NotebookRuntime"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListOptimalTrialsRequest": {
"description": "Request message for VizierService.ListOptimalTrials.",
"id": "GoogleCloudAiplatformV1ListOptimalTrialsRequest",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1ListOptimalTrialsResponse": {
"description": "Response message for VizierService.ListOptimalTrials.",
"id": "GoogleCloudAiplatformV1ListOptimalTrialsResponse",
"properties": {
"optimalTrials": {
"description": "The pareto-optimal Trials for multiple objective Study or the optimal trial for single objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency",
"items": {
"$ref": "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"
},
"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"
},
"pipelineJobs": {
"description": "List of PipelineJobs in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1PipelineJob"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListRagCorporaResponse": {
"description": "Response message for VertexRagDataService.ListRagCorpora.",
"id": "GoogleCloudAiplatformV1ListRagCorporaResponse",
"properties": {
"nextPageToken": {
"description": "A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page.",
"type": "string"
},
"ragCorpora": {
"description": "List of RagCorpora in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1RagCorpus"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListRagFilesResponse": {
"description": "Response message for VertexRagDataService.ListRagFiles.",
"id": "GoogleCloudAiplatformV1ListRagFilesResponse",
"properties": {
"nextPageToken": {
"description": "A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page.",
"type": "string"
},
"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"
},
"reasoningEngines": {
"description": "List of ReasoningEngines in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListSavedQueriesResponse": {
"description": "Response message for DatasetService.ListSavedQueries.",
"id": "GoogleCloudAiplatformV1ListSavedQueriesResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"savedQueries": {
"description": "A list of SavedQueries that match the specified filter in the request.",
"items": {
"$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"
},
"schedules": {
"description": "List of Schedules in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1Schedule"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListSpecialistPoolsResponse": {
"description": "Response message for SpecialistPoolService.ListSpecialistPools.",
"id": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"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"
},
"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"
},
"tensorboardExperiments": {
"description": "The TensorboardExperiments mathching the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListTensorboardRunsResponse": {
"description": "Response message for TensorboardService.ListTensorboardRuns.",
"id": "GoogleCloudAiplatformV1ListTensorboardRunsResponse",
"properties": {
"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"
},
"tensorboardRuns": {
"description": "The TensorboardRuns mathching the request.",
"items": {
"$ref": "GoogleCloudAiplatformV1TensorboardRun"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse": {
"description": "Response message for TensorboardService.ListTensorboardTimeSeries.",
"id": "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse",
"properties": {
"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"
},
"tensorboardTimeSeries": {
"description": "The TensorboardTimeSeries mathching the request.",
"items": {
"$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"
},
"tensorboards": {
"description": "The Tensorboards mathching the request.",
"items": {
"$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"
},
"trainingPipelines": {
"description": "List of TrainingPipelines in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1TrainingPipeline"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListTrialsResponse": {
"description": "Response message for VizierService.ListTrials.",
"id": "GoogleCloudAiplatformV1ListTrialsResponse",
"properties": {
"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"
},
"trials": {
"description": "The Trials associated with the Study.",
"items": {
"$ref": "GoogleCloudAiplatformV1Trial"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ListTuningJobsResponse": {
"description": "Response message for GenAiTuningService.ListTuningJobs",
"id": "GoogleCloudAiplatformV1ListTuningJobsResponse",
"properties": {
"nextPageToken": {
"description": "A token to retrieve the next page of results. Pass to ListTuningJobsRequest.page_token to obtain that page.",
"type": "string"
},
"tuningJobs": {
"description": "List of TuningJobs in the requested page.",
"items": {
"$ref": "GoogleCloudAiplatformV1TuningJob"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1LogprobsResult": {
"description": "Logprobs Result",
"id": "GoogleCloudAiplatformV1LogprobsResult",
"properties": {
"chosenCandidates": {
"description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.",
"items": {
"$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate"
},
"type": "array"
},
"topCandidates": {
"description": "Length = total number of decoding steps.",
"items": {
"$ref": "GoogleCloudAiplatformV1LogprobsResultTopCandidates"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1LogprobsResultCandidate": {
"description": "Candidate for the logprobs token and score.",
"id": "GoogleCloudAiplatformV1LogprobsResultCandidate",
"properties": {
"logProbability": {
"description": "The candidate's log probability.",
"format": "float",
"type": "number"
},
"token": {
"description": "The candidate's token string value.",
"type": "string"
},
"tokenId": {
"description": "The candidate's token id value.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1LogprobsResultTopCandidates": {
"description": "Candidates with top log probabilities at each decoding step.",
"id": "GoogleCloudAiplatformV1LogprobsResultTopCandidates",
"properties": {
"candidates": {
"description": "Sorted by log probability in descending order.",
"items": {
"$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate"
},
"type": "array"
}
},
"type": "object"
},
"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"
},
"GoogleCloudAiplatformV1MachineSpec": {
"description": "Specification of a single machine.",
"id": "GoogleCloudAiplatformV1MachineSpec",
"properties": {
"acceleratorCount": {
"description": "The number of accelerators to attach to the machine.",
"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",
"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
],
"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.",
"TPU v2.",
"TPU v3.",
"TPU v4.",
"TPU v5."
],
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1ManualBatchTuningParameters": {
"description": "Manual batch tuning parameters.",
"id": "GoogleCloudAiplatformV1ManualBatchTuningParameters",
"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.",
"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"
},
"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"
},
"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"
}
},
"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"
},
"value": {
"description": "Output only. The value for this metric.",
"format": "double",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MergeVersionAliasesRequest": {
"description": "Request message for ModelService.MergeVersionAliases.",
"id": "GoogleCloudAiplatformV1MergeVersionAliasesRequest",
"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.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MetadataSchema": {
"description": "Instance of a general MetadataSchema.",
"id": "GoogleCloudAiplatformV1MetadataSchema",
"properties": {
"createTime": {
"description": "Output only. Timestamp when this MetadataSchema was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Description of the Metadata Schema",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the MetadataSchema.",
"readOnly": true,
"type": "string"
},
"schema": {
"description": "Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by `title` in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 [MetadataSchema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)",
"type": "string"
},
"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"
},
"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"
},
"dataplexConfig": {
"$ref": "GoogleCloudAiplatformV1MetadataStoreDataplexConfig",
"description": "Optional. Dataplex integration settings."
},
"description": {
"description": "Description of the MetadataStore.",
"type": "string"
},
"encryptionSpec": {
"$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."
},
"name": {
"description": "Output only. The resource name of the MetadataStore instance.",
"readOnly": true,
"type": "string"
},
"state": {
"$ref": "GoogleCloudAiplatformV1MetadataStoreMetadataStoreState",
"description": "Output only. State information of the MetadataStore.",
"readOnly": true
},
"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"
},
"GoogleCloudAiplatformV1MetadataStoreMetadataStoreState": {
"description": "Represents state information for a MetadataStore.",
"id": "GoogleCloudAiplatformV1MetadataStoreMetadataStoreState",
"properties": {
"diskUtilizationBytes": {
"description": "The disk utilization of the MetadataStore in bytes.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1Metric": {
"description": "The metric used for dataset level evaluation.",
"id": "GoogleCloudAiplatformV1Metric",
"properties": {
"aggregationMetrics": {
"description": "Optional. The aggregation metrics to use.",
"items": {
"enum": [
"AGGREGATION_METRIC_UNSPECIFIED",
"AVERAGE",
"MODE",
"STANDARD_DEVIATION",
"VARIANCE",
"MINIMUM",
"MAXIMUM",
"MEDIAN",
"PERCENTILE_P90",
"PERCENTILE_P95",
"PERCENTILE_P99"
],
"enumDescriptions": [
"Unspecified aggregation metric.",
"Average aggregation metric.",
"Mode aggregation metric.",
"Standard deviation aggregation metric.",
"Variance aggregation metric.",
"Minimum aggregation metric.",
"Maximum aggregation metric.",
"Median aggregation metric.",
"90th percentile aggregation metric.",
"95th percentile aggregation metric.",
"99th percentile aggregation metric."
],
"type": "string"
},
"type": "array"
},
"bleuSpec": {
"$ref": "GoogleCloudAiplatformV1BleuSpec",
"description": "Spec for bleu metric."
},
"exactMatchSpec": {
"$ref": "GoogleCloudAiplatformV1ExactMatchSpec",
"description": "Spec for exact match metric."
},
"pairwiseMetricSpec": {
"$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec",
"description": "Spec for pairwise metric."
},
"pointwiseMetricSpec": {
"$ref": "GoogleCloudAiplatformV1PointwiseMetricSpec",
"description": "Spec for pointwise metric."
},
"rougeSpec": {
"$ref": "GoogleCloudAiplatformV1RougeSpec",
"description": "Spec for rouge metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MetricxInput": {
"description": "Input for MetricX metric.",
"id": "GoogleCloudAiplatformV1MetricxInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1MetricxInstance",
"description": "Required. Metricx instance."
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1MetricxResult": {
"description": "Spec for MetricX result - calculates the MetricX score for the given instance using the version specified in the spec.",
"id": "GoogleCloudAiplatformV1MetricxResult",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1MigratableResource": {
"description": "Represents one resource that exists in automl.googleapis.com, datalabeling.googleapis.com or ml.googleapis.com.",
"id": "GoogleCloudAiplatformV1MigratableResource",
"properties": {
"automlDataset": {
"$ref": "GoogleCloudAiplatformV1MigratableResourceAutomlDataset",
"description": "Output only. Represents one Dataset in automl.googleapis.com.",
"readOnly": true
},
"automlModel": {
"$ref": "GoogleCloudAiplatformV1MigratableResourceAutomlModel",
"description": "Output only. Represents one Model in automl.googleapis.com.",
"readOnly": true
},
"dataLabelingDataset": {
"$ref": "GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset",
"description": "Output only. 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"
},
"lastUpdateTime": {
"description": "Output only. Timestamp when this MigratableResource was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"mlEngineModelVersion": {
"$ref": "GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion",
"description": "Output only. Represents one Version in ml.googleapis.com.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MigratableResourceAutomlDataset": {
"description": "Represents one Dataset in automl.googleapis.com.",
"id": "GoogleCloudAiplatformV1MigratableResourceAutomlDataset",
"properties": {
"dataset": {
"description": "Full resource name of automl Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.",
"type": "string"
},
"datasetDisplayName": {
"description": "The Dataset's display name in automl.googleapis.com.",
"type": "string"
}
},
"type": "object"
},
"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"
},
"modelDisplayName": {
"description": "The Model's display name in automl.googleapis.com.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset": {
"description": "Represents one Dataset in datalabeling.googleapis.com.",
"id": "GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset",
"properties": {
"dataLabelingAnnotatedDatasets": {
"description": "The migratable AnnotatedDataset in datalabeling.googleapis.com belongs to the data labeling Dataset.",
"items": {
"$ref": "GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset"
},
"type": "array"
},
"dataset": {
"description": "Full resource name of data labeling Dataset. Format: `projects/{project}/datasets/{dataset}`.",
"type": "string"
},
"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"
},
"annotatedDatasetDisplayName": {
"description": "The AnnotatedDataset's display name in datalabeling.googleapis.com.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion": {
"description": "Represents one model Version in ml.googleapis.com.",
"id": "GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion",
"properties": {
"endpoint": {
"description": "The ml.googleapis.com endpoint that this model Version currently lives in. Example values: * ml.googleapis.com * us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * asia-east1-ml.googleapis.com",
"type": "string"
},
"version": {
"description": "Full resource name of ml engine model Version. Format: `projects/{project}/models/{model}/versions/{version}`.",
"type": "string"
}
},
"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": {
"migrateAutomlDatasetConfig": {
"$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig",
"description": "Config for migrating Dataset in automl.googleapis.com to Vertex AI's Dataset."
},
"migrateAutomlModelConfig": {
"$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig",
"description": "Config for migrating Model in automl.googleapis.com to Vertex AI's Model."
},
"migrateDataLabelingDatasetConfig": {
"$ref": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig",
"description": "Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI's Dataset."
},
"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"
},
"datasetDisplayName": {
"description": "Required. Display name of the Dataset in Vertex AI. System will pick a display name if unspecified.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig": {
"description": "Config for migrating Model in automl.googleapis.com to Vertex AI's Model.",
"id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig",
"properties": {
"model": {
"description": "Required. Full resource name of automl Model. Format: `projects/{project}/locations/{location}/models/{model}`.",
"type": "string"
},
"modelDisplayName": {
"description": "Optional. Display name of the model in Vertex AI. System will pick a display name if unspecified.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig": {
"description": "Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI's Dataset.",
"id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig",
"properties": {
"dataset": {
"description": "Required. Full resource name of data labeling Dataset. Format: `projects/{project}/datasets/{dataset}`.",
"type": "string"
},
"datasetDisplayName": {
"description": "Optional. Display name of the Dataset in Vertex AI. System will pick a display name if unspecified.",
"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"
},
"GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig": {
"description": "Config for migrating AnnotatedDataset in datalabeling.googleapis.com to Vertex AI's SavedQuery.",
"id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig",
"properties": {
"annotatedDataset": {
"description": "Required. Full resource name of data labeling AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig": {
"description": "Config for migrating version in ml.googleapis.com to Vertex AI's Model.",
"id": "GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig",
"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",
"type": "string"
},
"modelDisplayName": {
"description": "Required. Display name of the model in Vertex AI. System will pick a display name if unspecified.",
"type": "string"
},
"modelVersion": {
"description": "Required. Full resource name of ml engine model version. Format: `projects/{project}/models/{model}/versions/{version}`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MigrateResourceResponse": {
"description": "Describes a successfully migrated resource.",
"id": "GoogleCloudAiplatformV1MigrateResourceResponse",
"properties": {
"dataset": {
"description": "Migrated Dataset's resource name.",
"type": "string"
},
"migratableResource": {
"$ref": "GoogleCloudAiplatformV1MigratableResource",
"description": "Before migration, the identifier in ml.googleapis.com, automl.googleapis.com or datalabeling.googleapis.com."
},
"model": {
"description": "Migrated Model's resource name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ModalityTokenCount": {
"description": "Represents token counting info for a single modality.",
"id": "GoogleCloudAiplatformV1ModalityTokenCount",
"properties": {
"modality": {
"description": "The modality associated with this token count.",
"enum": [
"MODALITY_UNSPECIFIED",
"TEXT",
"IMAGE",
"VIDEO",
"AUDIO",
"DOCUMENT"
],
"enumDescriptions": [
"Unspecified modality.",
"Plain text.",
"Image.",
"Video.",
"Audio.",
"Document, e.g. PDF."
],
"type": "string"
},
"tokenCount": {
"description": "Number of tokens.",
"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"
},
"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."
},
"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."
},
"createTime": {
"description": "Output only. Timestamp when this Model was uploaded into Vertex AI.",
"format": "google-datetime",
"readOnly": true,
"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."
},
"defaultCheckpointId": {
"description": "The default checkpoint id of a model version.",
"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.",
"items": {
"$ref": "GoogleCloudAiplatformV1DeployedModelRef"
},
"readOnly": true,
"type": "array"
},
"description": {
"description": "The description of the Model.",
"type": "string"
},
"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"
},
"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."
},
"etag": {
"description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.",
"type": "string"
},
"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."
},
"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"
},
"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"
},
"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"
},
"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"
},
"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
},
"name": {
"description": "The resource name of the Model.",
"type": "string"
},
"originalModelInfo": {
"$ref": "GoogleCloudAiplatformV1ModelOriginalModelInfo",
"description": "Output only. If this Model is a copy of another Model, this contains info about the original.",
"readOnly": true
},
"pipelineJob": {
"description": "Optional. This field is populated if the model is produced by a pipeline job.",
"type": "string"
},
"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."
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"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": "array"
},
"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": "array"
},
"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": "array"
},
"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": "array"
},
"trainingPipeline": {
"description": "Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.",
"readOnly": true,
"type": "string"
},
"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"
},
"versionCreateTime": {
"description": "Output only. Timestamp when this version was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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": "string"
},
"versionUpdateTime": {
"description": "Output only. Timestamp when this version was most recently updated.",
"format": "google-datetime",
"readOnly": true,
"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"
},
"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": {
"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"
},
"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"
},
"deploymentTimeout": {
"description": "Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.",
"format": "google-duration",
"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).",
"items": {
"$ref": "GoogleCloudAiplatformV1EnvVar"
},
"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": "GoogleCloudAiplatformV1Port"
},
"type": "array"
},
"healthProbe": {
"$ref": "GoogleCloudAiplatformV1Probe",
"description": "Immutable. Specification for Kubernetes readiness probe."
},
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1ModelDataStats": {
"description": "Stats of data used for train or evaluate the Model.",
"id": "GoogleCloudAiplatformV1ModelDataStats",
"properties": {
"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"
},
"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"
},
"trainingAnnotationsCount": {
"description": "Number of Annotations that are used for training this Model.",
"format": "int64",
"type": "string"
},
"trainingDataItemsCount": {
"description": "Number of DataItems that were used for training this Model.",
"format": "int64",
"type": "string"
},
"validationAnnotationsCount": {
"description": "Number of Annotations that are used for validating this Model during training.",
"format": "int64",
"type": "string"
},
"validationDataItemsCount": {
"description": "Number of DataItems that were used for validating this Model during training.",
"format": "int64",
"type": "string"
}
},
"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": {
"bigqueryTablePath": {
"description": "The created BigQuery table to store logs. Customer could do their own query & analysis. Format: `bq://.model_deployment_monitoring_._`",
"type": "string"
},
"logSource": {
"description": "The source of log.",
"enum": [
"LOG_SOURCE_UNSPECIFIED",
"TRAINING",
"SERVING"
],
"enumDescriptions": [
"Unspecified source.",
"Logs coming from Training dataset.",
"Logs coming from Serving traffic."
],
"type": "string"
},
"logType": {
"description": "The type of log.",
"enum": [
"LOG_TYPE_UNSPECIFIED",
"PREDICT",
"EXPLAIN"
],
"enumDescriptions": [
"Unspecified type.",
"Predict logs.",
"Explain logs."
],
"type": "string"
},
"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"
},
"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": {
"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"
},
"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"
},
"createTime": {
"description": "Output only. Timestamp when this ModelDeploymentMonitoringJob was created.",
"format": "google-datetime",
"readOnly": true,
"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.",
"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"
},
"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"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Output only. Only populated when the job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.",
"readOnly": true
},
"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"
},
"latestMonitoringPipelineMetadata": {
"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata",
"description": "Output only. Latest triggered monitoring pipeline metadata.",
"readOnly": true
},
"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"
},
"loggingSamplingStrategy": {
"$ref": "GoogleCloudAiplatformV1SamplingStrategy",
"description": "Required. Sample Strategy for logging."
},
"modelDeploymentMonitoringObjectiveConfigs": {
"description": "Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.",
"items": {
"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig"
},
"type": "array"
},
"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"
},
"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"
},
"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"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"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"
},
"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"
},
"statsAnomaliesBaseDirectory": {
"$ref": "GoogleCloudAiplatformV1GcsDestination",
"description": "Stats anomalies base folder path."
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig": {
"description": "The config for scheduling monitoring job.",
"id": "GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig",
"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.",
"format": "google-duration",
"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.",
"format": "google-duration",
"type": "string"
}
},
"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": {
"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"
},
"createTime": {
"description": "Output only. Timestamp when this ModelEvaluation was created.",
"format": "google-datetime",
"readOnly": true,
"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"
},
"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": "GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec"
},
"type": "array"
},
"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"
},
"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": "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": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec": {
"id": "GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec",
"properties": {
"explanationSpec": {
"$ref": "GoogleCloudAiplatformV1ExplanationSpec",
"description": "Explanation spec details."
},
"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"
},
"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"
},
"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"
},
"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
},
"name": {
"description": "Output only. The resource name of the ModelEvaluationSlice.",
"readOnly": true,
"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"
},
"GoogleCloudAiplatformV1ModelEvaluationSliceSlice": {
"description": "Definition of a slice.",
"id": "GoogleCloudAiplatformV1ModelEvaluationSliceSlice",
"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,
"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 dimension in this slice.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec": {
"description": "Specification for how the data should be sliced.",
"id": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec",
"properties": {
"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"
},
"low": {
"description": "Inclusive low value for the range.",
"format": "float",
"type": "number"
}
},
"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": {
"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": {
"$ref": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue",
"description": "A unique specific value for a given feature. Example: `{ \"value\": { \"string_value\": \"12345\" } }`"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue": {
"description": "Single value that supports strings and floats.",
"id": "GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue",
"properties": {
"floatValue": {
"description": "Float type.",
"format": "float",
"type": "number"
},
"stringValue": {
"description": "String type.",
"type": "string"
}
},
"type": "object"
},
"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"
},
"GoogleCloudAiplatformV1ModelExportFormat": {
"description": "Represents export format supported by the Model. All formats export to Google Cloud Storage.",
"id": "GoogleCloudAiplatformV1ModelExportFormat",
"properties": {
"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": "array"
},
"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"
},
"skipHfModelCache": {
"description": "Optional. Whether to avoid pulling the model from the HF cache.",
"type": "boolean"
},
"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."
},
"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"
},
"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."
},
"predictionDriftDetectionConfig": {
"$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig",
"description": "The config for drift of prediction data."
},
"trainingDataset": {
"$ref": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset",
"description": "Training dataset for models. This field has to be set only if TrainingPredictionSkewDetectionConfig is specified."
},
"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"
},
"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."
},
"gcs": {
"$ref": "GoogleCloudAiplatformV1GcsDestination",
"description": "Cloud Storage location for BatchExplain output."
},
"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"
},
"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."
},
"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"
},
"GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset": {
"description": "Training Dataset information.",
"id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset",
"properties": {
"bigquerySource": {
"$ref": "GoogleCloudAiplatformV1BigQuerySource",
"description": "The BigQuery table of the unmanaged Dataset used to train this Model."
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig": {
"description": "The config for Training & Prediction data skew detection. It specifies the training dataset sources and the skew detection parameters.",
"id": "GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig",
"properties": {
"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"
},
"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."
},
"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"
},
"GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies": {
"description": "Statistics and anomalies generated by Model Monitoring.",
"id": "GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies",
"properties": {
"anomalyCount": {
"description": "Number of anomalies within all stats.",
"format": "int32",
"type": "integer"
},
"deployedModelId": {
"description": "Deployed Model ID.",
"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": [
"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"
},
"GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies": {
"description": "Historical Stats (and Anomalies) for a specific Feature.",
"id": "GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies",
"properties": {
"featureDisplayName": {
"description": "Display Name of the Feature.",
"type": "string"
},
"predictionStats": {
"description": "A list of historical stats generated by different time window's Prediction Dataset.",
"items": {
"$ref": "GoogleCloudAiplatformV1FeatureStatsAnomaly"
},
"type": "array"
},
"threshold": {
"$ref": "GoogleCloudAiplatformV1ThresholdConfig",
"description": "Threshold for anomaly detection."
},
"trainingStats": {
"$ref": "GoogleCloudAiplatformV1FeatureStatsAnomaly",
"description": "Stats calculated for the Training Dataset."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ModelOriginalModelInfo": {
"description": "Contains information about the original Model if this Model is a copy.",
"id": "GoogleCloudAiplatformV1ModelOriginalModelInfo",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ModelSourceInfo": {
"description": "Detail description of the source information of the model.",
"id": "GoogleCloudAiplatformV1ModelSourceInfo",
"properties": {
"copy": {
"description": "If this Model is copy of another Model. If true then source_type pertains to the original.",
"type": "boolean"
},
"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"
},
"GoogleCloudAiplatformV1ModelVersionCheckpoint": {
"description": "Describes the machine learning model version checkpoint.",
"id": "GoogleCloudAiplatformV1ModelVersionCheckpoint",
"properties": {
"checkpointId": {
"description": "The ID of the checkpoint.",
"type": "string"
},
"epoch": {
"description": "The epoch of the checkpoint.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project}/locations/{location}/models/{model}/versions/{version}/checkpoints/{checkpoint}`",
"type": "string"
},
"step": {
"description": "The step of the checkpoint.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata": {
"description": "Runtime operation information for IndexEndpointService.MutateDeployedIndex.",
"id": "GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata",
"properties": {
"deployedIndexId": {
"description": "The unique index id specified by user",
"type": "string"
},
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The operation generic information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MutateDeployedIndexResponse": {
"description": "Response message for IndexEndpointService.MutateDeployedIndex.",
"id": "GoogleCloudAiplatformV1MutateDeployedIndexResponse",
"properties": {
"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 * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only)"
},
"updateMask": {
"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1MutateDeployedModelResponse": {
"description": "Response message for EndpointService.MutateDeployedModel.",
"id": "GoogleCloudAiplatformV1MutateDeployedModelResponse",
"properties": {
"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 display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.",
"type": "string"
},
"enableRestrictedImageTraining": {
"deprecated": true,
"description": "Optional. Enable a separation of Custom model training and restricted image training for tenant project.",
"type": "boolean"
},
"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"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.",
"readOnly": true
},
"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"
},
"name": {
"description": "Output only. Resource name of the NasJob.",
"readOnly": true,
"type": "string"
},
"nasJobOutput": {
"$ref": "GoogleCloudAiplatformV1NasJobOutput",
"description": "Output only. Output of the NasJob.",
"readOnly": true
},
"nasJobSpec": {
"$ref": "GoogleCloudAiplatformV1NasJobSpec",
"description": "Required. The specification of a NasJob."
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"startTime": {
"description": "Output only. Time when the NasJob 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"
},
"updateTime": {
"description": "Output only. Time when the NasJob was most recently updated.",
"format": "google-datetime",
"readOnly": true,
"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": "GoogleCloudAiplatformV1NasTrial"
},
"readOnly": true,
"type": "array"
},
"trainTrials": {
"description": "Output only. List of NasTrials that were started as part of train stage.",
"items": {
"$ref": "GoogleCloudAiplatformV1NasTrial"
},
"readOnly": true,
"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."
},
"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"
},
"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."
},
"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"
},
"searchTrialSpec": {
"$ref": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec",
"description": "Required. Spec for search trials."
},
"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"
},
"metricId": {
"description": "Required. The ID of the metric. Must not contain whitespaces.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec": {
"description": "Represent spec for search trials.",
"id": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec",
"properties": {
"maxFailedTrialCount": {
"description": "The number of failed trials that need to be seen before failing the NasJob. If set to 0, Vertex AI decides how many trials must fail before the whole job fails.",
"format": "int32",
"type": "integer"
},
"maxParallelTrialCount": {
"description": "Required. The maximum number of trials to run in parallel.",
"format": "int32",
"type": "integer"
},
"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"
},
"GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec": {
"description": "Represent spec for train trials.",
"id": "GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec",
"properties": {
"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"
},
"maxParallelTrialCount": {
"description": "Required. The maximum number of trials to run in parallel.",
"format": "int32",
"type": "integer"
},
"trainTrialJobSpec": {
"$ref": "GoogleCloudAiplatformV1CustomJobSpec",
"description": "Required. The spec of a train trial job. The same spec applies to all train trials."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NasTrial": {
"description": "Represents a uCAIP NasJob trial.",
"id": "GoogleCloudAiplatformV1NasTrial",
"properties": {
"endTime": {
"description": "Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"finalMeasurement": {
"$ref": "GoogleCloudAiplatformV1Measurement",
"description": "Output only. The final measurement containing the objective value.",
"readOnly": true
},
"id": {
"description": "Output only. The identifier of the NasTrial assigned by the service.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. Time when the NasTrial was started.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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"
}
},
"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": {
"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"
},
"GoogleCloudAiplatformV1NearestNeighborQuery": {
"description": "A query to find a number of similar entities.",
"id": "GoogleCloudAiplatformV1NearestNeighborQuery",
"properties": {
"embedding": {
"$ref": "GoogleCloudAiplatformV1NearestNeighborQueryEmbedding",
"description": "Optional. The embedding vector that be used for similar search."
},
"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"
},
"neighborCount": {
"description": "Optional. The number of similar entities to be retrieved from feature view for each query.",
"format": "int32",
"type": "integer"
},
"numericFilters": {
"description": "Optional. The list of numeric filters.",
"items": {
"$ref": "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter"
},
"type": "array"
},
"parameters": {
"$ref": "GoogleCloudAiplatformV1NearestNeighborQueryParameters",
"description": "Optional. Parameters that can be set to tune query on the fly."
},
"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"
},
"stringFilters": {
"description": "Optional. The list of string filters.",
"items": {
"$ref": "GoogleCloudAiplatformV1NearestNeighborQueryStringFilter"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NearestNeighborQueryEmbedding": {
"description": "The embedding vector.",
"id": "GoogleCloudAiplatformV1NearestNeighborQueryEmbedding",
"properties": {
"value": {
"description": "Optional. Individual value in the embedding.",
"items": {
"format": "float",
"type": "number"
},
"type": "array"
}
},
"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": {
"name": {
"description": "Required. Column name in BigQuery that used as filters.",
"type": "string"
},
"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"
},
"valueDouble": {
"description": "double value type.",
"format": "double",
"type": "number"
},
"valueFloat": {
"description": "float value type.",
"format": "float",
"type": "number"
},
"valueInt": {
"description": "int value type.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NearestNeighborQueryParameters": {
"description": "Parameters that can be overrided in each query to tune query latency and recall.",
"id": "GoogleCloudAiplatformV1NearestNeighborQueryParameters",
"properties": {
"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"
},
"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"
},
"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": {
"allowTokens": {
"description": "Optional. The allowed tokens.",
"items": {
"type": "string"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata": {
"description": "Runtime operation metadata with regard to Matching Engine Index.",
"id": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata",
"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.",
"items": {
"$ref": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats"
},
"type": "array"
},
"dataBytesCount": {
"description": "The ingested data size in bytes.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats": {
"id": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats",
"properties": {
"invalidRecordCount": {
"description": "Number of records in this file we skipped due to validate errors.",
"format": "int64",
"type": "string"
},
"invalidSparseRecordCount": {
"description": "Number of sparse records in this file we skipped due to validate errors.",
"format": "int64",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError": {
"id": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError",
"properties": {
"embeddingId": {
"description": "Empty if the embedding id is failed to parse.",
"type": "string"
},
"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"
},
"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"
],
"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."
],
"type": "string"
},
"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": {
"$ref": "GoogleCloudAiplatformV1NearestNeighborsNeighbor"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NearestNeighborsNeighbor": {
"description": "A neighbor of the query vector.",
"id": "GoogleCloudAiplatformV1NearestNeighborsNeighbor",
"properties": {
"distance": {
"description": "The distance between the neighbor and the query vector.",
"format": "double",
"type": "number"
},
"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"
},
"GoogleCloudAiplatformV1Neighbor": {
"description": "Neighbors for example-based explanations.",
"id": "GoogleCloudAiplatformV1Neighbor",
"properties": {
"neighborDistance": {
"description": "Output only. The neighbor distance.",
"format": "double",
"readOnly": true,
"type": "number"
},
"neighborId": {
"description": "Output only. The neighbor id.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NetworkSpec": {
"description": "Network spec.",
"id": "GoogleCloudAiplatformV1NetworkSpec",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NfsMount": {
"description": "Represents a mount configuration for Network File System (NFS) to mount.",
"id": "GoogleCloudAiplatformV1NfsMount",
"properties": {
"mountPoint": {
"description": "Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/",
"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`",
"type": "string"
},
"server": {
"description": "Required. IP address of the NFS server.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NotebookEucConfig": {
"description": "The euc configuration of NotebookRuntimeTemplate.",
"id": "GoogleCloudAiplatformV1NotebookEucConfig",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1NotebookExecutionJob": {
"description": "NotebookExecutionJob represents an instance of a notebook execution.",
"id": "GoogleCloudAiplatformV1NotebookExecutionJob",
"properties": {
"createTime": {
"description": "Output only. Timestamp when this NotebookExecutionJob was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"customEnvironmentSpec": {
"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec",
"description": "The custom compute configuration for an execution job."
},
"dataformRepositorySource": {
"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource",
"description": "The Dataform Repository pointing to a single file notebook repository."
},
"directNotebookSource": {
"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource",
"description": "The contents of an input notebook file."
},
"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"
},
"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"
},
"executionUser": {
"description": "The user email to run the execution as. Only supported by Colab runtimes.",
"type": "string"
},
"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"
},
"jobState": {
"description": "Output only. The state of the NotebookExecutionJob.",
"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"
},
"kernelName": {
"description": "The name of the kernel to use during notebook execution. If unset, the default kernel is used.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"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"
},
"name": {
"description": "Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`",
"readOnly": true,
"type": "string"
},
"notebookRuntimeTemplateResourceName": {
"description": "The NotebookRuntimeTemplate to source compute configuration from.",
"type": "string"
},
"scheduleResourceName": {
"description": "The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`",
"type": "string"
},
"serviceAccount": {
"description": "The service account to run the execution as.",
"type": "string"
},
"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
},
"updateTime": {
"description": "Output only. Timestamp when this NotebookExecutionJob was most recently updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"workbenchRuntime": {
"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime",
"description": "The Workbench runtime configuration to use for the notebook execution."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec": {
"description": "Compute configuration to use for an execution job.",
"id": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec",
"properties": {
"machineSpec": {
"$ref": "GoogleCloudAiplatformV1MachineSpec",
"description": "The specification of a single machine for the execution job."
},
"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"
},
"GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource": {
"description": "The Dataform Repository containing the input notebook.",
"id": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource",
"properties": {
"commitSha": {
"description": "The commit SHA to read repository with. If unset, the file will be read at HEAD.",
"type": "string"
},
"dataformRepositoryResourceName": {
"description": "The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource": {
"description": "The content of the input notebook in ipynb format.",
"id": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource",
"properties": {
"content": {
"description": "The base64-encoded contents of the input notebook file.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource": {
"description": "The Cloud Storage uri for the input notebook.",
"id": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource",
"properties": {
"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"
},
"uri": {
"description": "The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime": {
"description": "Configuration for a Workbench Instances-based environment.",
"id": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1NotebookIdleShutdownConfig": {
"description": "The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.",
"id": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig",
"properties": {
"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"
},
"GoogleCloudAiplatformV1NotebookReservationAffinity": {
"description": "Notebook Reservation Affinity for consuming Zonal reservation.",
"id": "GoogleCloudAiplatformV1NotebookReservationAffinity",
"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.",
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1NotebookRuntime": {
"description": "A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.",
"id": "GoogleCloudAiplatformV1NotebookRuntime",
"properties": {
"createTime": {
"description": "Output only. Timestamp when this NotebookRuntime was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataPersistentDiskSpec": {
"$ref": "GoogleCloudAiplatformV1PersistentDiskSpec",
"description": "Output only. The specification of persistent disk attached to the notebook runtime as data disk storage.",
"readOnly": true
},
"description": {
"description": "The description of the NotebookRuntime.",
"type": "string"
},
"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"
},
"encryptionSpec": {
"$ref": "GoogleCloudAiplatformV1EncryptionSpec",
"description": "Output only. Customer-managed encryption key spec for the notebook runtime.",
"readOnly": true
},
"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": [
"Unspecified health state.",
"NotebookRuntime is in healthy state. Applies to ACTIVE state.",
"NotebookRuntime is in unhealthy state. Applies to ACTIVE state."
],
"readOnly": true,
"type": "string"
},
"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"
},
"machineSpec": {
"$ref": "GoogleCloudAiplatformV1MachineSpec",
"description": "Output only. The specification of a single machine used by the notebook runtime.",
"readOnly": true
},
"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"
},
"type": "array"
},
"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 notebook runtime type, NotebookRuntimeType will default to USER_DEFINED.",
"runtime or template with coustomized configurations from user.",
"runtime or template with system defined configurations."
],
"readOnly": true,
"type": "string"
},
"proxyUri": {
"description": "Output only. The proxy endpoint used to access the NotebookRuntime.",
"readOnly": true,
"type": "string"
},
"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.",
"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"
},
"runtimeUser": {
"description": "Required. The user email of the NotebookRuntime.",
"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"
},
"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"
},
"shieldedVmConfig": {
"$ref": "GoogleCloudAiplatformV1ShieldedVmConfig",
"description": "Output only. Runtime Shielded VM spec.",
"readOnly": true
},
"softwareConfig": {
"$ref": "GoogleCloudAiplatformV1NotebookSoftwareConfig",
"description": "Output only. Software config of the notebook runtime.",
"readOnly": true
},
"updateTime": {
"description": "Output only. Timestamp when this NotebookRuntime was most recently updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"version": {
"description": "Output only. The VM os image version of NotebookRuntime.",
"readOnly": true,
"type": "string"
}
},
"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": {
"createTime": {
"description": "Output only. Timestamp when this NotebookRuntimeTemplate was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"dataPersistentDiskSpec": {
"$ref": "GoogleCloudAiplatformV1PersistentDiskSpec",
"description": "Optional. The specification of persistent disk attached to the runtime as data disk storage."
},
"description": {
"description": "The description of the NotebookRuntimeTemplate.",
"type": "string"
},
"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"
},
"encryptionSpec": {
"$ref": "GoogleCloudAiplatformV1EncryptionSpec",
"description": "Customer-managed encryption key spec for the notebook runtime."
},
"etag": {
"description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.",
"type": "string"
},
"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": {
"additionalProperties": {
"type": "string"
},
"description": "The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.",
"type": "object"
},
"machineSpec": {
"$ref": "GoogleCloudAiplatformV1MachineSpec",
"description": "Optional. Immutable. The specification of a single machine for the template."
},
"name": {
"description": "The resource name of the NotebookRuntimeTemplate.",
"type": "string"
},
"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"
},
"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"
},
"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": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NotebookRuntimeTemplateRef": {
"description": "Points to a NotebookRuntimeTemplateRef.",
"id": "GoogleCloudAiplatformV1NotebookRuntimeTemplateRef",
"properties": {
"notebookRuntimeTemplate": {
"description": "Immutable. A resource name of the NotebookRuntimeTemplate.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1NotebookSoftwareConfig": {
"description": "Notebook Software Config.",
"id": "GoogleCloudAiplatformV1NotebookSoftwareConfig",
"properties": {
"env": {
"description": "Optional. Environment variables to be passed to the container. Maximum limit is 100.",
"items": {
"$ref": "GoogleCloudAiplatformV1EnvVar"
},
"type": "array"
},
"postStartupScriptConfig": {
"$ref": "GoogleCloudAiplatformV1PostStartupScriptConfig",
"description": "Optional. Post startup script config."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1OutputConfig": {
"description": "Config for evaluation output.",
"id": "GoogleCloudAiplatformV1OutputConfig",
"properties": {
"gcsDestination": {
"$ref": "GoogleCloudAiplatformV1GcsDestination",
"description": "Cloud storage destination for evaluation output."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PSCAutomationConfig": {
"description": "PSC config that is used to automatically create forwarding rule via ServiceConnectionMap.",
"id": "GoogleCloudAiplatformV1PSCAutomationConfig",
"properties": {
"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/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name.",
"type": "string"
},
"projectId": {
"description": "Required. Project id used to create forwarding rule.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PairwiseMetricInput": {
"description": "Input for pairwise metric.",
"id": "GoogleCloudAiplatformV1PairwiseMetricInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1PairwiseMetricInstance",
"description": "Required. Pairwise metric instance."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec",
"description": "Required. Spec for pairwise metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PairwiseMetricInstance": {
"description": "Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.",
"id": "GoogleCloudAiplatformV1PairwiseMetricInstance",
"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."
},
"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"
},
"GoogleCloudAiplatformV1PairwiseMetricResult": {
"description": "Spec for pairwise metric result.",
"id": "GoogleCloudAiplatformV1PairwiseMetricResult",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1PairwiseMetricSpec": {
"description": "Spec for pairwise metric.",
"id": "GoogleCloudAiplatformV1PairwiseMetricSpec",
"properties": {
"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"
},
"GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput": {
"description": "Input for pairwise question answering quality metric.",
"id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance",
"description": "Required. Pairwise question answering quality instance."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec",
"description": "Required. Spec for pairwise question answering quality score metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance": {
"description": "Spec for pairwise question answering quality instance.",
"id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance",
"properties": {
"baselinePrediction": {
"description": "Required. Output of the baseline model.",
"type": "string"
},
"context": {
"description": "Required. Text to answer the question.",
"type": "string"
},
"instruction": {
"description": "Required. Question Answering prompt for LLM.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult": {
"description": "Spec for pairwise question answering quality result.",
"id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult",
"properties": {
"confidence": {
"description": "Output only. Confidence for question answering quality score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"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"
},
"GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec": {
"description": "Spec for pairwise question answering quality score metric.",
"id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec",
"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.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PairwiseSummarizationQualityInput": {
"description": "Input for pairwise summarization quality metric.",
"id": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance",
"description": "Required. Pairwise summarization quality instance."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec",
"description": "Required. Spec for pairwise summarization quality score metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance": {
"description": "Spec for pairwise summarization quality instance.",
"id": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance",
"properties": {
"baselinePrediction": {
"description": "Required. Output of the baseline model.",
"type": "string"
},
"context": {
"description": "Required. Text to be summarized.",
"type": "string"
},
"instruction": {
"description": "Required. Summarization 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"
},
"GoogleCloudAiplatformV1PairwiseSummarizationQualityResult": {
"description": "Spec for pairwise summarization quality result.",
"id": "GoogleCloudAiplatformV1PairwiseSummarizationQualityResult",
"properties": {
"confidence": {
"description": "Output only. Confidence for summarization quality score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"explanation": {
"description": "Output only. Explanation for summarization quality score.",
"readOnly": true,
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec": {
"description": "Spec for pairwise summarization quality score metric.",
"id": "GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec",
"properties": {
"useReference": {
"description": "Optional. Whether to use instance.reference to compute pairwise summarization quality.",
"type": "boolean"
},
"version": {
"description": "Optional. Which version to use for evaluation.",
"format": "int32",
"type": "integer"
}
},
"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`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.",
"id": "GoogleCloudAiplatformV1Part",
"properties": {
"codeExecutionResult": {
"$ref": "GoogleCloudAiplatformV1CodeExecutionResult",
"description": "Optional. Result of executing the [ExecutableCode]."
},
"executableCode": {
"$ref": "GoogleCloudAiplatformV1ExecutableCode",
"description": "Optional. Code generated by the model that is meant to be executed."
},
"fileData": {
"$ref": "GoogleCloudAiplatformV1FileData",
"description": "Optional. URI based data."
},
"functionCall": {
"$ref": "GoogleCloudAiplatformV1FunctionCall",
"description": "Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values."
},
"functionResponse": {
"$ref": "GoogleCloudAiplatformV1FunctionResponse",
"description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
},
"inlineData": {
"$ref": "GoogleCloudAiplatformV1Blob",
"description": "Optional. Inlined bytes data."
},
"text": {
"description": "Optional. Text part (can be code).",
"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"
},
"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": {
"diskSizeGb": {
"description": "Size in GB of the disk (default is 100GB).",
"format": "int64",
"type": "string"
},
"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"
},
"name": {
"description": "Immutable. Resource name of a PersistentResource.",
"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"
},
"reservedIpRanges": {
"description": "Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].",
"items": {
"type": "string"
},
"type": "array"
},
"resourcePools": {
"description": "Required. The spec of the pools of different resources.",
"items": {
"$ref": "GoogleCloudAiplatformV1ResourcePool"
},
"type": "array"
},
"resourceRuntime": {
"$ref": "GoogleCloudAiplatformV1ResourceRuntime",
"description": "Output only. Runtime information of the Persistent Resource.",
"readOnly": true
},
"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": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"startTime": {
"description": "Output only. Time when the PersistentResource for the first time entered the `RUNNING` state.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The detailed state of a Study.",
"enum": [
"STATE_UNSPECIFIED",
"PROVISIONING",
"RUNNING",
"STOPPING",
"ERROR",
"REBOOTING",
"UPDATING"
],
"enumDescriptions": [
"Not set.",
"The PROVISIONING state indicates the persistent resources is being created.",
"The RUNNING state indicates the persistent resource is healthy and fully usable.",
"The STOPPING state indicates the persistent resource is being deleted.",
"The ERROR state indicates the persistent resource may be unusable. Details can be found in the `error` field.",
"The REBOOTING state indicates the persistent resource is being rebooted (PR is not available right now but is expected to be ready again later).",
"The UPDATING state indicates the persistent resource is being updated."
],
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. Time when the PersistentResource was most recently updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PipelineJob": {
"description": "An instance of a machine learning PipelineJob.",
"id": "GoogleCloudAiplatformV1PipelineJob",
"properties": {
"createTime": {
"description": "Output only. Pipeline creation time.",
"format": "google-datetime",
"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"
},
"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."
},
"endTime": {
"description": "Output only. Pipeline end time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.",
"readOnly": true
},
"jobDetail": {
"$ref": "GoogleCloudAiplatformV1PipelineJobDetail",
"description": "Output only. The details of pipeline run. Not available in the list view.",
"readOnly": true
},
"labels": {
"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"
},
"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": "The spec of the pipeline.",
"type": "object"
},
"preflightValidations": {
"description": "Optional. Whether to do component level validations before job creation.",
"type": "boolean"
},
"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": {
"type": "string"
},
"type": "array"
},
"runtimeConfig": {
"$ref": "GoogleCloudAiplatformV1PipelineJobRuntimeConfig",
"description": "Runtime config of the pipeline."
},
"scheduleName": {
"description": "Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.",
"readOnly": true,
"type": "string"
},
"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"
},
"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 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"
},
"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"
},
"GoogleCloudAiplatformV1PipelineJobDetail": {
"description": "The runtime detail of PipelineJob.",
"id": "GoogleCloudAiplatformV1PipelineJobDetail",
"properties": {
"pipelineContext": {
"$ref": "GoogleCloudAiplatformV1Context",
"description": "Output only. The context of the pipeline.",
"readOnly": true
},
"pipelineRunContext": {
"$ref": "GoogleCloudAiplatformV1Context",
"description": "Output only. The context of the current pipeline run.",
"readOnly": true
},
"taskDetails": {
"description": "Output only. The runtime details of the tasks under the pipeline.",
"items": {
"$ref": "GoogleCloudAiplatformV1PipelineTaskDetail"
},
"readOnly": true,
"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"
},
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact": {
"description": "The type of an input artifact.",
"id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact",
"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"
}
},
"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": "string"
},
"endTime": {
"description": "Output only. Task end time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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
},
"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,
"type": "object"
},
"outputs": {
"additionalProperties": {
"$ref": "GoogleCloudAiplatformV1PipelineTaskDetailArtifactList"
},
"description": "Output only. The runtime output artifacts of the task.",
"readOnly": true,
"type": "object"
},
"parentTaskId": {
"description": "Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"pipelineTaskStatus": {
"description": "Output only. A list of task status. This field keeps a record of task status evolving over time.",
"items": {
"$ref": "GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus"
},
"readOnly": true,
"type": "array"
},
"startTime": {
"description": "Output only. Task start time.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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,
"type": "string"
},
"taskId": {
"description": "Output only. The system generated ID of the task.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"taskName": {
"description": "Output only. The user specified name of the task that is defined in pipeline_spec.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PipelineTaskDetailArtifactList": {
"description": "A list of artifact metadata.",
"id": "GoogleCloudAiplatformV1PipelineTaskDetailArtifactList",
"properties": {
"artifacts": {
"description": "Output only. A list of artifact metadata.",
"items": {
"$ref": "GoogleCloudAiplatformV1Artifact"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus": {
"description": "A single record of the task status.",
"id": "GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus",
"properties": {
"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
},
"state": {
"description": "Output only. The 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,
"type": "string"
},
"updateTime": {
"description": "Output only. Update time of this status.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PipelineTaskExecutorDetail": {
"description": "The runtime detail of a pipeline executor.",
"id": "GoogleCloudAiplatformV1PipelineTaskExecutorDetail",
"properties": {
"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"
},
"GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail": {
"description": "The detail of a container execution. It contains the job names of the lifecycle of a container execution.",
"id": "GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail",
"properties": {
"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": "array"
},
"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": "array"
},
"mainJob": {
"description": "Output only. The name of the CustomJob for the main container execution.",
"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,
"type": "string"
}
},
"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": "array"
},
"job": {
"description": "Output only. The name of the CustomJob.",
"readOnly": true,
"type": "string"
}
},
"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": {
"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"
},
"GoogleCloudAiplatformV1PointwiseMetricInput": {
"description": "Input for pointwise metric.",
"id": "GoogleCloudAiplatformV1PointwiseMetricInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1PointwiseMetricInstance",
"description": "Required. Pointwise metric instance."
},
"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."
},
"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
},
"explanation": {
"description": "Output only. Explanation for pointwise metric score.",
"readOnly": true,
"type": "string"
},
"score": {
"description": "Output only. Pointwise metric score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PointwiseMetricSpec": {
"description": "Spec for pointwise metric.",
"id": "GoogleCloudAiplatformV1PointwiseMetricSpec",
"properties": {
"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"
},
"systemInstruction": {
"description": "Optional. System instructions for pointwise metric.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1Port": {
"description": "Represents a network port in a container.",
"id": "GoogleCloudAiplatformV1Port",
"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.",
"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"
},
"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"
},
"postStartupScriptUrl": {
"description": "Optional. Post startup script url to download. Example: `gs://bucket/script.sh`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PrebuiltVoiceConfig": {
"description": "The configuration for the prebuilt speaker to use.",
"id": "GoogleCloudAiplatformV1PrebuiltVoiceConfig",
"properties": {
"voiceName": {
"description": "The name of the preset voice to use.",
"type": "string"
}
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1PredictRequest": {
"description": "Request message for PredictionService.Predict.",
"id": "GoogleCloudAiplatformV1PredictRequest",
"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"
},
"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"
},
"GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig": {
"description": "Configuration for logging request-response to a BigQuery table.",
"id": "GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig",
"properties": {
"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`"
},
"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"
},
"GoogleCloudAiplatformV1PredictResponse": {
"description": "Response message for PredictionService.Predict.",
"id": "GoogleCloudAiplatformV1PredictResponse",
"properties": {
"deployedModelId": {
"description": "ID of the Endpoint's DeployedModel that served this prediction.",
"type": "string"
},
"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"
},
"modelDisplayName": {
"description": "Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.",
"readOnly": true,
"type": "string"
},
"modelVersionId": {
"description": "Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits.",
"readOnly": true,
"type": "string"
},
"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": {
"type": "any"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PredictSchemata": {
"description": "Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob.",
"id": "GoogleCloudAiplatformV1PredictSchemata",
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1Presets": {
"description": "Preset configuration for example-based explanations",
"id": "GoogleCloudAiplatformV1Presets",
"properties": {
"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"
},
"query": {
"description": "Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.",
"enum": [
"PRECISE",
"FAST"
],
"enumDescriptions": [
"More precise neighbors as a trade-off against slower response.",
"Faster response as a trade-off against less precise neighbors."
],
"type": "string"
}
},
"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": {
"explainHttpUri": {
"description": "Output only. Http(s) path to send explain requests.",
"readOnly": true,
"type": "string"
},
"healthHttpUri": {
"description": "Output only. Http(s) path to send health check requests.",
"readOnly": true,
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1PrivateServiceConnectConfig": {
"description": "Represents configuration for private service connect.",
"id": "GoogleCloudAiplatformV1PrivateServiceConnectConfig",
"properties": {
"enablePrivateServiceConnect": {
"description": "Required. If true, expose the IndexEndpoint via private service connect.",
"type": "boolean"
},
"projectAllowlist": {
"description": "A list of Projects from which the forwarding rule will target the service attachment.",
"items": {
"type": "string"
},
"type": "array"
},
"serviceAttachment": {
"description": "Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect.",
"readOnly": true,
"type": "string"
}
},
"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."
},
"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"
},
"grpc": {
"$ref": "GoogleCloudAiplatformV1ProbeGrpcAction",
"description": "GrpcAction probes the health of a container by sending a gRPC request."
},
"httpGet": {
"$ref": "GoogleCloudAiplatformV1ProbeHttpGetAction",
"description": "HttpGetAction probes the health of a container by sending an HTTP GET request."
},
"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"
},
"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": {
"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"
},
"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": "GoogleCloudAiplatformV1ProbeHttpHeader"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1ProbeHttpHeader": {
"description": "HttpHeader describes a custom header to be used in HTTP probes",
"id": "GoogleCloudAiplatformV1ProbeHttpHeader",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ProbeTcpSocketAction": {
"description": "TcpSocketAction probes the health of a container by opening a TCP socket connection.",
"id": "GoogleCloudAiplatformV1ProbeTcpSocketAction",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the model serving container's IP.",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PscAutomatedEndpoints": {
"description": "PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig.",
"id": "GoogleCloudAiplatformV1PscAutomatedEndpoints",
"properties": {
"matchAddress": {
"description": "Ip Address created by the automated forwarding rule.",
"type": "string"
},
"network": {
"description": "Corresponding network in pscAutomationConfigs.",
"type": "string"
},
"projectId": {
"description": "Corresponding project_id in pscAutomationConfigs",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PublisherModel": {
"description": "A Model Garden Publisher Model.",
"id": "GoogleCloudAiplatformV1PublisherModel",
"properties": {
"frameworks": {
"description": "Optional. Additional information about the model's Frameworks.",
"items": {
"type": "string"
},
"type": "array"
},
"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"
},
"name": {
"description": "Output only. The resource name of the PublisherModel.",
"readOnly": true,
"type": "string"
},
"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"
},
"predictSchemata": {
"$ref": "GoogleCloudAiplatformV1PredictSchemata",
"description": "Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict."
},
"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": "string"
},
"supportedActions": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToAction",
"description": "Optional. Supported call-to-action options."
},
"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": "string"
},
"versionState": {
"description": "Optional. Indicates the state of the model version.",
"enum": [
"VERSION_STATE_UNSPECIFIED",
"VERSION_STATE_STABLE",
"VERSION_STATE_UNSTABLE"
],
"enumDescriptions": [
"The version state is unspecified.",
"Used to indicate the version is stable.",
"Used to indicate the version is unstable."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PublisherModelCallToAction": {
"description": "Actions could take on this Publisher Model.",
"id": "GoogleCloudAiplatformV1PublisherModelCallToAction",
"properties": {
"createApplication": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences",
"description": "Optional. Create application using the PublisherModel."
},
"deploy": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy",
"description": "Optional. Deploy the PublisherModel to Vertex Endpoint."
},
"deployGke": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke",
"description": "Optional. Deploy PublisherModel to Google Kubernetes Engine."
},
"multiDeployVertex": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex",
"description": "Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint."
},
"openEvaluationPipeline": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences",
"description": "Optional. Open evaluation pipeline of the PublisherModel."
},
"openFineTuningPipeline": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences",
"description": "Optional. Open fine-tuning pipeline of the PublisherModel."
},
"openFineTuningPipelines": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines",
"description": "Optional. Open fine-tuning pipelines of the PublisherModel."
},
"openGenerationAiStudio": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences",
"description": "Optional. Open in Generation AI Studio."
},
"openGenie": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences",
"description": "Optional. Open Genie / Playground."
},
"openNotebook": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences",
"description": "Optional. Open notebook of the PublisherModel."
},
"openNotebooks": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks",
"description": "Optional. Open notebooks of the PublisherModel."
},
"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"
},
"GoogleCloudAiplatformV1PublisherModelCallToActionDeploy": {
"description": "Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.",
"id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy",
"properties": {
"artifactUri": {
"description": "Optional. The path to the directory containing the Model artifact and any of its supporting files.",
"type": "string"
},
"automaticResources": {
"$ref": "GoogleCloudAiplatformV1AutomaticResources",
"description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration."
},
"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."
},
"dedicatedResources": {
"$ref": "GoogleCloudAiplatformV1DedicatedResources",
"description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration."
},
"deployMetadata": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata",
"description": "Optional. Metadata information about this deployment config."
},
"deployTaskName": {
"description": "Optional. The name of the deploy task (e.g., \"text to image generation\").",
"type": "string"
},
"largeModelReference": {
"$ref": "GoogleCloudAiplatformV1LargeModelReference",
"description": "Optional. Large model reference. When this is set, model_artifact_spec is not needed."
},
"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"
},
"GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata": {
"description": "Metadata information about the deployment for managing deployment config.",
"id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata",
"properties": {
"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"
},
"GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke": {
"description": "Configurations for PublisherModel GKE deployment",
"id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke",
"properties": {
"gkeYamlConfigs": {
"description": "Optional. GKE deployment configuration in yaml format.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex": {
"description": "Multiple setups to deploy the PublisherModel.",
"id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex",
"properties": {
"multiDeployVertex": {
"description": "Optional. One click deployment configurations.",
"items": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines": {
"description": "Open fine tuning pipelines.",
"id": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines",
"properties": {
"fineTuningPipelines": {
"description": "Required. Regional resource references to fine tuning pipelines.",
"items": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks": {
"description": "Open notebooks.",
"id": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks",
"properties": {
"notebooks": {
"description": "Required. Regional resource references to notebooks.",
"items": {
"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences"
},
"type": "array"
}
},
"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": {
"references": {
"additionalProperties": {
"$ref": "GoogleCloudAiplatformV1PublisherModelResourceReference"
},
"description": "Required.",
"type": "object"
},
"resourceDescription": {
"description": "Optional. Description of the resource.",
"type": "string"
},
"resourceTitle": {
"description": "Optional. Title of the resource.",
"type": "string"
},
"resourceUseCase": {
"description": "Optional. Use case (CUJ) of the resource.",
"type": "string"
},
"title": {
"description": "Required. ",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi": {
"description": "Rest API docs.",
"id": "GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi",
"properties": {
"documentations": {
"description": "Required.",
"items": {
"$ref": "GoogleCloudAiplatformV1PublisherModelDocumentation"
},
"type": "array"
},
"title": {
"description": "Required. The title of the view rest API.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PublisherModelDocumentation": {
"description": "A named piece of documentation.",
"id": "GoogleCloudAiplatformV1PublisherModelDocumentation",
"properties": {
"content": {
"description": "Required. Content of this piece of document (in Markdown format).",
"type": "string"
},
"title": {
"description": "Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA, NODE.JS, etc..",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PublisherModelResourceReference": {
"description": "Reference to a resource.",
"id": "GoogleCloudAiplatformV1PublisherModelResourceReference",
"properties": {
"description": {
"deprecated": true,
"description": "Description of the resource.",
"type": "string"
},
"resourceName": {
"description": "The resource name of the Google Cloud resource.",
"type": "string"
},
"uri": {
"description": "The URI of the resource.",
"type": "string"
},
"useCase": {
"deprecated": true,
"description": "Use case (CUJ) of the resource.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PurgeArtifactsMetadata": {
"description": "Details of operations that perform MetadataService.PurgeArtifacts.",
"id": "GoogleCloudAiplatformV1PurgeArtifactsMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for purging Artifacts."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PurgeArtifactsRequest": {
"description": "Request message for MetadataService.PurgeArtifacts.",
"id": "GoogleCloudAiplatformV1PurgeArtifactsRequest",
"properties": {
"filter": {
"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"
},
"GoogleCloudAiplatformV1PurgeArtifactsResponse": {
"description": "Response message for MetadataService.PurgeArtifacts.",
"id": "GoogleCloudAiplatformV1PurgeArtifactsResponse",
"properties": {
"purgeCount": {
"description": "The number of Artifacts that this request deleted (or, if `force` is false, the number of Artifacts that will be deleted). This can be an estimate.",
"format": "int64",
"type": "string"
},
"purgeSample": {
"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"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PurgeContextsMetadata": {
"description": "Details of operations that perform MetadataService.PurgeContexts.",
"id": "GoogleCloudAiplatformV1PurgeContextsMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for purging Contexts."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PurgeContextsRequest": {
"description": "Request message for MetadataService.PurgeContexts.",
"id": "GoogleCloudAiplatformV1PurgeContextsRequest",
"properties": {
"filter": {
"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"
},
"GoogleCloudAiplatformV1PurgeContextsResponse": {
"description": "Response message for MetadataService.PurgeContexts.",
"id": "GoogleCloudAiplatformV1PurgeContextsResponse",
"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.",
"format": "int64",
"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).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PurgeExecutionsMetadata": {
"description": "Details of operations that perform MetadataService.PurgeExecutions.",
"id": "GoogleCloudAiplatformV1PurgeExecutionsMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for purging Executions."
}
},
"type": "object"
},
"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"
},
"GoogleCloudAiplatformV1PurgeExecutionsResponse": {
"description": "Response message for MetadataService.PurgeExecutions.",
"id": "GoogleCloudAiplatformV1PurgeExecutionsResponse",
"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.",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1PythonPackageSpec": {
"description": "The spec of a Python packaged code.",
"id": "GoogleCloudAiplatformV1PythonPackageSpec",
"properties": {
"args": {
"description": "Command line arguments to be passed to the Python task.",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "Environment variables to be passed to the python module. Maximum limit is 100.",
"items": {
"$ref": "GoogleCloudAiplatformV1EnvVar"
},
"type": "array"
},
"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"
},
"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"
},
"pythonModule": {
"description": "Required. The Python module name to run after installing the packages.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1QueryDeployedModelsResponse": {
"description": "Response message for QueryDeployedModels method.",
"id": "GoogleCloudAiplatformV1QueryDeployedModelsResponse",
"properties": {
"deployedModelRefs": {
"description": "References to the DeployedModels that share the specified deploymentResourcePool.",
"items": {
"$ref": "GoogleCloudAiplatformV1DeployedModelRef"
},
"type": "array"
},
"deployedModels": {
"deprecated": true,
"description": "DEPRECATED Use deployed_model_refs instead.",
"items": {
"$ref": "GoogleCloudAiplatformV1DeployedModel"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1QueryReasoningEngineRequest": {
"description": "Request message for ReasoningEngineExecutionService.Query.",
"id": "GoogleCloudAiplatformV1QueryReasoningEngineRequest",
"properties": {
"classMethod": {
"description": "Optional. Class method to be used for the query. It is optional and defaults to \"query\" if unspecified.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1QueryReasoningEngineResponse": {
"description": "Response message for ReasoningEngineExecutionService.Query",
"id": "GoogleCloudAiplatformV1QueryReasoningEngineResponse",
"properties": {
"output": {
"description": "Response provided by users in JSON object format.",
"type": "any"
}
},
"type": "object"
},
"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"
},
"GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance": {
"description": "Spec for question answering correctness instance.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance",
"properties": {
"context": {
"description": "Optional. Text provided as context to answer the question.",
"type": "string"
},
"instruction": {
"description": "Required. The question asked and other instruction in the inference prompt.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult": {
"description": "Spec for question answering correctness result.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult",
"properties": {
"confidence": {
"description": "Output only. Confidence for question answering correctness score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"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"
},
"GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec": {
"description": "Spec for question answering correctness metric.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec",
"properties": {
"useReference": {
"description": "Optional. Whether to use instance.reference to compute question answering correctness.",
"type": "boolean"
},
"version": {
"description": "Optional. Which version to use for evaluation.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput": {
"description": "Input for question answering helpfulness metric.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance",
"description": "Required. Question answering helpfulness instance."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec",
"description": "Required. Spec for question answering helpfulness score metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance": {
"description": "Spec for question answering helpfulness instance.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance",
"properties": {
"context": {
"description": "Optional. Text provided as context to answer the question.",
"type": "string"
},
"instruction": {
"description": "Required. The question asked and other instruction in the inference prompt.",
"type": "string"
},
"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"
},
"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,
"type": "number"
},
"explanation": {
"description": "Output only. Explanation for question answering helpfulness score.",
"readOnly": true,
"type": "string"
},
"score": {
"description": "Output only. Question Answering Helpfulness score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec": {
"description": "Spec for question answering helpfulness metric.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec",
"properties": {
"useReference": {
"description": "Optional. Whether to use instance.reference to compute question answering helpfulness.",
"type": "boolean"
},
"version": {
"description": "Optional. Which version to use for evaluation.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1QuestionAnsweringQualityInput": {
"description": "Input for question answering quality metric.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringQualityInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1QuestionAnsweringQualityInstance",
"description": "Required. Question answering quality instance."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1QuestionAnsweringQualitySpec",
"description": "Required. Spec for question answering quality score metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1QuestionAnsweringQualityInstance": {
"description": "Spec for question answering quality instance.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringQualityInstance",
"properties": {
"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 evaluated model.",
"type": "string"
},
"reference": {
"description": "Optional. Ground truth used to compare against the prediction.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1QuestionAnsweringQualityResult": {
"description": "Spec for question answering quality result.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringQualityResult",
"properties": {
"confidence": {
"description": "Output only. Confidence for question answering quality score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"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"
},
"GoogleCloudAiplatformV1QuestionAnsweringQualitySpec": {
"description": "Spec for question answering quality score metric.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringQualitySpec",
"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.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput": {
"description": "Input for question answering relevance metric.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance",
"description": "Required. Question answering relevance instance."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec",
"description": "Required. Spec for question answering relevance score metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance": {
"description": "Spec for question answering relevance instance.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance",
"properties": {
"context": {
"description": "Optional. Text provided as context to answer the question.",
"type": "string"
},
"instruction": {
"description": "Required. The question asked and other instruction in the inference prompt.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult": {
"description": "Spec for question answering relevance result.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult",
"properties": {
"confidence": {
"description": "Output only. Confidence for question answering relevance score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"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"
},
"GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec": {
"description": "Spec for question answering relevance metric.",
"id": "GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec",
"properties": {
"useReference": {
"description": "Optional. Whether to use instance.reference to compute question answering relevance.",
"type": "boolean"
},
"version": {
"description": "Optional. Which version to use for evaluation.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagChunk": {
"description": "A RagChunk includes the content of a chunk of a RagFile, and associated metadata.",
"id": "GoogleCloudAiplatformV1RagChunk",
"properties": {
"pageSpan": {
"$ref": "GoogleCloudAiplatformV1RagChunkPageSpan",
"description": "If populated, represents where the chunk starts and ends in the document."
},
"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"
},
"lastPage": {
"description": "Page where chunk ends in the document. Inclusive. 1-indexed.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagContexts": {
"description": "Relevant contexts for one query.",
"id": "GoogleCloudAiplatformV1RagContexts",
"properties": {
"contexts": {
"description": "All its contexts.",
"items": {
"$ref": "GoogleCloudAiplatformV1RagContextsContext"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagContextsContext": {
"description": "A context of the query.",
"id": "GoogleCloudAiplatformV1RagContextsContext",
"properties": {
"chunk": {
"$ref": "GoogleCloudAiplatformV1RagChunk",
"description": "Context of the retrieved chunk."
},
"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"
},
"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"
},
"text": {
"description": "The text chunk.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagCorpus": {
"description": "A RagCorpus is a RagFile container and a project can have multiple RagCorpora.",
"id": "GoogleCloudAiplatformV1RagCorpus",
"properties": {
"corpusStatus": {
"$ref": "GoogleCloudAiplatformV1CorpusStatus",
"description": "Output only. RagCorpus state.",
"readOnly": true
},
"createTime": {
"description": "Output only. Timestamp when this RagCorpus was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. The description of the RagCorpus.",
"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.",
"type": "string"
},
"name": {
"description": "Output only. The resource name of the RagCorpus.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. Timestamp when this RagCorpus was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"vectorDbConfig": {
"$ref": "GoogleCloudAiplatformV1RagVectorDbConfig",
"description": "Optional. Immutable. The config for the Vector DBs."
},
"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"
},
"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": "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,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagFile": {
"description": "A RagFile contains user data for chunking, embedding and indexing.",
"id": "GoogleCloudAiplatformV1RagFile",
"properties": {
"createTime": {
"description": "Output only. Timestamp when this RagFile was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. The description of the RagFile.",
"type": "string"
},
"directUploadSource": {
"$ref": "GoogleCloudAiplatformV1DirectUploadSource",
"description": "Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.",
"readOnly": true
},
"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"
},
"fileStatus": {
"$ref": "GoogleCloudAiplatformV1FileStatus",
"description": "Output only. State of the RagFile.",
"readOnly": true
},
"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
},
"googleDriveSource": {
"$ref": "GoogleCloudAiplatformV1GoogleDriveSource",
"description": "Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.",
"readOnly": true
},
"jiraSource": {
"$ref": "GoogleCloudAiplatformV1JiraSource",
"description": "The RagFile is imported from a Jira query."
},
"name": {
"description": "Output only. The resource name of the RagFile.",
"readOnly": true,
"type": "string"
},
"sharePointSources": {
"$ref": "GoogleCloudAiplatformV1SharePointSources",
"description": "The RagFile is imported from a SharePoint source."
},
"slackSource": {
"$ref": "GoogleCloudAiplatformV1SlackSource",
"description": "The RagFile is imported from a Slack channel."
},
"updateTime": {
"description": "Output only. Timestamp when this RagFile was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagFileChunkingConfig": {
"description": "Specifies the size and overlap of chunks for RagFiles.",
"id": "GoogleCloudAiplatformV1RagFileChunkingConfig",
"properties": {
"fixedLengthChunking": {
"$ref": "GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking",
"description": "Specifies the fixed length chunking config."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking": {
"description": "Specifies the fixed length chunking config.",
"id": "GoogleCloudAiplatformV1RagFileChunkingConfigFixedLengthChunking",
"properties": {
"chunkOverlap": {
"description": "The overlap between chunks.",
"format": "int32",
"type": "integer"
},
"chunkSize": {
"description": "The size of the chunks.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagFileParsingConfig": {
"description": "Specifies the parsing config for RagFiles.",
"id": "GoogleCloudAiplatformV1RagFileParsingConfig",
"properties": {
"layoutParser": {
"$ref": "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser",
"description": "The Layout Parser to use for RagFiles."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser": {
"description": "Document AI Layout Parser config.",
"id": "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser",
"properties": {
"maxParsingRequestsPerMin": {
"description": "The maximum number of requests the job is allowed to make to the Document AI processor per minute. Consult https://cloud.google.com/document-ai/quotas and the Quota page for your project to set an appropriate value here. If unspecified, a default value of 120 QPM would be used.",
"format": "int32",
"type": "integer"
},
"processorName": {
"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"
},
"GoogleCloudAiplatformV1RagFileTransformationConfig": {
"description": "Specifies the transformation config for RagFiles.",
"id": "GoogleCloudAiplatformV1RagFileTransformationConfig",
"properties": {
"ragFileChunkingConfig": {
"$ref": "GoogleCloudAiplatformV1RagFileChunkingConfig",
"description": "Specifies the chunking config for RagFiles."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagQuery": {
"description": "A query to retrieve relevant contexts.",
"id": "GoogleCloudAiplatformV1RagQuery",
"properties": {
"ragRetrievalConfig": {
"$ref": "GoogleCloudAiplatformV1RagRetrievalConfig",
"description": "Optional. The retrieval config for the query."
},
"text": {
"description": "Optional. The query in text format to get relevant contexts.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagRetrievalConfig": {
"description": "Specifies the context retrieval config.",
"id": "GoogleCloudAiplatformV1RagRetrievalConfig",
"properties": {
"filter": {
"$ref": "GoogleCloudAiplatformV1RagRetrievalConfigFilter",
"description": "Optional. Config for filters."
},
"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"
},
"GoogleCloudAiplatformV1RagRetrievalConfigFilter": {
"description": "Config for filters.",
"id": "GoogleCloudAiplatformV1RagRetrievalConfigFilter",
"properties": {
"metadataFilter": {
"description": "Optional. String for metadata filtering.",
"type": "string"
},
"vectorDistanceThreshold": {
"description": "Optional. Only returns contexts with vector distance smaller than the threshold.",
"format": "double",
"type": "number"
},
"vectorSimilarityThreshold": {
"description": "Optional. Only returns contexts with vector similarity larger than the threshold.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagRetrievalConfigRanking": {
"description": "Config for ranking and reranking.",
"id": "GoogleCloudAiplatformV1RagRetrievalConfigRanking",
"properties": {
"llmRanker": {
"$ref": "GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker",
"description": "Optional. Config for LlmRanker."
},
"rankService": {
"$ref": "GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService",
"description": "Optional. Config for Rank Service."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker": {
"description": "Config for LlmRanker.",
"id": "GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker",
"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).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService": {
"description": "Config for Rank Service.",
"id": "GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService",
"properties": {
"modelName": {
"description": "Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagVectorDbConfig": {
"description": "Config for the Vector DB to use for RAG.",
"id": "GoogleCloudAiplatformV1RagVectorDbConfig",
"properties": {
"apiAuth": {
"$ref": "GoogleCloudAiplatformV1ApiAuth",
"description": "Authentication config for the chosen Vector DB."
},
"pinecone": {
"$ref": "GoogleCloudAiplatformV1RagVectorDbConfigPinecone",
"description": "The config for the Pinecone."
},
"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"
},
"GoogleCloudAiplatformV1RagVectorDbConfigPinecone": {
"description": "The config for the Pinecone.",
"id": "GoogleCloudAiplatformV1RagVectorDbConfigPinecone",
"properties": {
"indexName": {
"description": "Pinecone index name. This value cannot be changed after it's set.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb": {
"description": "The config for the default RAG-managed Vector DB.",
"id": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch": {
"description": "The config for the Vertex Vector Search.",
"id": "GoogleCloudAiplatformV1RagVectorDbConfigVertexVectorSearch",
"properties": {
"index": {
"description": "The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}`",
"type": "string"
},
"indexEndpoint": {
"description": "The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RawOutput": {
"description": "Raw output.",
"id": "GoogleCloudAiplatformV1RawOutput",
"properties": {
"rawOutput": {
"description": "Output only. Raw output string.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RawPredictRequest": {
"description": "Request message for PredictionService.RawPredict.",
"id": "GoogleCloudAiplatformV1RawPredictRequest",
"properties": {
"httpBody": {
"$ref": "GoogleApiHttpBody",
"description": "The prediction input. Supports HTTP headers and arbitrary data payload. A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model. You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the `Model` as a `DeployedModel` to an Endpoint and use the `RawPredict` method."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RayLogsSpec": {
"description": "Configuration for the Ray OSS Logs.",
"id": "GoogleCloudAiplatformV1RayLogsSpec",
"properties": {
"disabled": {
"description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RayMetricSpec": {
"description": "Configuration for the Ray metrics.",
"id": "GoogleCloudAiplatformV1RayMetricSpec",
"properties": {
"disabled": {
"description": "Optional. Flag to disable the Ray metrics collection.",
"type": "boolean"
}
},
"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": {
"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"
},
"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"
},
"rayLogsSpec": {
"$ref": "GoogleCloudAiplatformV1RayLogsSpec",
"description": "Optional. OSS Ray logging configurations."
},
"rayMetricSpec": {
"$ref": "GoogleCloudAiplatformV1RayMetricSpec",
"description": "Optional. Ray metrics configurations."
},
"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"
},
"GoogleCloudAiplatformV1ReadFeatureValuesRequest": {
"description": "Request message for FeaturestoreOnlineServingService.ReadFeatureValues.",
"id": "GoogleCloudAiplatformV1ReadFeatureValuesRequest",
"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`.",
"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."
},
"header": {
"$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader",
"description": "Response header."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView": {
"description": "Entity view with Feature values.",
"id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView",
"properties": {
"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"
},
"GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData": {
"description": "Container to hold value(s), successive in time, for one Feature from the request.",
"id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData",
"properties": {
"value": {
"$ref": "GoogleCloudAiplatformV1FeatureValue",
"description": "Feature value if a single value is requested."
},
"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"
},
"GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor": {
"description": "Metadata for requested Features.",
"id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor",
"properties": {
"id": {
"description": "Feature ID.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader": {
"description": "Response header with metadata for the requested ReadFeatureValuesRequest.entity_type and Features.",
"id": "GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader",
"properties": {
"entityType": {
"description": "The resource name of the EntityType from the ReadFeatureValuesRequest. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.",
"type": "string"
},
"featureDescriptors": {
"description": "List of Feature metadata corresponding to each piece of ReadFeatureValuesResponse.EntityView.data.",
"items": {
"$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReadIndexDatapointsRequest": {
"description": "The request message for MatchService.ReadIndexDatapoints.",
"id": "GoogleCloudAiplatformV1ReadIndexDatapointsRequest",
"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.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReadIndexDatapointsResponse": {
"description": "The response message for MatchService.ReadIndexDatapoints.",
"id": "GoogleCloudAiplatformV1ReadIndexDatapointsResponse",
"properties": {
"datapoints": {
"description": "The result list of datapoints.",
"items": {
"$ref": "GoogleCloudAiplatformV1IndexDatapoint"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse": {
"description": "Response message for TensorboardService.ReadTensorboardBlobData.",
"id": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse",
"properties": {
"blobs": {
"description": "Blob messages containing blob bytes.",
"items": {
"$ref": "GoogleCloudAiplatformV1TensorboardBlob"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReadTensorboardSizeResponse": {
"description": "Response message for TensorboardService.ReadTensorboardSize.",
"id": "GoogleCloudAiplatformV1ReadTensorboardSizeResponse",
"properties": {
"storageSizeByte": {
"description": "Payload storage size for the TensorBoard",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse": {
"description": "Response message for TensorboardService.ReadTensorboardTimeSeriesData.",
"id": "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse",
"properties": {
"timeSeriesData": {
"$ref": "GoogleCloudAiplatformV1TimeSeriesData",
"description": "The returned time series data."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReadTensorboardUsageResponse": {
"description": "Response message for TensorboardService.ReadTensorboardUsage.",
"id": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse",
"properties": {
"monthlyUsageData": {
"additionalProperties": {
"$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData"
},
"description": "Maps year-month (YYYYMM) string to per month usage data.",
"type": "object"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData": {
"description": "Per month usage data",
"id": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData",
"properties": {
"userUsageData": {
"description": "Usage data for each user in the given month.",
"items": {
"$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData": {
"description": "Per user usage data.",
"id": "GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData",
"properties": {
"username": {
"description": "User's username",
"type": "string"
},
"viewCount": {
"description": "Number of times the user has read data within the Tensorboard.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReasoningEngine": {
"description": "ReasoningEngine provides a customizable runtime for models to determine which actions to take and in which order.",
"id": "GoogleCloudAiplatformV1ReasoningEngine",
"properties": {
"createTime": {
"description": "Output only. Timestamp when this ReasoningEngine was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. The description of the ReasoningEngine.",
"type": "string"
},
"displayName": {
"description": "Required. The display name of the ReasoningEngine.",
"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": "Identifier. The resource name of the ReasoningEngine.",
"type": "string"
},
"spec": {
"$ref": "GoogleCloudAiplatformV1ReasoningEngineSpec",
"description": "Optional. Configurations of the ReasoningEngine"
},
"updateTime": {
"description": "Output only. Timestamp when this ReasoningEngine was most recently updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReasoningEngineSpec": {
"description": "ReasoningEngine configurations",
"id": "GoogleCloudAiplatformV1ReasoningEngineSpec",
"properties": {
"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"
},
"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"
},
"deploymentSpec": {
"$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec",
"description": "Optional. The specification of a Reasoning Engine deployment."
},
"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."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec": {
"description": "The specification of a Reasoning Engine deployment.",
"id": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec",
"properties": {
"env": {
"description": "Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.",
"items": {
"$ref": "GoogleCloudAiplatformV1EnvVar"
},
"type": "array"
},
"secretEnv": {
"description": "Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.",
"items": {
"$ref": "GoogleCloudAiplatformV1SecretEnvVar"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec": {
"description": "User provided package spec like 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"
},
"pickleObjectGcsUri": {
"description": "Optional. The Cloud Storage URI of the pickled python object.",
"type": "string"
},
"pythonVersion": {
"description": "Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.",
"type": "string"
},
"requirementsGcsUri": {
"description": "Optional. The Cloud Storage URI of the `requirements.txt` file",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RebaseTunedModelRequest": {
"description": "Request message for GenAiTuningService.RebaseTunedModel.",
"id": "GoogleCloudAiplatformV1RebaseTunedModelRequest",
"properties": {
"artifactDestination": {
"$ref": "GoogleCloudAiplatformV1GcsDestination",
"description": "Optional. The Google Cloud Storage location to write the artifacts."
},
"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"
},
"tunedModelRef": {
"$ref": "GoogleCloudAiplatformV1TunedModelRef",
"description": "Required. TunedModel reference to retrieve the legacy model information."
},
"tuningJob": {
"$ref": "GoogleCloudAiplatformV1TuningJob",
"description": "Optional. The TuningJob to be updated. Users can use this TuningJob field to overwrite tuning configs."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata": {
"description": "Details of operations that perform reboot PersistentResource.",
"id": "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for PersistentResource."
},
"progressMessage": {
"description": "Progress Message for Reboot LRO",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RebootPersistentResourceRequest": {
"description": "Request message for PersistentResourceService.RebootPersistentResource.",
"id": "GoogleCloudAiplatformV1RebootPersistentResourceRequest",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1RemoveContextChildrenRequest": {
"description": "Request message for MetadataService.DeleteContextChildrenRequest.",
"id": "GoogleCloudAiplatformV1RemoveContextChildrenRequest",
"properties": {
"childContexts": {
"description": "The resource names of the child Contexts.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RemoveContextChildrenResponse": {
"description": "Response message for MetadataService.RemoveContextChildren.",
"id": "GoogleCloudAiplatformV1RemoveContextChildrenResponse",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1RemoveDatapointsRequest": {
"description": "Request message for IndexService.RemoveDatapoints",
"id": "GoogleCloudAiplatformV1RemoveDatapointsRequest",
"properties": {
"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"
},
"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"
},
"reservationAffinityType": {
"description": "Required. Specifies the reservation affinity type.",
"enum": [
"TYPE_UNSPECIFIED",
"NO_RESERVATION",
"ANY_RESERVATION",
"SPECIFIC_RESERVATION"
],
"enumDescriptions": [
"Default value. This should not be used.",
"Do not consume from any reserved capacity, only use on-demand.",
"Consume any reservation available, falling back to on-demand.",
"Consume from a specific reservation. When chosen, the reservation must be identified via the `key` and `values` fields."
],
"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.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ResourcePool": {
"description": "Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.",
"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": {
"$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.",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec": {
"description": "The min/max number of replicas allowed if enabling autoscaling",
"id": "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec",
"properties": {
"maxReplicaCount": {
"description": "Optional. max replicas in the node pool, must be \u2265 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 \u2264 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"
},
"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 retrieval in the grounding flow.",
"id": "GoogleCloudAiplatformV1RetrievalMetadata",
"properties": {
"googleSearchDynamicRetrievalScore": {
"description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.",
"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"
},
"GoogleCloudAiplatformV1RougeInput": {
"description": "Input for rouge metric.",
"id": "GoogleCloudAiplatformV1RougeInput",
"properties": {
"instances": {
"description": "Required. Repeated rouge instances.",
"items": {
"$ref": "GoogleCloudAiplatformV1RougeInstance"
},
"type": "array"
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1RougeSpec",
"description": "Required. Spec for rouge score metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RougeInstance": {
"description": "Spec for rouge instance.",
"id": "GoogleCloudAiplatformV1RougeInstance",
"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"
},
"GoogleCloudAiplatformV1RougeMetricValue": {
"description": "Rouge metric value for an instance.",
"id": "GoogleCloudAiplatformV1RougeMetricValue",
"properties": {
"score": {
"description": "Output only. Rouge score.",
"format": "float",
"readOnly": true,
"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": "array"
}
},
"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": {
"rougeType": {
"description": "Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.",
"type": "string"
},
"splitSummaries": {
"description": "Optional. Whether to split summaries while using rougeLsum.",
"type": "boolean"
},
"useStemmer": {
"description": "Optional. Whether to use stemmer to compute rouge score.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput": {
"description": "Instance and metric spec for RubricBasedInstructionFollowing metric.",
"id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance",
"description": "Required. Instance for RubricBasedInstructionFollowing metric."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec",
"description": "Required. Spec for RubricBasedInstructionFollowing metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance": {
"description": "Instance for RubricBasedInstructionFollowing metric - one instance corresponds to one row in an evaluation dataset.",
"id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingInstance",
"properties": {
"jsonInstance": {
"description": "Required. Instance specified as a json string. String key-value pairs are expected in the json_instance to render RubricBasedInstructionFollowing prompt templates.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult": {
"description": "Result for RubricBasedInstructionFollowing metric.",
"id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingResult",
"properties": {
"rubricCritiqueResults": {
"description": "Output only. List of per rubric critique results.",
"items": {
"$ref": "GoogleCloudAiplatformV1RubricCritiqueResult"
},
"readOnly": true,
"type": "array"
},
"score": {
"description": "Output only. Overall score for the instruction following.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec": {
"description": "Spec for RubricBasedInstructionFollowing metric - returns rubrics and verdicts corresponding to rubrics along with overall score.",
"id": "GoogleCloudAiplatformV1RubricBasedInstructionFollowingSpec",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1RubricCritiqueResult": {
"description": "Rubric critique result.",
"id": "GoogleCloudAiplatformV1RubricCritiqueResult",
"properties": {
"rubric": {
"description": "Output only. Rubric to be evaluated.",
"readOnly": true,
"type": "string"
},
"verdict": {
"description": "Output only. Verdict for the rubric - true if the rubric is met, false otherwise.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SafetyInput": {
"description": "Input for safety metric.",
"id": "GoogleCloudAiplatformV1SafetyInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1SafetyInstance",
"description": "Required. Safety instance."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1SafetySpec",
"description": "Required. Spec for safety metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SafetyInstance": {
"description": "Spec for safety instance.",
"id": "GoogleCloudAiplatformV1SafetyInstance",
"properties": {
"prediction": {
"description": "Required. Output of the evaluated model.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SafetyRating": {
"description": "Safety rating corresponding to the generated content.",
"id": "GoogleCloudAiplatformV1SafetyRating",
"properties": {
"blocked": {
"description": "Output only. Indicates whether the content was filtered out because of this rating.",
"readOnly": true,
"type": "boolean"
},
"category": {
"description": "Output only. Harm category.",
"enum": [
"HARM_CATEGORY_UNSPECIFIED",
"HARM_CATEGORY_HATE_SPEECH",
"HARM_CATEGORY_DANGEROUS_CONTENT",
"HARM_CATEGORY_HARASSMENT",
"HARM_CATEGORY_SEXUALLY_EXPLICIT",
"HARM_CATEGORY_CIVIC_INTEGRITY"
],
"enumDescriptions": [
"The harm category is unspecified.",
"The harm category is hate speech.",
"The harm category is dangerous content.",
"The harm category is harassment.",
"The harm category is sexually explicit content.",
"The harm category is civic integrity."
],
"readOnly": true,
"type": "string"
},
"probability": {
"description": "Output only. Harm probability levels in the content.",
"enum": [
"HARM_PROBABILITY_UNSPECIFIED",
"NEGLIGIBLE",
"LOW",
"MEDIUM",
"HIGH"
],
"enumDescriptions": [
"Harm probability unspecified.",
"Negligible level of harm.",
"Low level of harm.",
"Medium level of harm.",
"High level of harm."
],
"readOnly": true,
"type": "string"
},
"probabilityScore": {
"description": "Output only. Harm probability score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"severity": {
"description": "Output only. Harm severity levels in the content.",
"enum": [
"HARM_SEVERITY_UNSPECIFIED",
"HARM_SEVERITY_NEGLIGIBLE",
"HARM_SEVERITY_LOW",
"HARM_SEVERITY_MEDIUM",
"HARM_SEVERITY_HIGH"
],
"enumDescriptions": [
"Harm severity unspecified.",
"Negligible level of harm severity.",
"Low level of harm severity.",
"Medium level of harm severity.",
"High level of harm severity."
],
"readOnly": true,
"type": "string"
},
"severityScore": {
"description": "Output only. Harm severity score.",
"format": "float",
"readOnly": true,
"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": "number"
},
"explanation": {
"description": "Output only. Explanation for safety score.",
"readOnly": true,
"type": "string"
},
"score": {
"description": "Output only. Safety score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SafetySetting": {
"description": "Safety settings.",
"id": "GoogleCloudAiplatformV1SafetySetting",
"properties": {
"category": {
"description": "Required. Harm category.",
"enum": [
"HARM_CATEGORY_UNSPECIFIED",
"HARM_CATEGORY_HATE_SPEECH",
"HARM_CATEGORY_DANGEROUS_CONTENT",
"HARM_CATEGORY_HARASSMENT",
"HARM_CATEGORY_SEXUALLY_EXPLICIT",
"HARM_CATEGORY_CIVIC_INTEGRITY"
],
"enumDescriptions": [
"The harm category is unspecified.",
"The harm category is hate speech.",
"The harm category is dangerous content.",
"The harm category is harassment.",
"The harm category is sexually explicit content.",
"The harm category is civic integrity."
],
"type": "string"
},
"method": {
"description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for 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 harm block threshold.",
"enum": [
"HARM_BLOCK_THRESHOLD_UNSPECIFIED",
"BLOCK_LOW_AND_ABOVE",
"BLOCK_MEDIUM_AND_ABOVE",
"BLOCK_ONLY_HIGH",
"BLOCK_NONE",
"OFF"
],
"enumDescriptions": [
"Unspecified harm block threshold.",
"Block low threshold and above (i.e. block more).",
"Block medium threshold and above.",
"Block only high threshold (i.e. block less).",
"Block none.",
"Turn off the safety filter."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SafetySpec": {
"description": "Spec for safety metric.",
"id": "GoogleCloudAiplatformV1SafetySpec",
"properties": {
"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"
},
"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"
},
"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": {
"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"
},
"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"
},
"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 SavedQuery was created.",
"format": "google-datetime",
"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"
},
"etag": {
"description": "Used to perform a consistent read-modify-write update. If not set, a blind \"overwrite\" update happens.",
"type": "string"
},
"metadata": {
"description": "Some additional information about the SavedQuery.",
"type": "any"
},
"name": {
"description": "Output only. Resource name of the SavedQuery.",
"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"
},
"supportAutomlTraining": {
"description": "Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.",
"readOnly": true,
"type": "boolean"
},
"updateTime": {
"description": "Output only. Timestamp when SavedQuery was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1Scalar": {
"description": "One point viewable on a scalar metric plot.",
"id": "GoogleCloudAiplatformV1Scalar",
"properties": {
"value": {
"description": "Value of the point at this step / timestamp.",
"format": "double",
"type": "number"
}
},
"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": {
"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"
},
"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"
},
"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"
},
"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"
},
"lastPauseTime": {
"description": "Output only. Timestamp when this Schedule was last paused. Unset if never paused.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"lastResumeTime": {
"description": "Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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
},
"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"
},
"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"
},
"name": {
"description": "Immutable. The resource name of the Schedule.",
"type": "string"
},
"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"
},
"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"
},
"startedRunCount": {
"description": "Output only. The number of runs started by this schedule.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1ScheduleRunResponse": {
"description": "Status of a scheduled run.",
"id": "GoogleCloudAiplatformV1ScheduleRunResponse",
"properties": {
"runResponse": {
"description": "The response of the scheduled run.",
"type": "string"
},
"scheduledRunTime": {
"description": "The scheduled run time based on the user-specified schedule.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1Scheduling": {
"description": "All parameters related to queuing and scheduling of custom jobs.",
"id": "GoogleCloudAiplatformV1Scheduling",
"properties": {
"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"
},
"timeout": {
"description": "Optional. The maximum job running time. The default is 7 days.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"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.",
"id": "GoogleCloudAiplatformV1Schema",
"properties": {
"anyOf": {
"description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.",
"items": {
"$ref": "GoogleCloudAiplatformV1Schema"
},
"type": "array"
},
"default": {
"description": "Optional. Default value of the data.",
"type": "any"
},
"description": {
"description": "Optional. The description of the data.",
"type": "string"
},
"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\"]}",
"items": {
"type": "string"
},
"type": "array"
},
"example": {
"description": "Optional. Example of the object. Will only populated when the object is the root.",
"type": "any"
},
"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",
"type": "string"
},
"items": {
"$ref": "GoogleCloudAiplatformV1Schema",
"description": "Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY."
},
"maxItems": {
"description": "Optional. Maximum number of the elements for Type.ARRAY.",
"format": "int64",
"type": "string"
},
"maxLength": {
"description": "Optional. Maximum length of the Type.STRING",
"format": "int64",
"type": "string"
},
"maxProperties": {
"description": "Optional. Maximum number of the properties for Type.OBJECT.",
"format": "int64",
"type": "string"
},
"maximum": {
"description": "Optional. Maximum value of the Type.INTEGER and Type.NUMBER",
"format": "double",
"type": "number"
},
"minItems": {
"description": "Optional. Minimum number of the elements for Type.ARRAY.",
"format": "int64",
"type": "string"
},
"minLength": {
"description": "Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING",
"format": "int64",
"type": "string"
},
"minProperties": {
"description": "Optional. Minimum number of the properties for Type.OBJECT.",
"format": "int64",
"type": "string"
},
"minimum": {
"description": "Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER",
"format": "double",
"type": "number"
},
"nullable": {
"description": "Optional. Indicates if the value may be null.",
"type": "boolean"
},
"pattern": {
"description": "Optional. Pattern of the Type.STRING to restrict a string to a regular expression.",
"type": "string"
},
"properties": {
"additionalProperties": {
"$ref": "GoogleCloudAiplatformV1Schema"
},
"description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.",
"type": "object"
},
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Optional. Required properties of Type.OBJECT.",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Optional. The title of the Schema.",
"type": "string"
},
"type": {
"description": "Optional. The type of the data.",
"enum": [
"TYPE_UNSPECIFIED",
"STRING",
"NUMBER",
"INTEGER",
"BOOLEAN",
"ARRAY",
"OBJECT"
],
"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"
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaAnnotationSpecColor": {
"description": "An entry of mapping between color and AnnotationSpec. The mapping is used in segmentation mask.",
"id": "GoogleCloudAiplatformV1SchemaAnnotationSpecColor",
"properties": {
"color": {
"$ref": "GoogleTypeColor",
"description": "The color of the AnnotationSpec in a segmentation mask."
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation": {
"description": "Annotation details specific to image object detection.",
"id": "GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation",
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaImageClassificationAnnotation": {
"description": "Annotation details specific to image classification.",
"id": "GoogleCloudAiplatformV1SchemaImageClassificationAnnotation",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaImageDataItem": {
"description": "Payload of Image DataItem.",
"id": "GoogleCloudAiplatformV1SchemaImageDataItem",
"properties": {
"gcsUri": {
"description": "Required. Google Cloud Storage URI points to the original image in user's bucket. The image is up to 30MB in size.",
"type": "string"
},
"mimeType": {
"description": "Output only. The mime type of the content of the image. Only the images in below listed mime types are supported. - image/jpeg - image/gif - image/png - image/webp - image/bmp - image/tiff - image/vnd.microsoft.icon",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaImageDatasetMetadata": {
"description": "The metadata of Datasets that contain Image DataItems.",
"id": "GoogleCloudAiplatformV1SchemaImageDatasetMetadata",
"properties": {
"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"
},
"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."
},
"polygonAnnotation": {
"$ref": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation",
"description": "Polygon annotation."
},
"polylineAnnotation": {
"$ref": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation",
"description": "Polyline annotation."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation": {
"description": "The mask based segmentation annotation.",
"id": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation",
"properties": {
"annotationSpecColors": {
"description": "The mapping between color and AnnotationSpec for this Annotation.",
"items": {
"$ref": "GoogleCloudAiplatformV1SchemaAnnotationSpecColor"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation": {
"description": "Represents a polygon in image.",
"id": "GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation",
"properties": {
"annotationSpecId": {
"description": "The resource Id of the AnnotationSpec that this Annotation pertains to.",
"type": "string"
},
"displayName": {
"description": "The display name of the AnnotationSpec that this Annotation pertains to.",
"type": "string"
},
"vertexes": {
"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"
},
"displayName": {
"description": "The display name of the AnnotationSpec that this Annotation pertains to.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics": {
"description": "Bounding box matching model metrics for a single intersection-over-union threshold and multiple label match confidence thresholds.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics",
"properties": {
"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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics": {
"description": "Metrics for a single confidence threshold.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics": {
"description": "Metrics for classification evaluation results.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics",
"properties": {
"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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics"
},
"type": "array"
},
"confusionMatrix": {
"$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix",
"description": "Confusion matrix of the evaluation."
},
"logLoss": {
"description": "The Log Loss metric.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics": {
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics",
"properties": {
"confidenceThreshold": {
"description": "Metrics are computed with an assumption that the Model never returns predictions with score lower than this value.",
"format": "float",
"type": "number"
},
"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"
},
"falsePositiveCount": {
"description": "The number of Model created labels that do not match a ground truth label.",
"format": "int64",
"type": "string"
},
"falsePositiveRate": {
"description": "False Positive Rate for the given confidence threshold.",
"format": "float",
"type": "number"
},
"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"
},
"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"
},
"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"
},
"truePositiveCount": {
"description": "The number of Model created labels that match a ground truth label.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix": {
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix",
"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.",
"items": {
"$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef": {
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef",
"properties": {
"displayName": {
"description": "Display name of the AnnotationSpec.",
"type": "string"
},
"id": {
"description": "ID of the AnnotationSpec.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics": {
"description": "Metrics for forecasting evaluation results.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics",
"properties": {
"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": "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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry": {
"description": "Entry for the Quantiles loss type optimization objective.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry",
"properties": {
"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"
},
"quantile": {
"description": "The quantile for this entry.",
"format": "double",
"type": "number"
},
"scaledPinballLoss": {
"description": "The scaled pinball loss of this quantile.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics": {
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics": {
"description": "Metrics for image object detection evaluation results.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics",
"properties": {
"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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics": {
"description": "Metrics for image segmentation evaluation results.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics",
"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.",
"items": {
"$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry": {
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry",
"properties": {
"confidenceThreshold": {
"description": "Metrics are computed with an assumption that the model never returns predictions with score lower than this value.",
"format": "float",
"type": "number"
},
"confusionMatrix": {
"$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix",
"description": "Confusion matrix for the given confidence threshold."
},
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics": {
"description": "Metrics for general pairwise text generation evaluation results.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics",
"properties": {
"accuracy": {
"description": "Fraction of cases where the autorater agreed with the human raters.",
"format": "float",
"type": "number"
},
"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"
},
"falsePositiveCount": {
"description": "Number of examples where the autorater chose the model, but humans preferred the baseline model.",
"format": "int64",
"type": "string"
},
"humanPreferenceBaselineModelWinRate": {
"description": "Percentage of time humans decided the baseline model had the better response.",
"format": "float",
"type": "number"
},
"humanPreferenceModelWinRate": {
"description": "Percentage of time humans decided the model had the better response.",
"format": "float",
"type": "number"
},
"modelWinRate": {
"description": "Percentage of time the autorater decided the model had the better response.",
"format": "float",
"type": "number"
},
"precision": {
"description": "Fraction of cases where the autorater and humans thought the model had a better response out of all cases where the autorater thought the model had a better response. True positive divided by all positive.",
"format": "float",
"type": "number"
},
"recall": {
"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"
},
"trueNegativeCount": {
"description": "Number of examples where both the autorater and humans decided that the model had the worse response.",
"format": "int64",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics": {
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics",
"properties": {
"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"
},
"meanAbsolutePercentageError": {
"description": "Mean absolute percentage error. Infinity when there are zeros in the ground truth.",
"format": "float",
"type": "number"
},
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics": {
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics",
"properties": {
"rougeLSum": {
"description": "ROUGE-L (Longest Common Subsequence) scoring at summary level.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics": {
"description": "Metrics for text extraction evaluation results.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics",
"properties": {
"confidenceMetrics": {
"description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from them.",
"items": {
"$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics": {
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics": {
"description": "Model evaluation metrics for text sentiment problems.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics",
"properties": {
"confusionMatrix": {
"$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix",
"description": "Confusion matrix of the evaluation. Only set for ModelEvaluations, not for ModelEvaluationSlices."
},
"f1Score": {
"description": "The harmonic mean of recall and precision.",
"format": "float",
"type": "number"
},
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics": {
"description": "UNIMPLEMENTED. Track matching model metrics for a single track match threshold and multiple label match confidence thresholds.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics",
"properties": {
"confidenceMetrics": {
"description": "Metrics for each label-match `confidenceThreshold` from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is derived from them.",
"items": {
"$ref": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics"
},
"type": "array"
},
"iouThreshold": {
"description": "The intersection-over-union threshold value between bounding boxes across frames used to compute this metric entry.",
"format": "float",
"type": "number"
},
"meanBoundingBoxIou": {
"description": "The mean bounding box iou over all confidence thresholds.",
"format": "float",
"type": "number"
},
"meanMismatchRate": {
"description": "The mean mismatch rate over all confidence thresholds.",
"format": "float",
"type": "number"
},
"meanTrackingAveragePrecision": {
"description": "The mean average precision over all confidence thresholds.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics": {
"description": "Metrics for a single confidence threshold.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics": {
"description": "The Evaluation metrics given a specific precision_window_length.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics",
"properties": {
"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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics": {
"description": "Metrics for a single confidence threshold.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics": {
"description": "Model evaluation metrics for video action recognition.",
"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics",
"properties": {
"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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics"
},
"type": "array"
}
},
"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": {
"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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics"
},
"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": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance": {
"description": "Prediction input format for Image Classification.",
"id": "GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance",
"properties": {
"content": {
"description": "The image bytes or Cloud Storage URI to make the prediction on.",
"type": "string"
},
"mimeType": {
"description": "The MIME type of the content of the image. Only the images in below listed MIME types are supported. - image/jpeg - image/gif - image/png - image/webp - image/bmp - image/tiff - image/vnd.microsoft.icon",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance": {
"description": "Prediction input format for Image Object Detection.",
"id": "GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance",
"properties": {
"content": {
"description": "The image bytes or Cloud Storage URI to make the prediction on.",
"type": "string"
},
"mimeType": {
"description": "The MIME type of the content of the image. Only the images in below listed MIME types are supported. - image/jpeg - image/gif - image/png - image/webp - image/bmp - image/tiff - image/vnd.microsoft.icon",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance": {
"description": "Prediction input format for Image Segmentation.",
"id": "GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance": {
"description": "Prediction input format for Text Classification.",
"id": "GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance": {
"description": "Prediction input format for Text Extraction.",
"id": "GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance",
"properties": {
"content": {
"description": "The text snippet to make the predictions on.",
"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"
},
"mimeType": {
"description": "The MIME type of the text snippet. The supported MIME types are listed below. - text/plain",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance": {
"description": "Prediction input format for Text Sentiment.",
"id": "GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance": {
"description": "Prediction input format for Video Action Recognition.",
"id": "GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance",
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance": {
"description": "Prediction input format for Video Classification.",
"id": "GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance",
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance": {
"description": "Prediction input format for Video Object Tracking.",
"id": "GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance",
"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"
},
"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"
},
"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"
},
"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"
},
"inlineContext": {
"description": "The grounding text passed inline with the Predict API. It can support up to 1 million bytes.",
"type": "string"
},
"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"
},
"vertexAiSearchDatastore": {
"description": "The uri of the Vertex AI Search data source.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams": {
"description": "Prediction model parameters for Image Classification.",
"id": "GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams",
"properties": {
"confidenceThreshold": {
"description": "The Model only returns predictions with at least this confidence score. Default value is 0.0",
"format": "float",
"type": "number"
},
"maxPredictions": {
"description": "The Model only returns up to that many top, by confidence score, predictions per instance. If this number is very high, the Model may return fewer predictions. Default value is 10.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams": {
"description": "Prediction model parameters for Image Object Detection.",
"id": "GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams",
"properties": {
"confidenceThreshold": {
"description": "The Model only returns predictions with at least this confidence score. Default value is 0.0",
"format": "float",
"type": "number"
},
"maxPredictions": {
"description": "The Model only returns up to that many top, by confidence score, predictions per instance. Note that number of returned predictions is also limited by metadata's predictionsLimit. Default value is 10.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams": {
"description": "Prediction model parameters for Image Segmentation.",
"id": "GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams",
"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.",
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams": {
"description": "Prediction model parameters for Video Object Tracking.",
"id": "GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams",
"properties": {
"confidenceThreshold": {
"description": "The Model only returns predictions with at least this confidence score. Default value is 0.0",
"format": "float",
"type": "number"
},
"maxPredictions": {
"description": "The model only returns up to that many top, by confidence score, predictions per 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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult": {
"description": "Prediction output format for Image and Text Classification.",
"id": "GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult",
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult": {
"description": "Prediction output format for Image Object Detection.",
"id": "GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult",
"properties": {
"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": {
"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"
},
"GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult": {
"description": "Prediction output format for Image Segmentation.",
"id": "GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult",
"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.",
"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.",
"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"
},
"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"
},
"quantilePredictions": {
"description": "Quantile predictions, in 1-1 correspondence with quantile_values.",
"items": {
"format": "float",
"type": "number"
},
"type": "array"
},
"quantileValues": {
"description": "Quantile values.",
"items": {
"format": "float",
"type": "number"
},
"type": "array"
},
"upperBound": {
"description": "The upper bound of the prediction interval.",
"format": "float",
"type": "number"
},
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult": {
"description": "Prediction output format for Text Sentiment",
"id": "GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult",
"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).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance": {
"id": "GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance",
"properties": {
"attributeColumns": {
"items": {
"type": "string"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult": {
"description": "Prediction output format for Time Series Forecasting.",
"id": "GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult",
"properties": {
"quantilePredictions": {
"description": "Quantile predictions, in 1-1 correspondence with quantile_values.",
"items": {
"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"
},
"GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult": {
"description": "Prediction output format for Video Action Recognition.",
"id": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult": {
"description": "Prediction output format for Video Classification.",
"id": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult",
"properties": {
"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. 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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult": {
"description": "Prediction output format for Video Object Tracking.",
"id": "GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult",
"properties": {
"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"
},
"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"
},
"id": {
"description": "The resource ID of the AnnotationSpec that had been identified.",
"type": "string"
},
"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"
},
"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"
},
"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": {
"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"
},
"xMax": {
"description": "The rightmost coordinate of the bounding box.",
"format": "float",
"type": "number"
},
"xMin": {
"description": "The leftmost coordinate of the bounding box.",
"format": "float",
"type": "number"
},
"yMax": {
"description": "The bottommost coordinate of the bounding box.",
"format": "float",
"type": "number"
},
"yMin": {
"description": "The topmost coordinate of the bounding box.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPredictionResult": {
"description": "Represents a line of JSONL in the batch prediction output file.",
"id": "GoogleCloudAiplatformV1SchemaPredictionResult",
"properties": {
"error": {
"$ref": "GoogleCloudAiplatformV1SchemaPredictionResultError",
"description": "The error result. Do not set prediction if this is set."
},
"instance": {
"additionalProperties": {
"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"
},
"GoogleCloudAiplatformV1SchemaPredictionResultError": {
"id": "GoogleCloudAiplatformV1SchemaPredictionResultError",
"properties": {
"message": {
"description": "Error message with additional details.",
"type": "string"
},
"status": {
"description": "Error status. This will be serialized into the enum name e.g. \"NOT_FOUND\".",
"enum": [
"OK",
"CANCELLED",
"UNKNOWN",
"INVALID_ARGUMENT",
"DEADLINE_EXCEEDED",
"NOT_FOUND",
"ALREADY_EXISTS",
"PERMISSION_DENIED",
"UNAUTHENTICATED",
"RESOURCE_EXHAUSTED",
"FAILED_PRECONDITION",
"ABORTED",
"OUT_OF_RANGE",
"UNIMPLEMENTED",
"INTERNAL",
"UNAVAILABLE",
"DATA_LOSS"
],
"enumDescriptions": [
"Not an error; returned on success. HTTP Mapping: 200 OK",
"The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request",
"Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error",
"The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request",
"The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout",
"Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found",
"The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict",
"The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden",
"The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized",
"Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests",
"The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request",
"The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict",
"The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request",
"The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented",
"Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error",
"The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable",
"Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error"
],
"type": "string"
}
},
"type": "object"
},
"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"
},
"executions": {
"description": "A list of execution instances for constructing a ready-to-use prompt.",
"items": {
"$ref": "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution"
},
"type": "array"
},
"multimodalPrompt": {
"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt",
"description": "Multimodal prompt which embeds preambles to prompt string."
},
"structuredPrompt": {
"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt",
"description": "The prompt variation that stores preambles in separate fields."
},
"translationPrompt": {
"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt",
"description": "The prompt variation for Translation use case."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution": {
"description": "A prompt instance's parameters set that contains a set of variable values.",
"id": "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt": {
"description": "Prompt variation that embeds preambles to prompt string.",
"id": "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt",
"properties": {
"promptMessage": {
"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage",
"description": "The prompt message."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPromptSpecPartList": {
"description": "A list of elements and information that make up a portion of prompt.",
"id": "GoogleCloudAiplatformV1SchemaPromptSpecPartList",
"properties": {
"parts": {
"description": "A list of elements that can be part of a prompt.",
"items": {
"$ref": "GoogleCloudAiplatformV1Part"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage": {
"description": "The prompt message that aligns with the prompt message in google.cloud.aiplatform.master.GenerateContentRequest.",
"id": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair": {
"description": "A pair of sentences used as reference in source and target languages.",
"id": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair",
"properties": {
"sourceSentence": {
"description": "Source sentence in the sentence pair.",
"type": "string"
},
"targetSentence": {
"description": "Target sentence in the sentence pair.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList": {
"description": "A list of reference sentence pairs.",
"id": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList",
"properties": {
"referenceSentencePairs": {
"description": "Reference sentence pairs.",
"items": {
"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt": {
"description": "Prompt variation that stores preambles in separate fields.",
"id": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt",
"properties": {
"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"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample": {
"description": "The translation example that contains reference sentences from various sources.",
"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource": {
"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource",
"properties": {
"content": {
"description": "The file's contents.",
"type": "string"
},
"displayName": {
"description": "The file's display name.",
"type": "string"
},
"mimeType": {
"description": "The file's mime type.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource": {
"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource",
"properties": {
"inputUri": {
"description": "Source data URI. For example, `gs://my_bucket/my_object`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption": {
"description": "Optional settings for translation prompt.",
"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption",
"properties": {
"numberOfShots": {
"description": "How many shots to use.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt": {
"description": "Prompt variation for Translation use case.",
"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt",
"properties": {
"example": {
"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample",
"description": "The translation example."
},
"option": {
"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption",
"description": "The translation option."
},
"promptMessage": {
"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage",
"description": "The prompt message."
},
"sourceLanguageCode": {
"description": "The source language code.",
"type": "string"
},
"targetLanguageCode": {
"description": "The target language code.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput": {
"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput",
"properties": {
"fileInputSource": {
"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource",
"description": "Inlined file source."
},
"gcsInputSource": {
"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource",
"description": "Cloud Storage file source."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTablesDatasetMetadata": {
"description": "The metadata of Datasets that contain tables data.",
"id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadata",
"properties": {
"inputConfig": {
"$ref": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource": {
"id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource",
"properties": {
"uri": {
"description": "The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource": {
"id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource",
"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.",
"items": {
"type": "string"
},
"type": "array"
}
},
"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": {
"bigquerySource": {
"$ref": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource"
},
"gcsSource": {
"$ref": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTextClassificationAnnotation": {
"description": "Annotation details specific to text classification.",
"id": "GoogleCloudAiplatformV1SchemaTextClassificationAnnotation",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTextDataItem": {
"description": "Payload of Text DataItem.",
"id": "GoogleCloudAiplatformV1SchemaTextDataItem",
"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.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTextDatasetMetadata": {
"description": "The metadata of Datasets that contain Text DataItems.",
"id": "GoogleCloudAiplatformV1SchemaTextDatasetMetadata",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTextExtractionAnnotation": {
"description": "Annotation details specific to text extraction.",
"id": "GoogleCloudAiplatformV1SchemaTextExtractionAnnotation",
"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"
},
"textSegment": {
"$ref": "GoogleCloudAiplatformV1SchemaTextSegment",
"description": "The segment of the text content."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata": {
"description": "The metadata of Datasets that contain Text Prompt data.",
"id": "GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata",
"properties": {
"candidateCount": {
"description": "Number of candidates.",
"format": "int64",
"type": "string"
},
"gcsUri": {
"description": "The Google Cloud Storage URI that stores the prompt data.",
"type": "string"
},
"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"
},
"note": {
"description": "User-created prompt note. Note size limit is 2KB.",
"type": "string"
},
"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"
},
"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.",
"format": "int64",
"type": "string"
},
"stopSequences": {
"description": "Customized stop sequences.",
"items": {
"type": "string"
},
"type": "array"
},
"systemInstruction": {
"description": "The content of the prompt dataset system instruction.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1SchemaTextSegment": {
"description": "The text segment inside of DataItem.",
"id": "GoogleCloudAiplatformV1SchemaTextSegment",
"properties": {
"content": {
"description": "The text content in the segment for output only.",
"type": "string"
},
"endOffset": {
"description": "Zero-based character index of the first character past the end of the text segment (counting character from the beginning of the text). The character at the end_offset is NOT included in the text segment.",
"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"
},
"GoogleCloudAiplatformV1SchemaTextSentimentAnnotation": {
"description": "Annotation details specific to text sentiment.",
"id": "GoogleCloudAiplatformV1SchemaTextSentimentAnnotation",
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata": {
"description": "The metadata of SavedQuery contains TextSentiment Annotations.",
"id": "GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata",
"properties": {
"sentimentMax": {
"description": "The maximum sentiment of sentiment Anntoation in this SavedQuery.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTimeSegment": {
"description": "A time period inside of a DataItem that has a time dimension (e.g. video).",
"id": "GoogleCloudAiplatformV1SchemaTimeSegment",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata": {
"description": "The metadata of Datasets that contain time series data.",
"id": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata",
"properties": {
"inputConfig": {
"$ref": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig"
},
"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"
},
"GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource": {
"id": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource",
"properties": {
"uri": {
"description": "The URI of a BigQuery table.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource": {
"id": "GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource",
"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.",
"items": {
"type": "string"
},
"type": "array"
}
},
"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": {
"$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."
},
"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"
},
"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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity",
"description": "Expected difference in time granularity between rows in the data."
},
"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"
},
"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`, 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"
},
"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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation"
},
"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.",
"type": "string"
},
"windowConfig": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig",
"description": "Config containing strategy for generating sliding windows."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity": {
"description": "A duration of time expressed in time granularity units.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation",
"properties": {
"auto": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation"
},
"categorical": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation"
},
"numeric": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation"
},
"text": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation"
},
"timestamp": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation": {
"description": "Training pipeline will infer the proper transformation based on the statistic of dataset.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation",
"properties": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
},
"timeFormat": {
"description": "The format in which that time field is expressed. The time_format must either be one of: * `unix-seconds` * `unix-milliseconds` * `unix-microseconds` * `unix-nanoseconds` (for respectively number of seconds, milliseconds, microseconds and nanoseconds since start of the Unix epoch); or be written in `strftime` syntax. If time_format is not set, then the default format is RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z)",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata": {
"description": "Model metadata specific to AutoML Forecasting.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification": {
"description": "A TrainingJob that trains and uploads an AutoML Image Classification Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs",
"description": "The input parameters of this TrainingJob."
},
"metadata": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata",
"description": "The metadata information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs",
"properties": {
"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"
},
"budgetMilliNodeHours": {
"description": "The training budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The actual metadata.costMilliNodeHours will be equal or less than this value. If further model training ceases to provide any improvements, it will stop without using the full budget and the metadata.successfulStopReason will be `model-converged`. Note, node_hour = actual_hour * number_of_nodes_involved. For modelType `cloud`(default), the budget must be between 8,000 and 800,000 milli node hours, inclusive. The default value is 192,000 which represents one day in wall time, considering 8 nodes are used. For model types `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, `mobile-tf-high-accuracy-1`, the training budget must be between 1,000 and 100,000 milli node hours, inclusive. The default value is 24,000 which represents one day in wall time on a single node that is used.",
"format": "int64",
"type": "string"
},
"disableEarlyStopping": {
"description": "Use the entire training budget. This disables the early stopping feature. When false the early stopping feature is enabled, which means that AutoML Image Classification might stop training before the entire training budget has been used.",
"type": "boolean"
},
"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"
},
"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"
},
"tunableParameter": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter",
"description": "Trainer type for Vision TrainRequest."
},
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata",
"properties": {
"costMilliNodeHours": {
"description": "The actual training cost of creating this model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.",
"format": "int64",
"type": "string"
},
"successfulStopReason": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection": {
"description": "A TrainingJob that trains and uploads an AutoML Image Object Detection Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs",
"description": "The input parameters of this TrainingJob."
},
"metadata": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata",
"description": "The metadata information"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs",
"properties": {
"budgetMilliNodeHours": {
"description": "The training budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The actual metadata.costMilliNodeHours will be equal or less than this value. If further model training ceases to provide any improvements, it will stop without using the full budget and the metadata.successfulStopReason will be `model-converged`. Note, node_hour = actual_hour * number_of_nodes_involved. 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"
},
"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"
},
"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"
},
"tunableParameter": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter",
"description": "Trainer type for Vision TrainRequest."
},
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata",
"properties": {
"costMilliNodeHours": {
"description": "The actual training cost of creating this model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.",
"format": "int64",
"type": "string"
},
"successfulStopReason": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation": {
"description": "A TrainingJob that trains and uploads an AutoML Image Segmentation Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs",
"description": "The input parameters of this TrainingJob."
},
"metadata": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata",
"description": "The metadata information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs",
"properties": {
"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"
},
"budgetMilliNodeHours": {
"description": "The training budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The actual metadata.costMilliNodeHours will be equal or less than this value. If further model training ceases to provide any improvements, it will stop without using the full budget and the metadata.successfulStopReason will be `model-converged`. Note, node_hour = actual_hour * number_of_nodes_involved. Or actual_wall_clock_hours = train_budget_milli_node_hours / (number_of_nodes_involved * 1000) For modelType `cloud-high-accuracy-1`(default), the budget must be between 20,000 and 2,000,000 milli node hours, inclusive. The default value is 192,000 which represents one day in wall time (1000 milli * 24 hours * 8 nodes).",
"format": "int64",
"type": "string"
},
"modelType": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata",
"properties": {
"costMilliNodeHours": {
"description": "The actual training cost of creating this model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.",
"format": "int64",
"type": "string"
},
"successfulStopReason": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables": {
"description": "A TrainingJob that trains and uploads an AutoML Tables Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs",
"description": "The input parameters of this TrainingJob."
},
"metadata": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata",
"description": "The metadata information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs",
"properties": {
"additionalExperiments": {
"description": "Additional experiment flags for the Tables training pipeline.",
"items": {
"type": "string"
},
"type": "array"
},
"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"
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation": {
"description": "Training pipeline will infer the proper transformation based on the statistic of dataset.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation",
"properties": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
}
},
"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": {
"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"
},
"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": {
"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"
},
"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": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
}
},
"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": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata": {
"description": "Model metadata specific to AutoML Tables.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification": {
"description": "A TrainingJob that trains and uploads an AutoML Text Classification Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs",
"description": "The input parameters of this TrainingJob."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs",
"properties": {
"multiLabel": {
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction": {
"description": "A TrainingJob that trains and uploads an AutoML Text Extraction Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs",
"description": "The input parameters of this TrainingJob."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment": {
"description": "A TrainingJob that trains and uploads an AutoML Text Sentiment Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs",
"description": "The input parameters of this TrainingJob."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs",
"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).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition": {
"description": "A TrainingJob that trains and uploads an AutoML Video Action Recognition Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs",
"description": "The input parameters of this TrainingJob."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification": {
"description": "A TrainingJob that trains and uploads an AutoML Video Classification Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs",
"description": "The input parameters of this TrainingJob."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking": {
"description": "A TrainingJob that trains and uploads an AutoML Video ObjectTracking Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs",
"description": "The input parameters of this TrainingJob."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter": {
"description": "A wrapper class which contains the tunable parameters in an AutoML Image training job.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata",
"properties": {
"backingCustomJob": {
"description": "The resource name of the CustomJob that has been created to carry out this custom task.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask": {
"description": "A TrainingJob that trains a custom code Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1CustomJobSpec",
"description": "The input parameters of this CustomTask."
},
"metadata": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata",
"description": "The metadata information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig": {
"description": "Configuration for exporting test set predictions to a BigQuery table.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig",
"properties": {
"destinationBigqueryUri": {
"description": "URI of desired destination BigQuery table. Expected format: `bq://{project_id}:{dataset_id}:{table}` If not specified, then results are exported to the following auto-created BigQuery table: `{project_id}:export_evaluated_examples_{model_name}_{yyyy_MM_dd'T'HH_mm_ss_SSS'Z'}.evaluated_examples`",
"type": "string"
},
"overrideExistingTable": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig": {
"description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig",
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask": {
"description": "A TrainingJob that tunes Hypererparameters of a custom code Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec",
"description": "The input parameters of this HyperparameterTuningTask."
},
"metadata": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata",
"description": "The metadata information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting": {
"description": "A TrainingJob that trains and uploads an AutoML Forecasting Model.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting",
"properties": {
"inputs": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs",
"description": "The input parameters of this TrainingJob."
},
"metadata": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata",
"description": "The metadata information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs",
"properties": {
"additionalExperiments": {
"description": "Additional experiment flags for the time series forcasting training.",
"items": {
"type": "string"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity": {
"description": "A duration of time expressed in time granularity units.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation",
"properties": {
"auto": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation"
},
"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"
},
"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": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
}
},
"type": "object"
},
"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"
},
"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": {
"columnName": {
"type": "string"
},
"timeFormat": {
"description": "The format in which that time field is expressed. The time_format must either be one of: * `unix-seconds` * `unix-milliseconds` * `unix-microseconds` * `unix-nanoseconds` (for respectively number of seconds, milliseconds, microseconds and nanoseconds since start of the Unix epoch); or be written in `strftime` syntax. If time_format is not set, then the default format is RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z)",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata": {
"description": "Model metadata specific to Seq2Seq Plus Forecasting.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata",
"properties": {
"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."
},
"metadata": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata",
"description": "The metadata information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs",
"properties": {
"additionalExperiments": {
"description": "Additional experiment flags for the time series forcasting training.",
"items": {
"type": "string"
},
"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"
},
"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": "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"
},
"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": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation"
},
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity": {
"description": "A duration of time expressed in time granularity units.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation": {
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation",
"properties": {
"auto": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation"
},
"categorical": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation"
},
"numeric": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation"
},
"text": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation"
},
"timestamp": {
"$ref": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation": {
"description": "Training pipeline will infer the proper transformation based on the statistic of dataset.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation",
"properties": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
}
},
"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": {
"columnName": {
"type": "string"
},
"timeFormat": {
"description": "The format in which that time field is expressed. The time_format must either be one of: * `unix-seconds` * `unix-milliseconds` * `unix-microseconds` * `unix-nanoseconds` (for respectively number of seconds, milliseconds, microseconds and nanoseconds since start of the Unix epoch); or be written in `strftime` syntax. If time_format is not set, then the default format is RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z)",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata": {
"description": "Model metadata specific to TFT Forecasting.",
"id": "GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata",
"properties": {
"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"
},
"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": {
"column": {
"description": "Name of the column that should be used to generate sliding windows. The column should contain either booleans or string booleans; if the value of the row is True, generate a sliding window with the horizon starting at that row. The column will not be used as a feature in training.",
"type": "string"
},
"maxCount": {
"description": "Maximum number of windows that should be generated across all time series.",
"format": "int64",
"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.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"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.",
"id": "GoogleCloudAiplatformV1SchemaVertex",
"properties": {
"x": {
"description": "X coordinate.",
"format": "double",
"type": "number"
},
"y": {
"description": "Y coordinate.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation": {
"description": "Annotation details specific to video action recognition.",
"id": "GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation",
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation": {
"description": "Annotation details specific to video classification.",
"id": "GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation",
"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"
},
"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"
},
"GoogleCloudAiplatformV1SchemaVideoDataItem": {
"description": "Payload of Video DataItem.",
"id": "GoogleCloudAiplatformV1SchemaVideoDataItem",
"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"
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaVideoDatasetMetadata": {
"description": "The metadata of Datasets that contain Video DataItems.",
"id": "GoogleCloudAiplatformV1SchemaVideoDatasetMetadata",
"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"
},
"gcsBucket": {
"description": "Google Cloud Storage Bucket name that contains the blob data of this Dataset.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation": {
"description": "Annotation details specific to video object tracking.",
"id": "GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation",
"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"
},
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata": {
"id": "GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata",
"properties": {
"multiLabel": {
"description": "Whether or not the classification label is multi_label.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata": {
"id": "GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1SearchDataItemsResponse": {
"description": "Response message for DatasetService.SearchDataItems.",
"id": "GoogleCloudAiplatformV1SearchDataItemsResponse",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SearchEntryPoint": {
"description": "Google search entry point.",
"id": "GoogleCloudAiplatformV1SearchEntryPoint",
"properties": {
"renderedContent": {
"description": "Optional. Web content snippet that can be embedded in a web page or an app webview.",
"type": "string"
},
"sdkBlob": {
"description": "Optional. Base64 encoded JSON representing array of tuple.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SearchFeaturesResponse": {
"description": "Response message for FeaturestoreService.SearchFeatures.",
"id": "GoogleCloudAiplatformV1SearchFeaturesResponse",
"properties": {
"features": {
"description": "The Features matching the request. Fields returned: * `name` * `description` * `labels` * `create_time` * `update_time`",
"items": {
"$ref": "GoogleCloudAiplatformV1Feature"
},
"type": "array"
},
"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"
},
"GoogleCloudAiplatformV1SearchMigratableResourcesRequest": {
"description": "Request message for MigrationService.SearchMigratableResources.",
"id": "GoogleCloudAiplatformV1SearchMigratableResourcesRequest",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1SearchMigratableResourcesResponse": {
"description": "Response message for MigrationService.SearchMigratableResources.",
"id": "GoogleCloudAiplatformV1SearchMigratableResourcesResponse",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest": {
"description": "Request message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.",
"id": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest",
"properties": {
"deployedModelId": {
"description": "Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective": {
"description": "Stats requested for specific objective.",
"id": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse": {
"description": "Response message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.",
"id": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SearchNearestEntitiesRequest": {
"description": "The request message for FeatureOnlineStoreService.SearchNearestEntities.",
"id": "GoogleCloudAiplatformV1SearchNearestEntitiesRequest",
"properties": {
"query": {
"$ref": "GoogleCloudAiplatformV1NearestNeighborQuery",
"description": "Required. The query."
},
"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"
},
"GoogleCloudAiplatformV1SearchNearestEntitiesResponse": {
"description": "Response message for FeatureOnlineStoreService.SearchNearestEntities",
"id": "GoogleCloudAiplatformV1SearchNearestEntitiesResponse",
"properties": {
"nearestNeighbors": {
"$ref": "GoogleCloudAiplatformV1NearestNeighbors",
"description": "The nearest neighbors of the query entity."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SecretEnvVar": {
"description": "Represents an environment variable where the value is a secret in Cloud Secret Manager.",
"id": "GoogleCloudAiplatformV1SecretEnvVar",
"properties": {
"name": {
"description": "Required. Name of the secret environment variable.",
"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"
},
"GoogleCloudAiplatformV1SecretRef": {
"description": "Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.",
"id": "GoogleCloudAiplatformV1SecretRef",
"properties": {
"secret": {
"description": "Required. The name of the secret in Cloud Secret Manager. Format: {secret_name}.",
"type": "string"
},
"version": {
"description": "The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1Segment": {
"description": "Segment of the content.",
"id": "GoogleCloudAiplatformV1Segment",
"properties": {
"endIndex": {
"description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"partIndex": {
"description": "Output only. The index of a Part object within its parent Content object.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"startIndex": {
"description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"text": {
"description": "Output only. The text corresponding to the segment from the response.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ServiceAccountSpec": {
"description": "Configuration for the use of custom service account to run the workloads.",
"id": "GoogleCloudAiplatformV1ServiceAccountSpec",
"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"
},
"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"
},
"GoogleCloudAiplatformV1SharePointSources": {
"description": "The SharePointSources to pass to ImportRagFiles.",
"id": "GoogleCloudAiplatformV1SharePointSources",
"properties": {
"sharePointSources": {
"description": "The SharePoint sources.",
"items": {
"$ref": "GoogleCloudAiplatformV1SharePointSourcesSharePointSource"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SharePointSourcesSharePointSource": {
"description": "An individual SharePointSource.",
"id": "GoogleCloudAiplatformV1SharePointSourcesSharePointSource",
"properties": {
"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"
},
"clientSecret": {
"$ref": "GoogleCloudAiplatformV1ApiAuthApiKeyConfig",
"description": "The application secret for the app registered in Azure."
},
"driveId": {
"description": "The ID of the drive to download from.",
"type": "string"
},
"driveName": {
"description": "The name of the drive to download from.",
"type": "string"
},
"fileId": {
"description": "Output only. The SharePoint file id. Output only.",
"readOnly": true,
"type": "string"
},
"sharepointFolderId": {
"description": "The ID of the SharePoint folder to download from.",
"type": "string"
},
"sharepointFolderPath": {
"description": "The path of the SharePoint folder to download from.",
"type": "string"
},
"sharepointSiteName": {
"description": "The name of the SharePoint site to download from. This can be the site name or the site id.",
"type": "string"
},
"tenantId": {
"description": "Unique identifier of the Azure Active Directory Instance.",
"type": "string"
}
},
"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": {
"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."
},
"channels": {
"description": "Required. The Slack channel IDs.",
"items": {
"$ref": "GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel": {
"description": "SlackChannel contains the Slack channel ID and the time range to import.",
"id": "GoogleCloudAiplatformV1SlackSourceSlackChannelsSlackChannel",
"properties": {
"channelId": {
"description": "Required. The Slack channel ID.",
"type": "string"
},
"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"
},
"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": {
"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."
},
"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"
},
"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"
},
"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": {
"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"
},
"name": {
"description": "Required. The resource name of the SpecialistPool.",
"type": "string"
},
"pendingDataLabelingJobs": {
"description": "Output only. The resource name of the pending data labeling jobs.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"specialistManagerEmails": {
"description": "The email addresses of the managers in the SpecialistPool.",
"items": {
"type": "string"
},
"type": "array"
},
"specialistManagersCount": {
"description": "Output only. The number of managers in this SpecialistPool.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"specialistWorkerEmails": {
"description": "The email addresses of workers in the SpecialistPool.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SpeculativeDecodingSpec": {
"description": "Configuration for Speculative Decoding.",
"id": "GoogleCloudAiplatformV1SpeculativeDecodingSpec",
"properties": {
"draftModelSpeculation": {
"$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation",
"description": "draft model speculation."
},
"ngramSpeculation": {
"$ref": "GoogleCloudAiplatformV1SpeculativeDecodingSpecNgramSpeculation",
"description": "N-Gram speculation."
},
"speculativeTokenCount": {
"description": "The number of speculative tokens to generate at each step.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation": {
"description": "Draft model speculation works by using the smaller model to generate candidate tokens for speculative decoding.",
"id": "GoogleCloudAiplatformV1SpeculativeDecodingSpecDraftModelSpeculation",
"properties": {
"draftModel": {
"description": "Required. The resource name of the draft model.",
"type": "string"
}
},
"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": {
"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"
},
"GoogleCloudAiplatformV1SpeechConfig": {
"description": "The speech generation config.",
"id": "GoogleCloudAiplatformV1SpeechConfig",
"properties": {
"languageCode": {
"description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.",
"type": "string"
},
"voiceConfig": {
"$ref": "GoogleCloudAiplatformV1VoiceConfig",
"description": "The configuration for the speaker to use."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata": {
"description": "Metadata information for NotebookService.StartNotebookRuntime.",
"id": "GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata",
"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"
},
"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"
},
"testFraction": {
"description": "The fraction of the input data that is to be used to evaluate the Model.",
"format": "double",
"type": "number"
},
"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"
},
"GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest": {
"description": "Request message for ReasoningEngineExecutionService.StreamQuery.",
"id": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest",
"properties": {
"classMethod": {
"description": "Optional. Class method to be used for the stream query. It is optional and defaults to \"stream_query\" if unspecified.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1StreamRawPredictRequest": {
"description": "Request message for PredictionService.StreamRawPredict.",
"id": "GoogleCloudAiplatformV1StreamRawPredictRequest",
"properties": {
"httpBody": {
"$ref": "GoogleApiHttpBody",
"description": "The prediction input. Supports HTTP headers and arbitrary data payload."
}
},
"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": {
"inputs": {
"description": "The prediction input.",
"items": {
"$ref": "GoogleCloudAiplatformV1Tensor"
},
"type": "array"
},
"parameters": {
"$ref": "GoogleCloudAiplatformV1Tensor",
"description": "The parameters that govern the prediction."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1StreamingPredictResponse": {
"description": "Response message for PredictionService.StreamingPredict.",
"id": "GoogleCloudAiplatformV1StreamingPredictResponse",
"properties": {
"outputs": {
"description": "The prediction output.",
"items": {
"$ref": "GoogleCloudAiplatformV1Tensor"
},
"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": {
"type": "string"
},
"type": "array"
},
"featureSelector": {
"$ref": "GoogleCloudAiplatformV1FeatureSelector",
"description": "Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1StringArray": {
"description": "A list of string values.",
"id": "GoogleCloudAiplatformV1StringArray",
"properties": {
"values": {
"description": "A list of string values.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1StructFieldValue": {
"description": "One field of a Struct (or object) type feature value.",
"id": "GoogleCloudAiplatformV1StructFieldValue",
"properties": {
"name": {
"description": "Name of the field in the struct feature.",
"type": "string"
},
"value": {
"$ref": "GoogleCloudAiplatformV1FeatureValue",
"description": "The value for this field."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1StructValue": {
"description": "Struct (or object) type feature value.",
"id": "GoogleCloudAiplatformV1StructValue",
"properties": {
"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"
},
"displayName": {
"description": "Required. Describes the Study, default value is empty string.",
"type": "string"
},
"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"
},
"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"
},
"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"
},
"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"
},
"convexAutomatedStoppingSpec": {
"$ref": "GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec",
"description": "The automated early stopping spec using convex stopping rule."
},
"decayCurveStoppingSpec": {
"$ref": "GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec",
"description": "The automated early stopping spec using decay curve rule."
},
"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"
},
"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"
},
"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"
},
"parameters": {
"description": "Required. The set of parameters to tune.",
"items": {
"$ref": "GoogleCloudAiplatformV1StudySpecParameterSpec"
},
"type": "array"
},
"studyStoppingConfig": {
"$ref": "GoogleCloudAiplatformV1StudySpecStudyStoppingConfig",
"description": "Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition."
}
},
"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": {
"learningRateParameterName": {
"description": "The hyper-parameter name used in the tuning job that stands for learning rate. Leave it blank if learning rate is not in a parameter in tuning. The learning_rate is used to estimate the objective value of the ongoing trial.",
"type": "string"
},
"maxStepCount": {
"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"
},
"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"
},
"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"
},
"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": {
"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"
},
"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": {
"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"
},
"GoogleCloudAiplatformV1StudySpecMetricSpec": {
"description": "Represents a metric to optimize.",
"id": "GoogleCloudAiplatformV1StudySpecMetricSpec",
"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"
},
"metricId": {
"description": "Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.",
"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"
},
"GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig": {
"description": "Used in safe optimization to specify threshold levels and risk tolerance.",
"id": "GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1StudySpecParameterSpec": {
"description": "Represents a single parameter to optimize.",
"id": "GoogleCloudAiplatformV1StudySpecParameterSpec",
"properties": {
"categoricalValueSpec": {
"$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec",
"description": "The value spec for a 'CATEGORICAL' parameter."
},
"conditionalParameterSpecs": {
"description": "A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.",
"items": {
"$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec"
},
"type": "array"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec": {
"description": "Value specification for a parameter in `CATEGORICAL` type.",
"id": "GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec",
"properties": {
"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"
},
"values": {
"description": "Required. The list of possible categories.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec": {
"description": "Represents a parameter spec with condition from its parent parameter.",
"id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec",
"properties": {
"parameterSpec": {
"$ref": "GoogleCloudAiplatformV1StudySpecParameterSpec",
"description": "Required. The spec for a conditional parameter."
},
"parentCategoricalValues": {
"$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition",
"description": "The spec for matching values from a parent parameter of `CATEGORICAL` type."
},
"parentDiscreteValues": {
"$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition",
"description": "The spec for matching values from a parent parameter of `DISCRETE` type."
},
"parentIntValues": {
"$ref": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition",
"description": "The spec for matching values from a parent parameter of `INTEGER` type."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition": {
"description": "Represents the spec to match categorical values from parent parameter.",
"id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition",
"properties": {
"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"
},
"GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition": {
"description": "Represents the spec to match discrete values from parent parameter.",
"id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition",
"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.",
"items": {
"format": "double",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition": {
"description": "Represents the spec to match integer values from parent parameter.",
"id": "GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition",
"properties": {
"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"
},
"GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec": {
"description": "Value specification for a parameter in `DISCRETE` type.",
"id": "GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec": {
"description": "Value specification for a parameter in `DOUBLE` type.",
"id": "GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec",
"properties": {
"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"
},
"maxValue": {
"description": "Required. Inclusive maximum value of the parameter.",
"format": "double",
"type": "number"
},
"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"
},
"maxValue": {
"description": "Required. Inclusive maximum value of the parameter.",
"format": "int64",
"type": "string"
},
"minValue": {
"description": "Required. Inclusive minimum value of the parameter.",
"format": "int64",
"type": "string"
}
},
"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": {
"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"
},
"maxNumTrials": {
"description": "If there are more than this many trials, stop the study.",
"format": "int32",
"type": "integer"
},
"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"
},
"GoogleCloudAiplatformV1StudyTimeConstraint": {
"description": "Time-based Constraint for Study",
"id": "GoogleCloudAiplatformV1StudyTimeConstraint",
"properties": {
"endTime": {
"description": "Compares the wallclock time to this time. Must use UTC timezone.",
"format": "google-datetime",
"type": "string"
},
"maxDuration": {
"description": "Counts the wallclock time passed since the creation of this Study.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SuggestTrialsMetadata": {
"description": "Details of operations that perform Trials suggestion.",
"id": "GoogleCloudAiplatformV1SuggestTrialsMetadata",
"properties": {
"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"
},
"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"
},
"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": {
"$ref": "GoogleCloudAiplatformV1TrialContext"
},
"type": "array"
},
"suggestionCount": {
"description": "Required. The number of suggestions requested. It must be positive.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SuggestTrialsResponse": {
"description": "Response message for VizierService.SuggestTrials.",
"id": "GoogleCloudAiplatformV1SuggestTrialsResponse",
"properties": {
"endTime": {
"description": "The time at which operation processing completed.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "The time at which the operation was started.",
"format": "google-datetime",
"type": "string"
},
"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": {
"$ref": "GoogleCloudAiplatformV1Trial"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SummarizationHelpfulnessInput": {
"description": "Input for summarization helpfulness metric.",
"id": "GoogleCloudAiplatformV1SummarizationHelpfulnessInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1SummarizationHelpfulnessInstance",
"description": "Required. Summarization helpfulness instance."
},
"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"
},
"instruction": {
"description": "Optional. Summarization prompt for LLM.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1SummarizationHelpfulnessResult": {
"description": "Spec for summarization helpfulness result.",
"id": "GoogleCloudAiplatformV1SummarizationHelpfulnessResult",
"properties": {
"confidence": {
"description": "Output only. Confidence for summarization helpfulness score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"explanation": {
"description": "Output only. Explanation for summarization helpfulness score.",
"readOnly": true,
"type": "string"
},
"score": {
"description": "Output only. Summarization Helpfulness score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SummarizationHelpfulnessSpec": {
"description": "Spec for summarization helpfulness score metric.",
"id": "GoogleCloudAiplatformV1SummarizationHelpfulnessSpec",
"properties": {
"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"
},
"GoogleCloudAiplatformV1SummarizationQualityInput": {
"description": "Input for summarization quality metric.",
"id": "GoogleCloudAiplatformV1SummarizationQualityInput",
"properties": {
"instance": {
"$ref": "GoogleCloudAiplatformV1SummarizationQualityInstance",
"description": "Required. Summarization quality instance."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1SummarizationQualitySpec",
"description": "Required. Spec for summarization quality score metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SummarizationQualityInstance": {
"description": "Spec for summarization quality instance.",
"id": "GoogleCloudAiplatformV1SummarizationQualityInstance",
"properties": {
"context": {
"description": "Required. Text to be summarized.",
"type": "string"
},
"instruction": {
"description": "Required. Summarization prompt for LLM.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1SummarizationQualityResult": {
"description": "Spec for summarization quality result.",
"id": "GoogleCloudAiplatformV1SummarizationQualityResult",
"properties": {
"confidence": {
"description": "Output only. Confidence for summarization quality score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"explanation": {
"description": "Output only. Explanation for summarization quality score.",
"readOnly": true,
"type": "string"
},
"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"
},
"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."
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1SummarizationVerbositySpec",
"description": "Required. Spec for summarization verbosity score metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SummarizationVerbosityInstance": {
"description": "Spec for summarization verbosity instance.",
"id": "GoogleCloudAiplatformV1SummarizationVerbosityInstance",
"properties": {
"context": {
"description": "Required. Text to be summarized.",
"type": "string"
},
"instruction": {
"description": "Optional. Summarization prompt for LLM.",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1SummarizationVerbosityResult": {
"description": "Spec for summarization verbosity result.",
"id": "GoogleCloudAiplatformV1SummarizationVerbosityResult",
"properties": {
"confidence": {
"description": "Output only. Confidence for summarization verbosity score.",
"format": "float",
"readOnly": true,
"type": "number"
},
"explanation": {
"description": "Output only. Explanation for summarization verbosity score.",
"readOnly": true,
"type": "string"
},
"score": {
"description": "Output only. Summarization Verbosity score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SummarizationVerbositySpec": {
"description": "Spec for summarization verbosity score metric.",
"id": "GoogleCloudAiplatformV1SummarizationVerbositySpec",
"properties": {
"useReference": {
"description": "Optional. Whether to use instance.reference to compute summarization verbosity.",
"type": "boolean"
},
"version": {
"description": "Optional. Which version to use for evaluation.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SupervisedHyperParameters": {
"description": "Hyperparameters for SFT.",
"id": "GoogleCloudAiplatformV1SupervisedHyperParameters",
"properties": {
"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"
},
"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"
},
"GoogleCloudAiplatformV1SupervisedTuningDataStats": {
"description": "Tuning data statistics for Supervised Tuning.",
"id": "GoogleCloudAiplatformV1SupervisedTuningDataStats",
"properties": {
"droppedExampleReasons": {
"description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.",
"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"
},
"totalBillableTokenCount": {
"description": "Output only. Number of billable tokens in the tuning dataset.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"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"
},
"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": {
"format": "int64",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"tuningDatasetExampleCount": {
"description": "Output only. Number of examples in the tuning dataset.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"tuningStepCount": {
"description": "Output only. Number of tuning steps for this Tuning Job.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"userDatasetExamples": {
"description": "Output only. Sample user messages in the training dataset uri.",
"items": {
"$ref": "GoogleCloudAiplatformV1Content"
},
"readOnly": true,
"type": "array"
},
"userInputTokenDistribution": {
"$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution",
"description": "Output only. Dataset distributions for the user input tokens.",
"readOnly": true
},
"userMessagePerExampleDistribution": {
"$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution",
"description": "Output only. Dataset distributions for the messages per example.",
"readOnly": true
},
"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"
},
"buckets": {
"description": "Output only. Defines the histogram bucket.",
"items": {
"$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket"
},
"readOnly": true,
"type": "array"
},
"max": {
"description": "Output only. The maximum of the population values.",
"format": "double",
"readOnly": true,
"type": "number"
},
"mean": {
"description": "Output only. The arithmetic mean of the values in the population.",
"format": "double",
"readOnly": true,
"type": "number"
},
"median": {
"description": "Output only. The median of the values in the population.",
"format": "double",
"readOnly": true,
"type": "number"
},
"min": {
"description": "Output only. The minimum of the population values.",
"format": "double",
"readOnly": true,
"type": "number"
},
"p5": {
"description": "Output only. The 5th percentile of the values in the population.",
"format": "double",
"readOnly": true,
"type": "number"
},
"p95": {
"description": "Output only. The 95th percentile of the values in the population.",
"format": "double",
"readOnly": true,
"type": "number"
},
"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"
},
"left": {
"description": "Output only. Left bound of the bucket.",
"format": "double",
"readOnly": true,
"type": "number"
},
"right": {
"description": "Output only. Right bound of the bucket.",
"format": "double",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SupervisedTuningSpec": {
"description": "Tuning Spec for Supervised Tuning for first party models.",
"id": "GoogleCloudAiplatformV1SupervisedTuningSpec",
"properties": {
"hyperParameters": {
"$ref": "GoogleCloudAiplatformV1SupervisedHyperParameters",
"description": "Optional. Hyperparameters for SFT."
},
"trainingDatasetUri": {
"description": "Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.",
"type": "string"
},
"validationDatasetUri": {
"description": "Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1SyncFeatureViewRequest": {
"description": "Request message for FeatureOnlineStoreAdminService.SyncFeatureView.",
"id": "GoogleCloudAiplatformV1SyncFeatureViewRequest",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1SyncFeatureViewResponse": {
"description": "Response message for FeatureOnlineStoreAdminService.SyncFeatureView.",
"id": "GoogleCloudAiplatformV1SyncFeatureViewResponse",
"properties": {
"featureViewSync": {
"description": "Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TFRecordDestination": {
"description": "The storage details for TFRecord output content.",
"id": "GoogleCloudAiplatformV1TFRecordDestination",
"properties": {
"gcsDestination": {
"$ref": "GoogleCloudAiplatformV1GcsDestination",
"description": "Required. Google Cloud Storage location."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1Tensor": {
"description": "A tensor value type.",
"id": "GoogleCloudAiplatformV1Tensor",
"properties": {
"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"
},
"floatVal": {
"description": "FLOAT",
"items": {
"format": "float",
"type": "number"
},
"type": "array"
},
"int64Val": {
"description": "INT64",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"intVal": {
"description": "INT_8 INT_16 INT_32",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"listVal": {
"description": "A list of tensor values.",
"items": {
"$ref": "GoogleCloudAiplatformV1Tensor"
},
"type": "array"
},
"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"
},
"uint64Val": {
"description": "UINT64",
"items": {
"format": "uint64",
"type": "string"
},
"type": "array"
},
"uintVal": {
"description": "UINT8 UINT16 UINT32",
"items": {
"format": "uint32",
"type": "integer"
},
"type": "array"
}
},
"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": {
"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"
},
"createTime": {
"description": "Output only. Timestamp when this Tensorboard was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Description of this Tensorboard.",
"type": "string"
},
"displayName": {
"description": "Required. User provided name of this Tensorboard.",
"type": "string"
},
"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."
},
"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"
},
"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"
},
"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"
},
"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"
},
"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": {
"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"
},
"description": {
"description": "Description of this TensorboardExperiment.",
"type": "string"
},
"displayName": {
"description": "User provided name of this TensorboardExperiment.",
"type": "string"
},
"etag": {
"description": "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 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"
},
"name": {
"description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
"readOnly": true,
"type": "string"
},
"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"
},
"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": {
"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"
},
"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"
},
"etag": {
"description": "Used to perform a 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 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"
},
"updateTime": {
"description": "Output only. Timestamp when this TensorboardRun was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TensorboardTensor": {
"description": "One point viewable on a tensor metric plot.",
"id": "GoogleCloudAiplatformV1TensorboardTensor",
"properties": {
"value": {
"description": "Required. Serialized form of https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto",
"format": "byte",
"type": "string"
},
"versionNumber": {
"description": "Optional. Version number of TensorProto used to serialize value.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TensorboardTimeSeries": {
"description": "TensorboardTimeSeries maps to times series produced in training runs",
"id": "GoogleCloudAiplatformV1TensorboardTimeSeries",
"properties": {
"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": {
"$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"
},
"GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata": {
"description": "Describes metadata for a TensorboardTimeSeries.",
"id": "GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata",
"properties": {
"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"
},
"maxStep": {
"description": "Output only. Max step index of all data points within a TensorboardTimeSeries.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxWallTime": {
"description": "Output only. Max wall clock timestamp of all data points within a TensorboardTimeSeries.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ThresholdConfig": {
"description": "The config for feature monitoring threshold.",
"id": "GoogleCloudAiplatformV1ThresholdConfig",
"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\u2013Shannon 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"
},
"GoogleCloudAiplatformV1TimeSeriesData": {
"description": "All the data stored in a TensorboardTimeSeries.",
"id": "GoogleCloudAiplatformV1TimeSeriesData",
"properties": {
"tensorboardTimeSeriesId": {
"description": "Required. The ID of the TensorboardTimeSeries, which will become the final component of the TensorboardTimeSeries' resource name",
"type": "string"
},
"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"
},
"GoogleCloudAiplatformV1TimeSeriesDataPoint": {
"description": "A TensorboardTimeSeries data point.",
"id": "GoogleCloudAiplatformV1TimeSeriesDataPoint",
"properties": {
"blobs": {
"$ref": "GoogleCloudAiplatformV1TensorboardBlobSequence",
"description": "A blob sequence value."
},
"scalar": {
"$ref": "GoogleCloudAiplatformV1Scalar",
"description": "A scalar value."
},
"step": {
"description": "Step index of this data point within the run.",
"format": "int64",
"type": "string"
},
"tensor": {
"$ref": "GoogleCloudAiplatformV1TensorboardTensor",
"description": "A tensor value."
},
"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"
},
"testFraction": {
"description": "The fraction of the input data that is to be used to evaluate the Model.",
"format": "double",
"type": "number"
},
"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"
},
"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"
},
"tokenIds": {
"description": "A list of token ids from the input.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"tokens": {
"description": "A list of tokens from the input.",
"items": {
"format": "byte",
"type": "string"
},
"type": "array"
}
},
"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": {
"codeExecution": {
"$ref": "GoogleCloudAiplatformV1ToolCodeExecution",
"description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation."
},
"enterpriseWebSearch": {
"$ref": "GoogleCloudAiplatformV1EnterpriseWebSearch",
"description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance."
},
"functionDeclarations": {
"description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.",
"items": {
"$ref": "GoogleCloudAiplatformV1FunctionDeclaration"
},
"type": "array"
},
"googleSearch": {
"$ref": "GoogleCloudAiplatformV1ToolGoogleSearch",
"description": "Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google."
},
"googleSearchRetrieval": {
"$ref": "GoogleCloudAiplatformV1GoogleSearchRetrieval",
"description": "Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search."
},
"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."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolCall": {
"description": "Spec for tool call.",
"id": "GoogleCloudAiplatformV1ToolCall",
"properties": {
"toolInput": {
"description": "Optional. Spec for tool input",
"type": "string"
},
"toolName": {
"description": "Required. Spec for tool name",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolCallValidInput": {
"description": "Input for tool call valid metric.",
"id": "GoogleCloudAiplatformV1ToolCallValidInput",
"properties": {
"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"
},
"GoogleCloudAiplatformV1ToolCallValidInstance": {
"description": "Spec for tool call valid instance.",
"id": "GoogleCloudAiplatformV1ToolCallValidInstance",
"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"
},
"GoogleCloudAiplatformV1ToolCallValidMetricValue": {
"description": "Tool call valid metric value for an instance.",
"id": "GoogleCloudAiplatformV1ToolCallValidMetricValue",
"properties": {
"score": {
"description": "Output only. Tool call valid score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolCallValidResults": {
"description": "Results for tool call valid metric.",
"id": "GoogleCloudAiplatformV1ToolCallValidResults",
"properties": {
"toolCallValidMetricValues": {
"description": "Output only. Tool call valid metric values.",
"items": {
"$ref": "GoogleCloudAiplatformV1ToolCallValidMetricValue"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolCallValidSpec": {
"description": "Spec for tool call valid metric.",
"id": "GoogleCloudAiplatformV1ToolCallValidSpec",
"properties": {},
"type": "object"
},
"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"
},
"GoogleCloudAiplatformV1ToolConfig": {
"description": "Tool config. This config is shared for all tools provided in the request.",
"id": "GoogleCloudAiplatformV1ToolConfig",
"properties": {
"functionCallingConfig": {
"$ref": "GoogleCloudAiplatformV1FunctionCallingConfig",
"description": "Optional. Function calling config."
},
"retrievalConfig": {
"$ref": "GoogleCloudAiplatformV1RetrievalConfig",
"description": "Optional. Retrieval config."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolGoogleSearch": {
"description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.",
"id": "GoogleCloudAiplatformV1ToolGoogleSearch",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1ToolNameMatchInput": {
"description": "Input for tool name match metric.",
"id": "GoogleCloudAiplatformV1ToolNameMatchInput",
"properties": {
"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"
},
"GoogleCloudAiplatformV1ToolNameMatchInstance": {
"description": "Spec for tool name match instance.",
"id": "GoogleCloudAiplatformV1ToolNameMatchInstance",
"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"
},
"GoogleCloudAiplatformV1ToolNameMatchMetricValue": {
"description": "Tool name match metric value for an instance.",
"id": "GoogleCloudAiplatformV1ToolNameMatchMetricValue",
"properties": {
"score": {
"description": "Output only. Tool name match score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolNameMatchResults": {
"description": "Results for tool name match metric.",
"id": "GoogleCloudAiplatformV1ToolNameMatchResults",
"properties": {
"toolNameMatchMetricValues": {
"description": "Output only. Tool name match metric values.",
"items": {
"$ref": "GoogleCloudAiplatformV1ToolNameMatchMetricValue"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolNameMatchSpec": {
"description": "Spec for tool name match metric.",
"id": "GoogleCloudAiplatformV1ToolNameMatchSpec",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1ToolParameterKVMatchInput": {
"description": "Input for tool parameter key value match metric.",
"id": "GoogleCloudAiplatformV1ToolParameterKVMatchInput",
"properties": {
"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"
},
"GoogleCloudAiplatformV1ToolParameterKVMatchInstance": {
"description": "Spec for tool parameter key value match instance.",
"id": "GoogleCloudAiplatformV1ToolParameterKVMatchInstance",
"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"
},
"GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue": {
"description": "Tool parameter key value match metric value for an instance.",
"id": "GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue",
"properties": {
"score": {
"description": "Output only. Tool parameter key value match score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolParameterKVMatchResults": {
"description": "Results for tool parameter key value match metric.",
"id": "GoogleCloudAiplatformV1ToolParameterKVMatchResults",
"properties": {
"toolParameterKvMatchMetricValues": {
"description": "Output only. Tool parameter key value match metric values.",
"items": {
"$ref": "GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolParameterKVMatchSpec": {
"description": "Spec for tool parameter key value match metric.",
"id": "GoogleCloudAiplatformV1ToolParameterKVMatchSpec",
"properties": {
"useStrictStringMatch": {
"description": "Optional. Whether to use STRICT string match on parameter values.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolParameterKeyMatchInput": {
"description": "Input for tool parameter key match metric.",
"id": "GoogleCloudAiplatformV1ToolParameterKeyMatchInput",
"properties": {
"instances": {
"description": "Required. Repeated tool parameter key match instances.",
"items": {
"$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchInstance"
},
"type": "array"
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1ToolParameterKeyMatchSpec",
"description": "Required. Spec for tool parameter key match metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolParameterKeyMatchInstance": {
"description": "Spec for tool parameter key match instance.",
"id": "GoogleCloudAiplatformV1ToolParameterKeyMatchInstance",
"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"
},
"GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue": {
"description": "Tool parameter key match metric value for an instance.",
"id": "GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue",
"properties": {
"score": {
"description": "Output only. Tool parameter key match score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1ToolParameterKeyMatchResults": {
"description": "Results for tool parameter key match metric.",
"id": "GoogleCloudAiplatformV1ToolParameterKeyMatchResults",
"properties": {
"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"
}
},
"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"
},
"displayName": {
"description": "Required. The user-defined name of this TrainingPipeline.",
"type": "string"
},
"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."
},
"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"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Output only. Only populated when the pipeline's state is `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.",
"readOnly": true
},
"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."
},
"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"
},
"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"
},
"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."
},
"name": {
"description": "Output only. Resource name of the TrainingPipeline.",
"readOnly": true,
"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`.",
"type": "string"
},
"startTime": {
"description": "Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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"
},
"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"
},
"updateTime": {
"description": "Output only. Time when the TrainingPipeline was most recently updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1Trajectory": {
"description": "Spec for trajectory.",
"id": "GoogleCloudAiplatformV1Trajectory",
"properties": {
"toolCalls": {
"description": "Required. Tool calls in the trajectory.",
"items": {
"$ref": "GoogleCloudAiplatformV1ToolCall"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput": {
"description": "Instances and metric spec for TrajectoryAnyOrderMatch metric.",
"id": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInput",
"properties": {
"instances": {
"description": "Required. Repeated TrajectoryAnyOrderMatch instance.",
"items": {
"$ref": "GoogleCloudAiplatformV1TrajectoryAnyOrderMatchInstance"
},
"type": "array"
},
"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."
},
"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"
},
"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."
},
"referenceTrajectory": {
"$ref": "GoogleCloudAiplatformV1Trajectory",
"description": "Required. Spec for reference tool call trajectory."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue": {
"description": "TrajectoryExactMatch metric value for an instance.",
"id": "GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue",
"properties": {
"score": {
"description": "Output only. TrajectoryExactMatch score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectoryExactMatchResults": {
"description": "Results for TrajectoryExactMatch metric.",
"id": "GoogleCloudAiplatformV1TrajectoryExactMatchResults",
"properties": {
"trajectoryExactMatchMetricValues": {
"description": "Output only. TrajectoryExactMatch metric values.",
"items": {
"$ref": "GoogleCloudAiplatformV1TrajectoryExactMatchMetricValue"
},
"readOnly": true,
"type": "array"
}
},
"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": {
"instances": {
"description": "Required. Repeated TrajectoryInOrderMatch instance.",
"items": {
"$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance"
},
"type": "array"
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchSpec",
"description": "Required. Spec for TrajectoryInOrderMatch metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance": {
"description": "Spec for TrajectoryInOrderMatch instance.",
"id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchInstance",
"properties": {
"predictedTrajectory": {
"$ref": "GoogleCloudAiplatformV1Trajectory",
"description": "Required. Spec for predicted tool call trajectory."
},
"referenceTrajectory": {
"$ref": "GoogleCloudAiplatformV1Trajectory",
"description": "Required. Spec for reference tool call trajectory."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue": {
"description": "TrajectoryInOrderMatch metric value for an instance.",
"id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue",
"properties": {
"score": {
"description": "Output only. TrajectoryInOrderMatch score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectoryInOrderMatchResults": {
"description": "Results for TrajectoryInOrderMatch metric.",
"id": "GoogleCloudAiplatformV1TrajectoryInOrderMatchResults",
"properties": {
"trajectoryInOrderMatchMetricValues": {
"description": "Output only. TrajectoryInOrderMatch metric values.",
"items": {
"$ref": "GoogleCloudAiplatformV1TrajectoryInOrderMatchMetricValue"
},
"readOnly": true,
"type": "array"
}
},
"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": {
"instances": {
"description": "Required. Repeated TrajectoryPrecision instance.",
"items": {
"$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionInstance"
},
"type": "array"
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionSpec",
"description": "Required. Spec for TrajectoryPrecision metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectoryPrecisionInstance": {
"description": "Spec for TrajectoryPrecision instance.",
"id": "GoogleCloudAiplatformV1TrajectoryPrecisionInstance",
"properties": {
"predictedTrajectory": {
"$ref": "GoogleCloudAiplatformV1Trajectory",
"description": "Required. Spec for predicted tool call trajectory."
},
"referenceTrajectory": {
"$ref": "GoogleCloudAiplatformV1Trajectory",
"description": "Required. Spec for reference tool call trajectory."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue": {
"description": "TrajectoryPrecision metric value for an instance.",
"id": "GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue",
"properties": {
"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": {
"$ref": "GoogleCloudAiplatformV1TrajectoryPrecisionMetricValue"
},
"readOnly": true,
"type": "array"
}
},
"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": {
"instances": {
"description": "Required. Repeated TrajectoryRecall instance.",
"items": {
"$ref": "GoogleCloudAiplatformV1TrajectoryRecallInstance"
},
"type": "array"
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1TrajectoryRecallSpec",
"description": "Required. Spec for TrajectoryRecall metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectoryRecallInstance": {
"description": "Spec for TrajectoryRecall instance.",
"id": "GoogleCloudAiplatformV1TrajectoryRecallInstance",
"properties": {
"predictedTrajectory": {
"$ref": "GoogleCloudAiplatformV1Trajectory",
"description": "Required. Spec for predicted tool call trajectory."
},
"referenceTrajectory": {
"$ref": "GoogleCloudAiplatformV1Trajectory",
"description": "Required. Spec for reference tool call trajectory."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectoryRecallMetricValue": {
"description": "TrajectoryRecall metric value for an instance.",
"id": "GoogleCloudAiplatformV1TrajectoryRecallMetricValue",
"properties": {
"score": {
"description": "Output only. TrajectoryRecall score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectoryRecallResults": {
"description": "Results for TrajectoryRecall metric.",
"id": "GoogleCloudAiplatformV1TrajectoryRecallResults",
"properties": {
"trajectoryRecallMetricValues": {
"description": "Output only. TrajectoryRecall metric values.",
"items": {
"$ref": "GoogleCloudAiplatformV1TrajectoryRecallMetricValue"
},
"readOnly": true,
"type": "array"
}
},
"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": {
"instances": {
"description": "Required. Repeated TrajectorySingleToolUse instance.",
"items": {
"$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseInstance"
},
"type": "array"
},
"metricSpec": {
"$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseSpec",
"description": "Required. Spec for TrajectorySingleToolUse metric."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectorySingleToolUseInstance": {
"description": "Spec for TrajectorySingleToolUse instance.",
"id": "GoogleCloudAiplatformV1TrajectorySingleToolUseInstance",
"properties": {
"predictedTrajectory": {
"$ref": "GoogleCloudAiplatformV1Trajectory",
"description": "Required. Spec for predicted tool call trajectory."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue": {
"description": "TrajectorySingleToolUse metric value for an instance.",
"id": "GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue",
"properties": {
"score": {
"description": "Output only. TrajectorySingleToolUse score.",
"format": "float",
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectorySingleToolUseResults": {
"description": "Results for TrajectorySingleToolUse metric.",
"id": "GoogleCloudAiplatformV1TrajectorySingleToolUseResults",
"properties": {
"trajectorySingleToolUseMetricValues": {
"description": "Output only. TrajectorySingleToolUse metric values.",
"items": {
"$ref": "GoogleCloudAiplatformV1TrajectorySingleToolUseMetricValue"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TrajectorySingleToolUseSpec": {
"description": "Spec for TrajectorySingleToolUse metric - returns 1 if tool is present in the predicted trajectory, else 0.",
"id": "GoogleCloudAiplatformV1TrajectorySingleToolUseSpec",
"properties": {
"toolName": {
"description": "Required. Spec for tool name to be checked for in the predicted trajectory.",
"type": "string"
}
},
"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": {
"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"
},
"customJob": {
"description": "Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"finalMeasurement": {
"$ref": "GoogleCloudAiplatformV1Measurement",
"description": "Output only. The final measurement containing the objective value.",
"readOnly": true
},
"id": {
"description": "Output only. The identifier of the Trial assigned by the service.",
"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"
},
"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"
},
"name": {
"description": "Output only. Resource name of the Trial assigned by the service.",
"readOnly": true,
"type": "string"
},
"parameters": {
"description": "Output only. The parameters of the Trial.",
"items": {
"$ref": "GoogleCloudAiplatformV1TrialParameter"
},
"readOnly": true,
"type": "array"
},
"startTime": {
"description": "Output only. Time when the Trial was started.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1TrialContext": {
"id": "GoogleCloudAiplatformV1TrialContext",
"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.",
"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"
},
"GoogleCloudAiplatformV1TrialParameter": {
"description": "A message representing a parameter to be tuned.",
"id": "GoogleCloudAiplatformV1TrialParameter",
"properties": {
"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"
},
"GoogleCloudAiplatformV1TunedModel": {
"description": "The Model Registry Model and Online Prediction Endpoint associated with this TuningJob.",
"id": "GoogleCloudAiplatformV1TunedModel",
"properties": {
"endpoint": {
"description": "Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.",
"readOnly": true,
"type": "string"
},
"model": {
"description": "Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TunedModelRef": {
"description": "TunedModel Reference for legacy model migration.",
"id": "GoogleCloudAiplatformV1TunedModelRef",
"properties": {
"pipelineJob": {
"description": "Support migration from tuning job list page, from bison model to gemini model.",
"type": "string"
},
"tunedModel": {
"description": "Support migration from model registry.",
"type": "string"
},
"tuningJob": {
"description": "Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TuningDataStats": {
"description": "The tuning data statistic values for TuningJob.",
"id": "GoogleCloudAiplatformV1TuningDataStats",
"properties": {
"supervisedTuningDataStats": {
"$ref": "GoogleCloudAiplatformV1SupervisedTuningDataStats",
"description": "The SFT Tuning data stats."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1TuningJob": {
"description": "Represents a TuningJob that runs with Google owned models.",
"id": "GoogleCloudAiplatformV1TuningJob",
"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"
},
"createTime": {
"description": "Output only. Time when the TuningJob was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. The description of the TuningJob.",
"type": "string"
},
"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."
},
"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"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.",
"readOnly": true
},
"experiment": {
"description": "Output only. The Experiment associated with this TuningJob.",
"readOnly": true,
"type": "string"
},
"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"
},
"name": {
"description": "Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`",
"readOnly": true,
"type": "string"
},
"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"
},
"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"
},
"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"
},
"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.",
"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"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UndeployIndexOperationMetadata": {
"description": "Runtime operation information for IndexEndpointService.UndeployIndex.",
"id": "GoogleCloudAiplatformV1UndeployIndexOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The operation generic information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UndeployIndexRequest": {
"description": "Request message for IndexEndpointService.UndeployIndex.",
"id": "GoogleCloudAiplatformV1UndeployIndexRequest",
"properties": {
"deployedIndexId": {
"description": "Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.",
"type": "string"
}
},
"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": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The operation generic information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UndeployModelRequest": {
"description": "Request message for EndpointService.UndeployModel.",
"id": "GoogleCloudAiplatformV1UndeployModelRequest",
"properties": {
"deployedModelId": {
"description": "Required. The ID of the DeployedModel to be undeployed from the Endpoint.",
"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"
},
"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": {
"artifactUri": {
"description": "The path to the directory containing the Model artifact and any of its supporting files.",
"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"
},
"GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata": {
"description": "Runtime operation information for UpdateDeploymentResourcePool method.",
"id": "GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The operation generic information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest": {
"description": "Request message for EndpointService.UpdateEndpointLongRunning.",
"id": "GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest",
"properties": {
"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"
},
"GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata": {
"description": "Runtime operation information for ModelService.UpdateExplanationDataset.",
"id": "GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The common part of the operation metadata."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UpdateExplanationDatasetRequest": {
"description": "Request message for ModelService.UpdateExplanationDataset.",
"id": "GoogleCloudAiplatformV1UpdateExplanationDatasetRequest",
"properties": {
"examples": {
"$ref": "GoogleCloudAiplatformV1Examples",
"description": "The example config containing the location of the dataset."
}
},
"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": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for FeatureGroup."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata": {
"description": "Details of operations that perform update FeatureOnlineStore.",
"id": "GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for FeatureOnlineStore."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UpdateFeatureOperationMetadata": {
"description": "Details of operations that perform update Feature.",
"id": "GoogleCloudAiplatformV1UpdateFeatureOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for Feature Update."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata": {
"description": "Details of operations that perform update FeatureView.",
"id": "GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for FeatureView Update."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata": {
"description": "Details of operations that perform update Featurestore.",
"id": "GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for Featurestore."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UpdateIndexOperationMetadata": {
"description": "Runtime operation information for IndexService.UpdateIndex.",
"id": "GoogleCloudAiplatformV1UpdateIndexOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The operation generic information."
},
"nearestNeighborSearchOperationMetadata": {
"$ref": "GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata",
"description": "The operation metadata with regard to Matching Engine Index operation."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata": {
"description": "Runtime operation information for JobService.UpdateModelDeploymentMonitoringJob.",
"id": "GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The operation generic information."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata": {
"description": "Details of operations that perform update PersistentResource.",
"id": "GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for PersistentResource."
},
"progressMessage": {
"description": "Progress Message for Update LRO",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata": {
"description": "Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool.",
"id": "GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata",
"properties": {
"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"
},
"GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata": {
"description": "Details of operations that perform update Tensorboard.",
"id": "GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "Operation metadata for Tensorboard."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata": {
"description": "Metadata information for NotebookService.UpgradeNotebookRuntime.",
"id": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata",
"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"
},
"GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest": {
"description": "Request message for NotebookService.UpgradeNotebookRuntime.",
"id": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1UploadModelOperationMetadata": {
"description": "Details of ModelService.UploadModel operation.",
"id": "GoogleCloudAiplatformV1UploadModelOperationMetadata",
"properties": {
"genericMetadata": {
"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata",
"description": "The common part of the operation metadata."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UploadModelRequest": {
"description": "Request message for ModelService.UploadModel.",
"id": "GoogleCloudAiplatformV1UploadModelRequest",
"properties": {
"model": {
"$ref": "GoogleCloudAiplatformV1Model",
"description": "Required. The Model to create."
},
"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"
},
"parentModel": {
"description": "Optional. The resource name of the model into which to upload the version. Only specify this field when uploading a new version.",
"type": "string"
},
"serviceAccount": {
"description": "Optional. The user-provided custom service account to use to do the model upload. If empty, [Vertex AI Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used to access resources needed to upload the model. This account must belong to the target project where the model is uploaded to, i.e., the project specified in the `parent` field of this request and have necessary read permissions (to Google Cloud Storage, Artifact Registry, etc.).",
"type": "string"
}
},
"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"
},
"modelVersionId": {
"description": "Output only. The version ID of the model that is uploaded.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UploadRagFileConfig": {
"description": "Config for uploading RagFile.",
"id": "GoogleCloudAiplatformV1UploadRagFileConfig",
"properties": {
"ragFileTransformationConfig": {
"$ref": "GoogleCloudAiplatformV1RagFileTransformationConfig",
"description": "Specifies the transformation config for RagFiles."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1UploadRagFileRequest": {
"description": "Request message for VertexRagDataService.UploadRagFile.",
"id": "GoogleCloudAiplatformV1UploadRagFileRequest",
"properties": {
"ragFile": {
"$ref": "GoogleCloudAiplatformV1RagFile",
"description": "Required. The RagFile to upload."
},
"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."
},
"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"
},
"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"
},
"GoogleCloudAiplatformV1UpsertDatapointsResponse": {
"description": "Response message for IndexService.UpsertDatapoints",
"id": "GoogleCloudAiplatformV1UpsertDatapointsResponse",
"properties": {},
"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": {
"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"
},
"method": {
"description": "The method name of the API RPC call. For example, \"/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset\"",
"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"
},
"intValue": {
"description": "An integer value.",
"format": "int64",
"type": "string"
},
"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": {
"datastore": {
"description": "Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`",
"type": "string"
},
"engine": {
"description": "Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1VertexAiSearchConfig": {
"description": "Config for the Vertex AI Search.",
"id": "GoogleCloudAiplatformV1VertexAiSearchConfig",
"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"
}
},
"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"
},
"ragRetrievalConfig": {
"$ref": "GoogleCloudAiplatformV1RagRetrievalConfig",
"description": "Optional. The retrieval config for the Rag query."
},
"similarityTopK": {
"deprecated": true,
"description": "Optional. Number of top k results to return from the selected corpora.",
"format": "int32",
"type": "integer"
},
"vectorDistanceThreshold": {
"deprecated": true,
"description": "Optional. Only return results with vector distance smaller than the threshold.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1VertexRagStoreRagResource": {
"description": "The definition of the Rag resource.",
"id": "GoogleCloudAiplatformV1VertexRagStoreRagResource",
"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"
},
"GoogleCloudAiplatformV1VideoMetadata": {
"description": "Metadata describes the input video content.",
"id": "GoogleCloudAiplatformV1VideoMetadata",
"properties": {
"endOffset": {
"description": "Optional. The end offset of the video.",
"format": "google-duration",
"type": "string"
},
"startOffset": {
"description": "Optional. The start offset of the video.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1VoiceConfig": {
"description": "The configuration for the voice to use.",
"id": "GoogleCloudAiplatformV1VoiceConfig",
"properties": {
"prebuiltVoiceConfig": {
"$ref": "GoogleCloudAiplatformV1PrebuiltVoiceConfig",
"description": "The configuration for the prebuilt voice to use."
}
},
"type": "object"
},
"GoogleCloudAiplatformV1WorkerPoolSpec": {
"description": "Represents the spec of a worker pool in a job.",
"id": "GoogleCloudAiplatformV1WorkerPoolSpec",
"properties": {
"containerSpec": {
"$ref": "GoogleCloudAiplatformV1ContainerSpec",
"description": "The custom container task."
},
"diskSpec": {
"$ref": "GoogleCloudAiplatformV1DiskSpec",
"description": "Disk spec."
},
"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"
},
"GoogleCloudAiplatformV1WriteFeatureValuesPayload": {
"description": "Contains Feature values to be written for a specific entity.",
"id": "GoogleCloudAiplatformV1WriteFeatureValuesPayload",
"properties": {
"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"
},
"GoogleCloudAiplatformV1WriteFeatureValuesRequest": {
"description": "Request message for FeaturestoreOnlineServingService.WriteFeatureValues.",
"id": "GoogleCloudAiplatformV1WriteFeatureValuesRequest",
"properties": {
"payloads": {
"description": "Required. The entities to be written. Up to 100,000 feature values can be written across all `payloads`.",
"items": {
"$ref": "GoogleCloudAiplatformV1WriteFeatureValuesPayload"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAiplatformV1WriteFeatureValuesResponse": {
"description": "Response message for FeaturestoreOnlineServingService.WriteFeatureValues.",
"id": "GoogleCloudAiplatformV1WriteFeatureValuesResponse",
"properties": {},
"type": "object"
},
"GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest": {
"description": "Request message for TensorboardService.WriteTensorboardExperimentData.",
"id": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest",
"properties": {
"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"
},
"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"
},
"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": {
"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"
},
"GoogleCloudLocationListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "GoogleCloudLocationListLocationsResponse",
"properties": {
"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"
},
"GoogleCloudLocationLocation": {
"description": "A resource that represents a Google Cloud location.",
"id": "GoogleCloudLocationLocation",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"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"
},
"GoogleIamV1Binding": {
"description": "Associates `members`, or principals, with a `role`.",
"id": "GoogleIamV1Binding",
"properties": {
"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"
},
"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": {
"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"
},
"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"
},
"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"
},
"GoogleIamV1SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"id": "GoogleIamV1SetIamPolicyRequest",
"properties": {
"policy": {
"$ref": "GoogleIamV1Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
}
},
"type": "object"
},
"GoogleIamV1TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"id": "GoogleIamV1TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleLongrunningListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "GoogleLongrunningListOperationsResponse",
"properties": {
"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"
}
},
"type": "object"
},
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "GoogleLongrunningOperation",
"properties": {
"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"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
},
"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"
},
"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"
},
"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": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"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"
},
"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\u2014for 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": {
"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"
},
"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"
},
"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": {
"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"
},
"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"
},
"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": {
"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"
},
"expression": {
"description": "Textual representation of an expression in Common Expression Language syntax.",
"type": "string"
},
"location": {
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"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"
}
},
"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": {
"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"
},
"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"
},
"longitude": {
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleTypeMoney": {
"description": "Represents an amount of money with its currency type.",
"id": "GoogleTypeMoney",
"properties": {
"currencyCode": {
"description": "The three-letter currency code defined in ISO 4217.",
"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"
},
"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"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Vertex AI API",
"version": "v1",
"version_module": true
}