diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 2d41f35075..26748fc21d 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -20,14 +20,14 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { - "description": "Locational Endpoint", "location": "asia-east1", + "description": "Locational Endpoint", "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/" }, { "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", - "location": "asia-east2", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-east2" }, { "description": "Locational Endpoint", @@ -35,19 +35,19 @@ "location": "asia-northeast1" }, { - "description": "Locational Endpoint", + "location": "asia-northeast2", "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", - "location": "asia-northeast2" + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", - "location": "asia-northeast3" + "location": "asia-northeast3", + "description": "Locational Endpoint" }, { "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", - "location": "asia-south1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-south1" }, { "location": "asia-southeast1", @@ -65,9 +65,9 @@ "location": "australia-southeast1" }, { + "description": "Locational Endpoint", "location": "australia-southeast2", - "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/" }, { "location": "europe-central2", @@ -75,14 +75,14 @@ "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "location": "europe-north1", - "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { + "location": "europe-southwest1", "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "europe-southwest1" + "description": "Locational Endpoint" }, { "location": "europe-west1", @@ -91,58 +91,58 @@ }, { "description": "Locational Endpoint", - "location": "europe-west2", - "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", + "location": "europe-west2" }, { + "description": "Locational Endpoint", "location": "europe-west3", - "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", "location": "europe-west4", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", "location": "europe-west6", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "europe-west8" }, { - "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", "location": "europe-west9", + "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { - "location": "me-west1", "description": "Locational Endpoint", - "endpointUrl": "https://me-west1-aiplatform.googleapis.com/" + "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", + "location": "me-west1" }, { - "description": "Locational Endpoint", "location": "northamerica-northeast1", + "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" }, { - "location": "northamerica-northeast2", "description": "Locational Endpoint", - "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/" + "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", + "location": "northamerica-northeast2" }, { - "description": "Locational Endpoint", "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", - "location": "southamerica-east1" + "location": "southamerica-east1", + "description": "Locational Endpoint" }, { "description": "Locational Endpoint", - "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", - "location": "southamerica-west1" + "location": "southamerica-west1", + "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/" }, { "location": "us-central1", @@ -150,29 +150,29 @@ "endpointUrl": "https://us-central1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "us-central2", - "description": "Locational Endpoint" + "endpointUrl": "https://us-central2-aiplatform.googleapis.com/" }, { + "location": "us-east1", "description": "Locational Endpoint", - "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", - "location": "us-east1" + "endpointUrl": "https://us-east1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "us-east4" + "location": "us-east4", + "endpointUrl": "https://us-east4-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", "location": "us-south1", + "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", + "location": "us-west1", "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", - "location": "us-west1" + "description": "Locational Endpoint" }, { "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", @@ -180,14 +180,14 @@ "location": "us-west2" }, { - "description": "Locational Endpoint", + "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", "location": "us-west3", - "endpointUrl": "https://us-west3-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", - "location": "us-west4" + "location": "us-west4", + "description": "Locational Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -3405,6 +3405,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "streamRawPredict": { + "description": "", + "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" + ] + }, "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", @@ -4212,7 +4240,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}'`", + "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -7871,6 +7899,159 @@ "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": { @@ -8190,6 +8371,159 @@ "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": { @@ -8448,6 +8782,159 @@ "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": { @@ -8552,6 +9039,157 @@ ] } } + }, + "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" + ] + } + } } } }, @@ -10884,6 +11522,11 @@ "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" + }, + "preflightValidations": { + "description": "Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+parent}/pipelineJobs", @@ -11325,6 +11968,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "streamRawPredict": { + "description": "", + "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" + ] } } } @@ -14722,7 +15393,7 @@ } } }, - "revision": "20231218", + "revision": "20240125", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -15123,6 +15794,10 @@ ], "type": "string" }, + "groundingMetadata": { + "$ref": "LearningGenaiRootGroundingMetadata", + "description": "Grounding metadata. Combine with the facts list from response to generate grounding citations for this choice." + }, "index": { "description": "Index of the candidate.", "format": "int32", @@ -15203,6 +15878,29 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServiceFact": { + "description": "A condense version of WorldFact (assistant/boq/lamda/factuality/proto/factuality.proto) to propagate the essential information about the fact used in factuality to the upstream caller.", + "id": "CloudAiNlLlmProtoServiceFact", + "properties": { + "query": { + "description": "Query that is used to retrieve this fact.", + "type": "string" + }, + "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" + }, + "url": { + "description": "If present, this URL links to the webpage of the fact.", + "type": "string" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServiceFunctionCall": { "description": "Function call details.", "id": "CloudAiNlLlmProtoServiceFunctionCall", @@ -15251,6 +15949,17 @@ }, "type": "array" }, + "debugMetadata": { + "$ref": "CloudAiNlLlmProtoServiceMessageMetadata", + "description": "Debug information containing message metadata. Clients should not consume this field, and this is only populated for Flow Runner path." + }, + "facts": { + "description": "External facts retrieved for factuality/grounding.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceFact" + }, + "type": "array" + }, "promptFeedback": { "$ref": "CloudAiNlLlmProtoServicePromptFeedback", "description": "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." @@ -15266,6 +15975,27 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServiceMessageMetadata": { + "id": "CloudAiNlLlmProtoServiceMessageMetadata", + "properties": { + "inputFilterInfo": { + "$ref": "LearningServingLlmMessageMetadata", + "description": "Filter metadata of the input messages." + }, + "modelRoutingDecision": { + "$ref": "LearningGenaiRootRoutingDecision", + "description": "This score is generated by the router model to decide which model to use" + }, + "outputFilterInfo": { + "description": "Filter metadata of the output messages.", + "items": { + "$ref": "LearningServingLlmMessageMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServicePart": { "description": "A single part of a message.", "id": "CloudAiNlLlmProtoServicePart", @@ -15341,6 +16071,10 @@ "format": "google-duration", "type": "string" }, + "modelLevelMetaData": { + "$ref": "CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata", + "description": "Internal only model level metadata." + }, "startOffset": { "description": "The start offset of the video.", "format": "google-duration", @@ -15349,6 +16083,23 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata": { + "description": "Internal only fields", + "id": "CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata", + "properties": { + "fps": { + "description": "Frame rate to decode from this video.", + "format": "float", + "type": "number" + }, + "numFrames": { + "description": "Number of frames to decode from this video.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServicePromptFeedback": { "description": "Content filter results for a prompt sent in the request.", "id": "CloudAiNlLlmProtoServicePromptFeedback", @@ -15381,6 +16132,171 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServiceRaiResult": { + "description": "The RAI results for a given text.", + "id": "CloudAiNlLlmProtoServiceRaiResult", + "properties": { + "aidaRecitationResult": { + "$ref": "LanguageLabsAidaTrustRecitationProtoRecitationResult", + "description": "Recitation result from Aida recitation checker." + }, + "blocked": { + "deprecated": true, + "description": "Use `triggered_blocklist`.", + "type": "boolean" + }, + "errorCodes": { + "description": "The error codes indicate which RAI filters block the response.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "filtered": { + "description": "Whether the text should be filtered and not shown to the end user. This is determined based on a combination of `triggered_recitation`, `triggered_blocklist`, `language_filter_result`, and `triggered_safety_filter`.", + "type": "boolean" + }, + "languageFilterResult": { + "$ref": "LearningGenaiRootLanguageFilterResult", + "description": "Language filter result from SAFT LangId." + }, + "raiSignals": { + "description": "The RAI signals for the text.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceRaiSignal" + }, + "type": "array" + }, + "triggeredBlocklist": { + "description": "Whether the text triggered the blocklist.", + "type": "boolean" + }, + "triggeredRecitation": { + "description": "Whether the text should be blocked by the recitation result from Aida recitation checker. It is determined from aida_recitation_result.", + "type": "boolean" + }, + "triggeredSafetyFilter": { + "description": "Whether the text triggered the safety filter. Currently, this is due to CSAI triggering or one of four categories (derogatory, sexual, toxic, violent) having a score over the filter threshold.", + "type": "boolean" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceRaiSignal": { + "description": "An RAI signal for a single category.", + "id": "CloudAiNlLlmProtoServiceRaiSignal", + "properties": { + "confidence": { + "description": "The confidence level for the RAI category.", + "enum": [ + "CONFIDENCE_UNSPECIFIED", + "CONFIDENCE_NONE", + "CONFIDENCE_LOW", + "CONFIDENCE_MEDIUM", + "CONFIDENCE_HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "flagged": { + "description": "Whether the category is flagged as being present. Currently, this is set to true if score >= 0.5.", + "type": "boolean" + }, + "raiCategory": { + "description": "The RAI category.", + "enum": [ + "RAI_CATEGORY_UNSPECIFIED", + "TOXIC", + "SEXUALLY_EXPLICIT", + "HATE_SPEECH", + "VIOLENT", + "PROFANITY", + "HARASSMENT", + "DEATH_HARM_TRAGEDY", + "FIREARMS_WEAPONS", + "PUBLIC_SAFETY", + "HEALTH", + "RELIGIOUS_BELIEF", + "ILLICIT_DRUGS", + "WAR_CONFLICT", + "POLITICS", + "FINANCE", + "LEGAL", + "CSAI", + "FRINGE", + "THREAT", + "SEVERE_TOXICITY", + "TOXICITY", + "SEXUAL", + "INSULT", + "DEROGATORY", + "IDENTITY_ATTACK", + "VIOLENCE_ABUSE", + "OBSCENE", + "DRUGS", + "CSAM", + "SPII", + "DANGEROUS_CONTENT", + "DANGEROUS_CONTENT_SEVERITY", + "INSULT_SEVERITY", + "DEROGATORY_SEVERITY", + "SEXUAL_SEVERITY" + ], + "enumDescriptions": [ + "", + "SafetyCat categories.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "GRAIL categories that can't be exposed to end users.", + "", + "Unused categories.", + "", + "Old category names.", + "", + "", + "", + "", + "", + "", + "", + "CSAM V2", + "SPII", + "New SafetyCat v3 categories", + "", + "", + "", + "" + ], + "type": "string" + }, + "score": { + "description": "The score for the category, in the range [0.0, 1.0].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServiceSafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "CloudAiNlLlmProtoServiceSafetyRating", @@ -17217,6 +18133,10 @@ "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" + }, + "preflightValidations": { + "description": "Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines.", + "type": "boolean" } }, "type": "object" @@ -18939,7 +19859,7 @@ "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. 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.", + "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" }, @@ -20710,11 +21630,6 @@ }, "type": "array" }, - "endpoint": { - "deprecated": true, - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "type": "string" - }, "generationConfig": { "$ref": "GoogleCloudAiplatformV1GenerationConfig", "description": "Optional. Generation config." @@ -21511,6 +22426,14 @@ "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, @@ -23025,7 +23948,7 @@ }, "modelSourceInfo": { "$ref": "GoogleCloudAiplatformV1ModelSourceInfo", - "description": "Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model.", + "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": { @@ -24495,7 +25418,12 @@ "INVALID_AVRO_SYNTAX", "INVALID_EMBEDDING_ID", "EMBEDDING_SIZE_MISMATCH", - "NAMESPACE_MISSING" + "NAMESPACE_MISSING", + "PARSING_ERROR", + "DUPLICATE_NAMESPACE", + "OP_IN_DATAPOINT", + "MULTIPLE_VALUES", + "INVALID_NUMERIC_VALUE" ], "enumDescriptions": [ "Default, shall not be used.", @@ -24505,7 +25433,12 @@ "Invalid avro format.", "The embedding id is not valid.", "The size of the embedding vectors does not match with the specified dimension.", - "The `namespace` field is missing." + "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." ], "type": "string" }, @@ -25108,6 +26041,10 @@ "description": "The runtime config of a PipelineJob.", "id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfig", "properties": { + "defaultRuntime": { + "$ref": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigDefaultRuntime", + "description": "Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview" + }, "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": [ @@ -25151,6 +26088,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PipelineJobRuntimeConfigDefaultRuntime": { + "description": "The default runtime for the PipelineJob.", + "id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigDefaultRuntime", + "properties": { + "persistentResourceRuntimeDetail": { + "$ref": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail", + "description": "Persistent resource based runtime detail." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact": { "description": "The type of an input artifact.", "id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact", @@ -25162,6 +26110,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail": { + "description": "Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview", + "id": "GoogleCloudAiplatformV1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail", + "properties": { + "persistentResourceName": { + "description": "Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PipelineTaskDetail": { "description": "The runtime detail of a task execution.", "id": "GoogleCloudAiplatformV1PipelineTaskDetail", @@ -25648,6 +26607,25 @@ }, "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", @@ -25757,6 +26735,10 @@ "$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." @@ -25769,6 +26751,10 @@ "$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." @@ -25827,6 +26813,34 @@ }, "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", @@ -25838,8 +26852,20 @@ "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. The title of the regional resource reference.", + "description": "Required. ", "type": "string" } }, @@ -25883,6 +26909,7 @@ "id": "GoogleCloudAiplatformV1PublisherModelResourceReference", "properties": { "description": { + "deprecated": true, "description": "Description of the resource.", "type": "string" }, @@ -25895,6 +26922,7 @@ "type": "string" }, "useCase": { + "deprecated": true, "description": "Use case (CUJ) of the resource.", "type": "string" } @@ -27930,7 +28958,7 @@ "type": "string" }, "inlineContext": { - "description": "The grounding text passed inline with the Predict API. It can support up to 1 million token context.", + "description": "The grounding text passed inline with the Predict API. It can support up to 1 million bytes.", "type": "string" }, "type": { @@ -30832,6 +31860,17 @@ }, "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", @@ -32893,7 +33932,7 @@ "type": "array" }, "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "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" } }, @@ -33207,6 +34246,4239 @@ } }, "type": "object" + }, + "LanguageLabsAidaTrustRecitationProtoDocAttribution": { + "description": "The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30", + "id": "LanguageLabsAidaTrustRecitationProtoDocAttribution", + "properties": { + "amarnaId": { + "type": "string" + }, + "arxivId": { + "type": "string" + }, + "author": { + "type": "string" + }, + "bibkey": { + "type": "string" + }, + "biorxivId": { + "description": "ID of the paper in bioarxiv like ddoi.org/{biorxiv_id} eg: https://doi.org/10.1101/343517", + "type": "string" + }, + "bookTitle": { + "type": "string" + }, + "bookVolumeId": { + "description": "The Oceanographers full-view books dataset uses a 'volume id' as the unique ID of a book. There is a deterministic function from a volume id to a URL under the books.google.com domain. Marked as 'optional' since a volume ID of zero is potentially possible and we want to distinguish that from the volume ID not being set.", + "format": "int64", + "type": "string" + }, + "category": { + "enum": [ + "CATEGORY_UNSPECIFIED", + "CATEGORY_NEWS", + "CATEGORY_NON_NEWS_WEBDOC", + "CATEGORY_UNKNOWN_MISSING_SIGNAL" + ], + "enumDescriptions": [ + "", + "The doc has a url and the news classifier has classified this doc as news.", + "The doc has a url and the news classifier classified this doc as non-news.", + "The doc has a url but the url was missing from the news classifier URL table." + ], + "type": "string" + }, + "conversationId": { + "type": "string" + }, + "dataset": { + "description": "The dataset this document comes from.", + "enum": [ + "DATASET_UNSPECIFIED", + "WIKIPEDIA", + "WEBDOCS", + "WEBDOCS_FINETUNE", + "GITHUB_MIRROR", + "BOOKS_FULL_VIEW", + "BOOKS_PRIVATE", + "GNEWS", + "ULM_DOCJOINS", + "ULM_DOCJOINS_DEDUPED", + "MEENA_FC", + "PODCAST", + "AQUA", + "WEB_ASR", + "BARD_GOLDEN", + "COMMON_SENSE_REASONING", + "MATH", + "MATH_REASONING", + "CLEAN_ARXIV", + "LAMDA_FACTUALITY_E2E_QUERY_GENERATION", + "LAMDA_FACTUALITY_E2E_RESPONSE_GENERATION", + "MASSIVE_FORUM_THREAD_SCORED_BARD", + "MASSIVE_FORUM_THREAD_SCORED_LONG_200", + "MASSIVE_FORUM_THREAD_SCORED_LONG_500", + "DOCUMENT_CHUNKS", + "MEENA_RESEARCH_PHASE_GOLDEN_MARKDOWN", + "MEENA_RESEARCH_PHASE_GOOGLERS", + "MEENA_RESPONSE_SAFETY_HUMAN_GEN", + "MEENA_RESPONSE_SAFETY_SCHEMA_NO_BROADCAST", + "MEENA_RESPONSE_SAFETY_V3_HUMAN_GEN2", + "MEENA_RESPONSE_SAFETY_V3_SCHEMA_NO_BROADCAST", + "LAMDA_FACTUALITY_TRIGGER", + "LAMDA_SAFETY_V2_SCHEMA_NO_BROADCAST", + "LAMDA_SSI_DISCRIMINATIVE", + "ASSISTANT_PERSONALITY_SAFETY", + "PODCAST_FINETUNE_DIALOG", + "WORLD_QUERY_GENERATOR", + "C4_JOINED_DOCJOINS", + "HOL4_THEORIES", + "HOL_LIGHT_THEORIES", + "HOLSTEPS", + "ISABELLE_STEP", + "ISABELLE_THEORIES", + "LEAN_MATHLIB_THEORIES", + "LEAN_STEP", + "MIZAR_THEORIES", + "COQ_STEP", + "COQ_THEORIES", + "AMPS_KHAN", + "AMPS_MATHEMATICA", + "CODEY_CODE", + "CODE_QA_SE", + "CODE_QA_SO", + "CODE_QA_FT_FORMAT", + "CODE_QA_FT_KNOWLEDGE", + "CODE_QA_GITHUB_FILTERED_CODE", + "BARD_PERSONALITY_GOLDEN", + "ULM_DOCJOINS_WITH_URLS_EN", + "ULM_DOCJOINS_WITH_URLS_I18N", + "GOODALL_MTV5_GITHUB", + "GOODALL_MTV5_BOOKS", + "GOODALL_MTV5_C4", + "GOODALL_MTV5_WIKIPEDIA", + "GOODALL_MW_TOP_100B", + "GOODALL_MW_STACK_EXCHANGE", + "GOODALL_MW_TOP_0_10B", + "GOODALL_MW_TOP_10B_20B", + "CODEY_NOTEBOOK_LM_PRETRAINING", + "VERTEX_SAFE_FLAN", + "GITHUB_MIRROR_V1_0_1", + "GITHUB_MIRROR_V2_1_0", + "CMS_WIKIPEDIA_LANG_FILTERED", + "CMS_STACKOVERFLOW_MULTILINGUAL", + "CMS_STACKEXCHANGE", + "PUBMED", + "GEMINI_DOCJOINS_EN_TOP10B_GCC", + "GEMINI_DOCJOINS_EN_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_EN_TOP20B_TOP100B_GCC", + "GEMINI_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_I18N_TOP20B_TOP100B_GCC", + "SIMPLIFIED_HTML_V1_GCC", + "GEMINI_DOCJOINS_TOXICITY_TAGGED_GCC", + "CMS_GITHUB_V4", + "GITHUB_HTML_V4", + "GITHUB_OTHER_V4", + "GITHUB_LONG_TAIL_V4", + "CMS_GITHUB_MULTIFILE_V4", + "GITHUB_DIFFS_WITH_COMMIT_MESSAGE", + "ULM_ARXIV", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_ENONLY", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_NONENONLY", + "QUORA", + "PODCASTS_ROBOTSTXT", + "COMBINED_REDDIT", + "CANARIES_SHUFFLED", + "CLM_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "TECHDOCS_DATA_SOURCE", + "SCIENCE_PDF_70M_DOCS_FILTERED", + "GEMINI_V1_CMS_WIKIPEDIA_LANG_FILTERED", + "GEMINI_V1_WIKIPEDIA_DIFFS", + "GEMINI_V1_DOCJOINS_EN_TOP10B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP10B_TOP20B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP20B_TOP100B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_TOP20B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP20B_TOP100B_GCC_050523", + "GEMINI_V1_SIMPLIFIED_HTML_V2_GCC", + "GEMINI_V1_CMS_STACKOVERFLOW_MULTILINGUAL_V2", + "GEMINI_V1_CMS_STACKEXCHANGE_DECONT", + "GEMINI_V1_QUORA", + "GEMINI_V1_COMBINED_REDDIT", + "GEMINI_V1_DOCJOIN_100B_EN_TOXICITY_TAGGED_GCC_FIXED_TAGS", + "GEMINI_V1_PUBMED", + "GEMINI_V1_WEB_MATH_V2", + "GEMINI_V1_CMS_GITHUB_DECONTAMINATED_V_7", + "GEMINI_V1_GITHUB_DIFF_WITH_COMMIT_MESSAGE_V2", + "GEMINI_V1_GITHUB_HTML_CSS_XML_V4", + "GEMINI_V1_GITHUB_OTHER_V4", + "GEMINI_V1_GITHUB_LONG_TAIL_V4", + "GEMINI_V1_GITHUB_JUPTYER_NOTEBOOKS_SSTABLE", + "GEMINI_V1_ULM_ARXIV_SSTABLE", + "GEMINI_V1_PODCASTS_ROBOTSTXT", + "GEMINI_V1_SCIENCE_PDF_68M_HQ_DOCS_GCC", + "GEMINI_V1_GITHUB_TECHDOCS_V2", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_EN", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_NONEN", + "GEMINI_V1_STEM_BOOKS_650K_TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_M3W_V2_FILTERED", + "GEMINI_V1_VQCOCA_1B_MULTIRES_WEBLI_EN_V4_350M_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_SCREENAI_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CULTURE_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_EN_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_I18N_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_NON_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_VTP_4F_VIDEO2TEXT_PREFIX", + "GEMINI_V1_FORMAL_MATH_WITHOUT_HOLSTEPS_AND_MIZAR", + "GEMINI_V1_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "GEMINI_V1_CANARIES_SHUFFLED_DOCJOIN_EN_NONEN_CODE_ARXIV_TRANSLATE", + "DUET_CLOUD_SECURITY_DOCS", + "DUET_GITHUB_CODE_SNIPPETS", + "DUET_GITHUB_FILES", + "DUET_GOBYEXAMPLE", + "DUET_GOLANG_DOCS", + "DUET_CLOUD_DOCS_TROUBLESHOOTING_TABLES", + "DUET_DEVSITE_DOCS", + "DUET_CLOUD_BLOG_POSTS", + "DUET_CLOUD_PODCAST_EPISODES", + "DUET_YOUTUBE_VIDEOS", + "DUET_CLOUD_SKILLS_BOOST", + "DUET_CLOUD_DOCS", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_GENERATED", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_HANDWRITTEN", + "DUET_GOOGLESQL_GENERATION", + "DUET_CLOUD_IX_PROMPTS", + "DUET_RAD", + "BARD_ARCADE_GITHUB", + "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", + "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", + "GENESIS_NEWS_INSIGHTS", + "CLOUD_SECURITY_PRETRAINING", + "CLOUD_SECURITY_FINETUNING", + "LABS_AQA_DSCOUT", + "LABS_AQA_TAILWIND", + "LABS_AQA_DELEWARE", + "GEMINI_MULTIMODAL_FT_URL", + "GEMINI_MULTIMODAL_FT_YT", + "GEMINI_MULTIMODAL_FT_SHUTTERSTOCK", + "GEMINI_MULTIMODAL_FT_NONE", + "GEMINI_MULTIMODAL_FT_OTHER", + "GEMINI_MULTIMODAL_FT_INK", + "GEMINI_MULTIMODAL_IT", + "GEMINI_IT_SHUTTERSTOCK", + "GEMINI_IT_M3W", + "GEMINI_IT_HEDGING", + "GEMINI_IT_DSCOUT_FACTUALITY", + "GEMINI_IT_AQUAMUSE", + "GEMINI_IT_SHOTGUN", + "GEMINI_IT_ACI_BENCH", + "GEMINI_IT_SPIDER_FILTERED", + "GEMINI_IT_TAB_SUM_BQ", + "GEMINI_IT_QA_WITH_URL", + "GEMINI_IT_CODE_INSTRUCT", + "GEMINI_IT_MED_PALM", + "GEMINI_IT_TASK_ORIENTED_DIALOG", + "GEMINI_IT_NIMBUS_GROUNDING_TO_PROMPT", + "GEMINI_IT_EITL_GEN", + "GEMINI_IT_HITL_GEN", + "GEMINI_IT_MECH", + "GEMINI_IT_TABLE_GEN", + "GEMINI_IT_NIMBUS_DECIBEL", + "GEMIT_BRIDGE_SUFFIX_FT", + "GEMINI_IT_CLOUD_CODE_IF", + "GEMINI_IT_CLOUD_EUR_LEX_JSON", + "GEMINI_IT_CLOUD_OASST", + "GEMINI_IT_CLOUD_SELF_INSTRUCT", + "GEMINI_IT_CLOUD_UCS_AQUAMUSE", + "GEMINI_V2_CMS_WIKIPEDIA_LANG_FILTERED_GCC_PII", + "GEMINI_V2_WIKIPEDIA_DIFFS_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_QUORA_COMPLIANT", + "GEMINI_V2_FORUMS_V2_COMPLIANT", + "GEMINI_V2_CMS_STACKOVERFLOW_MULTILINGUAL_V2_COMPLIANT", + "GEMINI_V2_SIMPLIFIED_HTML_V2_CORRECT_FORMAT_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_TOXICITY_TAGGED_FIXED_TAGS_COMPLIANT", + "GEMINI_V2_CODEWEB_V1_COMPLIANT", + "GEMINI_V2_LEETCODE_GCC_PII", + "GEMINI_V2_CODE_CONTESTS_COMPLIANT", + "GEMINI_V2_CMS_GITHUB_MULTI_FILE_FOR_FIM_GEMBAGZ_FIXED_BYTES_LENGTHS", + "GEMINI_V2_GITHUB_EVALED_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_NON_EVAL_HIGH_PRI_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_LOW_PRI_LANGUAGES_AND_CONFIGS_COMPLIANT", + "GEMINI_V2_GITHUB_LONG_TAIL_AND_STRUCTURED_DATA_COMPLIANT", + "GEMINI_V2_GITHUB_PYTHON_NOTEBOOKS_COMPLIANT", + "GEMINI_V2_GITHUB_DIFFS_COMPLIANT", + "GEMINI_V2_GITHUB_TECHDOCS_COMPLIANT", + "GEMINI_V2_HIGH_QUALITY_CODE_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_SCIENCE_PDF_68M_HQ_DOCS_DEDUP_COMPLIANT_CLEAN_TEX", + "GEMINI_V2_ARXIV_2023_COMPLIANT", + "GEMINI_V2_FORMAL_COMPLIANT", + "GEMINI_V2_CMS_STACKEXCHANGE_COMPLIANT", + "GEMINI_V2_PUBMED_COMPLIANT", + "GEMINI_V2_WEB_MATH_V3_COMPLIANT", + "GEMINI_V2_SCIENCEWEB_V0_GCC_PII", + "GEMINI_V2_WEB_POLYMATH_V1_COMPLIANT", + "GEMINI_V2_MATH_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_BIOLOGY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_PHYSICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHEMISTRY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MACHINE_LEARNING_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_QA_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_ECONOMICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MEDICAL_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHESS_COMPLIANT", + "GEMINI_V2_YOUTUBE_SCIENCE_V4_FILTERED_COMPLIANT", + "GEMINI_V2_GOALDMINE_XL_GENERATED_PLUS_GT_NO_DM_MATH_COMPLIANT", + "GEMINI_V2_FIRSTTIMES_SCIENCE_PDF_DEDUP_HQ_LENGTH_FILTERED_COMPLIANT", + "GEMINI_V2_PODCASTS_COMPLIANT", + "GEMINI_V2_EN_NONSCIENCE_PDF_DEDUP_46M_DOCS_COMPLIANT", + "GEMINI_V2_NONPUB_COPYRIGHT_BOOKS_V3_70_CONF_082323_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_COPYRIGHT_BOOKS_V3_111823_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_BOOKS_318K_TEXT_COMPLIANT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_T2I_TEXT_TO_IMAGE_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_I18N_680M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_FULL_HTML_75M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_V1_1_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_DOC_240M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_VIDEO_VIDEO_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M4W_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CULTURE_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_DETECTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_ALT_TEXT_NONEN_500M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SPATIAL_AWARE_PALI_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_3D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_NON_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_3D_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CC3M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_INFOGRAPHICS_LARGE_WEB_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_BIORXIV_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PLOT2TABLE_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TIKZ_DERENDERING_MERGED_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_2D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WIKIPEDIA_EQUATIONS_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_EQ2LATEX_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_ARXIV_EQUATIONS_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_HEAD_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_CLM_TRANSLATE_DATAV3_WEB_UNWMT_INCR_MIX", + "GEMINI_V2_NTL_NTLV4A_MONOLINGUAL_DEDUP_N5", + "GEMINI_V2_NTL_STT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_TRANSLIT_BILEX_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_BT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_FT_FIXED_TRANSLATE_DEDUP_N5", + "GEMINI_V2_CANARIES_SHUFFLED_COMPLIANT" + ], + "enumDescriptions": [ + "", + "Wikipedia article Tensorflow datasets used by Tarzan and maintained by TFDS team.", + "Webdocs that have been filtered from the docjoins by the Tarzan team for use in the Tarzan training set.", + "", + "", + "'Full view' books dataset maintained by Oceanographers team, meaning 'ok to view the book in full in all localities'. Largely the same as 'public domain', but with potentially subtle distinction.", + "Filtered private books used by ULM: http://google3/learning/multipod/pax/lm/params/ulm/tasks.py;l=123;rcl=494241309. which corresponds with /cns/mf-d/home/multipod-language-data/private_books/books_filtered_en_resharded@50000", + "Google news dataset referenced in: http://google3/learning/brain/research/conversation/meena/t5/pretrain_tasks.py;l=922;rcl=496534668", + "The docjoins data for ULM /cns/yo-d/home/multipod-language-data/docjoins/rs=6.3/20220728/100B_docstructure_split/examples_en.tfrecord_lattice_05_score_01_HFV13@3929", + "", + "Meena full conversations. http://google3/learning/brain/research/conversation/meena/t5/pretrain_mixtures.py;l=675;rcl=496583228", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Academic dataset of math text. http://google3/learning/brain/research/conversation/meena/seqio/mixtures/experimental/bard.py;rcl=500222380", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Datasets managed by the Goodall team: deepmind-goodall@google.com", + "", + "", + "", + "", + "", + "", + "", + "Datasets used by Codepoet", + "Datasets used by Vertex", + "", + "", + "Datasets used by Gemini Public data", + "", + "", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "Arxiv", + "Others", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemini V1, order by precedence. Wikipedia", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "ArXiv", + "Citable misc", + "", + "", + "Non-public books", + "", + "", + "Other", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Duet AI finetune datasets, order by precedence.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Bard ARCADE finetune dataset.", + "Mobile assistant finetune datasets.", + "", + "Genesis fine-tune datasets.", + "Cloud Security fine-tune datasets.", + "", + "LABS AQA fine-tune datasets.", + "", + "", + "Gemini multimodal instruction tune(IT) and fine tune(FT) datasets datasets.", + "", + "", + "", + "", + "", + "", + "Gemini IT 1.2.7 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemit Bridge ULM FT dataset", + "Gemini IT Cloud Build datasets.", + "", + "", + "", + "", + "Gemini V2 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "filepath": { + "type": "string" + }, + "geminiId": { + "type": "string" + }, + "gnewsArticleTitle": { + "type": "string" + }, + "goodallExampleId": { + "type": "string" + }, + "isOptOut": { + "description": "Whether the document is opted out.", + "type": "boolean" + }, + "isPrompt": { + "type": "boolean" + }, + "lamdaExampleId": { + "type": "string" + }, + "license": { + "type": "string" + }, + "meenaConversationId": { + "type": "string" + }, + "naturalLanguageCode": { + "description": "Natural (not programming) language of the document. Language code as defined by http://www.unicode.org/reports/tr35/#Identifiers and https://tools.ietf.org/html/bcp47. Currently applicable to full-view books. Use docinfo-util.h to set & read language fields. See go/iii.", + "type": "string" + }, + "noAttribution": { + "description": "True if this doc has no attribution information available. We use an explicit field for this instead of just implicitly leaving all the DocAttribution fields blank to distinguish a case where a bug/oversight has left the attribution information empty vs when we really have no attribution information available.", + "type": "boolean" + }, + "podcastUtteranceId": { + "type": "string" + }, + "publicationDate": { + "$ref": "GoogleTypeDate" + }, + "qualityScoreExperimentOnly": { + "description": "This field is for opt-out experiment only, MUST never be used during actual production/serving. ", + "format": "double", + "type": "number" + }, + "repo": { + "description": "Github repository", + "type": "string" + }, + "url": { + "description": "URL of a webdoc", + "type": "string" + }, + "volumeId": { + "type": "string" + }, + "wikipediaArticleTitle": { + "description": "Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset.", + "type": "string" + }, + "youtubeVideoId": { + "description": "The unique video id from Youtube. Example: AkoGsW52Ir0", + "type": "string" + } + }, + "type": "object" + }, + "LanguageLabsAidaTrustRecitationProtoRecitationResult": { + "description": "The recitation result for one input", + "id": "LanguageLabsAidaTrustRecitationProtoRecitationResult", + "properties": { + "dynamicSegmentResults": { + "items": { + "$ref": "LanguageLabsAidaTrustRecitationProtoSegmentResult" + }, + "type": "array" + }, + "recitationAction": { + "description": "The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK > CITE > NO_ACTION.", + "enum": [ + "ACTION_UNSPECIFIED", + "CITE", + "BLOCK", + "NO_ACTION", + "EXEMPT_FOUND_IN_PROMPT" + ], + "enumDescriptions": [ + "", + "indicate that attribution must be shown for a Segment", + "indicate that a Segment should be blocked from being used", + "for tagging high-frequency code snippets", + "The recitation was found in prompt and is exempted from overall results" + ], + "type": "string" + }, + "trainingSegmentResults": { + "items": { + "$ref": "LanguageLabsAidaTrustRecitationProtoSegmentResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "LanguageLabsAidaTrustRecitationProtoSegmentResult": { + "description": "The recitation result for each segment in a given input.", + "id": "LanguageLabsAidaTrustRecitationProtoSegmentResult", + "properties": { + "attributionDataset": { + "description": "The dataset the segment came from.", + "enum": [ + "DATASET_UNSPECIFIED", + "WIKIPEDIA", + "WEBDOCS", + "WEBDOCS_FINETUNE", + "GITHUB_MIRROR", + "BOOKS_FULL_VIEW", + "BOOKS_PRIVATE", + "GNEWS", + "ULM_DOCJOINS", + "ULM_DOCJOINS_DEDUPED", + "MEENA_FC", + "PODCAST", + "AQUA", + "WEB_ASR", + "BARD_GOLDEN", + "COMMON_SENSE_REASONING", + "MATH", + "MATH_REASONING", + "CLEAN_ARXIV", + "LAMDA_FACTUALITY_E2E_QUERY_GENERATION", + "LAMDA_FACTUALITY_E2E_RESPONSE_GENERATION", + "MASSIVE_FORUM_THREAD_SCORED_BARD", + "MASSIVE_FORUM_THREAD_SCORED_LONG_200", + "MASSIVE_FORUM_THREAD_SCORED_LONG_500", + "DOCUMENT_CHUNKS", + "MEENA_RESEARCH_PHASE_GOLDEN_MARKDOWN", + "MEENA_RESEARCH_PHASE_GOOGLERS", + "MEENA_RESPONSE_SAFETY_HUMAN_GEN", + "MEENA_RESPONSE_SAFETY_SCHEMA_NO_BROADCAST", + "MEENA_RESPONSE_SAFETY_V3_HUMAN_GEN2", + "MEENA_RESPONSE_SAFETY_V3_SCHEMA_NO_BROADCAST", + "LAMDA_FACTUALITY_TRIGGER", + "LAMDA_SAFETY_V2_SCHEMA_NO_BROADCAST", + "LAMDA_SSI_DISCRIMINATIVE", + "ASSISTANT_PERSONALITY_SAFETY", + "PODCAST_FINETUNE_DIALOG", + "WORLD_QUERY_GENERATOR", + "C4_JOINED_DOCJOINS", + "HOL4_THEORIES", + "HOL_LIGHT_THEORIES", + "HOLSTEPS", + "ISABELLE_STEP", + "ISABELLE_THEORIES", + "LEAN_MATHLIB_THEORIES", + "LEAN_STEP", + "MIZAR_THEORIES", + "COQ_STEP", + "COQ_THEORIES", + "AMPS_KHAN", + "AMPS_MATHEMATICA", + "CODEY_CODE", + "CODE_QA_SE", + "CODE_QA_SO", + "CODE_QA_FT_FORMAT", + "CODE_QA_FT_KNOWLEDGE", + "CODE_QA_GITHUB_FILTERED_CODE", + "BARD_PERSONALITY_GOLDEN", + "ULM_DOCJOINS_WITH_URLS_EN", + "ULM_DOCJOINS_WITH_URLS_I18N", + "GOODALL_MTV5_GITHUB", + "GOODALL_MTV5_BOOKS", + "GOODALL_MTV5_C4", + "GOODALL_MTV5_WIKIPEDIA", + "GOODALL_MW_TOP_100B", + "GOODALL_MW_STACK_EXCHANGE", + "GOODALL_MW_TOP_0_10B", + "GOODALL_MW_TOP_10B_20B", + "CODEY_NOTEBOOK_LM_PRETRAINING", + "VERTEX_SAFE_FLAN", + "GITHUB_MIRROR_V1_0_1", + "GITHUB_MIRROR_V2_1_0", + "CMS_WIKIPEDIA_LANG_FILTERED", + "CMS_STACKOVERFLOW_MULTILINGUAL", + "CMS_STACKEXCHANGE", + "PUBMED", + "GEMINI_DOCJOINS_EN_TOP10B_GCC", + "GEMINI_DOCJOINS_EN_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_EN_TOP20B_TOP100B_GCC", + "GEMINI_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_I18N_TOP20B_TOP100B_GCC", + "SIMPLIFIED_HTML_V1_GCC", + "GEMINI_DOCJOINS_TOXICITY_TAGGED_GCC", + "CMS_GITHUB_V4", + "GITHUB_HTML_V4", + "GITHUB_OTHER_V4", + "GITHUB_LONG_TAIL_V4", + "CMS_GITHUB_MULTIFILE_V4", + "GITHUB_DIFFS_WITH_COMMIT_MESSAGE", + "ULM_ARXIV", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_ENONLY", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_NONENONLY", + "QUORA", + "PODCASTS_ROBOTSTXT", + "COMBINED_REDDIT", + "CANARIES_SHUFFLED", + "CLM_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "TECHDOCS_DATA_SOURCE", + "SCIENCE_PDF_70M_DOCS_FILTERED", + "GEMINI_V1_CMS_WIKIPEDIA_LANG_FILTERED", + "GEMINI_V1_WIKIPEDIA_DIFFS", + "GEMINI_V1_DOCJOINS_EN_TOP10B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP10B_TOP20B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP20B_TOP100B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_TOP20B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP20B_TOP100B_GCC_050523", + "GEMINI_V1_SIMPLIFIED_HTML_V2_GCC", + "GEMINI_V1_CMS_STACKOVERFLOW_MULTILINGUAL_V2", + "GEMINI_V1_CMS_STACKEXCHANGE_DECONT", + "GEMINI_V1_QUORA", + "GEMINI_V1_COMBINED_REDDIT", + "GEMINI_V1_DOCJOIN_100B_EN_TOXICITY_TAGGED_GCC_FIXED_TAGS", + "GEMINI_V1_PUBMED", + "GEMINI_V1_WEB_MATH_V2", + "GEMINI_V1_CMS_GITHUB_DECONTAMINATED_V_7", + "GEMINI_V1_GITHUB_DIFF_WITH_COMMIT_MESSAGE_V2", + "GEMINI_V1_GITHUB_HTML_CSS_XML_V4", + "GEMINI_V1_GITHUB_OTHER_V4", + "GEMINI_V1_GITHUB_LONG_TAIL_V4", + "GEMINI_V1_GITHUB_JUPTYER_NOTEBOOKS_SSTABLE", + "GEMINI_V1_ULM_ARXIV_SSTABLE", + "GEMINI_V1_PODCASTS_ROBOTSTXT", + "GEMINI_V1_SCIENCE_PDF_68M_HQ_DOCS_GCC", + "GEMINI_V1_GITHUB_TECHDOCS_V2", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_EN", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_NONEN", + "GEMINI_V1_STEM_BOOKS_650K_TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_M3W_V2_FILTERED", + "GEMINI_V1_VQCOCA_1B_MULTIRES_WEBLI_EN_V4_350M_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_SCREENAI_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CULTURE_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_EN_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_I18N_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_NON_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_VTP_4F_VIDEO2TEXT_PREFIX", + "GEMINI_V1_FORMAL_MATH_WITHOUT_HOLSTEPS_AND_MIZAR", + "GEMINI_V1_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "GEMINI_V1_CANARIES_SHUFFLED_DOCJOIN_EN_NONEN_CODE_ARXIV_TRANSLATE", + "DUET_CLOUD_SECURITY_DOCS", + "DUET_GITHUB_CODE_SNIPPETS", + "DUET_GITHUB_FILES", + "DUET_GOBYEXAMPLE", + "DUET_GOLANG_DOCS", + "DUET_CLOUD_DOCS_TROUBLESHOOTING_TABLES", + "DUET_DEVSITE_DOCS", + "DUET_CLOUD_BLOG_POSTS", + "DUET_CLOUD_PODCAST_EPISODES", + "DUET_YOUTUBE_VIDEOS", + "DUET_CLOUD_SKILLS_BOOST", + "DUET_CLOUD_DOCS", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_GENERATED", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_HANDWRITTEN", + "DUET_GOOGLESQL_GENERATION", + "DUET_CLOUD_IX_PROMPTS", + "DUET_RAD", + "BARD_ARCADE_GITHUB", + "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", + "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", + "GENESIS_NEWS_INSIGHTS", + "CLOUD_SECURITY_PRETRAINING", + "CLOUD_SECURITY_FINETUNING", + "LABS_AQA_DSCOUT", + "LABS_AQA_TAILWIND", + "LABS_AQA_DELEWARE", + "GEMINI_MULTIMODAL_FT_URL", + "GEMINI_MULTIMODAL_FT_YT", + "GEMINI_MULTIMODAL_FT_SHUTTERSTOCK", + "GEMINI_MULTIMODAL_FT_NONE", + "GEMINI_MULTIMODAL_FT_OTHER", + "GEMINI_MULTIMODAL_FT_INK", + "GEMINI_MULTIMODAL_IT", + "GEMINI_IT_SHUTTERSTOCK", + "GEMINI_IT_M3W", + "GEMINI_IT_HEDGING", + "GEMINI_IT_DSCOUT_FACTUALITY", + "GEMINI_IT_AQUAMUSE", + "GEMINI_IT_SHOTGUN", + "GEMINI_IT_ACI_BENCH", + "GEMINI_IT_SPIDER_FILTERED", + "GEMINI_IT_TAB_SUM_BQ", + "GEMINI_IT_QA_WITH_URL", + "GEMINI_IT_CODE_INSTRUCT", + "GEMINI_IT_MED_PALM", + "GEMINI_IT_TASK_ORIENTED_DIALOG", + "GEMINI_IT_NIMBUS_GROUNDING_TO_PROMPT", + "GEMINI_IT_EITL_GEN", + "GEMINI_IT_HITL_GEN", + "GEMINI_IT_MECH", + "GEMINI_IT_TABLE_GEN", + "GEMINI_IT_NIMBUS_DECIBEL", + "GEMIT_BRIDGE_SUFFIX_FT", + "GEMINI_IT_CLOUD_CODE_IF", + "GEMINI_IT_CLOUD_EUR_LEX_JSON", + "GEMINI_IT_CLOUD_OASST", + "GEMINI_IT_CLOUD_SELF_INSTRUCT", + "GEMINI_IT_CLOUD_UCS_AQUAMUSE", + "GEMINI_V2_CMS_WIKIPEDIA_LANG_FILTERED_GCC_PII", + "GEMINI_V2_WIKIPEDIA_DIFFS_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_QUORA_COMPLIANT", + "GEMINI_V2_FORUMS_V2_COMPLIANT", + "GEMINI_V2_CMS_STACKOVERFLOW_MULTILINGUAL_V2_COMPLIANT", + "GEMINI_V2_SIMPLIFIED_HTML_V2_CORRECT_FORMAT_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_TOXICITY_TAGGED_FIXED_TAGS_COMPLIANT", + "GEMINI_V2_CODEWEB_V1_COMPLIANT", + "GEMINI_V2_LEETCODE_GCC_PII", + "GEMINI_V2_CODE_CONTESTS_COMPLIANT", + "GEMINI_V2_CMS_GITHUB_MULTI_FILE_FOR_FIM_GEMBAGZ_FIXED_BYTES_LENGTHS", + "GEMINI_V2_GITHUB_EVALED_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_NON_EVAL_HIGH_PRI_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_LOW_PRI_LANGUAGES_AND_CONFIGS_COMPLIANT", + "GEMINI_V2_GITHUB_LONG_TAIL_AND_STRUCTURED_DATA_COMPLIANT", + "GEMINI_V2_GITHUB_PYTHON_NOTEBOOKS_COMPLIANT", + "GEMINI_V2_GITHUB_DIFFS_COMPLIANT", + "GEMINI_V2_GITHUB_TECHDOCS_COMPLIANT", + "GEMINI_V2_HIGH_QUALITY_CODE_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_SCIENCE_PDF_68M_HQ_DOCS_DEDUP_COMPLIANT_CLEAN_TEX", + "GEMINI_V2_ARXIV_2023_COMPLIANT", + "GEMINI_V2_FORMAL_COMPLIANT", + "GEMINI_V2_CMS_STACKEXCHANGE_COMPLIANT", + "GEMINI_V2_PUBMED_COMPLIANT", + "GEMINI_V2_WEB_MATH_V3_COMPLIANT", + "GEMINI_V2_SCIENCEWEB_V0_GCC_PII", + "GEMINI_V2_WEB_POLYMATH_V1_COMPLIANT", + "GEMINI_V2_MATH_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_BIOLOGY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_PHYSICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHEMISTRY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MACHINE_LEARNING_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_QA_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_ECONOMICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MEDICAL_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHESS_COMPLIANT", + "GEMINI_V2_YOUTUBE_SCIENCE_V4_FILTERED_COMPLIANT", + "GEMINI_V2_GOALDMINE_XL_GENERATED_PLUS_GT_NO_DM_MATH_COMPLIANT", + "GEMINI_V2_FIRSTTIMES_SCIENCE_PDF_DEDUP_HQ_LENGTH_FILTERED_COMPLIANT", + "GEMINI_V2_PODCASTS_COMPLIANT", + "GEMINI_V2_EN_NONSCIENCE_PDF_DEDUP_46M_DOCS_COMPLIANT", + "GEMINI_V2_NONPUB_COPYRIGHT_BOOKS_V3_70_CONF_082323_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_COPYRIGHT_BOOKS_V3_111823_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_BOOKS_318K_TEXT_COMPLIANT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_T2I_TEXT_TO_IMAGE_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_I18N_680M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_FULL_HTML_75M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_V1_1_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_DOC_240M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_VIDEO_VIDEO_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M4W_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CULTURE_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_DETECTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_ALT_TEXT_NONEN_500M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SPATIAL_AWARE_PALI_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_3D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_NON_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_3D_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CC3M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_INFOGRAPHICS_LARGE_WEB_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_BIORXIV_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PLOT2TABLE_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TIKZ_DERENDERING_MERGED_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_2D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WIKIPEDIA_EQUATIONS_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_EQ2LATEX_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_ARXIV_EQUATIONS_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_HEAD_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_CLM_TRANSLATE_DATAV3_WEB_UNWMT_INCR_MIX", + "GEMINI_V2_NTL_NTLV4A_MONOLINGUAL_DEDUP_N5", + "GEMINI_V2_NTL_STT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_TRANSLIT_BILEX_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_BT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_FT_FIXED_TRANSLATE_DEDUP_N5", + "GEMINI_V2_CANARIES_SHUFFLED_COMPLIANT" + ], + "enumDescriptions": [ + "", + "Wikipedia article Tensorflow datasets used by Tarzan and maintained by TFDS team.", + "Webdocs that have been filtered from the docjoins by the Tarzan team for use in the Tarzan training set.", + "", + "", + "'Full view' books dataset maintained by Oceanographers team, meaning 'ok to view the book in full in all localities'. Largely the same as 'public domain', but with potentially subtle distinction.", + "Filtered private books used by ULM: http://google3/learning/multipod/pax/lm/params/ulm/tasks.py;l=123;rcl=494241309. which corresponds with /cns/mf-d/home/multipod-language-data/private_books/books_filtered_en_resharded@50000", + "Google news dataset referenced in: http://google3/learning/brain/research/conversation/meena/t5/pretrain_tasks.py;l=922;rcl=496534668", + "The docjoins data for ULM /cns/yo-d/home/multipod-language-data/docjoins/rs=6.3/20220728/100B_docstructure_split/examples_en.tfrecord_lattice_05_score_01_HFV13@3929", + "", + "Meena full conversations. http://google3/learning/brain/research/conversation/meena/t5/pretrain_mixtures.py;l=675;rcl=496583228", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Academic dataset of math text. http://google3/learning/brain/research/conversation/meena/seqio/mixtures/experimental/bard.py;rcl=500222380", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Datasets managed by the Goodall team: deepmind-goodall@google.com", + "", + "", + "", + "", + "", + "", + "", + "Datasets used by Codepoet", + "Datasets used by Vertex", + "", + "", + "Datasets used by Gemini Public data", + "", + "", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "Arxiv", + "Others", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemini V1, order by precedence. Wikipedia", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "ArXiv", + "Citable misc", + "", + "", + "Non-public books", + "", + "", + "Other", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Duet AI finetune datasets, order by precedence.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Bard ARCADE finetune dataset.", + "Mobile assistant finetune datasets.", + "", + "Genesis fine-tune datasets.", + "Cloud Security fine-tune datasets.", + "", + "LABS AQA fine-tune datasets.", + "", + "", + "Gemini multimodal instruction tune(IT) and fine tune(FT) datasets datasets.", + "", + "", + "", + "", + "", + "", + "Gemini IT 1.2.7 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemit Bridge ULM FT dataset", + "Gemini IT Cloud Build datasets.", + "", + "", + "", + "", + "Gemini V2 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "displayAttributionMessage": { + "description": "human-friendly string that contains information from doc_attribution which could be shown by clients", + "type": "string" + }, + "docAttribution": { + "$ref": "LanguageLabsAidaTrustRecitationProtoDocAttribution", + "description": "populated when recitation_action == CITE" + }, + "docOccurrences": { + "description": "number of documents that contained this segment", + "format": "int32", + "type": "integer" + }, + "endIndex": { + "format": "int32", + "type": "integer" + }, + "rawText": { + "description": "The raw text in the given input that is corresponding to the segment. It will be available only when 'return_segment_raw_text' is enabled in the request options.", + "type": "string" + }, + "segmentRecitationAction": { + "enum": [ + "ACTION_UNSPECIFIED", + "CITE", + "BLOCK", + "NO_ACTION", + "EXEMPT_FOUND_IN_PROMPT" + ], + "enumDescriptions": [ + "", + "indicate that attribution must be shown for a Segment", + "indicate that a Segment should be blocked from being used", + "for tagging high-frequency code snippets", + "The recitation was found in prompt and is exempted from overall results" + ], + "type": "string" + }, + "startIndex": { + "description": "The segment boundary start (inclusive) and end index (exclusive) in the given text. In the streaming RPC, the indexes always start from the beginning of the first text in the entire stream. The indexes are measured in UTF-16 code units.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LanguageLabsAidaTrustRecitationProtoStreamRecitationResult": { + "description": "The recitation result for one stream input", + "id": "LanguageLabsAidaTrustRecitationProtoStreamRecitationResult", + "properties": { + "dynamicSegmentResults": { + "description": "The recitation result against the given dynamic data source.", + "items": { + "$ref": "LanguageLabsAidaTrustRecitationProtoSegmentResult" + }, + "type": "array" + }, + "fullyCheckedTextIndex": { + "description": "Last index of input text fully checked for recitation in the entire streaming context. Would return `-1` if no Input was checked for recitation.", + "format": "int32", + "type": "integer" + }, + "recitationAction": { + "description": "The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK > CITE > NO_ACTION.", + "enum": [ + "ACTION_UNSPECIFIED", + "CITE", + "BLOCK", + "NO_ACTION", + "EXEMPT_FOUND_IN_PROMPT" + ], + "enumDescriptions": [ + "", + "indicate that attribution must be shown for a Segment", + "indicate that a Segment should be blocked from being used", + "for tagging high-frequency code snippets", + "The recitation was found in prompt and is exempted from overall results" + ], + "type": "string" + }, + "trainingSegmentResults": { + "description": "The recitation result against model training data.", + "items": { + "$ref": "LanguageLabsAidaTrustRecitationProtoSegmentResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRecitationDocAttribution": { + "description": "The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30", + "id": "LearningGenaiRecitationDocAttribution", + "properties": { + "amarnaId": { + "type": "string" + }, + "arxivId": { + "type": "string" + }, + "author": { + "type": "string" + }, + "bibkey": { + "type": "string" + }, + "biorxivId": { + "description": "ID of the paper in bioarxiv like ddoi.org/{biorxiv_id} eg: https://doi.org/10.1101/343517", + "type": "string" + }, + "bookTitle": { + "type": "string" + }, + "bookVolumeId": { + "description": "The Oceanographers full-view books dataset uses a 'volume id' as the unique ID of a book. There is a deterministic function from a volume id to a URL under the books.google.com domain. Marked as 'optional' since a volume ID of zero is potentially possible and we want to distinguish that from the volume ID not being set.", + "format": "int64", + "type": "string" + }, + "conversationId": { + "type": "string" + }, + "dataset": { + "description": "The dataset this document comes from.", + "enum": [ + "DATASET_UNSPECIFIED", + "WIKIPEDIA", + "WEBDOCS", + "WEBDOCS_FINETUNE", + "GITHUB_MIRROR", + "BOOKS_FULL_VIEW", + "BOOKS_PRIVATE", + "GNEWS", + "ULM_DOCJOINS", + "ULM_DOCJOINS_DEDUPED", + "MEENA_FC", + "PODCAST", + "AQUA", + "WEB_ASR", + "BARD_GOLDEN", + "COMMON_SENSE_REASONING", + "MATH", + "MATH_REASONING", + "CLEAN_ARXIV", + "LAMDA_FACTUALITY_E2E_QUERY_GENERATION", + "LAMDA_FACTUALITY_E2E_RESPONSE_GENERATION", + "MASSIVE_FORUM_THREAD_SCORED_BARD", + "MASSIVE_FORUM_THREAD_SCORED_LONG_200", + "MASSIVE_FORUM_THREAD_SCORED_LONG_500", + "DOCUMENT_CHUNKS", + "MEENA_RESEARCH_PHASE_GOLDEN_MARKDOWN", + "MEENA_RESEARCH_PHASE_GOOGLERS", + "MEENA_RESPONSE_SAFETY_HUMAN_GEN", + "MEENA_RESPONSE_SAFETY_SCHEMA_NO_BROADCAST", + "MEENA_RESPONSE_SAFETY_V3_HUMAN_GEN2", + "MEENA_RESPONSE_SAFETY_V3_SCHEMA_NO_BROADCAST", + "LAMDA_FACTUALITY_TRIGGER", + "LAMDA_SAFETY_V2_SCHEMA_NO_BROADCAST", + "LAMDA_SSI_DISCRIMINATIVE", + "ASSISTANT_PERSONALITY_SAFETY", + "PODCAST_FINETUNE_DIALOG", + "WORLD_QUERY_GENERATOR", + "C4_JOINED_DOCJOINS", + "HOL4_THEORIES", + "HOL_LIGHT_THEORIES", + "HOLSTEPS", + "ISABELLE_STEP", + "ISABELLE_THEORIES", + "LEAN_MATHLIB_THEORIES", + "LEAN_STEP", + "MIZAR_THEORIES", + "COQ_STEP", + "COQ_THEORIES", + "AMPS_KHAN", + "AMPS_MATHEMATICA", + "CODEY_CODE", + "CODE_QA_SE", + "CODE_QA_SO", + "CODE_QA_FT_FORMAT", + "CODE_QA_FT_KNOWLEDGE", + "CODE_QA_GITHUB_FILTERED_CODE", + "BARD_PERSONALITY_GOLDEN", + "ULM_DOCJOINS_WITH_URLS_EN", + "ULM_DOCJOINS_WITH_URLS_I18N", + "GOODALL_MTV5_GITHUB", + "GOODALL_MTV5_BOOKS", + "GOODALL_MTV5_C4", + "GOODALL_MTV5_WIKIPEDIA", + "GOODALL_MW_TOP_100B", + "GOODALL_MW_STACK_EXCHANGE", + "GOODALL_MW_TOP_0_10B", + "GOODALL_MW_TOP_10B_20B", + "CODEY_NOTEBOOK_LM_PRETRAINING", + "VERTEX_SAFE_FLAN", + "GITHUB_MIRROR_V1_0_1", + "GITHUB_MIRROR_V2_1_0", + "CMS_WIKIPEDIA_LANG_FILTERED", + "CMS_STACKOVERFLOW_MULTILINGUAL", + "CMS_STACKEXCHANGE", + "PUBMED", + "GEMINI_DOCJOINS_EN_TOP10B_GCC", + "GEMINI_DOCJOINS_EN_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_EN_TOP20B_TOP100B_GCC", + "GEMINI_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_I18N_TOP20B_TOP100B_GCC", + "SIMPLIFIED_HTML_V1_GCC", + "GEMINI_DOCJOINS_TOXICITY_TAGGED_GCC", + "CMS_GITHUB_V4", + "GITHUB_HTML_V4", + "GITHUB_OTHER_V4", + "GITHUB_LONG_TAIL_V4", + "CMS_GITHUB_MULTIFILE_V4", + "GITHUB_DIFFS_WITH_COMMIT_MESSAGE", + "ULM_ARXIV", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_ENONLY", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_NONENONLY", + "QUORA", + "PODCASTS_ROBOTSTXT", + "COMBINED_REDDIT", + "CANARIES_SHUFFLED", + "CLM_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "TECHDOCS_DATA_SOURCE", + "SCIENCE_PDF_70M_DOCS_FILTERED", + "GEMINI_V1_CMS_WIKIPEDIA_LANG_FILTERED", + "GEMINI_V1_WIKIPEDIA_DIFFS", + "GEMINI_V1_DOCJOINS_EN_TOP10B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP10B_TOP20B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP20B_TOP100B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_TOP20B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP20B_TOP100B_GCC_050523", + "GEMINI_V1_SIMPLIFIED_HTML_V2_GCC", + "GEMINI_V1_CMS_STACKOVERFLOW_MULTILINGUAL_V2", + "GEMINI_V1_CMS_STACKEXCHANGE_DECONT", + "GEMINI_V1_QUORA", + "GEMINI_V1_COMBINED_REDDIT", + "GEMINI_V1_DOCJOIN_100B_EN_TOXICITY_TAGGED_GCC_FIXED_TAGS", + "GEMINI_V1_PUBMED", + "GEMINI_V1_WEB_MATH_V2", + "GEMINI_V1_CMS_GITHUB_DECONTAMINATED_V_7", + "GEMINI_V1_GITHUB_DIFF_WITH_COMMIT_MESSAGE_V2", + "GEMINI_V1_GITHUB_HTML_CSS_XML_V4", + "GEMINI_V1_GITHUB_OTHER_V4", + "GEMINI_V1_GITHUB_LONG_TAIL_V4", + "GEMINI_V1_GITHUB_JUPTYER_NOTEBOOKS_SSTABLE", + "GEMINI_V1_ULM_ARXIV_SSTABLE", + "GEMINI_V1_PODCASTS_ROBOTSTXT", + "GEMINI_V1_SCIENCE_PDF_68M_HQ_DOCS_GCC", + "GEMINI_V1_GITHUB_TECHDOCS_V2", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_EN", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_NONEN", + "GEMINI_V1_STEM_BOOKS_650K_TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_M3W_V2_FILTERED", + "GEMINI_V1_VQCOCA_1B_MULTIRES_WEBLI_EN_V4_350M_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_SCREENAI_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CULTURE_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_EN_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_I18N_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_NON_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_VTP_4F_VIDEO2TEXT_PREFIX", + "GEMINI_V1_FORMAL_MATH_WITHOUT_HOLSTEPS_AND_MIZAR", + "GEMINI_V1_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "GEMINI_V1_CANARIES_SHUFFLED_DOCJOIN_EN_NONEN_CODE_ARXIV_TRANSLATE", + "DUET_CLOUD_SECURITY_DOCS", + "DUET_GITHUB_CODE_SNIPPETS", + "DUET_GITHUB_FILES", + "DUET_GOBYEXAMPLE", + "DUET_GOLANG_DOCS", + "DUET_CLOUD_DOCS_TROUBLESHOOTING_TABLES", + "DUET_DEVSITE_DOCS", + "DUET_CLOUD_BLOG_POSTS", + "DUET_CLOUD_PODCAST_EPISODES", + "DUET_YOUTUBE_VIDEOS", + "DUET_CLOUD_SKILLS_BOOST", + "DUET_CLOUD_DOCS", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_GENERATED", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_HANDWRITTEN", + "DUET_GOOGLESQL_GENERATION", + "DUET_CLOUD_IX_PROMPTS", + "DUET_RAD", + "BARD_ARCADE_GITHUB", + "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", + "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", + "GENESIS_NEWS_INSIGHTS", + "CLOUD_SECURITY_PRETRAINING", + "CLOUD_SECURITY_FINETUNING", + "LABS_AQA_DSCOUT", + "LABS_AQA_TAILWIND", + "LABS_AQA_DELEWARE", + "GEMINI_MULTIMODAL_FT_URL", + "GEMINI_MULTIMODAL_FT_YT", + "GEMINI_MULTIMODAL_FT_SHUTTERSTOCK", + "GEMINI_MULTIMODAL_FT_NONE", + "GEMINI_MULTIMODAL_FT_OTHER", + "GEMINI_MULTIMODAL_FT_INK", + "GEMINI_MULTIMODAL_IT", + "GEMINI_IT_SHUTTERSTOCK", + "GEMINI_IT_M3W", + "GEMINI_IT_HEDGING", + "GEMINI_IT_DSCOUT_FACTUALITY", + "GEMINI_IT_AQUAMUSE", + "GEMINI_IT_SHOTGUN", + "GEMINI_IT_ACI_BENCH", + "GEMINI_IT_SPIDER_FILTERED", + "GEMINI_IT_TAB_SUM_BQ", + "GEMINI_IT_QA_WITH_URL", + "GEMINI_IT_CODE_INSTRUCT", + "GEMINI_IT_MED_PALM", + "GEMINI_IT_TASK_ORIENTED_DIALOG", + "GEMINI_IT_NIMBUS_GROUNDING_TO_PROMPT", + "GEMINI_IT_EITL_GEN", + "GEMINI_IT_HITL_GEN", + "GEMINI_IT_MECH", + "GEMINI_IT_TABLE_GEN", + "GEMINI_IT_NIMBUS_DECIBEL", + "GEMIT_BRIDGE_SUFFIX_FT", + "GEMINI_IT_CLOUD_CODE_IF", + "GEMINI_IT_CLOUD_EUR_LEX_JSON", + "GEMINI_IT_CLOUD_OASST", + "GEMINI_IT_CLOUD_SELF_INSTRUCT", + "GEMINI_IT_CLOUD_UCS_AQUAMUSE", + "GEMINI_V2_CMS_WIKIPEDIA_LANG_FILTERED_GCC_PII", + "GEMINI_V2_WIKIPEDIA_DIFFS_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_QUORA_COMPLIANT", + "GEMINI_V2_FORUMS_V2_COMPLIANT", + "GEMINI_V2_CMS_STACKOVERFLOW_MULTILINGUAL_V2_COMPLIANT", + "GEMINI_V2_SIMPLIFIED_HTML_V2_CORRECT_FORMAT_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_TOXICITY_TAGGED_FIXED_TAGS_COMPLIANT", + "GEMINI_V2_CODEWEB_V1_COMPLIANT", + "GEMINI_V2_LEETCODE_GCC_PII", + "GEMINI_V2_CODE_CONTESTS_COMPLIANT", + "GEMINI_V2_CMS_GITHUB_MULTI_FILE_FOR_FIM_GEMBAGZ_FIXED_BYTES_LENGTHS", + "GEMINI_V2_GITHUB_EVALED_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_NON_EVAL_HIGH_PRI_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_LOW_PRI_LANGUAGES_AND_CONFIGS_COMPLIANT", + "GEMINI_V2_GITHUB_LONG_TAIL_AND_STRUCTURED_DATA_COMPLIANT", + "GEMINI_V2_GITHUB_PYTHON_NOTEBOOKS_COMPLIANT", + "GEMINI_V2_GITHUB_DIFFS_COMPLIANT", + "GEMINI_V2_GITHUB_TECHDOCS_COMPLIANT", + "GEMINI_V2_HIGH_QUALITY_CODE_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_SCIENCE_PDF_68M_HQ_DOCS_DEDUP_COMPLIANT_CLEAN_TEX", + "GEMINI_V2_ARXIV_2023_COMPLIANT", + "GEMINI_V2_FORMAL_COMPLIANT", + "GEMINI_V2_CMS_STACKEXCHANGE_COMPLIANT", + "GEMINI_V2_PUBMED_COMPLIANT", + "GEMINI_V2_WEB_MATH_V3_COMPLIANT", + "GEMINI_V2_SCIENCEWEB_V0_GCC_PII", + "GEMINI_V2_WEB_POLYMATH_V1_COMPLIANT", + "GEMINI_V2_MATH_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_BIOLOGY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_PHYSICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHEMISTRY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MACHINE_LEARNING_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_QA_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_ECONOMICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MEDICAL_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHESS_COMPLIANT", + "GEMINI_V2_YOUTUBE_SCIENCE_V4_FILTERED_COMPLIANT", + "GEMINI_V2_GOALDMINE_XL_GENERATED_PLUS_GT_NO_DM_MATH_COMPLIANT", + "GEMINI_V2_FIRSTTIMES_SCIENCE_PDF_DEDUP_HQ_LENGTH_FILTERED_COMPLIANT", + "GEMINI_V2_PODCASTS_COMPLIANT", + "GEMINI_V2_EN_NONSCIENCE_PDF_DEDUP_46M_DOCS_COMPLIANT", + "GEMINI_V2_NONPUB_COPYRIGHT_BOOKS_V3_70_CONF_082323_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_COPYRIGHT_BOOKS_V3_111823_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_BOOKS_318K_TEXT_COMPLIANT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_T2I_TEXT_TO_IMAGE_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_I18N_680M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_FULL_HTML_75M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_V1_1_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_DOC_240M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_VIDEO_VIDEO_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M4W_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CULTURE_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_DETECTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_ALT_TEXT_NONEN_500M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SPATIAL_AWARE_PALI_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_3D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_NON_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_3D_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CC3M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_INFOGRAPHICS_LARGE_WEB_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_BIORXIV_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PLOT2TABLE_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TIKZ_DERENDERING_MERGED_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_2D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WIKIPEDIA_EQUATIONS_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_EQ2LATEX_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_ARXIV_EQUATIONS_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_HEAD_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_CLM_TRANSLATE_DATAV3_WEB_UNWMT_INCR_MIX", + "GEMINI_V2_NTL_NTLV4A_MONOLINGUAL_DEDUP_N5", + "GEMINI_V2_NTL_STT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_TRANSLIT_BILEX_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_BT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_FT_FIXED_TRANSLATE_DEDUP_N5", + "GEMINI_V2_CANARIES_SHUFFLED_COMPLIANT" + ], + "enumDescriptions": [ + "", + "Wikipedia article Tensorflow datasets used by Tarzan and maintained by TFDS team.", + "Webdocs that have been filtered from the docjoins by the Tarzan team for use in the Tarzan training set.", + "", + "", + "'Full view' books dataset maintained by Oceanographers team, meaning 'ok to view the book in full in all localities'. Largely the same as 'public domain', but with potentially subtle distinction.", + "Filtered private books used by ULM: http://google3/learning/multipod/pax/lm/params/ulm/tasks.py;l=123;rcl=494241309. which corresponds with /cns/mf-d/home/multipod-language-data/private_books/books_filtered_en_resharded@50000", + "Google news dataset referenced in: http://google3/learning/brain/research/conversation/meena/t5/pretrain_tasks.py;l=922;rcl=496534668", + "The docjoins data for ULM /cns/yo-d/home/multipod-language-data/docjoins/rs=6.3/20220728/100B_docstructure_split/examples_en.tfrecord_lattice_05_score_01_HFV13@3929", + "", + "Meena full conversations. http://google3/learning/brain/research/conversation/meena/t5/pretrain_mixtures.py;l=675;rcl=496583228", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Academic dataset of math text. http://google3/learning/brain/research/conversation/meena/seqio/mixtures/experimental/bard.py;rcl=500222380", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Datasets managed by the Goodall team: deepmind-goodall@google.com", + "", + "", + "", + "", + "", + "", + "", + "Datasets used by Codepoet", + "Datasets used by Vertex", + "", + "", + "Datasets used by Gemini Public data", + "", + "", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "Arxiv", + "Others", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemini V1, order by precedence. Wikipedia", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "ArXiv", + "Citable misc", + "", + "", + "Non-public books", + "", + "", + "Other", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Duet AI finetune datasets, order by precedence.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Bard ARCADE finetune dataset", + "Mobile assistant finetune datasets.", + "", + "Genesis fine tuned datasets.", + "Cloud Security fine tuned datasets.", + "", + "LABS AQA fine-tune datasets.", + "", + "", + "Gemini multimodal instruction tune(IT) and fine tune(FT) datasets datasets.", + "", + "", + "", + "", + "", + "", + "Gemini IT 1.2.7 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemit Bridge ULM FT dataset", + "Gemini IT Cloud Build datasets.", + "", + "", + "", + "", + "Gemini V2 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "filepath": { + "type": "string" + }, + "geminiId": { + "type": "string" + }, + "gnewsArticleTitle": { + "type": "string" + }, + "goodallExampleId": { + "type": "string" + }, + "isOptOut": { + "description": "Whether the document is opted out.", + "type": "boolean" + }, + "isPrompt": { + "description": "When true, this attribution came from the user's prompt.", + "type": "boolean" + }, + "lamdaExampleId": { + "type": "string" + }, + "license": { + "type": "string" + }, + "meenaConversationId": { + "type": "string" + }, + "naturalLanguageCode": { + "description": "Natural (not programming) language of the document. Language code as defined by http://www.unicode.org/reports/tr35/#Identifiers and https://tools.ietf.org/html/bcp47. Currently applicable to full-view books. Use docinfo-util.h to set & read language fields. See go/iii.", + "type": "string" + }, + "noAttribution": { + "description": "True if this doc has no attribution information available. We use an explicit field for this instead of just implicitly leaving all the DocAttribution fields blank to distinguish a case where a bug/oversight has left the attribution information empty vs when we really have no attribution information available.", + "type": "boolean" + }, + "podcastUtteranceId": { + "type": "string" + }, + "publicationDate": { + "$ref": "GoogleTypeDate" + }, + "qualityScoreExperimentOnly": { + "description": "This field is for opt-out experiment only, MUST never be used during actual production/serving. ", + "format": "double", + "type": "number" + }, + "repo": { + "description": "Github repository", + "type": "string" + }, + "url": { + "description": "URL of a webdoc", + "type": "string" + }, + "volumeId": { + "type": "string" + }, + "wikipediaArticleTitle": { + "description": "Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset.", + "type": "string" + }, + "youtubeVideoId": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRecitationRecitationResult": { + "description": "The recitation result for one input", + "id": "LearningGenaiRecitationRecitationResult", + "properties": { + "dynamicSegmentResults": { + "items": { + "$ref": "LearningGenaiRecitationSegmentResult" + }, + "type": "array" + }, + "recitationAction": { + "description": "The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK > CITE > NO_ACTION.", + "enum": [ + "ACTION_UNSPECIFIED", + "CITE", + "BLOCK", + "NO_ACTION", + "EXEMPT_FOUND_IN_PROMPT" + ], + "enumDescriptions": [ + "", + "indicate that attribution must be shown for a Segment", + "indicate that a Segment should be blocked from being used", + "for tagging high-frequency code snippets", + "The recitation was found in prompt and is exempted from overall results" + ], + "type": "string" + }, + "trainingSegmentResults": { + "items": { + "$ref": "LearningGenaiRecitationSegmentResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRecitationSegmentResult": { + "description": "The recitation result for each segment in a given input.", + "id": "LearningGenaiRecitationSegmentResult", + "properties": { + "attributionDataset": { + "description": "The dataset the segment came from.", + "enum": [ + "DATASET_UNSPECIFIED", + "WIKIPEDIA", + "WEBDOCS", + "WEBDOCS_FINETUNE", + "GITHUB_MIRROR", + "BOOKS_FULL_VIEW", + "BOOKS_PRIVATE", + "GNEWS", + "ULM_DOCJOINS", + "ULM_DOCJOINS_DEDUPED", + "MEENA_FC", + "PODCAST", + "AQUA", + "WEB_ASR", + "BARD_GOLDEN", + "COMMON_SENSE_REASONING", + "MATH", + "MATH_REASONING", + "CLEAN_ARXIV", + "LAMDA_FACTUALITY_E2E_QUERY_GENERATION", + "LAMDA_FACTUALITY_E2E_RESPONSE_GENERATION", + "MASSIVE_FORUM_THREAD_SCORED_BARD", + "MASSIVE_FORUM_THREAD_SCORED_LONG_200", + "MASSIVE_FORUM_THREAD_SCORED_LONG_500", + "DOCUMENT_CHUNKS", + "MEENA_RESEARCH_PHASE_GOLDEN_MARKDOWN", + "MEENA_RESEARCH_PHASE_GOOGLERS", + "MEENA_RESPONSE_SAFETY_HUMAN_GEN", + "MEENA_RESPONSE_SAFETY_SCHEMA_NO_BROADCAST", + "MEENA_RESPONSE_SAFETY_V3_HUMAN_GEN2", + "MEENA_RESPONSE_SAFETY_V3_SCHEMA_NO_BROADCAST", + "LAMDA_FACTUALITY_TRIGGER", + "LAMDA_SAFETY_V2_SCHEMA_NO_BROADCAST", + "LAMDA_SSI_DISCRIMINATIVE", + "ASSISTANT_PERSONALITY_SAFETY", + "PODCAST_FINETUNE_DIALOG", + "WORLD_QUERY_GENERATOR", + "C4_JOINED_DOCJOINS", + "HOL4_THEORIES", + "HOL_LIGHT_THEORIES", + "HOLSTEPS", + "ISABELLE_STEP", + "ISABELLE_THEORIES", + "LEAN_MATHLIB_THEORIES", + "LEAN_STEP", + "MIZAR_THEORIES", + "COQ_STEP", + "COQ_THEORIES", + "AMPS_KHAN", + "AMPS_MATHEMATICA", + "CODEY_CODE", + "CODE_QA_SE", + "CODE_QA_SO", + "CODE_QA_FT_FORMAT", + "CODE_QA_FT_KNOWLEDGE", + "CODE_QA_GITHUB_FILTERED_CODE", + "BARD_PERSONALITY_GOLDEN", + "ULM_DOCJOINS_WITH_URLS_EN", + "ULM_DOCJOINS_WITH_URLS_I18N", + "GOODALL_MTV5_GITHUB", + "GOODALL_MTV5_BOOKS", + "GOODALL_MTV5_C4", + "GOODALL_MTV5_WIKIPEDIA", + "GOODALL_MW_TOP_100B", + "GOODALL_MW_STACK_EXCHANGE", + "GOODALL_MW_TOP_0_10B", + "GOODALL_MW_TOP_10B_20B", + "CODEY_NOTEBOOK_LM_PRETRAINING", + "VERTEX_SAFE_FLAN", + "GITHUB_MIRROR_V1_0_1", + "GITHUB_MIRROR_V2_1_0", + "CMS_WIKIPEDIA_LANG_FILTERED", + "CMS_STACKOVERFLOW_MULTILINGUAL", + "CMS_STACKEXCHANGE", + "PUBMED", + "GEMINI_DOCJOINS_EN_TOP10B_GCC", + "GEMINI_DOCJOINS_EN_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_EN_TOP20B_TOP100B_GCC", + "GEMINI_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_I18N_TOP20B_TOP100B_GCC", + "SIMPLIFIED_HTML_V1_GCC", + "GEMINI_DOCJOINS_TOXICITY_TAGGED_GCC", + "CMS_GITHUB_V4", + "GITHUB_HTML_V4", + "GITHUB_OTHER_V4", + "GITHUB_LONG_TAIL_V4", + "CMS_GITHUB_MULTIFILE_V4", + "GITHUB_DIFFS_WITH_COMMIT_MESSAGE", + "ULM_ARXIV", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_ENONLY", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_NONENONLY", + "QUORA", + "PODCASTS_ROBOTSTXT", + "COMBINED_REDDIT", + "CANARIES_SHUFFLED", + "CLM_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "TECHDOCS_DATA_SOURCE", + "SCIENCE_PDF_70M_DOCS_FILTERED", + "GEMINI_V1_CMS_WIKIPEDIA_LANG_FILTERED", + "GEMINI_V1_WIKIPEDIA_DIFFS", + "GEMINI_V1_DOCJOINS_EN_TOP10B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP10B_TOP20B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP20B_TOP100B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_TOP20B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP20B_TOP100B_GCC_050523", + "GEMINI_V1_SIMPLIFIED_HTML_V2_GCC", + "GEMINI_V1_CMS_STACKOVERFLOW_MULTILINGUAL_V2", + "GEMINI_V1_CMS_STACKEXCHANGE_DECONT", + "GEMINI_V1_QUORA", + "GEMINI_V1_COMBINED_REDDIT", + "GEMINI_V1_DOCJOIN_100B_EN_TOXICITY_TAGGED_GCC_FIXED_TAGS", + "GEMINI_V1_PUBMED", + "GEMINI_V1_WEB_MATH_V2", + "GEMINI_V1_CMS_GITHUB_DECONTAMINATED_V_7", + "GEMINI_V1_GITHUB_DIFF_WITH_COMMIT_MESSAGE_V2", + "GEMINI_V1_GITHUB_HTML_CSS_XML_V4", + "GEMINI_V1_GITHUB_OTHER_V4", + "GEMINI_V1_GITHUB_LONG_TAIL_V4", + "GEMINI_V1_GITHUB_JUPTYER_NOTEBOOKS_SSTABLE", + "GEMINI_V1_ULM_ARXIV_SSTABLE", + "GEMINI_V1_PODCASTS_ROBOTSTXT", + "GEMINI_V1_SCIENCE_PDF_68M_HQ_DOCS_GCC", + "GEMINI_V1_GITHUB_TECHDOCS_V2", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_EN", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_NONEN", + "GEMINI_V1_STEM_BOOKS_650K_TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_M3W_V2_FILTERED", + "GEMINI_V1_VQCOCA_1B_MULTIRES_WEBLI_EN_V4_350M_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_SCREENAI_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CULTURE_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_EN_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_I18N_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_NON_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_VTP_4F_VIDEO2TEXT_PREFIX", + "GEMINI_V1_FORMAL_MATH_WITHOUT_HOLSTEPS_AND_MIZAR", + "GEMINI_V1_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "GEMINI_V1_CANARIES_SHUFFLED_DOCJOIN_EN_NONEN_CODE_ARXIV_TRANSLATE", + "DUET_CLOUD_SECURITY_DOCS", + "DUET_GITHUB_CODE_SNIPPETS", + "DUET_GITHUB_FILES", + "DUET_GOBYEXAMPLE", + "DUET_GOLANG_DOCS", + "DUET_CLOUD_DOCS_TROUBLESHOOTING_TABLES", + "DUET_DEVSITE_DOCS", + "DUET_CLOUD_BLOG_POSTS", + "DUET_CLOUD_PODCAST_EPISODES", + "DUET_YOUTUBE_VIDEOS", + "DUET_CLOUD_SKILLS_BOOST", + "DUET_CLOUD_DOCS", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_GENERATED", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_HANDWRITTEN", + "DUET_GOOGLESQL_GENERATION", + "DUET_CLOUD_IX_PROMPTS", + "DUET_RAD", + "BARD_ARCADE_GITHUB", + "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", + "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", + "GENESIS_NEWS_INSIGHTS", + "CLOUD_SECURITY_PRETRAINING", + "CLOUD_SECURITY_FINETUNING", + "LABS_AQA_DSCOUT", + "LABS_AQA_TAILWIND", + "LABS_AQA_DELEWARE", + "GEMINI_MULTIMODAL_FT_URL", + "GEMINI_MULTIMODAL_FT_YT", + "GEMINI_MULTIMODAL_FT_SHUTTERSTOCK", + "GEMINI_MULTIMODAL_FT_NONE", + "GEMINI_MULTIMODAL_FT_OTHER", + "GEMINI_MULTIMODAL_FT_INK", + "GEMINI_MULTIMODAL_IT", + "GEMINI_IT_SHUTTERSTOCK", + "GEMINI_IT_M3W", + "GEMINI_IT_HEDGING", + "GEMINI_IT_DSCOUT_FACTUALITY", + "GEMINI_IT_AQUAMUSE", + "GEMINI_IT_SHOTGUN", + "GEMINI_IT_ACI_BENCH", + "GEMINI_IT_SPIDER_FILTERED", + "GEMINI_IT_TAB_SUM_BQ", + "GEMINI_IT_QA_WITH_URL", + "GEMINI_IT_CODE_INSTRUCT", + "GEMINI_IT_MED_PALM", + "GEMINI_IT_TASK_ORIENTED_DIALOG", + "GEMINI_IT_NIMBUS_GROUNDING_TO_PROMPT", + "GEMINI_IT_EITL_GEN", + "GEMINI_IT_HITL_GEN", + "GEMINI_IT_MECH", + "GEMINI_IT_TABLE_GEN", + "GEMINI_IT_NIMBUS_DECIBEL", + "GEMIT_BRIDGE_SUFFIX_FT", + "GEMINI_IT_CLOUD_CODE_IF", + "GEMINI_IT_CLOUD_EUR_LEX_JSON", + "GEMINI_IT_CLOUD_OASST", + "GEMINI_IT_CLOUD_SELF_INSTRUCT", + "GEMINI_IT_CLOUD_UCS_AQUAMUSE", + "GEMINI_V2_CMS_WIKIPEDIA_LANG_FILTERED_GCC_PII", + "GEMINI_V2_WIKIPEDIA_DIFFS_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_QUORA_COMPLIANT", + "GEMINI_V2_FORUMS_V2_COMPLIANT", + "GEMINI_V2_CMS_STACKOVERFLOW_MULTILINGUAL_V2_COMPLIANT", + "GEMINI_V2_SIMPLIFIED_HTML_V2_CORRECT_FORMAT_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_TOXICITY_TAGGED_FIXED_TAGS_COMPLIANT", + "GEMINI_V2_CODEWEB_V1_COMPLIANT", + "GEMINI_V2_LEETCODE_GCC_PII", + "GEMINI_V2_CODE_CONTESTS_COMPLIANT", + "GEMINI_V2_CMS_GITHUB_MULTI_FILE_FOR_FIM_GEMBAGZ_FIXED_BYTES_LENGTHS", + "GEMINI_V2_GITHUB_EVALED_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_NON_EVAL_HIGH_PRI_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_LOW_PRI_LANGUAGES_AND_CONFIGS_COMPLIANT", + "GEMINI_V2_GITHUB_LONG_TAIL_AND_STRUCTURED_DATA_COMPLIANT", + "GEMINI_V2_GITHUB_PYTHON_NOTEBOOKS_COMPLIANT", + "GEMINI_V2_GITHUB_DIFFS_COMPLIANT", + "GEMINI_V2_GITHUB_TECHDOCS_COMPLIANT", + "GEMINI_V2_HIGH_QUALITY_CODE_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_SCIENCE_PDF_68M_HQ_DOCS_DEDUP_COMPLIANT_CLEAN_TEX", + "GEMINI_V2_ARXIV_2023_COMPLIANT", + "GEMINI_V2_FORMAL_COMPLIANT", + "GEMINI_V2_CMS_STACKEXCHANGE_COMPLIANT", + "GEMINI_V2_PUBMED_COMPLIANT", + "GEMINI_V2_WEB_MATH_V3_COMPLIANT", + "GEMINI_V2_SCIENCEWEB_V0_GCC_PII", + "GEMINI_V2_WEB_POLYMATH_V1_COMPLIANT", + "GEMINI_V2_MATH_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_BIOLOGY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_PHYSICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHEMISTRY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MACHINE_LEARNING_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_QA_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_ECONOMICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MEDICAL_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHESS_COMPLIANT", + "GEMINI_V2_YOUTUBE_SCIENCE_V4_FILTERED_COMPLIANT", + "GEMINI_V2_GOALDMINE_XL_GENERATED_PLUS_GT_NO_DM_MATH_COMPLIANT", + "GEMINI_V2_FIRSTTIMES_SCIENCE_PDF_DEDUP_HQ_LENGTH_FILTERED_COMPLIANT", + "GEMINI_V2_PODCASTS_COMPLIANT", + "GEMINI_V2_EN_NONSCIENCE_PDF_DEDUP_46M_DOCS_COMPLIANT", + "GEMINI_V2_NONPUB_COPYRIGHT_BOOKS_V3_70_CONF_082323_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_COPYRIGHT_BOOKS_V3_111823_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_BOOKS_318K_TEXT_COMPLIANT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_T2I_TEXT_TO_IMAGE_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_I18N_680M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_FULL_HTML_75M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_V1_1_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_DOC_240M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_VIDEO_VIDEO_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M4W_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CULTURE_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_DETECTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_ALT_TEXT_NONEN_500M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SPATIAL_AWARE_PALI_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_3D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_NON_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_3D_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CC3M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_INFOGRAPHICS_LARGE_WEB_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_BIORXIV_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PLOT2TABLE_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TIKZ_DERENDERING_MERGED_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_2D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WIKIPEDIA_EQUATIONS_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_EQ2LATEX_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_ARXIV_EQUATIONS_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_HEAD_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_CLM_TRANSLATE_DATAV3_WEB_UNWMT_INCR_MIX", + "GEMINI_V2_NTL_NTLV4A_MONOLINGUAL_DEDUP_N5", + "GEMINI_V2_NTL_STT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_TRANSLIT_BILEX_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_BT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_FT_FIXED_TRANSLATE_DEDUP_N5", + "GEMINI_V2_CANARIES_SHUFFLED_COMPLIANT" + ], + "enumDescriptions": [ + "", + "Wikipedia article Tensorflow datasets used by Tarzan and maintained by TFDS team.", + "Webdocs that have been filtered from the docjoins by the Tarzan team for use in the Tarzan training set.", + "", + "", + "'Full view' books dataset maintained by Oceanographers team, meaning 'ok to view the book in full in all localities'. Largely the same as 'public domain', but with potentially subtle distinction.", + "Filtered private books used by ULM: http://google3/learning/multipod/pax/lm/params/ulm/tasks.py;l=123;rcl=494241309. which corresponds with /cns/mf-d/home/multipod-language-data/private_books/books_filtered_en_resharded@50000", + "Google news dataset referenced in: http://google3/learning/brain/research/conversation/meena/t5/pretrain_tasks.py;l=922;rcl=496534668", + "The docjoins data for ULM /cns/yo-d/home/multipod-language-data/docjoins/rs=6.3/20220728/100B_docstructure_split/examples_en.tfrecord_lattice_05_score_01_HFV13@3929", + "", + "Meena full conversations. http://google3/learning/brain/research/conversation/meena/t5/pretrain_mixtures.py;l=675;rcl=496583228", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Academic dataset of math text. http://google3/learning/brain/research/conversation/meena/seqio/mixtures/experimental/bard.py;rcl=500222380", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Datasets managed by the Goodall team: deepmind-goodall@google.com", + "", + "", + "", + "", + "", + "", + "", + "Datasets used by Codepoet", + "Datasets used by Vertex", + "", + "", + "Datasets used by Gemini Public data", + "", + "", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "Arxiv", + "Others", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemini V1, order by precedence. Wikipedia", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "ArXiv", + "Citable misc", + "", + "", + "Non-public books", + "", + "", + "Other", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Duet AI finetune datasets, order by precedence.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Bard ARCADE finetune dataset", + "Mobile assistant finetune datasets.", + "", + "Genesis fine tuned datasets.", + "Cloud Security fine tuned datasets.", + "", + "LABS AQA fine-tune datasets.", + "", + "", + "Gemini multimodal instruction tune(IT) and fine tune(FT) datasets datasets.", + "", + "", + "", + "", + "", + "", + "Gemini IT 1.2.7 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemit Bridge ULM FT dataset", + "Gemini IT Cloud Build datasets.", + "", + "", + "", + "", + "Gemini V2 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "displayAttributionMessage": { + "description": "human-friendly string that contains information from doc_attribution which could be shown by clients", + "type": "string" + }, + "docAttribution": { + "$ref": "LearningGenaiRecitationDocAttribution", + "description": "populated when recitation_action == CITE" + }, + "docOccurrences": { + "description": "number of documents that contained this segment", + "format": "int32", + "type": "integer" + }, + "endIndex": { + "format": "int32", + "type": "integer" + }, + "rawText": { + "description": "The raw text in the given input that is corresponding to the segment. It will be available only when 'return_segment_raw_text' is enabled in the request options.", + "type": "string" + }, + "segmentRecitationAction": { + "enum": [ + "ACTION_UNSPECIFIED", + "CITE", + "BLOCK", + "NO_ACTION", + "EXEMPT_FOUND_IN_PROMPT" + ], + "enumDescriptions": [ + "", + "indicate that attribution must be shown for a Segment", + "indicate that a Segment should be blocked from being used", + "for tagging high-frequency code snippets", + "The recitation was found in prompt and is exempted from overall results" + ], + "type": "string" + }, + "startIndex": { + "description": "The segment boundary start (inclusive) and end index (exclusive) in the given text. In the streaming RPC, the indexes always start from the beginning of the first text in the entire stream. The indexes are measured in UTF-16 code units.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LearningGenaiRootCalculationType": { + "description": "The type used for final weights calculation.", + "id": "LearningGenaiRootCalculationType", + "properties": { + "scoreType": { + "enum": [ + "TYPE_UNKNOWN", + "TYPE_SAFE", + "TYPE_POLICY", + "TYPE_GENERATION" + ], + "enumDescriptions": [ + "Unknown scorer type.", + "Safety scorer.", + "Policy scorer.", + "Generation scorer." + ], + "type": "string" + }, + "weights": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootClassifierOutput": { + "id": "LearningGenaiRootClassifierOutput", + "properties": { + "ruleOutput": { + "$ref": "LearningGenaiRootRuleOutput", + "deprecated": true, + "description": "If set, this is the output of the first matching rule." + }, + "ruleOutputs": { + "description": "outputs of all matching rule.", + "items": { + "$ref": "LearningGenaiRootRuleOutput" + }, + "type": "array" + }, + "state": { + "$ref": "LearningGenaiRootClassifierState", + "description": "The results of data_providers and metrics." + } + }, + "type": "object" + }, + "LearningGenaiRootClassifierOutputSummary": { + "id": "LearningGenaiRootClassifierOutputSummary", + "properties": { + "metrics": { + "items": { + "$ref": "LearningGenaiRootMetricOutput" + }, + "type": "array" + }, + "ruleOutput": { + "$ref": "LearningGenaiRootRuleOutput", + "deprecated": true, + "description": "Output of the first matching rule." + }, + "ruleOutputs": { + "description": "outputs of all matching rule.", + "items": { + "$ref": "LearningGenaiRootRuleOutput" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootClassifierState": { + "description": "DataProviderOutput and MetricOutput can be saved between calls to the Classifier framework. For instance, you can run the query classifier, get outputs from those metrics, then use them in a result classifier as well. Example rule based on this idea: and_rules { rule { metric_name: 'query_safesearch_v2' ... } rule { metric_name: 'response_safesearch_v2' ... } }", + "id": "LearningGenaiRootClassifierState", + "properties": { + "dataProviderOutput": { + "items": { + "$ref": "LearningGenaiRootDataProviderOutput" + }, + "type": "array" + }, + "metricOutput": { + "items": { + "$ref": "LearningGenaiRootMetricOutput" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootDataProviderOutput": { + "id": "LearningGenaiRootDataProviderOutput", + "properties": { + "name": { + "type": "string" + }, + "status": { + "$ref": "UtilStatusProto", + "description": "If set, this DataProvider failed and this is the error message." + } + }, + "type": "object" + }, + "LearningGenaiRootFilterMetadata": { + "id": "LearningGenaiRootFilterMetadata", + "properties": { + "confidence": { + "description": "Filter confidence.", + "enum": [ + "FILTER_CONFIDENCE_UNKNOWN", + "FILTER_CONFIDENCE_VERY_LOW", + "FILTER_CONFIDENCE_LOW", + "FILTER_CONFIDENCE_MEDIUM", + "FILTER_CONFIDENCE_HIGH", + "FILTER_CONFIDENCE_VERY_HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "debugInfo": { + "$ref": "LearningGenaiRootFilterMetadataFilterDebugInfo", + "description": "Debug info for the message." + }, + "fallback": { + "description": "A fallback message chosen by the applied filter.", + "type": "string" + }, + "info": { + "description": "Additional info for the filter.", + "type": "string" + }, + "name": { + "description": "Name of the filter that triggered.", + "type": "string" + }, + "reason": { + "description": "Filter reason.", + "enum": [ + "FILTER_REASON_UNKNOWN", + "FILTER_REASON_NOT_FILTERED", + "FILTER_REASON_SENSITIVE", + "FILTER_REASON_RECITATION", + "FILTER_REASON_LANGUAGE", + "FILTER_REASON_TAKEDOWN", + "FILTER_REASON_CLASSIFIER", + "FILTER_REASON_EMPTY_RESPONSE", + "FILTER_REASON_SIMILARITY_TAKEDOWN", + "FILTER_REASON_UNSAFE", + "FILTER_REASON_PAIRWISE_CLASSIFIER", + "FILTER_REASON_CODEY", + "FILTER_REASON_URL", + "FILTER_REASON_EMAIL", + "FILTER_REASON_SAFETY_CAT", + "FILTER_REASON_REQUEST_RESPONSE_TAKEDOWN", + "FILTER_REASON_RAI_PQC", + "FILTER_REASON_ATLAS", + "FILTER_REASON_RAI_CSAM", + "FILTER_REASON_RAI_FRINGE", + "FILTER_REASON_RAI_SPII", + "FILTER_REASON_RAI_IMAGE_VIOLENCE", + "FILTER_REASON_RAI_IMAGE_PORN", + "FILTER_REASON_RAI_IMAGE_CSAM", + "FILTER_REASON_RAI_IMAGE_PEDO", + "FILTER_REASON_RAI_VIDEO_FRAME_VIOLENCE", + "FILTER_REASON_RAI_VIDEO_FRAME_PORN", + "FILTER_REASON_RAI_VIDEO_FRAME_CSAM", + "FILTER_REASON_RAI_VIDEO_FRAME_PEDO", + "FILTER_REASON_RAI_CONTEXTUAL_DANGEROUS", + "FILTER_REASON_RAI_GRAIL_TEXT", + "FILTER_REASON_RAI_GRAIL_IMAGE", + "FILTER_REASON_RAI_SAFETYCAT", + "FILTER_REASON_TOXICITY", + "FILTER_REASON_ATLAS_PRICING", + "FILTER_REASON_ATLAS_BILLING", + "FILTER_REASON_ATLAS_NON_ENGLISH_QUESTION", + "FILTER_REASON_ATLAS_NOT_RELATED_TO_GCP", + "FILTER_REASON_ATLAS_AWS_AZURE_RELATED" + ], + "enumDescriptions": [ + "Unknown filter reason.", + "Input not filtered.", + "Sensitive content.", + "Recited content.", + "Language filtering", + "Takedown policy", + "Classifier Module", + "Empty response message.", + "Similarity takedown.", + "Unsafe responses from scorers.", + "Pairwise classifier.", + "Codey Filter.", + "URLs Filter.", + "Emails Filter.", + "SafetyCat filter.", + "Request Response takedown.", + "RAI Filter.", + "Atlas specific topic filter", + "RAI Filter.", + "RAI Filter.", + "RAI Filter.", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "Grail Text", + "Grail Image", + "SafetyCat.", + "Toxic content.", + "Atlas specific topic filter for pricing questions.", + "Atlas specific topic filter for billing questions.", + "Atlas specific topic filter for non english questions.", + "Atlas specific topic filter for non GCP questions.", + "Atlas specific topic filter aws/azure related questions." + ], + "type": "string" + }, + "text": { + "description": "The input query or generated response that is getting filtered.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootFilterMetadataFilterDebugInfo": { + "id": "LearningGenaiRootFilterMetadataFilterDebugInfo", + "properties": { + "classifierOutput": { + "$ref": "LearningGenaiRootClassifierOutput" + }, + "defaultMetadata": { + "type": "string" + }, + "languageFilterResult": { + "$ref": "LearningGenaiRootLanguageFilterResult" + }, + "raiOutput": { + "$ref": "LearningGenaiRootRAIOutput", + "description": "Safety filter output information for LLM Root RAI harm check." + }, + "raiResult": { + "$ref": "CloudAiNlLlmProtoServiceRaiResult" + }, + "raiSignal": { + "$ref": "CloudAiNlLlmProtoServiceRaiSignal", + "deprecated": true + }, + "streamRecitationResult": { + "$ref": "LanguageLabsAidaTrustRecitationProtoStreamRecitationResult", + "deprecated": true + }, + "takedownResult": { + "$ref": "LearningGenaiRootTakedownResult" + }, + "toxicityResult": { + "$ref": "LearningGenaiRootToxicityResult" + } + }, + "type": "object" + }, + "LearningGenaiRootGroundingMetadata": { + "id": "LearningGenaiRootGroundingMetadata", + "properties": { + "citations": { + "items": { + "$ref": "LearningGenaiRootGroundingMetadataCitation" + }, + "type": "array" + }, + "groundingCancelled": { + "description": "True if grounding is cancelled, for example, no facts being retrieved.", + "type": "boolean" + }, + "searchQueries": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootGroundingMetadataCitation": { + "id": "LearningGenaiRootGroundingMetadataCitation", + "properties": { + "endIndex": { + "description": "Index in the prediction output where the citation ends (exclusive). Must be > start_index and < len(output).", + "format": "int32", + "type": "integer" + }, + "factIndex": { + "description": "Index of the fact supporting this claim. Should be within the range of the `world_facts` in the GenerateResponse.", + "format": "int32", + "type": "integer" + }, + "score": { + "description": "Confidence score of this entailment. Value is [0,1] with 1 is the most confidence.", + "format": "double", + "type": "number" + }, + "startIndex": { + "description": "Index in the prediction output where the citation starts (inclusive). Must be >= 0 and < end_index.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LearningGenaiRootHarm": { + "id": "LearningGenaiRootHarm", + "properties": { + "contextualDangerous": { + "description": "Please do not use, this is still under development.", + "type": "boolean" + }, + "csam": { + "type": "boolean" + }, + "fringe": { + "type": "boolean" + }, + "grailImageHarmType": { + "$ref": "LearningGenaiRootHarmGrailImageHarmType" + }, + "grailTextHarmType": { + "$ref": "LearningGenaiRootHarmGrailTextHarmType" + }, + "imageCsam": { + "type": "boolean" + }, + "imagePedo": { + "type": "boolean" + }, + "imagePorn": { + "description": "Image signals", + "type": "boolean" + }, + "imageViolence": { + "type": "boolean" + }, + "pqc": { + "type": "boolean" + }, + "safetycat": { + "$ref": "LearningGenaiRootHarmSafetyCatCategories" + }, + "spii": { + "$ref": "LearningGenaiRootHarmSpiiFilter" + }, + "threshold": { + "format": "double", + "type": "number" + }, + "videoFrameCsam": { + "type": "boolean" + }, + "videoFramePedo": { + "type": "boolean" + }, + "videoFramePorn": { + "description": "Video frame signals", + "type": "boolean" + }, + "videoFrameViolence": { + "type": "boolean" + } + }, + "type": "object" + }, + "LearningGenaiRootHarmGrailImageHarmType": { + "description": "Harm type for images", + "id": "LearningGenaiRootHarmGrailImageHarmType", + "properties": { + "imageHarmType": { + "items": { + "enum": [ + "IMAGE_HARM_TYPE_UNSPECIFIED", + "IMAGE_HARM_TYPE_PORN", + "IMAGE_HARM_TYPE_VIOLENCE", + "IMAGE_HARM_TYPE_CSAI", + "IMAGE_HARM_TYPE_PEDO", + "IMAGE_HARM_TYPE_MINORS", + "IMAGE_HARM_TYPE_DANGEROUS", + "IMAGE_HARM_TYPE_MEDICAL", + "IMAGE_HARM_TYPE_RACY", + "IMAGE_HARM_TYPE_OBSCENE", + "IMAGE_HARM_TYPE_MINOR_PRESENCE", + "IMAGE_HARM_TYPE_GENERATIVE_MINOR_PRESENCE", + "IMAGE_HARM_TYPE_GENERATIVE_REALISTIC_VISIBLE_FACE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootHarmGrailTextHarmType": { + "description": "Harm type for text", + "id": "LearningGenaiRootHarmGrailTextHarmType", + "properties": { + "harmType": { + "items": { + "enum": [ + "HARM_TYPE_UNSPECIFIED", + "HARM_TYPE_HATE", + "HARM_TYPE_TOXICITY", + "HARM_TYPE_VIOLENCE", + "HARM_TYPE_CSAI", + "HARM_TYPE_SEXUAL", + "HARM_TYPE_FRINGE", + "HARM_TYPE_POLITICAL", + "HARM_TYPE_MEMORIZATION", + "HARM_TYPE_SPII", + "HARM_TYPE_NEW_DANGEROUS", + "HARM_TYPE_MEDICAL", + "HARM_TYPE_HARASSMENT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "New definition of dangerous.", + "", + "" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootHarmSafetyCatCategories": { + "id": "LearningGenaiRootHarmSafetyCatCategories", + "properties": { + "categories": { + "items": { + "enum": [ + "SAFETYCAT_CATEGORY_UNSPECIFIED", + "TOXICITY", + "OBSCENE", + "SEXUAL", + "INSULT", + "IDENTITY_HATE", + "DEATH_HARM_TRAGEDY", + "VIOLENCE_ABUSE", + "FIREARMS_WEAPONS", + "PUBLIC_SAFETY", + "HEALTH", + "RELIGION_BELIEF", + "DRUGS", + "WAR_CONFLICT", + "POLITICS", + "FINANCE", + "LEGAL", + "DANGEROUS", + "DANGEROUS_SEVERITY", + "HARASSMENT_SEVERITY", + "HATE_SEVERITY", + "SEXUAL_SEVERITY" + ], + "enumDescriptions": [ + "", + "SafetyCat categories.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Following categories are only supported in SAFETY_CAT_TEXT_V3_PAX model", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootHarmSpiiFilter": { + "id": "LearningGenaiRootHarmSpiiFilter", + "properties": { + "usBankRoutingMicr": { + "type": "boolean" + }, + "usEmployerIdentificationNumber": { + "type": "boolean" + }, + "usSocialSecurityNumber": { + "type": "boolean" + } + }, + "type": "object" + }, + "LearningGenaiRootInternalMetadata": { + "id": "LearningGenaiRootInternalMetadata", + "properties": { + "scoredTokens": { + "items": { + "$ref": "LearningGenaiRootScoredToken" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootLanguageFilterResult": { + "id": "LearningGenaiRootLanguageFilterResult", + "properties": { + "allowed": { + "description": "False when query or response should be filtered out due to unsupported language.", + "type": "boolean" + }, + "detectedLanguage": { + "description": "Language of the query or response.", + "type": "string" + }, + "detectedLanguageProbability": { + "description": "Probability of the language predicted as returned by LangID.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootMetricOutput": { + "id": "LearningGenaiRootMetricOutput", + "properties": { + "debug": { + "type": "string" + }, + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "numericValue": { + "format": "double", + "type": "number" + }, + "status": { + "$ref": "UtilStatusProto" + }, + "stringValue": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRAIOutput": { + "description": "This is per harm.", + "id": "LearningGenaiRootRAIOutput", + "properties": { + "allowed": { + "type": "boolean" + }, + "harm": { + "$ref": "LearningGenaiRootHarm" + }, + "name": { + "type": "string" + }, + "score": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootRegexTakedownResult": { + "id": "LearningGenaiRootRegexTakedownResult", + "properties": { + "allowed": { + "description": "False when query or response should be taken down due to match with a blocked regex, true otherwise.", + "type": "boolean" + }, + "takedownRegex": { + "description": "Regex used to decide that query or response should be taken down. Empty when query or response is kept.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRequestResponseTakedownResult": { + "id": "LearningGenaiRootRequestResponseTakedownResult", + "properties": { + "allowed": { + "description": "False when response has to be taken down per above config.", + "type": "boolean" + }, + "requestTakedownRegex": { + "description": "Regex used to match the request.", + "type": "string" + }, + "responseTakedownRegex": { + "description": "Regex used to decide that response should be taken down. Empty when response is kept.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecision": { + "description": "Holds the final routing decision, by storing the model_config_id. And individual scores each model got.", + "id": "LearningGenaiRootRoutingDecision", + "properties": { + "metadata": { + "$ref": "LearningGenaiRootRoutingDecisionMetadata" + }, + "modelConfigId": { + "description": "The selected model to route traffic to.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecisionMetadata": { + "description": "Debug metadata about the routing decision.", + "id": "LearningGenaiRootRoutingDecisionMetadata", + "properties": { + "scoreBasedRoutingMetadata": { + "$ref": "LearningGenaiRootRoutingDecisionMetadataScoreBased" + }, + "tokenLengthBasedRoutingMetadata": { + "$ref": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBased" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecisionMetadataScoreBased": { + "description": "If we are routing using scored based configuration, then the metadata about that is available in this proto.", + "id": "LearningGenaiRootRoutingDecisionMetadataScoreBased", + "properties": { + "matchedRule": { + "$ref": "LearningGenaiRootScoreBasedRoutingConfigRule", + "description": "The rule that was matched." + }, + "score": { + "$ref": "LearningGenaiRootScore", + "description": "The score that was generated by the router i.e. the model." + }, + "usedDefaultFallback": { + "description": "No rules were matched & therefore used the default fallback.", + "type": "boolean" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecisionMetadataTokenLengthBased": { + "id": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBased", + "properties": { + "modelInputTokenMetadata": { + "items": { + "$ref": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelInputTokenMetadata" + }, + "type": "array" + }, + "modelMaxTokenMetadata": { + "items": { + "$ref": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelMaxTokenMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelInputTokenMetadata": { + "id": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelInputTokenMetadata", + "properties": { + "computedInputTokenLength": { + "description": "The length computed by backends using the formatter & tokenizer specific to the model", + "format": "int32", + "type": "integer" + }, + "modelId": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelMaxTokenMetadata": { + "id": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelMaxTokenMetadata", + "properties": { + "maxNumInputTokens": { + "format": "int32", + "type": "integer" + }, + "maxNumOutputTokens": { + "format": "int32", + "type": "integer" + }, + "modelId": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRuleOutput": { + "id": "LearningGenaiRootRuleOutput", + "properties": { + "decision": { + "enum": [ + "NO_MATCH", + "MATCH" + ], + "enumDescriptions": [ + "This rule was not matched. When used in a ClassifierOutput, this means that no rules were matched.", + "This is a generic \"match\" message, indicating that a rule was triggered. Usually you would use this for a categorization classifier." + ], + "type": "string" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootScore": { + "id": "LearningGenaiRootScore", + "properties": { + "calculationType": { + "$ref": "LearningGenaiRootCalculationType" + }, + "internalMetadata": { + "$ref": "LearningGenaiRootInternalMetadata", + "description": "The internal_metadata is intended to be used by internal processors and will be cleared before returns." + }, + "thresholdType": { + "$ref": "LearningGenaiRootThresholdType" + }, + "tokensAndLogprobPerDecodingStep": { + "$ref": "LearningGenaiRootTokensAndLogProbPerDecodingStep", + "description": "Top candidate tokens and log probabilities at each decoding step." + }, + "value": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootScoreBasedRoutingConfigRule": { + "id": "LearningGenaiRootScoreBasedRoutingConfigRule", + "properties": { + "equalOrGreaterThan": { + "$ref": "LearningGenaiRootScore", + "description": "NOTE: Hardest examples have smaller values in their routing scores." + }, + "lessThan": { + "$ref": "LearningGenaiRootScore" + }, + "modelConfigId": { + "description": "This model_config_id points to ModelConfig::id which allows us to find the ModelConfig to route to. This is part of the banks specified in the ModelBankConfig.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootScoredSimilarityTakedownPhrase": { + "description": "Proto containing the results from the Universal Sentence Encoder / Other models", + "id": "LearningGenaiRootScoredSimilarityTakedownPhrase", + "properties": { + "phrase": { + "$ref": "LearningGenaiRootSimilarityTakedownPhrase" + }, + "similarityScore": { + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootScoredToken": { + "description": "A token with its own score.", + "id": "LearningGenaiRootScoredToken", + "properties": { + "endTokenScore": { + "description": "Each end_token_score is a logprob for how well the completion would end at a particular token. See http://google3/labs/language/aida/config/proto/model_config.proto;l=376;rcl=573039459", + "format": "float", + "type": "number" + }, + "score": { + "description": "Each score is the logprob for the token in model response.", + "format": "float", + "type": "number" + }, + "token": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootSimilarityTakedownPhrase": { + "description": "Each SimilarityTakedownPhrase treats a logical group of blocked and allowed phrases together along with a corresponding punt If the closest matching response is of the allowed type, we allow the response If the closest matching response is of the blocked type, we block the response. eg: Blocked phrase - \"All lives matter\"", + "id": "LearningGenaiRootSimilarityTakedownPhrase", + "properties": { + "blockedPhrase": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootSimilarityTakedownResult": { + "id": "LearningGenaiRootSimilarityTakedownResult", + "properties": { + "allowed": { + "description": "False when query or response should be taken down by any of the takedown rules, true otherwise.", + "type": "boolean" + }, + "scoredPhrases": { + "description": "List of similar phrases with score. Set only if allowed=false.", + "items": { + "$ref": "LearningGenaiRootScoredSimilarityTakedownPhrase" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootTakedownResult": { + "id": "LearningGenaiRootTakedownResult", + "properties": { + "allowed": { + "description": "False when query or response should be taken down by any of the takedown rules, true otherwise.", + "type": "boolean" + }, + "regexTakedownResult": { + "$ref": "LearningGenaiRootRegexTakedownResult" + }, + "requestResponseTakedownResult": { + "$ref": "LearningGenaiRootRequestResponseTakedownResult" + }, + "similarityTakedownResult": { + "$ref": "LearningGenaiRootSimilarityTakedownResult" + } + }, + "type": "object" + }, + "LearningGenaiRootThresholdType": { + "description": "The type of score that bundled with a threshold, and will not be attending the final score calculation. How each score type uses the threshold can be implementation details.", + "id": "LearningGenaiRootThresholdType", + "properties": { + "scoreType": { + "enum": [ + "TYPE_UNKNOWN", + "TYPE_SAFE", + "TYPE_POLICY", + "TYPE_GENERATION" + ], + "enumDescriptions": [ + "Unknown scorer type.", + "Safety scorer.", + "Policy scorer.", + "Generation scorer." + ], + "type": "string" + }, + "threshold": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootTokensAndLogProbPerDecodingStep": { + "description": "Results of RandomSamplingParams::top_k_logprob_per_decoding_step.", + "id": "LearningGenaiRootTokensAndLogProbPerDecodingStep", + "properties": { + "chosenCandidates": { + "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.", + "items": { + "$ref": "LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate" + }, + "type": "array" + }, + "topCandidates": { + "description": "Length = total number of decoding steps.", + "items": { + "$ref": "LearningGenaiRootTokensAndLogProbPerDecodingStepTopCandidates" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate": { + "description": "A candidate at a decoding step.", + "id": "LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate", + "properties": { + "logProbability": { + "description": "The candidate's log probability.", + "format": "float", + "type": "number" + }, + "token": { + "description": "The candidate’s token value.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootTokensAndLogProbPerDecodingStepTopCandidates": { + "description": "Candidates with top log probabilities at each decoding step.", + "id": "LearningGenaiRootTokensAndLogProbPerDecodingStepTopCandidates", + "properties": { + "candidates": { + "description": "Sorted by log probability in descending order.", + "items": { + "$ref": "LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootToxicityResult": { + "description": "A model can generate multiple signals and this captures all the generated signals for a single message.", + "id": "LearningGenaiRootToxicityResult", + "properties": { + "signals": { + "items": { + "$ref": "LearningGenaiRootToxicitySignal" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootToxicitySignal": { + "description": "Proto to capture a signal generated by the toxicity model.", + "id": "LearningGenaiRootToxicitySignal", + "properties": { + "allowed": { + "type": "boolean" + }, + "label": { + "enum": [ + "LABEL_UNSPECIFIED", + "NOT_SENSITIVE", + "SENSITIVE", + "ACCIDENTS_DISASTERS", + "ADULT", + "COMPUTER_SECURITY", + "CONTROVERSIAL_SOCIAL_ISSUES", + "DEATH_TRAGEDY", + "DRUGS", + "IDENTITY_ETHNICITY", + "FINANCIAL_HARDSHIP", + "FIREARMS_WEAPONS", + "HEALTH", + "INSULT", + "LEGAL", + "MENTAL_HEALTH", + "POLITICS", + "RELIGION_BELIEFS", + "SAFETY", + "SELF_HARM", + "SPECIAL_NEEDS", + "TERRORISM", + "TOXIC", + "TROUBLED_RELATIONSHIP", + "VIOLENCE_ABUSE", + "VULGAR", + "WAR_CONFLICT" + ], + "enumDescriptions": [ + "Default label.", + "Input is not sensitive.", + "Input is sensitive.", + "Input is related to accidents or disasters.", + "Input contains adult content.", + "Input is related to computer security.", + "Input contains controversial social issues.", + "Input is related to death tragedy.", + "Input is related to drugs.", + "Input is related to identity or ethnicity.", + "Input is related to financial hardship.", + "Input is related to firearms or weapons.", + "Input contains health related information.", + "Input may be an insult.", + "Input is related to legal content.", + "Input contains mental health related information.", + "Input is related to politics.", + "Input is related to religions or beliefs.", + "Input is related to safety.", + "Input is related to self-harm.", + "Input is related to special needs.", + "Input is related to terrorism.", + "Input is toxic.", + "Input is related to troubled relationships.", + "Input contains content about violence or abuse.", + "Input is vulgar.", + "Input is related to war and conflict." + ], + "type": "string" + }, + "score": { + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "LearningServingLlmMessageMetadata": { + "description": "LINT.IfChange This metadata contains additional information required for debugging.", + "id": "LearningServingLlmMessageMetadata", + "properties": { + "classifierSummary": { + "$ref": "LearningGenaiRootClassifierOutputSummary", + "description": "Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not." + }, + "currentStreamTextLength": { + "format": "uint32", + "type": "integer" + }, + "deleted": { + "description": "Whether the corresponding message has been deleted.", + "type": "boolean" + }, + "filterMeta": { + "description": "Metadata for filters that triggered.", + "items": { + "$ref": "LearningGenaiRootFilterMetadata" + }, + "type": "array" + }, + "finalMessageScore": { + "$ref": "LearningGenaiRootScore", + "description": "This score is finally used for ranking the message. This will be same as the score present in `Message.score` field." + }, + "finishReason": { + "description": "NOT YET IMPLEMENTED.", + "enum": [ + "UNSPECIFIED", + "RETURN", + "STOP", + "MAX_TOKENS", + "FILTER" + ], + "enumDescriptions": [ + "", + "Return all the tokens back. This typically implies no filtering or stop sequence was triggered.", + "Finished due to provided stop sequence.", + "Model has emitted the maximum number of tokens as specified by max_decoding_steps.", + "Finished due to triggering some post-processing filter." + ], + "type": "string" + }, + "groundingMetadata": { + "$ref": "LearningGenaiRootGroundingMetadata" + }, + "isFallback": { + "description": "Applies to Response message only. Indicates whether the message is a fallback and the response would have otherwise been empty.", + "type": "boolean" + }, + "langidResult": { + "$ref": "NlpSaftLangIdResult", + "description": "Result from nlp_saft DetectLanguage method. Currently the predicted language code and language probability is used." + }, + "language": { + "description": "Detected language.", + "type": "string" + }, + "lmPrefix": { + "description": "The LM prefix used to generate this response.", + "type": "string" + }, + "originalText": { + "description": "The original text generated by LLM. This is the raw output for debugging purposes.", + "type": "string" + }, + "perStreamDecodedTokenCount": { + "description": "NOT YET IMPLEMENTED. Applies to streaming only. Number of tokens decoded / emitted by the model as part of this stream. This may be different from token_count, which contains number of tokens returned in this response after any response rewriting / truncation.", + "format": "int32", + "type": "integer" + }, + "raiOutputs": { + "description": "Results of running RAI on the query or this response candidate. One output per rai_config. It will be populated regardless of whether the threshold is exceeded or not.", + "items": { + "$ref": "LearningGenaiRootRAIOutput" + }, + "type": "array" + }, + "recitationResult": { + "$ref": "LearningGenaiRecitationRecitationResult", + "description": "Recitation Results. It will be populated as long as Recitation processing is enabled, regardless of recitation outcome." + }, + "returnTokenCount": { + "description": "NOT YET IMPLEMENTED. Number of tokens returned as part of this candidate.", + "format": "int32", + "type": "integer" + }, + "scores": { + "description": "All the different scores for a message are logged here.", + "items": { + "$ref": "LearningGenaiRootScore" + }, + "type": "array" + }, + "streamTerminated": { + "description": "Whether the response is terminated during streaming return. Only used for streaming requests.", + "type": "boolean" + }, + "totalDecodedTokenCount": { + "description": "NOT YET IMPLEMENTED. Aggregated number of total tokens decoded so far. For streaming, this is sum of all the tokens decoded so far i.e. aggregated count.", + "format": "int32", + "type": "integer" + }, + "translatedUserPrompts": { + "description": "Translated user-prompt used for RAI post processing. This is for internal processing only. We will translate in pre-processor and pass the translated text to the post processor using this field. It will be empty if non of the signals requested need translation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "vertexRaiResult": { + "$ref": "CloudAiNlLlmProtoServiceRaiResult", + "description": "The metadata from Vertex SafetyCat processors" + } + }, + "type": "object" + }, + "NlpSaftLangIdLocalesResult": { + "id": "NlpSaftLangIdLocalesResult", + "properties": { + "predictions": { + "description": "List of locales in which the text would be considered acceptable. Sorted in descending order according to each locale's respective likelihood. For example, if a Portuguese text is acceptable in both Brazil and Portugal, but is more strongly associated with Brazil, then the predictions would be [\"pt-BR\", \"pt-PT\"], in that order. May be empty, indicating that the model did not predict any acceptable locales.", + "items": { + "$ref": "NlpSaftLangIdLocalesResultLocale" + }, + "type": "array" + } + }, + "type": "object" + }, + "NlpSaftLangIdLocalesResultLocale": { + "id": "NlpSaftLangIdLocalesResultLocale", + "properties": { + "languageCode": { + "description": "A BCP 47 language code that includes region information. For example, \"pt-BR\" or \"pt-PT\". This field will always be populated.", + "type": "string" + } + }, + "type": "object" + }, + "NlpSaftLangIdResult": { + "id": "NlpSaftLangIdResult", + "properties": { + "modelVersion": { + "description": "The version of the model used to create these annotations.", + "enum": [ + "VERSION_UNSPECIFIED", + "INDEXING_20181017", + "INDEXING_20191206", + "INDEXING_20200313", + "INDEXING_20210618", + "STANDARD_20220516" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "predictions": { + "description": "This field stores the n-best list of possible BCP 47 language code strings for a given input sorted in descending order according to each code's respective probability.", + "items": { + "$ref": "NlpSaftLanguageSpan" + }, + "type": "array" + }, + "spanPredictions": { + "description": "This field stores language predictions of subspans of the input, when available. Each LanguageSpanSequence is a sequence of LanguageSpans. A particular sequence of LanguageSpans has an associated probability, and need not necessarily cover the entire input. If no language could be predicted for any span, then this field may be empty.", + "items": { + "$ref": "NlpSaftLanguageSpanSequence" + }, + "type": "array" + } + }, + "type": "object" + }, + "NlpSaftLanguageSpan": { + "id": "NlpSaftLanguageSpan", + "properties": { + "end": { + "format": "int32", + "type": "integer" + }, + "languageCode": { + "description": "A BCP 47 language code for this span.", + "type": "string" + }, + "locales": { + "$ref": "NlpSaftLangIdLocalesResult", + "description": "Optional field containing any information that was predicted about the specific locale(s) of the span." + }, + "probability": { + "description": "A probability associated with this prediction.", + "format": "float", + "type": "number" + }, + "start": { + "description": "Start and end byte offsets, inclusive, within the given input string. A value of -1 implies that this field is not set. Both fields must either be set with a nonnegative value or both are unset. If both are unset then this LanguageSpan applies to the entire input.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "NlpSaftLanguageSpanSequence": { + "id": "NlpSaftLanguageSpanSequence", + "properties": { + "languageSpans": { + "description": "A sequence of LanguageSpan objects, each assigning a language to a subspan of the input.", + "items": { + "$ref": "NlpSaftLanguageSpan" + }, + "type": "array" + }, + "probability": { + "description": "The probability of this sequence of LanguageSpans.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "Proto2BridgeMessageSet": { + "description": "This is proto2's version of MessageSet.", + "id": "Proto2BridgeMessageSet", + "properties": {}, + "type": "object" + }, + "UtilStatusProto": { + "description": "Wire-format for a Status object", + "id": "UtilStatusProto", + "properties": { + "canonicalCode": { + "description": "The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be.", + "format": "int32", + "type": "integer" + }, + "code": { + "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto", + "format": "int32", + "type": "integer" + }, + "message": { + "description": "Detail message", + "type": "string" + }, + "messageSet": { + "$ref": "Proto2BridgeMessageSet", + "description": "message_set associates an arbitrary proto message with the status." + }, + "space": { + "description": "The following are usually only present when code != 0 Space to which this status belongs", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index 72980dfe33..77f23cd3ed 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -20,29 +20,29 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { + "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", "location": "asia-east1", - "description": "Locational Endpoint", - "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { + "description": "Locational Endpoint", "location": "asia-east2", - "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", + "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", "location": "asia-northeast1", - "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { - "location": "asia-northeast2", "description": "Locational Endpoint", - "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", + "location": "asia-northeast2" }, { + "description": "Locational Endpoint", "location": "asia-northeast3", - "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/" }, { "location": "asia-south1", @@ -55,9 +55,9 @@ "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "asia-southeast2", - "description": "Locational Endpoint" + "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", @@ -65,9 +65,9 @@ "location": "australia-southeast1" }, { - "description": "Locational Endpoint", + "location": "australia-southeast2", "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", - "location": "australia-southeast2" + "description": "Locational Endpoint" }, { "location": "europe-central2", @@ -75,89 +75,89 @@ "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "location": "europe-north1", - "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/" }, { "location": "europe-southwest1", - "description": "Locational Endpoint", - "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { - "location": "europe-west1", "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", + "location": "europe-west1", "description": "Locational Endpoint" }, { + "description": "Locational Endpoint", "location": "europe-west2", - "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", - "location": "europe-west3", - "description": "Locational Endpoint" + "location": "europe-west3" }, { "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", - "location": "europe-west4", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "europe-west4" }, { - "location": "europe-west6", + "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" + "location": "europe-west6" }, { + "location": "europe-west8", "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "europe-west8" + "description": "Locational Endpoint" }, { + "location": "europe-west9", "description": "Locational Endpoint", - "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "location": "europe-west9" + "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/" }, { - "location": "me-west1", "description": "Locational Endpoint", + "location": "me-west1", "endpointUrl": "https://me-west1-aiplatform.googleapis.com/" }, { - "location": "northamerica-northeast1", "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "northamerica-northeast1" }, { "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "northamerica-northeast2" + "location": "northamerica-northeast2", + "description": "Locational Endpoint" }, { - "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "southamerica-east1", - "description": "Locational Endpoint" + "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", + "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", "location": "southamerica-west1", - "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "location": "us-central1", + "description": "Locational Endpoint", "endpointUrl": "https://us-central1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "location": "us-central2", + "description": "Locational Endpoint", "endpointUrl": "https://us-central2-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", - "location": "us-east1" + "location": "us-east1", + "description": "Locational Endpoint" }, { "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", @@ -166,28 +166,28 @@ }, { "description": "Locational Endpoint", - "location": "us-south1", - "endpointUrl": "https://us-south1-aiplatform.googleapis.com/" + "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", + "location": "us-south1" }, { "description": "Locational Endpoint", - "location": "us-west1", - "endpointUrl": "https://us-west1-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", + "location": "us-west1" }, { - "description": "Locational Endpoint", "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", - "location": "us-west2" + "location": "us-west2", + "description": "Locational Endpoint" }, { - "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "us-west3", - "description": "Locational Endpoint" + "endpointUrl": "https://us-west3-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "us-west4", - "description": "Locational Endpoint" + "endpointUrl": "https://us-west4-aiplatform.googleapis.com/" } ], "fullyEncodeReservedExpansion": true, @@ -5072,7 +5072,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}'`", + "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -8753,6 +8753,159 @@ "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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } }, "contexts": { @@ -9072,6 +9225,159 @@ "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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } }, "executions": { @@ -9330,6 +9636,159 @@ "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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } }, "metadataSchemas": { @@ -9434,6 +9893,157 @@ ] } } + }, + "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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -12488,6 +13098,11 @@ "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" + }, + "preflightValidations": { + "description": "Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines.", + "location": "query", + "type": "boolean" } }, "path": "v1beta1/{+parent}/pipelineJobs", @@ -12965,6 +13580,161 @@ } } }, + "reasoningEngines": { + "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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "schedules": { "methods": { "create": { @@ -16514,7 +17284,7 @@ } } }, - "revision": "20231218", + "revision": "20240125", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -16915,6 +17685,10 @@ ], "type": "string" }, + "groundingMetadata": { + "$ref": "LearningGenaiRootGroundingMetadata", + "description": "Grounding metadata. Combine with the facts list from response to generate grounding citations for this choice." + }, "index": { "description": "Index of the candidate.", "format": "int32", @@ -16995,6 +17769,29 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServiceFact": { + "description": "A condense version of WorldFact (assistant/boq/lamda/factuality/proto/factuality.proto) to propagate the essential information about the fact used in factuality to the upstream caller.", + "id": "CloudAiNlLlmProtoServiceFact", + "properties": { + "query": { + "description": "Query that is used to retrieve this fact.", + "type": "string" + }, + "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" + }, + "url": { + "description": "If present, this URL links to the webpage of the fact.", + "type": "string" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServiceFunctionCall": { "description": "Function call details.", "id": "CloudAiNlLlmProtoServiceFunctionCall", @@ -17043,6 +17840,17 @@ }, "type": "array" }, + "debugMetadata": { + "$ref": "CloudAiNlLlmProtoServiceMessageMetadata", + "description": "Debug information containing message metadata. Clients should not consume this field, and this is only populated for Flow Runner path." + }, + "facts": { + "description": "External facts retrieved for factuality/grounding.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceFact" + }, + "type": "array" + }, "promptFeedback": { "$ref": "CloudAiNlLlmProtoServicePromptFeedback", "description": "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." @@ -17058,6 +17866,27 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServiceMessageMetadata": { + "id": "CloudAiNlLlmProtoServiceMessageMetadata", + "properties": { + "inputFilterInfo": { + "$ref": "LearningServingLlmMessageMetadata", + "description": "Filter metadata of the input messages." + }, + "modelRoutingDecision": { + "$ref": "LearningGenaiRootRoutingDecision", + "description": "This score is generated by the router model to decide which model to use" + }, + "outputFilterInfo": { + "description": "Filter metadata of the output messages.", + "items": { + "$ref": "LearningServingLlmMessageMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServicePart": { "description": "A single part of a message.", "id": "CloudAiNlLlmProtoServicePart", @@ -17133,6 +17962,10 @@ "format": "google-duration", "type": "string" }, + "modelLevelMetaData": { + "$ref": "CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata", + "description": "Internal only model level metadata." + }, "startOffset": { "description": "The start offset of the video.", "format": "google-duration", @@ -17141,6 +17974,23 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata": { + "description": "Internal only fields", + "id": "CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata", + "properties": { + "fps": { + "description": "Frame rate to decode from this video.", + "format": "float", + "type": "number" + }, + "numFrames": { + "description": "Number of frames to decode from this video.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServicePromptFeedback": { "description": "Content filter results for a prompt sent in the request.", "id": "CloudAiNlLlmProtoServicePromptFeedback", @@ -17173,6 +18023,171 @@ }, "type": "object" }, + "CloudAiNlLlmProtoServiceRaiResult": { + "description": "The RAI results for a given text.", + "id": "CloudAiNlLlmProtoServiceRaiResult", + "properties": { + "aidaRecitationResult": { + "$ref": "LanguageLabsAidaTrustRecitationProtoRecitationResult", + "description": "Recitation result from Aida recitation checker." + }, + "blocked": { + "deprecated": true, + "description": "Use `triggered_blocklist`.", + "type": "boolean" + }, + "errorCodes": { + "description": "The error codes indicate which RAI filters block the response.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "filtered": { + "description": "Whether the text should be filtered and not shown to the end user. This is determined based on a combination of `triggered_recitation`, `triggered_blocklist`, `language_filter_result`, and `triggered_safety_filter`.", + "type": "boolean" + }, + "languageFilterResult": { + "$ref": "LearningGenaiRootLanguageFilterResult", + "description": "Language filter result from SAFT LangId." + }, + "raiSignals": { + "description": "The RAI signals for the text.", + "items": { + "$ref": "CloudAiNlLlmProtoServiceRaiSignal" + }, + "type": "array" + }, + "triggeredBlocklist": { + "description": "Whether the text triggered the blocklist.", + "type": "boolean" + }, + "triggeredRecitation": { + "description": "Whether the text should be blocked by the recitation result from Aida recitation checker. It is determined from aida_recitation_result.", + "type": "boolean" + }, + "triggeredSafetyFilter": { + "description": "Whether the text triggered the safety filter. Currently, this is due to CSAI triggering or one of four categories (derogatory, sexual, toxic, violent) having a score over the filter threshold.", + "type": "boolean" + } + }, + "type": "object" + }, + "CloudAiNlLlmProtoServiceRaiSignal": { + "description": "An RAI signal for a single category.", + "id": "CloudAiNlLlmProtoServiceRaiSignal", + "properties": { + "confidence": { + "description": "The confidence level for the RAI category.", + "enum": [ + "CONFIDENCE_UNSPECIFIED", + "CONFIDENCE_NONE", + "CONFIDENCE_LOW", + "CONFIDENCE_MEDIUM", + "CONFIDENCE_HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "flagged": { + "description": "Whether the category is flagged as being present. Currently, this is set to true if score >= 0.5.", + "type": "boolean" + }, + "raiCategory": { + "description": "The RAI category.", + "enum": [ + "RAI_CATEGORY_UNSPECIFIED", + "TOXIC", + "SEXUALLY_EXPLICIT", + "HATE_SPEECH", + "VIOLENT", + "PROFANITY", + "HARASSMENT", + "DEATH_HARM_TRAGEDY", + "FIREARMS_WEAPONS", + "PUBLIC_SAFETY", + "HEALTH", + "RELIGIOUS_BELIEF", + "ILLICIT_DRUGS", + "WAR_CONFLICT", + "POLITICS", + "FINANCE", + "LEGAL", + "CSAI", + "FRINGE", + "THREAT", + "SEVERE_TOXICITY", + "TOXICITY", + "SEXUAL", + "INSULT", + "DEROGATORY", + "IDENTITY_ATTACK", + "VIOLENCE_ABUSE", + "OBSCENE", + "DRUGS", + "CSAM", + "SPII", + "DANGEROUS_CONTENT", + "DANGEROUS_CONTENT_SEVERITY", + "INSULT_SEVERITY", + "DEROGATORY_SEVERITY", + "SEXUAL_SEVERITY" + ], + "enumDescriptions": [ + "", + "SafetyCat categories.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "GRAIL categories that can't be exposed to end users.", + "", + "Unused categories.", + "", + "Old category names.", + "", + "", + "", + "", + "", + "", + "", + "CSAM V2", + "SPII", + "New SafetyCat v3 categories", + "", + "", + "", + "" + ], + "type": "string" + }, + "score": { + "description": "The score for the category, in the range [0.0, 1.0].", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "CloudAiNlLlmProtoServiceSafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "CloudAiNlLlmProtoServiceSafetyRating", @@ -18955,17 +19970,6 @@ }, "type": "object" }, - "GoogleCloudAiplatformV1beta1CreateExtensionDeploymentOperationMetadata": { - "description": "Details of ExtensionRegistryService.CreateExtensionDeployment operation.", - "id": "GoogleCloudAiplatformV1beta1CreateExtensionDeploymentOperationMetadata", - "properties": { - "genericMetadata": { - "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", - "description": "The common part of the operation metadata." - } - }, - "type": "object" - }, "GoogleCloudAiplatformV1beta1CreateFeatureGroupOperationMetadata": { "description": "Details of operations that perform create FeatureGroup.", "id": "GoogleCloudAiplatformV1beta1CreateFeatureGroupOperationMetadata", @@ -19095,6 +20099,10 @@ "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for PersistentResource." + }, + "progressMessage": { + "description": "Progress Message for Create LRO", + "type": "string" } }, "type": "object" @@ -19114,6 +20122,10 @@ "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" + }, + "preflightValidations": { + "description": "Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines.", + "type": "boolean" } }, "type": "object" @@ -20898,7 +21910,7 @@ "id": "GoogleCloudAiplatformV1beta1Explanation", "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. 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.", + "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": "GoogleCloudAiplatformV1beta1Attribution" }, @@ -21872,12 +22884,12 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint": { - "description": "The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type or enable EmbeddingManagement. Will use public endpoint by default.", + "description": "The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type or enable EmbeddingManagement. Will use public endpoint by default. Note, for EmbeddingManagement use case, only [DedicatedServingEndpoint.public_endpoint_domain_name] is available now.", "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint", "properties": { "privateServiceConnectConfig": { "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", - "description": "Optional. Private service connect config. 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." + "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", @@ -22850,11 +23862,6 @@ }, "type": "array" }, - "endpoint": { - "deprecated": true, - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "type": "string" - }, "generationConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", "description": "Optional. Generation config." @@ -23662,6 +24669,14 @@ "readOnly": true, "type": "string" }, + "pscAutomatedEndpoints": { + "description": "Output only. PscAutomatedEndpoints is populated if private service connect is enabled if PscAutomatedConfig is set.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1PscAutomatedEndpoints" + }, + "readOnly": true, + "type": "array" + }, "serviceAttachment": { "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled.", "readOnly": true, @@ -25260,7 +26275,7 @@ }, "modelSourceInfo": { "$ref": "GoogleCloudAiplatformV1beta1ModelSourceInfo", - "description": "Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model.", + "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": { @@ -26822,7 +27837,12 @@ "INVALID_AVRO_SYNTAX", "INVALID_EMBEDDING_ID", "EMBEDDING_SIZE_MISMATCH", - "NAMESPACE_MISSING" + "NAMESPACE_MISSING", + "PARSING_ERROR", + "DUPLICATE_NAMESPACE", + "OP_IN_DATAPOINT", + "MULTIPLE_VALUES", + "INVALID_NUMERIC_VALUE" ], "enumDescriptions": [ "Default, shall not be used.", @@ -26832,7 +27852,12 @@ "Invalid avro format.", "The embedding id is not valid.", "The size of the embedding vectors does not match with the specified dimension.", - "The `namespace` field is missing." + "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." ], "type": "string" }, @@ -27564,6 +28589,10 @@ "description": "The runtime config of a PipelineJob.", "id": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig", "properties": { + "defaultRuntime": { + "$ref": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigDefaultRuntime", + "description": "Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview" + }, "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": [ @@ -27607,6 +28636,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigDefaultRuntime": { + "description": "The default runtime for the PipelineJob.", + "id": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigDefaultRuntime", + "properties": { + "persistentResourceRuntimeDetail": { + "$ref": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail", + "description": "Persistent resource based runtime detail." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigInputArtifact": { "description": "The type of an input artifact.", "id": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigInputArtifact", @@ -27618,6 +28658,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail": { + "description": "Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview", + "id": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail", + "properties": { + "persistentResourceName": { + "description": "Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PipelineTaskDetail": { "description": "The runtime detail of a task execution.", "id": "GoogleCloudAiplatformV1beta1PipelineTaskDetail", @@ -28104,6 +29155,25 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PscAutomatedEndpoints": { + "description": "PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig.", + "id": "GoogleCloudAiplatformV1beta1PscAutomatedEndpoints", + "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" + }, "GoogleCloudAiplatformV1beta1PublisherModel": { "description": "A Model Garden Publisher Model.", "id": "GoogleCloudAiplatformV1beta1PublisherModel", @@ -28217,6 +29287,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open fine-tuning pipeline of the PublisherModel." }, + "openFineTuningPipelines": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines", + "description": "Optional. Open fine-tuning pipelines of the PublisherModel." + }, "openGenerationAiStudio": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open in Generation AI Studio." @@ -28229,6 +29303,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open notebook of the PublisherModel." }, + "openNotebooks": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenNotebooks", + "description": "Optional. Open notebooks of the PublisherModel." + }, "openPromptTuningPipeline": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open prompt-tuning pipeline of the PublisherModel." @@ -28287,6 +29365,34 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines": { + "description": "Open fine tuning pipelines.", + "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines", + "properties": { + "fineTuningPipelines": { + "description": "Required. Regional resource references to fine tuning pipelines.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenNotebooks": { + "description": "Open notebooks.", + "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenNotebooks", + "properties": { + "notebooks": { + "description": "Required. Regional resource references to notebooks.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences": { "description": "The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc..", "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", @@ -28298,8 +29404,20 @@ "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. The title of the regional resource reference.", + "description": "Required. ", "type": "string" } }, @@ -28358,6 +29476,7 @@ "id": "GoogleCloudAiplatformV1beta1PublisherModelResourceReference", "properties": { "description": { + "deprecated": true, "description": "Description of the resource.", "type": "string" }, @@ -28370,6 +29489,7 @@ "type": "string" }, "useCase": { + "deprecated": true, "description": "Use case (CUJ) of the resource.", "type": "string" } @@ -28821,17 +29941,6 @@ }, "type": "object" }, - "GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata": { - "description": "Details of operations that perform reboot PersistentResource.", - "id": "GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata", - "properties": { - "genericMetadata": { - "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", - "description": "Operation metadata for PersistentResource." - } - }, - "type": "object" - }, "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest": { "description": "Request message for MetadataService.DeleteContextChildrenRequest.", "id": "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest", @@ -28910,7 +30019,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest": { - "description": "LINT.IfChange(report_event_message_types) Request message for NotebookInternalService.ReportRuntimeEvent.", + "description": "Request message for NotebookInternalService.ReportRuntimeEvent.", "id": "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest", "properties": { "eventDetails": { @@ -35198,6 +36307,10 @@ "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for PersistentResource." + }, + "progressMessage": { + "description": "Progress Message for Update LRO", + "type": "string" } }, "type": "object" @@ -35582,7 +36695,7 @@ "type": "array" }, "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "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" } }, @@ -35933,6 +37046,4239 @@ } }, "type": "object" + }, + "LanguageLabsAidaTrustRecitationProtoDocAttribution": { + "description": "The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30", + "id": "LanguageLabsAidaTrustRecitationProtoDocAttribution", + "properties": { + "amarnaId": { + "type": "string" + }, + "arxivId": { + "type": "string" + }, + "author": { + "type": "string" + }, + "bibkey": { + "type": "string" + }, + "biorxivId": { + "description": "ID of the paper in bioarxiv like ddoi.org/{biorxiv_id} eg: https://doi.org/10.1101/343517", + "type": "string" + }, + "bookTitle": { + "type": "string" + }, + "bookVolumeId": { + "description": "The Oceanographers full-view books dataset uses a 'volume id' as the unique ID of a book. There is a deterministic function from a volume id to a URL under the books.google.com domain. Marked as 'optional' since a volume ID of zero is potentially possible and we want to distinguish that from the volume ID not being set.", + "format": "int64", + "type": "string" + }, + "category": { + "enum": [ + "CATEGORY_UNSPECIFIED", + "CATEGORY_NEWS", + "CATEGORY_NON_NEWS_WEBDOC", + "CATEGORY_UNKNOWN_MISSING_SIGNAL" + ], + "enumDescriptions": [ + "", + "The doc has a url and the news classifier has classified this doc as news.", + "The doc has a url and the news classifier classified this doc as non-news.", + "The doc has a url but the url was missing from the news classifier URL table." + ], + "type": "string" + }, + "conversationId": { + "type": "string" + }, + "dataset": { + "description": "The dataset this document comes from.", + "enum": [ + "DATASET_UNSPECIFIED", + "WIKIPEDIA", + "WEBDOCS", + "WEBDOCS_FINETUNE", + "GITHUB_MIRROR", + "BOOKS_FULL_VIEW", + "BOOKS_PRIVATE", + "GNEWS", + "ULM_DOCJOINS", + "ULM_DOCJOINS_DEDUPED", + "MEENA_FC", + "PODCAST", + "AQUA", + "WEB_ASR", + "BARD_GOLDEN", + "COMMON_SENSE_REASONING", + "MATH", + "MATH_REASONING", + "CLEAN_ARXIV", + "LAMDA_FACTUALITY_E2E_QUERY_GENERATION", + "LAMDA_FACTUALITY_E2E_RESPONSE_GENERATION", + "MASSIVE_FORUM_THREAD_SCORED_BARD", + "MASSIVE_FORUM_THREAD_SCORED_LONG_200", + "MASSIVE_FORUM_THREAD_SCORED_LONG_500", + "DOCUMENT_CHUNKS", + "MEENA_RESEARCH_PHASE_GOLDEN_MARKDOWN", + "MEENA_RESEARCH_PHASE_GOOGLERS", + "MEENA_RESPONSE_SAFETY_HUMAN_GEN", + "MEENA_RESPONSE_SAFETY_SCHEMA_NO_BROADCAST", + "MEENA_RESPONSE_SAFETY_V3_HUMAN_GEN2", + "MEENA_RESPONSE_SAFETY_V3_SCHEMA_NO_BROADCAST", + "LAMDA_FACTUALITY_TRIGGER", + "LAMDA_SAFETY_V2_SCHEMA_NO_BROADCAST", + "LAMDA_SSI_DISCRIMINATIVE", + "ASSISTANT_PERSONALITY_SAFETY", + "PODCAST_FINETUNE_DIALOG", + "WORLD_QUERY_GENERATOR", + "C4_JOINED_DOCJOINS", + "HOL4_THEORIES", + "HOL_LIGHT_THEORIES", + "HOLSTEPS", + "ISABELLE_STEP", + "ISABELLE_THEORIES", + "LEAN_MATHLIB_THEORIES", + "LEAN_STEP", + "MIZAR_THEORIES", + "COQ_STEP", + "COQ_THEORIES", + "AMPS_KHAN", + "AMPS_MATHEMATICA", + "CODEY_CODE", + "CODE_QA_SE", + "CODE_QA_SO", + "CODE_QA_FT_FORMAT", + "CODE_QA_FT_KNOWLEDGE", + "CODE_QA_GITHUB_FILTERED_CODE", + "BARD_PERSONALITY_GOLDEN", + "ULM_DOCJOINS_WITH_URLS_EN", + "ULM_DOCJOINS_WITH_URLS_I18N", + "GOODALL_MTV5_GITHUB", + "GOODALL_MTV5_BOOKS", + "GOODALL_MTV5_C4", + "GOODALL_MTV5_WIKIPEDIA", + "GOODALL_MW_TOP_100B", + "GOODALL_MW_STACK_EXCHANGE", + "GOODALL_MW_TOP_0_10B", + "GOODALL_MW_TOP_10B_20B", + "CODEY_NOTEBOOK_LM_PRETRAINING", + "VERTEX_SAFE_FLAN", + "GITHUB_MIRROR_V1_0_1", + "GITHUB_MIRROR_V2_1_0", + "CMS_WIKIPEDIA_LANG_FILTERED", + "CMS_STACKOVERFLOW_MULTILINGUAL", + "CMS_STACKEXCHANGE", + "PUBMED", + "GEMINI_DOCJOINS_EN_TOP10B_GCC", + "GEMINI_DOCJOINS_EN_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_EN_TOP20B_TOP100B_GCC", + "GEMINI_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_I18N_TOP20B_TOP100B_GCC", + "SIMPLIFIED_HTML_V1_GCC", + "GEMINI_DOCJOINS_TOXICITY_TAGGED_GCC", + "CMS_GITHUB_V4", + "GITHUB_HTML_V4", + "GITHUB_OTHER_V4", + "GITHUB_LONG_TAIL_V4", + "CMS_GITHUB_MULTIFILE_V4", + "GITHUB_DIFFS_WITH_COMMIT_MESSAGE", + "ULM_ARXIV", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_ENONLY", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_NONENONLY", + "QUORA", + "PODCASTS_ROBOTSTXT", + "COMBINED_REDDIT", + "CANARIES_SHUFFLED", + "CLM_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "TECHDOCS_DATA_SOURCE", + "SCIENCE_PDF_70M_DOCS_FILTERED", + "GEMINI_V1_CMS_WIKIPEDIA_LANG_FILTERED", + "GEMINI_V1_WIKIPEDIA_DIFFS", + "GEMINI_V1_DOCJOINS_EN_TOP10B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP10B_TOP20B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP20B_TOP100B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_TOP20B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP20B_TOP100B_GCC_050523", + "GEMINI_V1_SIMPLIFIED_HTML_V2_GCC", + "GEMINI_V1_CMS_STACKOVERFLOW_MULTILINGUAL_V2", + "GEMINI_V1_CMS_STACKEXCHANGE_DECONT", + "GEMINI_V1_QUORA", + "GEMINI_V1_COMBINED_REDDIT", + "GEMINI_V1_DOCJOIN_100B_EN_TOXICITY_TAGGED_GCC_FIXED_TAGS", + "GEMINI_V1_PUBMED", + "GEMINI_V1_WEB_MATH_V2", + "GEMINI_V1_CMS_GITHUB_DECONTAMINATED_V_7", + "GEMINI_V1_GITHUB_DIFF_WITH_COMMIT_MESSAGE_V2", + "GEMINI_V1_GITHUB_HTML_CSS_XML_V4", + "GEMINI_V1_GITHUB_OTHER_V4", + "GEMINI_V1_GITHUB_LONG_TAIL_V4", + "GEMINI_V1_GITHUB_JUPTYER_NOTEBOOKS_SSTABLE", + "GEMINI_V1_ULM_ARXIV_SSTABLE", + "GEMINI_V1_PODCASTS_ROBOTSTXT", + "GEMINI_V1_SCIENCE_PDF_68M_HQ_DOCS_GCC", + "GEMINI_V1_GITHUB_TECHDOCS_V2", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_EN", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_NONEN", + "GEMINI_V1_STEM_BOOKS_650K_TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_M3W_V2_FILTERED", + "GEMINI_V1_VQCOCA_1B_MULTIRES_WEBLI_EN_V4_350M_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_SCREENAI_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CULTURE_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_EN_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_I18N_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_NON_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_VTP_4F_VIDEO2TEXT_PREFIX", + "GEMINI_V1_FORMAL_MATH_WITHOUT_HOLSTEPS_AND_MIZAR", + "GEMINI_V1_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "GEMINI_V1_CANARIES_SHUFFLED_DOCJOIN_EN_NONEN_CODE_ARXIV_TRANSLATE", + "DUET_CLOUD_SECURITY_DOCS", + "DUET_GITHUB_CODE_SNIPPETS", + "DUET_GITHUB_FILES", + "DUET_GOBYEXAMPLE", + "DUET_GOLANG_DOCS", + "DUET_CLOUD_DOCS_TROUBLESHOOTING_TABLES", + "DUET_DEVSITE_DOCS", + "DUET_CLOUD_BLOG_POSTS", + "DUET_CLOUD_PODCAST_EPISODES", + "DUET_YOUTUBE_VIDEOS", + "DUET_CLOUD_SKILLS_BOOST", + "DUET_CLOUD_DOCS", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_GENERATED", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_HANDWRITTEN", + "DUET_GOOGLESQL_GENERATION", + "DUET_CLOUD_IX_PROMPTS", + "DUET_RAD", + "BARD_ARCADE_GITHUB", + "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", + "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", + "GENESIS_NEWS_INSIGHTS", + "CLOUD_SECURITY_PRETRAINING", + "CLOUD_SECURITY_FINETUNING", + "LABS_AQA_DSCOUT", + "LABS_AQA_TAILWIND", + "LABS_AQA_DELEWARE", + "GEMINI_MULTIMODAL_FT_URL", + "GEMINI_MULTIMODAL_FT_YT", + "GEMINI_MULTIMODAL_FT_SHUTTERSTOCK", + "GEMINI_MULTIMODAL_FT_NONE", + "GEMINI_MULTIMODAL_FT_OTHER", + "GEMINI_MULTIMODAL_FT_INK", + "GEMINI_MULTIMODAL_IT", + "GEMINI_IT_SHUTTERSTOCK", + "GEMINI_IT_M3W", + "GEMINI_IT_HEDGING", + "GEMINI_IT_DSCOUT_FACTUALITY", + "GEMINI_IT_AQUAMUSE", + "GEMINI_IT_SHOTGUN", + "GEMINI_IT_ACI_BENCH", + "GEMINI_IT_SPIDER_FILTERED", + "GEMINI_IT_TAB_SUM_BQ", + "GEMINI_IT_QA_WITH_URL", + "GEMINI_IT_CODE_INSTRUCT", + "GEMINI_IT_MED_PALM", + "GEMINI_IT_TASK_ORIENTED_DIALOG", + "GEMINI_IT_NIMBUS_GROUNDING_TO_PROMPT", + "GEMINI_IT_EITL_GEN", + "GEMINI_IT_HITL_GEN", + "GEMINI_IT_MECH", + "GEMINI_IT_TABLE_GEN", + "GEMINI_IT_NIMBUS_DECIBEL", + "GEMIT_BRIDGE_SUFFIX_FT", + "GEMINI_IT_CLOUD_CODE_IF", + "GEMINI_IT_CLOUD_EUR_LEX_JSON", + "GEMINI_IT_CLOUD_OASST", + "GEMINI_IT_CLOUD_SELF_INSTRUCT", + "GEMINI_IT_CLOUD_UCS_AQUAMUSE", + "GEMINI_V2_CMS_WIKIPEDIA_LANG_FILTERED_GCC_PII", + "GEMINI_V2_WIKIPEDIA_DIFFS_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_QUORA_COMPLIANT", + "GEMINI_V2_FORUMS_V2_COMPLIANT", + "GEMINI_V2_CMS_STACKOVERFLOW_MULTILINGUAL_V2_COMPLIANT", + "GEMINI_V2_SIMPLIFIED_HTML_V2_CORRECT_FORMAT_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_TOXICITY_TAGGED_FIXED_TAGS_COMPLIANT", + "GEMINI_V2_CODEWEB_V1_COMPLIANT", + "GEMINI_V2_LEETCODE_GCC_PII", + "GEMINI_V2_CODE_CONTESTS_COMPLIANT", + "GEMINI_V2_CMS_GITHUB_MULTI_FILE_FOR_FIM_GEMBAGZ_FIXED_BYTES_LENGTHS", + "GEMINI_V2_GITHUB_EVALED_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_NON_EVAL_HIGH_PRI_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_LOW_PRI_LANGUAGES_AND_CONFIGS_COMPLIANT", + "GEMINI_V2_GITHUB_LONG_TAIL_AND_STRUCTURED_DATA_COMPLIANT", + "GEMINI_V2_GITHUB_PYTHON_NOTEBOOKS_COMPLIANT", + "GEMINI_V2_GITHUB_DIFFS_COMPLIANT", + "GEMINI_V2_GITHUB_TECHDOCS_COMPLIANT", + "GEMINI_V2_HIGH_QUALITY_CODE_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_SCIENCE_PDF_68M_HQ_DOCS_DEDUP_COMPLIANT_CLEAN_TEX", + "GEMINI_V2_ARXIV_2023_COMPLIANT", + "GEMINI_V2_FORMAL_COMPLIANT", + "GEMINI_V2_CMS_STACKEXCHANGE_COMPLIANT", + "GEMINI_V2_PUBMED_COMPLIANT", + "GEMINI_V2_WEB_MATH_V3_COMPLIANT", + "GEMINI_V2_SCIENCEWEB_V0_GCC_PII", + "GEMINI_V2_WEB_POLYMATH_V1_COMPLIANT", + "GEMINI_V2_MATH_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_BIOLOGY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_PHYSICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHEMISTRY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MACHINE_LEARNING_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_QA_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_ECONOMICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MEDICAL_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHESS_COMPLIANT", + "GEMINI_V2_YOUTUBE_SCIENCE_V4_FILTERED_COMPLIANT", + "GEMINI_V2_GOALDMINE_XL_GENERATED_PLUS_GT_NO_DM_MATH_COMPLIANT", + "GEMINI_V2_FIRSTTIMES_SCIENCE_PDF_DEDUP_HQ_LENGTH_FILTERED_COMPLIANT", + "GEMINI_V2_PODCASTS_COMPLIANT", + "GEMINI_V2_EN_NONSCIENCE_PDF_DEDUP_46M_DOCS_COMPLIANT", + "GEMINI_V2_NONPUB_COPYRIGHT_BOOKS_V3_70_CONF_082323_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_COPYRIGHT_BOOKS_V3_111823_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_BOOKS_318K_TEXT_COMPLIANT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_T2I_TEXT_TO_IMAGE_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_I18N_680M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_FULL_HTML_75M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_V1_1_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_DOC_240M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_VIDEO_VIDEO_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M4W_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CULTURE_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_DETECTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_ALT_TEXT_NONEN_500M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SPATIAL_AWARE_PALI_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_3D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_NON_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_3D_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CC3M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_INFOGRAPHICS_LARGE_WEB_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_BIORXIV_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PLOT2TABLE_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TIKZ_DERENDERING_MERGED_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_2D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WIKIPEDIA_EQUATIONS_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_EQ2LATEX_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_ARXIV_EQUATIONS_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_HEAD_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_CLM_TRANSLATE_DATAV3_WEB_UNWMT_INCR_MIX", + "GEMINI_V2_NTL_NTLV4A_MONOLINGUAL_DEDUP_N5", + "GEMINI_V2_NTL_STT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_TRANSLIT_BILEX_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_BT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_FT_FIXED_TRANSLATE_DEDUP_N5", + "GEMINI_V2_CANARIES_SHUFFLED_COMPLIANT" + ], + "enumDescriptions": [ + "", + "Wikipedia article Tensorflow datasets used by Tarzan and maintained by TFDS team.", + "Webdocs that have been filtered from the docjoins by the Tarzan team for use in the Tarzan training set.", + "", + "", + "'Full view' books dataset maintained by Oceanographers team, meaning 'ok to view the book in full in all localities'. Largely the same as 'public domain', but with potentially subtle distinction.", + "Filtered private books used by ULM: http://google3/learning/multipod/pax/lm/params/ulm/tasks.py;l=123;rcl=494241309. which corresponds with /cns/mf-d/home/multipod-language-data/private_books/books_filtered_en_resharded@50000", + "Google news dataset referenced in: http://google3/learning/brain/research/conversation/meena/t5/pretrain_tasks.py;l=922;rcl=496534668", + "The docjoins data for ULM /cns/yo-d/home/multipod-language-data/docjoins/rs=6.3/20220728/100B_docstructure_split/examples_en.tfrecord_lattice_05_score_01_HFV13@3929", + "", + "Meena full conversations. http://google3/learning/brain/research/conversation/meena/t5/pretrain_mixtures.py;l=675;rcl=496583228", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Academic dataset of math text. http://google3/learning/brain/research/conversation/meena/seqio/mixtures/experimental/bard.py;rcl=500222380", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Datasets managed by the Goodall team: deepmind-goodall@google.com", + "", + "", + "", + "", + "", + "", + "", + "Datasets used by Codepoet", + "Datasets used by Vertex", + "", + "", + "Datasets used by Gemini Public data", + "", + "", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "Arxiv", + "Others", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemini V1, order by precedence. Wikipedia", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "ArXiv", + "Citable misc", + "", + "", + "Non-public books", + "", + "", + "Other", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Duet AI finetune datasets, order by precedence.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Bard ARCADE finetune dataset.", + "Mobile assistant finetune datasets.", + "", + "Genesis fine-tune datasets.", + "Cloud Security fine-tune datasets.", + "", + "LABS AQA fine-tune datasets.", + "", + "", + "Gemini multimodal instruction tune(IT) and fine tune(FT) datasets datasets.", + "", + "", + "", + "", + "", + "", + "Gemini IT 1.2.7 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemit Bridge ULM FT dataset", + "Gemini IT Cloud Build datasets.", + "", + "", + "", + "", + "Gemini V2 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "filepath": { + "type": "string" + }, + "geminiId": { + "type": "string" + }, + "gnewsArticleTitle": { + "type": "string" + }, + "goodallExampleId": { + "type": "string" + }, + "isOptOut": { + "description": "Whether the document is opted out.", + "type": "boolean" + }, + "isPrompt": { + "type": "boolean" + }, + "lamdaExampleId": { + "type": "string" + }, + "license": { + "type": "string" + }, + "meenaConversationId": { + "type": "string" + }, + "naturalLanguageCode": { + "description": "Natural (not programming) language of the document. Language code as defined by http://www.unicode.org/reports/tr35/#Identifiers and https://tools.ietf.org/html/bcp47. Currently applicable to full-view books. Use docinfo-util.h to set & read language fields. See go/iii.", + "type": "string" + }, + "noAttribution": { + "description": "True if this doc has no attribution information available. We use an explicit field for this instead of just implicitly leaving all the DocAttribution fields blank to distinguish a case where a bug/oversight has left the attribution information empty vs when we really have no attribution information available.", + "type": "boolean" + }, + "podcastUtteranceId": { + "type": "string" + }, + "publicationDate": { + "$ref": "GoogleTypeDate" + }, + "qualityScoreExperimentOnly": { + "description": "This field is for opt-out experiment only, MUST never be used during actual production/serving. ", + "format": "double", + "type": "number" + }, + "repo": { + "description": "Github repository", + "type": "string" + }, + "url": { + "description": "URL of a webdoc", + "type": "string" + }, + "volumeId": { + "type": "string" + }, + "wikipediaArticleTitle": { + "description": "Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset.", + "type": "string" + }, + "youtubeVideoId": { + "description": "The unique video id from Youtube. Example: AkoGsW52Ir0", + "type": "string" + } + }, + "type": "object" + }, + "LanguageLabsAidaTrustRecitationProtoRecitationResult": { + "description": "The recitation result for one input", + "id": "LanguageLabsAidaTrustRecitationProtoRecitationResult", + "properties": { + "dynamicSegmentResults": { + "items": { + "$ref": "LanguageLabsAidaTrustRecitationProtoSegmentResult" + }, + "type": "array" + }, + "recitationAction": { + "description": "The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK > CITE > NO_ACTION.", + "enum": [ + "ACTION_UNSPECIFIED", + "CITE", + "BLOCK", + "NO_ACTION", + "EXEMPT_FOUND_IN_PROMPT" + ], + "enumDescriptions": [ + "", + "indicate that attribution must be shown for a Segment", + "indicate that a Segment should be blocked from being used", + "for tagging high-frequency code snippets", + "The recitation was found in prompt and is exempted from overall results" + ], + "type": "string" + }, + "trainingSegmentResults": { + "items": { + "$ref": "LanguageLabsAidaTrustRecitationProtoSegmentResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "LanguageLabsAidaTrustRecitationProtoSegmentResult": { + "description": "The recitation result for each segment in a given input.", + "id": "LanguageLabsAidaTrustRecitationProtoSegmentResult", + "properties": { + "attributionDataset": { + "description": "The dataset the segment came from.", + "enum": [ + "DATASET_UNSPECIFIED", + "WIKIPEDIA", + "WEBDOCS", + "WEBDOCS_FINETUNE", + "GITHUB_MIRROR", + "BOOKS_FULL_VIEW", + "BOOKS_PRIVATE", + "GNEWS", + "ULM_DOCJOINS", + "ULM_DOCJOINS_DEDUPED", + "MEENA_FC", + "PODCAST", + "AQUA", + "WEB_ASR", + "BARD_GOLDEN", + "COMMON_SENSE_REASONING", + "MATH", + "MATH_REASONING", + "CLEAN_ARXIV", + "LAMDA_FACTUALITY_E2E_QUERY_GENERATION", + "LAMDA_FACTUALITY_E2E_RESPONSE_GENERATION", + "MASSIVE_FORUM_THREAD_SCORED_BARD", + "MASSIVE_FORUM_THREAD_SCORED_LONG_200", + "MASSIVE_FORUM_THREAD_SCORED_LONG_500", + "DOCUMENT_CHUNKS", + "MEENA_RESEARCH_PHASE_GOLDEN_MARKDOWN", + "MEENA_RESEARCH_PHASE_GOOGLERS", + "MEENA_RESPONSE_SAFETY_HUMAN_GEN", + "MEENA_RESPONSE_SAFETY_SCHEMA_NO_BROADCAST", + "MEENA_RESPONSE_SAFETY_V3_HUMAN_GEN2", + "MEENA_RESPONSE_SAFETY_V3_SCHEMA_NO_BROADCAST", + "LAMDA_FACTUALITY_TRIGGER", + "LAMDA_SAFETY_V2_SCHEMA_NO_BROADCAST", + "LAMDA_SSI_DISCRIMINATIVE", + "ASSISTANT_PERSONALITY_SAFETY", + "PODCAST_FINETUNE_DIALOG", + "WORLD_QUERY_GENERATOR", + "C4_JOINED_DOCJOINS", + "HOL4_THEORIES", + "HOL_LIGHT_THEORIES", + "HOLSTEPS", + "ISABELLE_STEP", + "ISABELLE_THEORIES", + "LEAN_MATHLIB_THEORIES", + "LEAN_STEP", + "MIZAR_THEORIES", + "COQ_STEP", + "COQ_THEORIES", + "AMPS_KHAN", + "AMPS_MATHEMATICA", + "CODEY_CODE", + "CODE_QA_SE", + "CODE_QA_SO", + "CODE_QA_FT_FORMAT", + "CODE_QA_FT_KNOWLEDGE", + "CODE_QA_GITHUB_FILTERED_CODE", + "BARD_PERSONALITY_GOLDEN", + "ULM_DOCJOINS_WITH_URLS_EN", + "ULM_DOCJOINS_WITH_URLS_I18N", + "GOODALL_MTV5_GITHUB", + "GOODALL_MTV5_BOOKS", + "GOODALL_MTV5_C4", + "GOODALL_MTV5_WIKIPEDIA", + "GOODALL_MW_TOP_100B", + "GOODALL_MW_STACK_EXCHANGE", + "GOODALL_MW_TOP_0_10B", + "GOODALL_MW_TOP_10B_20B", + "CODEY_NOTEBOOK_LM_PRETRAINING", + "VERTEX_SAFE_FLAN", + "GITHUB_MIRROR_V1_0_1", + "GITHUB_MIRROR_V2_1_0", + "CMS_WIKIPEDIA_LANG_FILTERED", + "CMS_STACKOVERFLOW_MULTILINGUAL", + "CMS_STACKEXCHANGE", + "PUBMED", + "GEMINI_DOCJOINS_EN_TOP10B_GCC", + "GEMINI_DOCJOINS_EN_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_EN_TOP20B_TOP100B_GCC", + "GEMINI_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_I18N_TOP20B_TOP100B_GCC", + "SIMPLIFIED_HTML_V1_GCC", + "GEMINI_DOCJOINS_TOXICITY_TAGGED_GCC", + "CMS_GITHUB_V4", + "GITHUB_HTML_V4", + "GITHUB_OTHER_V4", + "GITHUB_LONG_TAIL_V4", + "CMS_GITHUB_MULTIFILE_V4", + "GITHUB_DIFFS_WITH_COMMIT_MESSAGE", + "ULM_ARXIV", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_ENONLY", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_NONENONLY", + "QUORA", + "PODCASTS_ROBOTSTXT", + "COMBINED_REDDIT", + "CANARIES_SHUFFLED", + "CLM_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "TECHDOCS_DATA_SOURCE", + "SCIENCE_PDF_70M_DOCS_FILTERED", + "GEMINI_V1_CMS_WIKIPEDIA_LANG_FILTERED", + "GEMINI_V1_WIKIPEDIA_DIFFS", + "GEMINI_V1_DOCJOINS_EN_TOP10B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP10B_TOP20B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP20B_TOP100B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_TOP20B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP20B_TOP100B_GCC_050523", + "GEMINI_V1_SIMPLIFIED_HTML_V2_GCC", + "GEMINI_V1_CMS_STACKOVERFLOW_MULTILINGUAL_V2", + "GEMINI_V1_CMS_STACKEXCHANGE_DECONT", + "GEMINI_V1_QUORA", + "GEMINI_V1_COMBINED_REDDIT", + "GEMINI_V1_DOCJOIN_100B_EN_TOXICITY_TAGGED_GCC_FIXED_TAGS", + "GEMINI_V1_PUBMED", + "GEMINI_V1_WEB_MATH_V2", + "GEMINI_V1_CMS_GITHUB_DECONTAMINATED_V_7", + "GEMINI_V1_GITHUB_DIFF_WITH_COMMIT_MESSAGE_V2", + "GEMINI_V1_GITHUB_HTML_CSS_XML_V4", + "GEMINI_V1_GITHUB_OTHER_V4", + "GEMINI_V1_GITHUB_LONG_TAIL_V4", + "GEMINI_V1_GITHUB_JUPTYER_NOTEBOOKS_SSTABLE", + "GEMINI_V1_ULM_ARXIV_SSTABLE", + "GEMINI_V1_PODCASTS_ROBOTSTXT", + "GEMINI_V1_SCIENCE_PDF_68M_HQ_DOCS_GCC", + "GEMINI_V1_GITHUB_TECHDOCS_V2", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_EN", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_NONEN", + "GEMINI_V1_STEM_BOOKS_650K_TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_M3W_V2_FILTERED", + "GEMINI_V1_VQCOCA_1B_MULTIRES_WEBLI_EN_V4_350M_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_SCREENAI_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CULTURE_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_EN_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_I18N_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_NON_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_VTP_4F_VIDEO2TEXT_PREFIX", + "GEMINI_V1_FORMAL_MATH_WITHOUT_HOLSTEPS_AND_MIZAR", + "GEMINI_V1_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "GEMINI_V1_CANARIES_SHUFFLED_DOCJOIN_EN_NONEN_CODE_ARXIV_TRANSLATE", + "DUET_CLOUD_SECURITY_DOCS", + "DUET_GITHUB_CODE_SNIPPETS", + "DUET_GITHUB_FILES", + "DUET_GOBYEXAMPLE", + "DUET_GOLANG_DOCS", + "DUET_CLOUD_DOCS_TROUBLESHOOTING_TABLES", + "DUET_DEVSITE_DOCS", + "DUET_CLOUD_BLOG_POSTS", + "DUET_CLOUD_PODCAST_EPISODES", + "DUET_YOUTUBE_VIDEOS", + "DUET_CLOUD_SKILLS_BOOST", + "DUET_CLOUD_DOCS", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_GENERATED", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_HANDWRITTEN", + "DUET_GOOGLESQL_GENERATION", + "DUET_CLOUD_IX_PROMPTS", + "DUET_RAD", + "BARD_ARCADE_GITHUB", + "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", + "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", + "GENESIS_NEWS_INSIGHTS", + "CLOUD_SECURITY_PRETRAINING", + "CLOUD_SECURITY_FINETUNING", + "LABS_AQA_DSCOUT", + "LABS_AQA_TAILWIND", + "LABS_AQA_DELEWARE", + "GEMINI_MULTIMODAL_FT_URL", + "GEMINI_MULTIMODAL_FT_YT", + "GEMINI_MULTIMODAL_FT_SHUTTERSTOCK", + "GEMINI_MULTIMODAL_FT_NONE", + "GEMINI_MULTIMODAL_FT_OTHER", + "GEMINI_MULTIMODAL_FT_INK", + "GEMINI_MULTIMODAL_IT", + "GEMINI_IT_SHUTTERSTOCK", + "GEMINI_IT_M3W", + "GEMINI_IT_HEDGING", + "GEMINI_IT_DSCOUT_FACTUALITY", + "GEMINI_IT_AQUAMUSE", + "GEMINI_IT_SHOTGUN", + "GEMINI_IT_ACI_BENCH", + "GEMINI_IT_SPIDER_FILTERED", + "GEMINI_IT_TAB_SUM_BQ", + "GEMINI_IT_QA_WITH_URL", + "GEMINI_IT_CODE_INSTRUCT", + "GEMINI_IT_MED_PALM", + "GEMINI_IT_TASK_ORIENTED_DIALOG", + "GEMINI_IT_NIMBUS_GROUNDING_TO_PROMPT", + "GEMINI_IT_EITL_GEN", + "GEMINI_IT_HITL_GEN", + "GEMINI_IT_MECH", + "GEMINI_IT_TABLE_GEN", + "GEMINI_IT_NIMBUS_DECIBEL", + "GEMIT_BRIDGE_SUFFIX_FT", + "GEMINI_IT_CLOUD_CODE_IF", + "GEMINI_IT_CLOUD_EUR_LEX_JSON", + "GEMINI_IT_CLOUD_OASST", + "GEMINI_IT_CLOUD_SELF_INSTRUCT", + "GEMINI_IT_CLOUD_UCS_AQUAMUSE", + "GEMINI_V2_CMS_WIKIPEDIA_LANG_FILTERED_GCC_PII", + "GEMINI_V2_WIKIPEDIA_DIFFS_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_QUORA_COMPLIANT", + "GEMINI_V2_FORUMS_V2_COMPLIANT", + "GEMINI_V2_CMS_STACKOVERFLOW_MULTILINGUAL_V2_COMPLIANT", + "GEMINI_V2_SIMPLIFIED_HTML_V2_CORRECT_FORMAT_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_TOXICITY_TAGGED_FIXED_TAGS_COMPLIANT", + "GEMINI_V2_CODEWEB_V1_COMPLIANT", + "GEMINI_V2_LEETCODE_GCC_PII", + "GEMINI_V2_CODE_CONTESTS_COMPLIANT", + "GEMINI_V2_CMS_GITHUB_MULTI_FILE_FOR_FIM_GEMBAGZ_FIXED_BYTES_LENGTHS", + "GEMINI_V2_GITHUB_EVALED_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_NON_EVAL_HIGH_PRI_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_LOW_PRI_LANGUAGES_AND_CONFIGS_COMPLIANT", + "GEMINI_V2_GITHUB_LONG_TAIL_AND_STRUCTURED_DATA_COMPLIANT", + "GEMINI_V2_GITHUB_PYTHON_NOTEBOOKS_COMPLIANT", + "GEMINI_V2_GITHUB_DIFFS_COMPLIANT", + "GEMINI_V2_GITHUB_TECHDOCS_COMPLIANT", + "GEMINI_V2_HIGH_QUALITY_CODE_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_SCIENCE_PDF_68M_HQ_DOCS_DEDUP_COMPLIANT_CLEAN_TEX", + "GEMINI_V2_ARXIV_2023_COMPLIANT", + "GEMINI_V2_FORMAL_COMPLIANT", + "GEMINI_V2_CMS_STACKEXCHANGE_COMPLIANT", + "GEMINI_V2_PUBMED_COMPLIANT", + "GEMINI_V2_WEB_MATH_V3_COMPLIANT", + "GEMINI_V2_SCIENCEWEB_V0_GCC_PII", + "GEMINI_V2_WEB_POLYMATH_V1_COMPLIANT", + "GEMINI_V2_MATH_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_BIOLOGY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_PHYSICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHEMISTRY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MACHINE_LEARNING_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_QA_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_ECONOMICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MEDICAL_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHESS_COMPLIANT", + "GEMINI_V2_YOUTUBE_SCIENCE_V4_FILTERED_COMPLIANT", + "GEMINI_V2_GOALDMINE_XL_GENERATED_PLUS_GT_NO_DM_MATH_COMPLIANT", + "GEMINI_V2_FIRSTTIMES_SCIENCE_PDF_DEDUP_HQ_LENGTH_FILTERED_COMPLIANT", + "GEMINI_V2_PODCASTS_COMPLIANT", + "GEMINI_V2_EN_NONSCIENCE_PDF_DEDUP_46M_DOCS_COMPLIANT", + "GEMINI_V2_NONPUB_COPYRIGHT_BOOKS_V3_70_CONF_082323_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_COPYRIGHT_BOOKS_V3_111823_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_BOOKS_318K_TEXT_COMPLIANT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_T2I_TEXT_TO_IMAGE_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_I18N_680M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_FULL_HTML_75M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_V1_1_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_DOC_240M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_VIDEO_VIDEO_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M4W_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CULTURE_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_DETECTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_ALT_TEXT_NONEN_500M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SPATIAL_AWARE_PALI_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_3D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_NON_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_3D_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CC3M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_INFOGRAPHICS_LARGE_WEB_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_BIORXIV_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PLOT2TABLE_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TIKZ_DERENDERING_MERGED_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_2D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WIKIPEDIA_EQUATIONS_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_EQ2LATEX_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_ARXIV_EQUATIONS_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_HEAD_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_CLM_TRANSLATE_DATAV3_WEB_UNWMT_INCR_MIX", + "GEMINI_V2_NTL_NTLV4A_MONOLINGUAL_DEDUP_N5", + "GEMINI_V2_NTL_STT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_TRANSLIT_BILEX_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_BT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_FT_FIXED_TRANSLATE_DEDUP_N5", + "GEMINI_V2_CANARIES_SHUFFLED_COMPLIANT" + ], + "enumDescriptions": [ + "", + "Wikipedia article Tensorflow datasets used by Tarzan and maintained by TFDS team.", + "Webdocs that have been filtered from the docjoins by the Tarzan team for use in the Tarzan training set.", + "", + "", + "'Full view' books dataset maintained by Oceanographers team, meaning 'ok to view the book in full in all localities'. Largely the same as 'public domain', but with potentially subtle distinction.", + "Filtered private books used by ULM: http://google3/learning/multipod/pax/lm/params/ulm/tasks.py;l=123;rcl=494241309. which corresponds with /cns/mf-d/home/multipod-language-data/private_books/books_filtered_en_resharded@50000", + "Google news dataset referenced in: http://google3/learning/brain/research/conversation/meena/t5/pretrain_tasks.py;l=922;rcl=496534668", + "The docjoins data for ULM /cns/yo-d/home/multipod-language-data/docjoins/rs=6.3/20220728/100B_docstructure_split/examples_en.tfrecord_lattice_05_score_01_HFV13@3929", + "", + "Meena full conversations. http://google3/learning/brain/research/conversation/meena/t5/pretrain_mixtures.py;l=675;rcl=496583228", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Academic dataset of math text. http://google3/learning/brain/research/conversation/meena/seqio/mixtures/experimental/bard.py;rcl=500222380", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Datasets managed by the Goodall team: deepmind-goodall@google.com", + "", + "", + "", + "", + "", + "", + "", + "Datasets used by Codepoet", + "Datasets used by Vertex", + "", + "", + "Datasets used by Gemini Public data", + "", + "", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "Arxiv", + "Others", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemini V1, order by precedence. Wikipedia", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "ArXiv", + "Citable misc", + "", + "", + "Non-public books", + "", + "", + "Other", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Duet AI finetune datasets, order by precedence.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Bard ARCADE finetune dataset.", + "Mobile assistant finetune datasets.", + "", + "Genesis fine-tune datasets.", + "Cloud Security fine-tune datasets.", + "", + "LABS AQA fine-tune datasets.", + "", + "", + "Gemini multimodal instruction tune(IT) and fine tune(FT) datasets datasets.", + "", + "", + "", + "", + "", + "", + "Gemini IT 1.2.7 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemit Bridge ULM FT dataset", + "Gemini IT Cloud Build datasets.", + "", + "", + "", + "", + "Gemini V2 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "displayAttributionMessage": { + "description": "human-friendly string that contains information from doc_attribution which could be shown by clients", + "type": "string" + }, + "docAttribution": { + "$ref": "LanguageLabsAidaTrustRecitationProtoDocAttribution", + "description": "populated when recitation_action == CITE" + }, + "docOccurrences": { + "description": "number of documents that contained this segment", + "format": "int32", + "type": "integer" + }, + "endIndex": { + "format": "int32", + "type": "integer" + }, + "rawText": { + "description": "The raw text in the given input that is corresponding to the segment. It will be available only when 'return_segment_raw_text' is enabled in the request options.", + "type": "string" + }, + "segmentRecitationAction": { + "enum": [ + "ACTION_UNSPECIFIED", + "CITE", + "BLOCK", + "NO_ACTION", + "EXEMPT_FOUND_IN_PROMPT" + ], + "enumDescriptions": [ + "", + "indicate that attribution must be shown for a Segment", + "indicate that a Segment should be blocked from being used", + "for tagging high-frequency code snippets", + "The recitation was found in prompt and is exempted from overall results" + ], + "type": "string" + }, + "startIndex": { + "description": "The segment boundary start (inclusive) and end index (exclusive) in the given text. In the streaming RPC, the indexes always start from the beginning of the first text in the entire stream. The indexes are measured in UTF-16 code units.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LanguageLabsAidaTrustRecitationProtoStreamRecitationResult": { + "description": "The recitation result for one stream input", + "id": "LanguageLabsAidaTrustRecitationProtoStreamRecitationResult", + "properties": { + "dynamicSegmentResults": { + "description": "The recitation result against the given dynamic data source.", + "items": { + "$ref": "LanguageLabsAidaTrustRecitationProtoSegmentResult" + }, + "type": "array" + }, + "fullyCheckedTextIndex": { + "description": "Last index of input text fully checked for recitation in the entire streaming context. Would return `-1` if no Input was checked for recitation.", + "format": "int32", + "type": "integer" + }, + "recitationAction": { + "description": "The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK > CITE > NO_ACTION.", + "enum": [ + "ACTION_UNSPECIFIED", + "CITE", + "BLOCK", + "NO_ACTION", + "EXEMPT_FOUND_IN_PROMPT" + ], + "enumDescriptions": [ + "", + "indicate that attribution must be shown for a Segment", + "indicate that a Segment should be blocked from being used", + "for tagging high-frequency code snippets", + "The recitation was found in prompt and is exempted from overall results" + ], + "type": "string" + }, + "trainingSegmentResults": { + "description": "The recitation result against model training data.", + "items": { + "$ref": "LanguageLabsAidaTrustRecitationProtoSegmentResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRecitationDocAttribution": { + "description": "The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30", + "id": "LearningGenaiRecitationDocAttribution", + "properties": { + "amarnaId": { + "type": "string" + }, + "arxivId": { + "type": "string" + }, + "author": { + "type": "string" + }, + "bibkey": { + "type": "string" + }, + "biorxivId": { + "description": "ID of the paper in bioarxiv like ddoi.org/{biorxiv_id} eg: https://doi.org/10.1101/343517", + "type": "string" + }, + "bookTitle": { + "type": "string" + }, + "bookVolumeId": { + "description": "The Oceanographers full-view books dataset uses a 'volume id' as the unique ID of a book. There is a deterministic function from a volume id to a URL under the books.google.com domain. Marked as 'optional' since a volume ID of zero is potentially possible and we want to distinguish that from the volume ID not being set.", + "format": "int64", + "type": "string" + }, + "conversationId": { + "type": "string" + }, + "dataset": { + "description": "The dataset this document comes from.", + "enum": [ + "DATASET_UNSPECIFIED", + "WIKIPEDIA", + "WEBDOCS", + "WEBDOCS_FINETUNE", + "GITHUB_MIRROR", + "BOOKS_FULL_VIEW", + "BOOKS_PRIVATE", + "GNEWS", + "ULM_DOCJOINS", + "ULM_DOCJOINS_DEDUPED", + "MEENA_FC", + "PODCAST", + "AQUA", + "WEB_ASR", + "BARD_GOLDEN", + "COMMON_SENSE_REASONING", + "MATH", + "MATH_REASONING", + "CLEAN_ARXIV", + "LAMDA_FACTUALITY_E2E_QUERY_GENERATION", + "LAMDA_FACTUALITY_E2E_RESPONSE_GENERATION", + "MASSIVE_FORUM_THREAD_SCORED_BARD", + "MASSIVE_FORUM_THREAD_SCORED_LONG_200", + "MASSIVE_FORUM_THREAD_SCORED_LONG_500", + "DOCUMENT_CHUNKS", + "MEENA_RESEARCH_PHASE_GOLDEN_MARKDOWN", + "MEENA_RESEARCH_PHASE_GOOGLERS", + "MEENA_RESPONSE_SAFETY_HUMAN_GEN", + "MEENA_RESPONSE_SAFETY_SCHEMA_NO_BROADCAST", + "MEENA_RESPONSE_SAFETY_V3_HUMAN_GEN2", + "MEENA_RESPONSE_SAFETY_V3_SCHEMA_NO_BROADCAST", + "LAMDA_FACTUALITY_TRIGGER", + "LAMDA_SAFETY_V2_SCHEMA_NO_BROADCAST", + "LAMDA_SSI_DISCRIMINATIVE", + "ASSISTANT_PERSONALITY_SAFETY", + "PODCAST_FINETUNE_DIALOG", + "WORLD_QUERY_GENERATOR", + "C4_JOINED_DOCJOINS", + "HOL4_THEORIES", + "HOL_LIGHT_THEORIES", + "HOLSTEPS", + "ISABELLE_STEP", + "ISABELLE_THEORIES", + "LEAN_MATHLIB_THEORIES", + "LEAN_STEP", + "MIZAR_THEORIES", + "COQ_STEP", + "COQ_THEORIES", + "AMPS_KHAN", + "AMPS_MATHEMATICA", + "CODEY_CODE", + "CODE_QA_SE", + "CODE_QA_SO", + "CODE_QA_FT_FORMAT", + "CODE_QA_FT_KNOWLEDGE", + "CODE_QA_GITHUB_FILTERED_CODE", + "BARD_PERSONALITY_GOLDEN", + "ULM_DOCJOINS_WITH_URLS_EN", + "ULM_DOCJOINS_WITH_URLS_I18N", + "GOODALL_MTV5_GITHUB", + "GOODALL_MTV5_BOOKS", + "GOODALL_MTV5_C4", + "GOODALL_MTV5_WIKIPEDIA", + "GOODALL_MW_TOP_100B", + "GOODALL_MW_STACK_EXCHANGE", + "GOODALL_MW_TOP_0_10B", + "GOODALL_MW_TOP_10B_20B", + "CODEY_NOTEBOOK_LM_PRETRAINING", + "VERTEX_SAFE_FLAN", + "GITHUB_MIRROR_V1_0_1", + "GITHUB_MIRROR_V2_1_0", + "CMS_WIKIPEDIA_LANG_FILTERED", + "CMS_STACKOVERFLOW_MULTILINGUAL", + "CMS_STACKEXCHANGE", + "PUBMED", + "GEMINI_DOCJOINS_EN_TOP10B_GCC", + "GEMINI_DOCJOINS_EN_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_EN_TOP20B_TOP100B_GCC", + "GEMINI_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_I18N_TOP20B_TOP100B_GCC", + "SIMPLIFIED_HTML_V1_GCC", + "GEMINI_DOCJOINS_TOXICITY_TAGGED_GCC", + "CMS_GITHUB_V4", + "GITHUB_HTML_V4", + "GITHUB_OTHER_V4", + "GITHUB_LONG_TAIL_V4", + "CMS_GITHUB_MULTIFILE_V4", + "GITHUB_DIFFS_WITH_COMMIT_MESSAGE", + "ULM_ARXIV", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_ENONLY", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_NONENONLY", + "QUORA", + "PODCASTS_ROBOTSTXT", + "COMBINED_REDDIT", + "CANARIES_SHUFFLED", + "CLM_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "TECHDOCS_DATA_SOURCE", + "SCIENCE_PDF_70M_DOCS_FILTERED", + "GEMINI_V1_CMS_WIKIPEDIA_LANG_FILTERED", + "GEMINI_V1_WIKIPEDIA_DIFFS", + "GEMINI_V1_DOCJOINS_EN_TOP10B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP10B_TOP20B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP20B_TOP100B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_TOP20B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP20B_TOP100B_GCC_050523", + "GEMINI_V1_SIMPLIFIED_HTML_V2_GCC", + "GEMINI_V1_CMS_STACKOVERFLOW_MULTILINGUAL_V2", + "GEMINI_V1_CMS_STACKEXCHANGE_DECONT", + "GEMINI_V1_QUORA", + "GEMINI_V1_COMBINED_REDDIT", + "GEMINI_V1_DOCJOIN_100B_EN_TOXICITY_TAGGED_GCC_FIXED_TAGS", + "GEMINI_V1_PUBMED", + "GEMINI_V1_WEB_MATH_V2", + "GEMINI_V1_CMS_GITHUB_DECONTAMINATED_V_7", + "GEMINI_V1_GITHUB_DIFF_WITH_COMMIT_MESSAGE_V2", + "GEMINI_V1_GITHUB_HTML_CSS_XML_V4", + "GEMINI_V1_GITHUB_OTHER_V4", + "GEMINI_V1_GITHUB_LONG_TAIL_V4", + "GEMINI_V1_GITHUB_JUPTYER_NOTEBOOKS_SSTABLE", + "GEMINI_V1_ULM_ARXIV_SSTABLE", + "GEMINI_V1_PODCASTS_ROBOTSTXT", + "GEMINI_V1_SCIENCE_PDF_68M_HQ_DOCS_GCC", + "GEMINI_V1_GITHUB_TECHDOCS_V2", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_EN", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_NONEN", + "GEMINI_V1_STEM_BOOKS_650K_TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_M3W_V2_FILTERED", + "GEMINI_V1_VQCOCA_1B_MULTIRES_WEBLI_EN_V4_350M_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_SCREENAI_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CULTURE_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_EN_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_I18N_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_NON_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_VTP_4F_VIDEO2TEXT_PREFIX", + "GEMINI_V1_FORMAL_MATH_WITHOUT_HOLSTEPS_AND_MIZAR", + "GEMINI_V1_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "GEMINI_V1_CANARIES_SHUFFLED_DOCJOIN_EN_NONEN_CODE_ARXIV_TRANSLATE", + "DUET_CLOUD_SECURITY_DOCS", + "DUET_GITHUB_CODE_SNIPPETS", + "DUET_GITHUB_FILES", + "DUET_GOBYEXAMPLE", + "DUET_GOLANG_DOCS", + "DUET_CLOUD_DOCS_TROUBLESHOOTING_TABLES", + "DUET_DEVSITE_DOCS", + "DUET_CLOUD_BLOG_POSTS", + "DUET_CLOUD_PODCAST_EPISODES", + "DUET_YOUTUBE_VIDEOS", + "DUET_CLOUD_SKILLS_BOOST", + "DUET_CLOUD_DOCS", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_GENERATED", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_HANDWRITTEN", + "DUET_GOOGLESQL_GENERATION", + "DUET_CLOUD_IX_PROMPTS", + "DUET_RAD", + "BARD_ARCADE_GITHUB", + "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", + "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", + "GENESIS_NEWS_INSIGHTS", + "CLOUD_SECURITY_PRETRAINING", + "CLOUD_SECURITY_FINETUNING", + "LABS_AQA_DSCOUT", + "LABS_AQA_TAILWIND", + "LABS_AQA_DELEWARE", + "GEMINI_MULTIMODAL_FT_URL", + "GEMINI_MULTIMODAL_FT_YT", + "GEMINI_MULTIMODAL_FT_SHUTTERSTOCK", + "GEMINI_MULTIMODAL_FT_NONE", + "GEMINI_MULTIMODAL_FT_OTHER", + "GEMINI_MULTIMODAL_FT_INK", + "GEMINI_MULTIMODAL_IT", + "GEMINI_IT_SHUTTERSTOCK", + "GEMINI_IT_M3W", + "GEMINI_IT_HEDGING", + "GEMINI_IT_DSCOUT_FACTUALITY", + "GEMINI_IT_AQUAMUSE", + "GEMINI_IT_SHOTGUN", + "GEMINI_IT_ACI_BENCH", + "GEMINI_IT_SPIDER_FILTERED", + "GEMINI_IT_TAB_SUM_BQ", + "GEMINI_IT_QA_WITH_URL", + "GEMINI_IT_CODE_INSTRUCT", + "GEMINI_IT_MED_PALM", + "GEMINI_IT_TASK_ORIENTED_DIALOG", + "GEMINI_IT_NIMBUS_GROUNDING_TO_PROMPT", + "GEMINI_IT_EITL_GEN", + "GEMINI_IT_HITL_GEN", + "GEMINI_IT_MECH", + "GEMINI_IT_TABLE_GEN", + "GEMINI_IT_NIMBUS_DECIBEL", + "GEMIT_BRIDGE_SUFFIX_FT", + "GEMINI_IT_CLOUD_CODE_IF", + "GEMINI_IT_CLOUD_EUR_LEX_JSON", + "GEMINI_IT_CLOUD_OASST", + "GEMINI_IT_CLOUD_SELF_INSTRUCT", + "GEMINI_IT_CLOUD_UCS_AQUAMUSE", + "GEMINI_V2_CMS_WIKIPEDIA_LANG_FILTERED_GCC_PII", + "GEMINI_V2_WIKIPEDIA_DIFFS_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_QUORA_COMPLIANT", + "GEMINI_V2_FORUMS_V2_COMPLIANT", + "GEMINI_V2_CMS_STACKOVERFLOW_MULTILINGUAL_V2_COMPLIANT", + "GEMINI_V2_SIMPLIFIED_HTML_V2_CORRECT_FORMAT_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_TOXICITY_TAGGED_FIXED_TAGS_COMPLIANT", + "GEMINI_V2_CODEWEB_V1_COMPLIANT", + "GEMINI_V2_LEETCODE_GCC_PII", + "GEMINI_V2_CODE_CONTESTS_COMPLIANT", + "GEMINI_V2_CMS_GITHUB_MULTI_FILE_FOR_FIM_GEMBAGZ_FIXED_BYTES_LENGTHS", + "GEMINI_V2_GITHUB_EVALED_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_NON_EVAL_HIGH_PRI_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_LOW_PRI_LANGUAGES_AND_CONFIGS_COMPLIANT", + "GEMINI_V2_GITHUB_LONG_TAIL_AND_STRUCTURED_DATA_COMPLIANT", + "GEMINI_V2_GITHUB_PYTHON_NOTEBOOKS_COMPLIANT", + "GEMINI_V2_GITHUB_DIFFS_COMPLIANT", + "GEMINI_V2_GITHUB_TECHDOCS_COMPLIANT", + "GEMINI_V2_HIGH_QUALITY_CODE_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_SCIENCE_PDF_68M_HQ_DOCS_DEDUP_COMPLIANT_CLEAN_TEX", + "GEMINI_V2_ARXIV_2023_COMPLIANT", + "GEMINI_V2_FORMAL_COMPLIANT", + "GEMINI_V2_CMS_STACKEXCHANGE_COMPLIANT", + "GEMINI_V2_PUBMED_COMPLIANT", + "GEMINI_V2_WEB_MATH_V3_COMPLIANT", + "GEMINI_V2_SCIENCEWEB_V0_GCC_PII", + "GEMINI_V2_WEB_POLYMATH_V1_COMPLIANT", + "GEMINI_V2_MATH_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_BIOLOGY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_PHYSICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHEMISTRY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MACHINE_LEARNING_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_QA_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_ECONOMICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MEDICAL_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHESS_COMPLIANT", + "GEMINI_V2_YOUTUBE_SCIENCE_V4_FILTERED_COMPLIANT", + "GEMINI_V2_GOALDMINE_XL_GENERATED_PLUS_GT_NO_DM_MATH_COMPLIANT", + "GEMINI_V2_FIRSTTIMES_SCIENCE_PDF_DEDUP_HQ_LENGTH_FILTERED_COMPLIANT", + "GEMINI_V2_PODCASTS_COMPLIANT", + "GEMINI_V2_EN_NONSCIENCE_PDF_DEDUP_46M_DOCS_COMPLIANT", + "GEMINI_V2_NONPUB_COPYRIGHT_BOOKS_V3_70_CONF_082323_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_COPYRIGHT_BOOKS_V3_111823_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_BOOKS_318K_TEXT_COMPLIANT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_T2I_TEXT_TO_IMAGE_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_I18N_680M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_FULL_HTML_75M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_V1_1_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_DOC_240M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_VIDEO_VIDEO_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M4W_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CULTURE_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_DETECTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_ALT_TEXT_NONEN_500M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SPATIAL_AWARE_PALI_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_3D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_NON_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_3D_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CC3M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_INFOGRAPHICS_LARGE_WEB_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_BIORXIV_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PLOT2TABLE_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TIKZ_DERENDERING_MERGED_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_2D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WIKIPEDIA_EQUATIONS_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_EQ2LATEX_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_ARXIV_EQUATIONS_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_HEAD_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_CLM_TRANSLATE_DATAV3_WEB_UNWMT_INCR_MIX", + "GEMINI_V2_NTL_NTLV4A_MONOLINGUAL_DEDUP_N5", + "GEMINI_V2_NTL_STT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_TRANSLIT_BILEX_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_BT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_FT_FIXED_TRANSLATE_DEDUP_N5", + "GEMINI_V2_CANARIES_SHUFFLED_COMPLIANT" + ], + "enumDescriptions": [ + "", + "Wikipedia article Tensorflow datasets used by Tarzan and maintained by TFDS team.", + "Webdocs that have been filtered from the docjoins by the Tarzan team for use in the Tarzan training set.", + "", + "", + "'Full view' books dataset maintained by Oceanographers team, meaning 'ok to view the book in full in all localities'. Largely the same as 'public domain', but with potentially subtle distinction.", + "Filtered private books used by ULM: http://google3/learning/multipod/pax/lm/params/ulm/tasks.py;l=123;rcl=494241309. which corresponds with /cns/mf-d/home/multipod-language-data/private_books/books_filtered_en_resharded@50000", + "Google news dataset referenced in: http://google3/learning/brain/research/conversation/meena/t5/pretrain_tasks.py;l=922;rcl=496534668", + "The docjoins data for ULM /cns/yo-d/home/multipod-language-data/docjoins/rs=6.3/20220728/100B_docstructure_split/examples_en.tfrecord_lattice_05_score_01_HFV13@3929", + "", + "Meena full conversations. http://google3/learning/brain/research/conversation/meena/t5/pretrain_mixtures.py;l=675;rcl=496583228", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Academic dataset of math text. http://google3/learning/brain/research/conversation/meena/seqio/mixtures/experimental/bard.py;rcl=500222380", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Datasets managed by the Goodall team: deepmind-goodall@google.com", + "", + "", + "", + "", + "", + "", + "", + "Datasets used by Codepoet", + "Datasets used by Vertex", + "", + "", + "Datasets used by Gemini Public data", + "", + "", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "Arxiv", + "Others", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemini V1, order by precedence. Wikipedia", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "ArXiv", + "Citable misc", + "", + "", + "Non-public books", + "", + "", + "Other", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Duet AI finetune datasets, order by precedence.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Bard ARCADE finetune dataset", + "Mobile assistant finetune datasets.", + "", + "Genesis fine tuned datasets.", + "Cloud Security fine tuned datasets.", + "", + "LABS AQA fine-tune datasets.", + "", + "", + "Gemini multimodal instruction tune(IT) and fine tune(FT) datasets datasets.", + "", + "", + "", + "", + "", + "", + "Gemini IT 1.2.7 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemit Bridge ULM FT dataset", + "Gemini IT Cloud Build datasets.", + "", + "", + "", + "", + "Gemini V2 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "filepath": { + "type": "string" + }, + "geminiId": { + "type": "string" + }, + "gnewsArticleTitle": { + "type": "string" + }, + "goodallExampleId": { + "type": "string" + }, + "isOptOut": { + "description": "Whether the document is opted out.", + "type": "boolean" + }, + "isPrompt": { + "description": "When true, this attribution came from the user's prompt.", + "type": "boolean" + }, + "lamdaExampleId": { + "type": "string" + }, + "license": { + "type": "string" + }, + "meenaConversationId": { + "type": "string" + }, + "naturalLanguageCode": { + "description": "Natural (not programming) language of the document. Language code as defined by http://www.unicode.org/reports/tr35/#Identifiers and https://tools.ietf.org/html/bcp47. Currently applicable to full-view books. Use docinfo-util.h to set & read language fields. See go/iii.", + "type": "string" + }, + "noAttribution": { + "description": "True if this doc has no attribution information available. We use an explicit field for this instead of just implicitly leaving all the DocAttribution fields blank to distinguish a case where a bug/oversight has left the attribution information empty vs when we really have no attribution information available.", + "type": "boolean" + }, + "podcastUtteranceId": { + "type": "string" + }, + "publicationDate": { + "$ref": "GoogleTypeDate" + }, + "qualityScoreExperimentOnly": { + "description": "This field is for opt-out experiment only, MUST never be used during actual production/serving. ", + "format": "double", + "type": "number" + }, + "repo": { + "description": "Github repository", + "type": "string" + }, + "url": { + "description": "URL of a webdoc", + "type": "string" + }, + "volumeId": { + "type": "string" + }, + "wikipediaArticleTitle": { + "description": "Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset.", + "type": "string" + }, + "youtubeVideoId": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRecitationRecitationResult": { + "description": "The recitation result for one input", + "id": "LearningGenaiRecitationRecitationResult", + "properties": { + "dynamicSegmentResults": { + "items": { + "$ref": "LearningGenaiRecitationSegmentResult" + }, + "type": "array" + }, + "recitationAction": { + "description": "The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK > CITE > NO_ACTION.", + "enum": [ + "ACTION_UNSPECIFIED", + "CITE", + "BLOCK", + "NO_ACTION", + "EXEMPT_FOUND_IN_PROMPT" + ], + "enumDescriptions": [ + "", + "indicate that attribution must be shown for a Segment", + "indicate that a Segment should be blocked from being used", + "for tagging high-frequency code snippets", + "The recitation was found in prompt and is exempted from overall results" + ], + "type": "string" + }, + "trainingSegmentResults": { + "items": { + "$ref": "LearningGenaiRecitationSegmentResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRecitationSegmentResult": { + "description": "The recitation result for each segment in a given input.", + "id": "LearningGenaiRecitationSegmentResult", + "properties": { + "attributionDataset": { + "description": "The dataset the segment came from.", + "enum": [ + "DATASET_UNSPECIFIED", + "WIKIPEDIA", + "WEBDOCS", + "WEBDOCS_FINETUNE", + "GITHUB_MIRROR", + "BOOKS_FULL_VIEW", + "BOOKS_PRIVATE", + "GNEWS", + "ULM_DOCJOINS", + "ULM_DOCJOINS_DEDUPED", + "MEENA_FC", + "PODCAST", + "AQUA", + "WEB_ASR", + "BARD_GOLDEN", + "COMMON_SENSE_REASONING", + "MATH", + "MATH_REASONING", + "CLEAN_ARXIV", + "LAMDA_FACTUALITY_E2E_QUERY_GENERATION", + "LAMDA_FACTUALITY_E2E_RESPONSE_GENERATION", + "MASSIVE_FORUM_THREAD_SCORED_BARD", + "MASSIVE_FORUM_THREAD_SCORED_LONG_200", + "MASSIVE_FORUM_THREAD_SCORED_LONG_500", + "DOCUMENT_CHUNKS", + "MEENA_RESEARCH_PHASE_GOLDEN_MARKDOWN", + "MEENA_RESEARCH_PHASE_GOOGLERS", + "MEENA_RESPONSE_SAFETY_HUMAN_GEN", + "MEENA_RESPONSE_SAFETY_SCHEMA_NO_BROADCAST", + "MEENA_RESPONSE_SAFETY_V3_HUMAN_GEN2", + "MEENA_RESPONSE_SAFETY_V3_SCHEMA_NO_BROADCAST", + "LAMDA_FACTUALITY_TRIGGER", + "LAMDA_SAFETY_V2_SCHEMA_NO_BROADCAST", + "LAMDA_SSI_DISCRIMINATIVE", + "ASSISTANT_PERSONALITY_SAFETY", + "PODCAST_FINETUNE_DIALOG", + "WORLD_QUERY_GENERATOR", + "C4_JOINED_DOCJOINS", + "HOL4_THEORIES", + "HOL_LIGHT_THEORIES", + "HOLSTEPS", + "ISABELLE_STEP", + "ISABELLE_THEORIES", + "LEAN_MATHLIB_THEORIES", + "LEAN_STEP", + "MIZAR_THEORIES", + "COQ_STEP", + "COQ_THEORIES", + "AMPS_KHAN", + "AMPS_MATHEMATICA", + "CODEY_CODE", + "CODE_QA_SE", + "CODE_QA_SO", + "CODE_QA_FT_FORMAT", + "CODE_QA_FT_KNOWLEDGE", + "CODE_QA_GITHUB_FILTERED_CODE", + "BARD_PERSONALITY_GOLDEN", + "ULM_DOCJOINS_WITH_URLS_EN", + "ULM_DOCJOINS_WITH_URLS_I18N", + "GOODALL_MTV5_GITHUB", + "GOODALL_MTV5_BOOKS", + "GOODALL_MTV5_C4", + "GOODALL_MTV5_WIKIPEDIA", + "GOODALL_MW_TOP_100B", + "GOODALL_MW_STACK_EXCHANGE", + "GOODALL_MW_TOP_0_10B", + "GOODALL_MW_TOP_10B_20B", + "CODEY_NOTEBOOK_LM_PRETRAINING", + "VERTEX_SAFE_FLAN", + "GITHUB_MIRROR_V1_0_1", + "GITHUB_MIRROR_V2_1_0", + "CMS_WIKIPEDIA_LANG_FILTERED", + "CMS_STACKOVERFLOW_MULTILINGUAL", + "CMS_STACKEXCHANGE", + "PUBMED", + "GEMINI_DOCJOINS_EN_TOP10B_GCC", + "GEMINI_DOCJOINS_EN_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_EN_TOP20B_TOP100B_GCC", + "GEMINI_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_GCC", + "GEMINI_DOCJOINS_I18N_TOP10B_TOP20B_GCC", + "GEMINI_DOCJOINS_I18N_TOP20B_TOP100B_GCC", + "SIMPLIFIED_HTML_V1_GCC", + "GEMINI_DOCJOINS_TOXICITY_TAGGED_GCC", + "CMS_GITHUB_V4", + "GITHUB_HTML_V4", + "GITHUB_OTHER_V4", + "GITHUB_LONG_TAIL_V4", + "CMS_GITHUB_MULTIFILE_V4", + "GITHUB_DIFFS_WITH_COMMIT_MESSAGE", + "ULM_ARXIV", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_ENONLY", + "NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_040623_LONG_DEDUP_NONENONLY", + "QUORA", + "PODCASTS_ROBOTSTXT", + "COMBINED_REDDIT", + "CANARIES_SHUFFLED", + "CLM_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "TECHDOCS_DATA_SOURCE", + "SCIENCE_PDF_70M_DOCS_FILTERED", + "GEMINI_V1_CMS_WIKIPEDIA_LANG_FILTERED", + "GEMINI_V1_WIKIPEDIA_DIFFS", + "GEMINI_V1_DOCJOINS_EN_TOP10B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP10B_TOP20B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP20B_TOP100B_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_EN_TOP100B_ALL_INDEXED_GCC_NODEDUP_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP10B_TOP20B_GCC_050523", + "GEMINI_V1_DOCJOINS_I18N_TOP20B_TOP100B_GCC_050523", + "GEMINI_V1_SIMPLIFIED_HTML_V2_GCC", + "GEMINI_V1_CMS_STACKOVERFLOW_MULTILINGUAL_V2", + "GEMINI_V1_CMS_STACKEXCHANGE_DECONT", + "GEMINI_V1_QUORA", + "GEMINI_V1_COMBINED_REDDIT", + "GEMINI_V1_DOCJOIN_100B_EN_TOXICITY_TAGGED_GCC_FIXED_TAGS", + "GEMINI_V1_PUBMED", + "GEMINI_V1_WEB_MATH_V2", + "GEMINI_V1_CMS_GITHUB_DECONTAMINATED_V_7", + "GEMINI_V1_GITHUB_DIFF_WITH_COMMIT_MESSAGE_V2", + "GEMINI_V1_GITHUB_HTML_CSS_XML_V4", + "GEMINI_V1_GITHUB_OTHER_V4", + "GEMINI_V1_GITHUB_LONG_TAIL_V4", + "GEMINI_V1_GITHUB_JUPTYER_NOTEBOOKS_SSTABLE", + "GEMINI_V1_ULM_ARXIV_SSTABLE", + "GEMINI_V1_PODCASTS_ROBOTSTXT", + "GEMINI_V1_SCIENCE_PDF_68M_HQ_DOCS_GCC", + "GEMINI_V1_GITHUB_TECHDOCS_V2", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_EN", + "GEMINI_V1_NONPUB_COPYRIGHT_BOOKS_V2_70_CONF_LONG_DEDUP_NONEN", + "GEMINI_V1_STEM_BOOKS_650K_TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_M3W_V2_FILTERED", + "GEMINI_V1_VQCOCA_1B_MULTIRES_WEBLI_EN_V4_350M_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_SCREENAI_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CULTURE_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_EN_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_CC3M_I18N_PREFIXED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_OCR_NON_EN_PREFIXED_FILTERED_IMAGE2TEXT", + "GEMINI_V1_VQCOCA_1B_MULTIRES_VTP_4F_VIDEO2TEXT_PREFIX", + "GEMINI_V1_FORMAL_MATH_WITHOUT_HOLSTEPS_AND_MIZAR", + "GEMINI_V1_TRANSLATE_DATAV2_ALLTIERS_GCC_MIX", + "GEMINI_V1_CANARIES_SHUFFLED_DOCJOIN_EN_NONEN_CODE_ARXIV_TRANSLATE", + "DUET_CLOUD_SECURITY_DOCS", + "DUET_GITHUB_CODE_SNIPPETS", + "DUET_GITHUB_FILES", + "DUET_GOBYEXAMPLE", + "DUET_GOLANG_DOCS", + "DUET_CLOUD_DOCS_TROUBLESHOOTING_TABLES", + "DUET_DEVSITE_DOCS", + "DUET_CLOUD_BLOG_POSTS", + "DUET_CLOUD_PODCAST_EPISODES", + "DUET_YOUTUBE_VIDEOS", + "DUET_CLOUD_SKILLS_BOOST", + "DUET_CLOUD_DOCS", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_GENERATED", + "DUET_CLOUD_GITHUB_CODE_SNIPPETS_HANDWRITTEN", + "DUET_GOOGLESQL_GENERATION", + "DUET_CLOUD_IX_PROMPTS", + "DUET_RAD", + "BARD_ARCADE_GITHUB", + "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K", + "MOBILE_ASSISTANT_PALM24B_FILTERED_400K", + "GENESIS_NEWS_INSIGHTS", + "CLOUD_SECURITY_PRETRAINING", + "CLOUD_SECURITY_FINETUNING", + "LABS_AQA_DSCOUT", + "LABS_AQA_TAILWIND", + "LABS_AQA_DELEWARE", + "GEMINI_MULTIMODAL_FT_URL", + "GEMINI_MULTIMODAL_FT_YT", + "GEMINI_MULTIMODAL_FT_SHUTTERSTOCK", + "GEMINI_MULTIMODAL_FT_NONE", + "GEMINI_MULTIMODAL_FT_OTHER", + "GEMINI_MULTIMODAL_FT_INK", + "GEMINI_MULTIMODAL_IT", + "GEMINI_IT_SHUTTERSTOCK", + "GEMINI_IT_M3W", + "GEMINI_IT_HEDGING", + "GEMINI_IT_DSCOUT_FACTUALITY", + "GEMINI_IT_AQUAMUSE", + "GEMINI_IT_SHOTGUN", + "GEMINI_IT_ACI_BENCH", + "GEMINI_IT_SPIDER_FILTERED", + "GEMINI_IT_TAB_SUM_BQ", + "GEMINI_IT_QA_WITH_URL", + "GEMINI_IT_CODE_INSTRUCT", + "GEMINI_IT_MED_PALM", + "GEMINI_IT_TASK_ORIENTED_DIALOG", + "GEMINI_IT_NIMBUS_GROUNDING_TO_PROMPT", + "GEMINI_IT_EITL_GEN", + "GEMINI_IT_HITL_GEN", + "GEMINI_IT_MECH", + "GEMINI_IT_TABLE_GEN", + "GEMINI_IT_NIMBUS_DECIBEL", + "GEMIT_BRIDGE_SUFFIX_FT", + "GEMINI_IT_CLOUD_CODE_IF", + "GEMINI_IT_CLOUD_EUR_LEX_JSON", + "GEMINI_IT_CLOUD_OASST", + "GEMINI_IT_CLOUD_SELF_INSTRUCT", + "GEMINI_IT_CLOUD_UCS_AQUAMUSE", + "GEMINI_V2_CMS_WIKIPEDIA_LANG_FILTERED_GCC_PII", + "GEMINI_V2_WIKIPEDIA_DIFFS_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP10B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP10B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP20B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP20B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP100B_211123_PII_FILTERED", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_NONARTICLES_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_NONEN_TOP100B_111323_WITHOUT_CJKT_STOP_ARTICLES_COMPLIANT", + "GEMINI_V2_ENGLISH_ARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_ENGLISH_NONARTICLES_TOP500B_211123_PII_FILTERED", + "GEMINI_V2_QUORA_COMPLIANT", + "GEMINI_V2_FORUMS_V2_COMPLIANT", + "GEMINI_V2_CMS_STACKOVERFLOW_MULTILINGUAL_V2_COMPLIANT", + "GEMINI_V2_SIMPLIFIED_HTML_V2_CORRECT_FORMAT_COMPLIANT", + "GEMINI_V2_GEMINI_DOCJOINS_TOXICITY_TAGGED_FIXED_TAGS_COMPLIANT", + "GEMINI_V2_CODEWEB_V1_COMPLIANT", + "GEMINI_V2_LEETCODE_GCC_PII", + "GEMINI_V2_CODE_CONTESTS_COMPLIANT", + "GEMINI_V2_CMS_GITHUB_MULTI_FILE_FOR_FIM_GEMBAGZ_FIXED_BYTES_LENGTHS", + "GEMINI_V2_GITHUB_EVALED_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_NON_EVAL_HIGH_PRI_LANGUAGES_COMPLIANT", + "GEMINI_V2_GITHUB_LOW_PRI_LANGUAGES_AND_CONFIGS_COMPLIANT", + "GEMINI_V2_GITHUB_LONG_TAIL_AND_STRUCTURED_DATA_COMPLIANT", + "GEMINI_V2_GITHUB_PYTHON_NOTEBOOKS_COMPLIANT", + "GEMINI_V2_GITHUB_DIFFS_COMPLIANT", + "GEMINI_V2_GITHUB_TECHDOCS_COMPLIANT", + "GEMINI_V2_HIGH_QUALITY_CODE_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_SCIENCE_PDF_68M_HQ_DOCS_DEDUP_COMPLIANT_CLEAN_TEX", + "GEMINI_V2_ARXIV_2023_COMPLIANT", + "GEMINI_V2_FORMAL_COMPLIANT", + "GEMINI_V2_CMS_STACKEXCHANGE_COMPLIANT", + "GEMINI_V2_PUBMED_COMPLIANT", + "GEMINI_V2_WEB_MATH_V3_COMPLIANT", + "GEMINI_V2_SCIENCEWEB_V0_GCC_PII", + "GEMINI_V2_WEB_POLYMATH_V1_COMPLIANT", + "GEMINI_V2_MATH_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_BIOLOGY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_PHYSICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHEMISTRY_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MACHINE_LEARNING_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_QA_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_ECONOMICS_V2_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_MEDICAL_TARGETED_DATA_COMPLIANT2", + "GEMINI_V2_CHESS_COMPLIANT", + "GEMINI_V2_YOUTUBE_SCIENCE_V4_FILTERED_COMPLIANT", + "GEMINI_V2_GOALDMINE_XL_GENERATED_PLUS_GT_NO_DM_MATH_COMPLIANT", + "GEMINI_V2_FIRSTTIMES_SCIENCE_PDF_DEDUP_HQ_LENGTH_FILTERED_COMPLIANT", + "GEMINI_V2_PODCASTS_COMPLIANT", + "GEMINI_V2_EN_NONSCIENCE_PDF_DEDUP_46M_DOCS_COMPLIANT", + "GEMINI_V2_NONPUB_COPYRIGHT_BOOKS_V3_70_CONF_082323_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_COPYRIGHT_BOOKS_V3_111823_LONG_DEDUP_ENONLY_COMPLIANT", + "GEMINI_V2_STEM_BOOKS_318K_TEXT_COMPLIANT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M3W_WITH_IMAGE_TOKENS_INSERTED_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_T2I_TEXT_TO_IMAGE_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_EN_V4_350M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_I18N_680M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_FULL_HTML_75M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SCREENAI_V1_1_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_OCR_DOC_240M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SHUTTERSTOCK_VIDEO_VIDEO_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_M4W_INTERLEAVED_COMPLIANT_PII_FILTERED_SOFT", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CULTURE_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_DETECTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WEBLI_ALT_TEXT_NONEN_500M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_SPATIAL_AWARE_PALI_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_3D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TABLE2MD_V2_NON_EN_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_3D_DOC_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CC3M_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_INFOGRAPHICS_LARGE_WEB_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_BIORXIV_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PLOT2TABLE_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_TIKZ_DERENDERING_MERGED_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_CLOUDAI_TABLE2HTML_2D_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_WIKIPEDIA_EQUATIONS_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_PHOTOMATH_EQ2LATEX_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_CACHED_VQCOCA_MMFT_17T_ARXIV_EQUATIONS_V2_IMAGE_TO_TEXT_COMPLIANT_PII_FILTERED", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_ASR_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_SUP_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_TTS_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_PODIOSET_INTERLEAVE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_ENUS_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_SCIENCE_I18N_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_1P5M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_USM2B_MLPV5_YT_INTERLEAVE_HEAD_4M_GEMBAGZ_V2_COMPLIANT", + "GEMINI_V2_CLM_TRANSLATE_DATAV3_WEB_UNWMT_INCR_MIX", + "GEMINI_V2_NTL_NTLV4A_MONOLINGUAL_DEDUP_N5", + "GEMINI_V2_NTL_STT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_TRANSLIT_BILEX_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_BT_TRANSLATE_DEDUP_N5", + "GEMINI_V2_NTL_SYN_FT_FIXED_TRANSLATE_DEDUP_N5", + "GEMINI_V2_CANARIES_SHUFFLED_COMPLIANT" + ], + "enumDescriptions": [ + "", + "Wikipedia article Tensorflow datasets used by Tarzan and maintained by TFDS team.", + "Webdocs that have been filtered from the docjoins by the Tarzan team for use in the Tarzan training set.", + "", + "", + "'Full view' books dataset maintained by Oceanographers team, meaning 'ok to view the book in full in all localities'. Largely the same as 'public domain', but with potentially subtle distinction.", + "Filtered private books used by ULM: http://google3/learning/multipod/pax/lm/params/ulm/tasks.py;l=123;rcl=494241309. which corresponds with /cns/mf-d/home/multipod-language-data/private_books/books_filtered_en_resharded@50000", + "Google news dataset referenced in: http://google3/learning/brain/research/conversation/meena/t5/pretrain_tasks.py;l=922;rcl=496534668", + "The docjoins data for ULM /cns/yo-d/home/multipod-language-data/docjoins/rs=6.3/20220728/100B_docstructure_split/examples_en.tfrecord_lattice_05_score_01_HFV13@3929", + "", + "Meena full conversations. http://google3/learning/brain/research/conversation/meena/t5/pretrain_mixtures.py;l=675;rcl=496583228", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Academic dataset of math text. http://google3/learning/brain/research/conversation/meena/seqio/mixtures/experimental/bard.py;rcl=500222380", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Datasets managed by the Goodall team: deepmind-goodall@google.com", + "", + "", + "", + "", + "", + "", + "", + "Datasets used by Codepoet", + "Datasets used by Vertex", + "", + "", + "Datasets used by Gemini Public data", + "", + "", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "Arxiv", + "Others", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemini V1, order by precedence. Wikipedia", + "", + "Public webdocs", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Github", + "", + "", + "", + "", + "", + "ArXiv", + "Citable misc", + "", + "", + "Non-public books", + "", + "", + "Other", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Duet AI finetune datasets, order by precedence.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Bard ARCADE finetune dataset", + "Mobile assistant finetune datasets.", + "", + "Genesis fine tuned datasets.", + "Cloud Security fine tuned datasets.", + "", + "LABS AQA fine-tune datasets.", + "", + "", + "Gemini multimodal instruction tune(IT) and fine tune(FT) datasets datasets.", + "", + "", + "", + "", + "", + "", + "Gemini IT 1.2.7 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Gemit Bridge ULM FT dataset", + "Gemini IT Cloud Build datasets.", + "", + "", + "", + "", + "Gemini V2 datasets", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "displayAttributionMessage": { + "description": "human-friendly string that contains information from doc_attribution which could be shown by clients", + "type": "string" + }, + "docAttribution": { + "$ref": "LearningGenaiRecitationDocAttribution", + "description": "populated when recitation_action == CITE" + }, + "docOccurrences": { + "description": "number of documents that contained this segment", + "format": "int32", + "type": "integer" + }, + "endIndex": { + "format": "int32", + "type": "integer" + }, + "rawText": { + "description": "The raw text in the given input that is corresponding to the segment. It will be available only when 'return_segment_raw_text' is enabled in the request options.", + "type": "string" + }, + "segmentRecitationAction": { + "enum": [ + "ACTION_UNSPECIFIED", + "CITE", + "BLOCK", + "NO_ACTION", + "EXEMPT_FOUND_IN_PROMPT" + ], + "enumDescriptions": [ + "", + "indicate that attribution must be shown for a Segment", + "indicate that a Segment should be blocked from being used", + "for tagging high-frequency code snippets", + "The recitation was found in prompt and is exempted from overall results" + ], + "type": "string" + }, + "startIndex": { + "description": "The segment boundary start (inclusive) and end index (exclusive) in the given text. In the streaming RPC, the indexes always start from the beginning of the first text in the entire stream. The indexes are measured in UTF-16 code units.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LearningGenaiRootCalculationType": { + "description": "The type used for final weights calculation.", + "id": "LearningGenaiRootCalculationType", + "properties": { + "scoreType": { + "enum": [ + "TYPE_UNKNOWN", + "TYPE_SAFE", + "TYPE_POLICY", + "TYPE_GENERATION" + ], + "enumDescriptions": [ + "Unknown scorer type.", + "Safety scorer.", + "Policy scorer.", + "Generation scorer." + ], + "type": "string" + }, + "weights": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootClassifierOutput": { + "id": "LearningGenaiRootClassifierOutput", + "properties": { + "ruleOutput": { + "$ref": "LearningGenaiRootRuleOutput", + "deprecated": true, + "description": "If set, this is the output of the first matching rule." + }, + "ruleOutputs": { + "description": "outputs of all matching rule.", + "items": { + "$ref": "LearningGenaiRootRuleOutput" + }, + "type": "array" + }, + "state": { + "$ref": "LearningGenaiRootClassifierState", + "description": "The results of data_providers and metrics." + } + }, + "type": "object" + }, + "LearningGenaiRootClassifierOutputSummary": { + "id": "LearningGenaiRootClassifierOutputSummary", + "properties": { + "metrics": { + "items": { + "$ref": "LearningGenaiRootMetricOutput" + }, + "type": "array" + }, + "ruleOutput": { + "$ref": "LearningGenaiRootRuleOutput", + "deprecated": true, + "description": "Output of the first matching rule." + }, + "ruleOutputs": { + "description": "outputs of all matching rule.", + "items": { + "$ref": "LearningGenaiRootRuleOutput" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootClassifierState": { + "description": "DataProviderOutput and MetricOutput can be saved between calls to the Classifier framework. For instance, you can run the query classifier, get outputs from those metrics, then use them in a result classifier as well. Example rule based on this idea: and_rules { rule { metric_name: 'query_safesearch_v2' ... } rule { metric_name: 'response_safesearch_v2' ... } }", + "id": "LearningGenaiRootClassifierState", + "properties": { + "dataProviderOutput": { + "items": { + "$ref": "LearningGenaiRootDataProviderOutput" + }, + "type": "array" + }, + "metricOutput": { + "items": { + "$ref": "LearningGenaiRootMetricOutput" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootDataProviderOutput": { + "id": "LearningGenaiRootDataProviderOutput", + "properties": { + "name": { + "type": "string" + }, + "status": { + "$ref": "UtilStatusProto", + "description": "If set, this DataProvider failed and this is the error message." + } + }, + "type": "object" + }, + "LearningGenaiRootFilterMetadata": { + "id": "LearningGenaiRootFilterMetadata", + "properties": { + "confidence": { + "description": "Filter confidence.", + "enum": [ + "FILTER_CONFIDENCE_UNKNOWN", + "FILTER_CONFIDENCE_VERY_LOW", + "FILTER_CONFIDENCE_LOW", + "FILTER_CONFIDENCE_MEDIUM", + "FILTER_CONFIDENCE_HIGH", + "FILTER_CONFIDENCE_VERY_HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "debugInfo": { + "$ref": "LearningGenaiRootFilterMetadataFilterDebugInfo", + "description": "Debug info for the message." + }, + "fallback": { + "description": "A fallback message chosen by the applied filter.", + "type": "string" + }, + "info": { + "description": "Additional info for the filter.", + "type": "string" + }, + "name": { + "description": "Name of the filter that triggered.", + "type": "string" + }, + "reason": { + "description": "Filter reason.", + "enum": [ + "FILTER_REASON_UNKNOWN", + "FILTER_REASON_NOT_FILTERED", + "FILTER_REASON_SENSITIVE", + "FILTER_REASON_RECITATION", + "FILTER_REASON_LANGUAGE", + "FILTER_REASON_TAKEDOWN", + "FILTER_REASON_CLASSIFIER", + "FILTER_REASON_EMPTY_RESPONSE", + "FILTER_REASON_SIMILARITY_TAKEDOWN", + "FILTER_REASON_UNSAFE", + "FILTER_REASON_PAIRWISE_CLASSIFIER", + "FILTER_REASON_CODEY", + "FILTER_REASON_URL", + "FILTER_REASON_EMAIL", + "FILTER_REASON_SAFETY_CAT", + "FILTER_REASON_REQUEST_RESPONSE_TAKEDOWN", + "FILTER_REASON_RAI_PQC", + "FILTER_REASON_ATLAS", + "FILTER_REASON_RAI_CSAM", + "FILTER_REASON_RAI_FRINGE", + "FILTER_REASON_RAI_SPII", + "FILTER_REASON_RAI_IMAGE_VIOLENCE", + "FILTER_REASON_RAI_IMAGE_PORN", + "FILTER_REASON_RAI_IMAGE_CSAM", + "FILTER_REASON_RAI_IMAGE_PEDO", + "FILTER_REASON_RAI_VIDEO_FRAME_VIOLENCE", + "FILTER_REASON_RAI_VIDEO_FRAME_PORN", + "FILTER_REASON_RAI_VIDEO_FRAME_CSAM", + "FILTER_REASON_RAI_VIDEO_FRAME_PEDO", + "FILTER_REASON_RAI_CONTEXTUAL_DANGEROUS", + "FILTER_REASON_RAI_GRAIL_TEXT", + "FILTER_REASON_RAI_GRAIL_IMAGE", + "FILTER_REASON_RAI_SAFETYCAT", + "FILTER_REASON_TOXICITY", + "FILTER_REASON_ATLAS_PRICING", + "FILTER_REASON_ATLAS_BILLING", + "FILTER_REASON_ATLAS_NON_ENGLISH_QUESTION", + "FILTER_REASON_ATLAS_NOT_RELATED_TO_GCP", + "FILTER_REASON_ATLAS_AWS_AZURE_RELATED" + ], + "enumDescriptions": [ + "Unknown filter reason.", + "Input not filtered.", + "Sensitive content.", + "Recited content.", + "Language filtering", + "Takedown policy", + "Classifier Module", + "Empty response message.", + "Similarity takedown.", + "Unsafe responses from scorers.", + "Pairwise classifier.", + "Codey Filter.", + "URLs Filter.", + "Emails Filter.", + "SafetyCat filter.", + "Request Response takedown.", + "RAI Filter.", + "Atlas specific topic filter", + "RAI Filter.", + "RAI Filter.", + "RAI Filter.", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "RAI Filter", + "Grail Text", + "Grail Image", + "SafetyCat.", + "Toxic content.", + "Atlas specific topic filter for pricing questions.", + "Atlas specific topic filter for billing questions.", + "Atlas specific topic filter for non english questions.", + "Atlas specific topic filter for non GCP questions.", + "Atlas specific topic filter aws/azure related questions." + ], + "type": "string" + }, + "text": { + "description": "The input query or generated response that is getting filtered.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootFilterMetadataFilterDebugInfo": { + "id": "LearningGenaiRootFilterMetadataFilterDebugInfo", + "properties": { + "classifierOutput": { + "$ref": "LearningGenaiRootClassifierOutput" + }, + "defaultMetadata": { + "type": "string" + }, + "languageFilterResult": { + "$ref": "LearningGenaiRootLanguageFilterResult" + }, + "raiOutput": { + "$ref": "LearningGenaiRootRAIOutput", + "description": "Safety filter output information for LLM Root RAI harm check." + }, + "raiResult": { + "$ref": "CloudAiNlLlmProtoServiceRaiResult" + }, + "raiSignal": { + "$ref": "CloudAiNlLlmProtoServiceRaiSignal", + "deprecated": true + }, + "streamRecitationResult": { + "$ref": "LanguageLabsAidaTrustRecitationProtoStreamRecitationResult", + "deprecated": true + }, + "takedownResult": { + "$ref": "LearningGenaiRootTakedownResult" + }, + "toxicityResult": { + "$ref": "LearningGenaiRootToxicityResult" + } + }, + "type": "object" + }, + "LearningGenaiRootGroundingMetadata": { + "id": "LearningGenaiRootGroundingMetadata", + "properties": { + "citations": { + "items": { + "$ref": "LearningGenaiRootGroundingMetadataCitation" + }, + "type": "array" + }, + "groundingCancelled": { + "description": "True if grounding is cancelled, for example, no facts being retrieved.", + "type": "boolean" + }, + "searchQueries": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootGroundingMetadataCitation": { + "id": "LearningGenaiRootGroundingMetadataCitation", + "properties": { + "endIndex": { + "description": "Index in the prediction output where the citation ends (exclusive). Must be > start_index and < len(output).", + "format": "int32", + "type": "integer" + }, + "factIndex": { + "description": "Index of the fact supporting this claim. Should be within the range of the `world_facts` in the GenerateResponse.", + "format": "int32", + "type": "integer" + }, + "score": { + "description": "Confidence score of this entailment. Value is [0,1] with 1 is the most confidence.", + "format": "double", + "type": "number" + }, + "startIndex": { + "description": "Index in the prediction output where the citation starts (inclusive). Must be >= 0 and < end_index.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LearningGenaiRootHarm": { + "id": "LearningGenaiRootHarm", + "properties": { + "contextualDangerous": { + "description": "Please do not use, this is still under development.", + "type": "boolean" + }, + "csam": { + "type": "boolean" + }, + "fringe": { + "type": "boolean" + }, + "grailImageHarmType": { + "$ref": "LearningGenaiRootHarmGrailImageHarmType" + }, + "grailTextHarmType": { + "$ref": "LearningGenaiRootHarmGrailTextHarmType" + }, + "imageCsam": { + "type": "boolean" + }, + "imagePedo": { + "type": "boolean" + }, + "imagePorn": { + "description": "Image signals", + "type": "boolean" + }, + "imageViolence": { + "type": "boolean" + }, + "pqc": { + "type": "boolean" + }, + "safetycat": { + "$ref": "LearningGenaiRootHarmSafetyCatCategories" + }, + "spii": { + "$ref": "LearningGenaiRootHarmSpiiFilter" + }, + "threshold": { + "format": "double", + "type": "number" + }, + "videoFrameCsam": { + "type": "boolean" + }, + "videoFramePedo": { + "type": "boolean" + }, + "videoFramePorn": { + "description": "Video frame signals", + "type": "boolean" + }, + "videoFrameViolence": { + "type": "boolean" + } + }, + "type": "object" + }, + "LearningGenaiRootHarmGrailImageHarmType": { + "description": "Harm type for images", + "id": "LearningGenaiRootHarmGrailImageHarmType", + "properties": { + "imageHarmType": { + "items": { + "enum": [ + "IMAGE_HARM_TYPE_UNSPECIFIED", + "IMAGE_HARM_TYPE_PORN", + "IMAGE_HARM_TYPE_VIOLENCE", + "IMAGE_HARM_TYPE_CSAI", + "IMAGE_HARM_TYPE_PEDO", + "IMAGE_HARM_TYPE_MINORS", + "IMAGE_HARM_TYPE_DANGEROUS", + "IMAGE_HARM_TYPE_MEDICAL", + "IMAGE_HARM_TYPE_RACY", + "IMAGE_HARM_TYPE_OBSCENE", + "IMAGE_HARM_TYPE_MINOR_PRESENCE", + "IMAGE_HARM_TYPE_GENERATIVE_MINOR_PRESENCE", + "IMAGE_HARM_TYPE_GENERATIVE_REALISTIC_VISIBLE_FACE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootHarmGrailTextHarmType": { + "description": "Harm type for text", + "id": "LearningGenaiRootHarmGrailTextHarmType", + "properties": { + "harmType": { + "items": { + "enum": [ + "HARM_TYPE_UNSPECIFIED", + "HARM_TYPE_HATE", + "HARM_TYPE_TOXICITY", + "HARM_TYPE_VIOLENCE", + "HARM_TYPE_CSAI", + "HARM_TYPE_SEXUAL", + "HARM_TYPE_FRINGE", + "HARM_TYPE_POLITICAL", + "HARM_TYPE_MEMORIZATION", + "HARM_TYPE_SPII", + "HARM_TYPE_NEW_DANGEROUS", + "HARM_TYPE_MEDICAL", + "HARM_TYPE_HARASSMENT" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "New definition of dangerous.", + "", + "" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootHarmSafetyCatCategories": { + "id": "LearningGenaiRootHarmSafetyCatCategories", + "properties": { + "categories": { + "items": { + "enum": [ + "SAFETYCAT_CATEGORY_UNSPECIFIED", + "TOXICITY", + "OBSCENE", + "SEXUAL", + "INSULT", + "IDENTITY_HATE", + "DEATH_HARM_TRAGEDY", + "VIOLENCE_ABUSE", + "FIREARMS_WEAPONS", + "PUBLIC_SAFETY", + "HEALTH", + "RELIGION_BELIEF", + "DRUGS", + "WAR_CONFLICT", + "POLITICS", + "FINANCE", + "LEGAL", + "DANGEROUS", + "DANGEROUS_SEVERITY", + "HARASSMENT_SEVERITY", + "HATE_SEVERITY", + "SEXUAL_SEVERITY" + ], + "enumDescriptions": [ + "", + "SafetyCat categories.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "Following categories are only supported in SAFETY_CAT_TEXT_V3_PAX model", + "", + "", + "", + "" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootHarmSpiiFilter": { + "id": "LearningGenaiRootHarmSpiiFilter", + "properties": { + "usBankRoutingMicr": { + "type": "boolean" + }, + "usEmployerIdentificationNumber": { + "type": "boolean" + }, + "usSocialSecurityNumber": { + "type": "boolean" + } + }, + "type": "object" + }, + "LearningGenaiRootInternalMetadata": { + "id": "LearningGenaiRootInternalMetadata", + "properties": { + "scoredTokens": { + "items": { + "$ref": "LearningGenaiRootScoredToken" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootLanguageFilterResult": { + "id": "LearningGenaiRootLanguageFilterResult", + "properties": { + "allowed": { + "description": "False when query or response should be filtered out due to unsupported language.", + "type": "boolean" + }, + "detectedLanguage": { + "description": "Language of the query or response.", + "type": "string" + }, + "detectedLanguageProbability": { + "description": "Probability of the language predicted as returned by LangID.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootMetricOutput": { + "id": "LearningGenaiRootMetricOutput", + "properties": { + "debug": { + "type": "string" + }, + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "numericValue": { + "format": "double", + "type": "number" + }, + "status": { + "$ref": "UtilStatusProto" + }, + "stringValue": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRAIOutput": { + "description": "This is per harm.", + "id": "LearningGenaiRootRAIOutput", + "properties": { + "allowed": { + "type": "boolean" + }, + "harm": { + "$ref": "LearningGenaiRootHarm" + }, + "name": { + "type": "string" + }, + "score": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootRegexTakedownResult": { + "id": "LearningGenaiRootRegexTakedownResult", + "properties": { + "allowed": { + "description": "False when query or response should be taken down due to match with a blocked regex, true otherwise.", + "type": "boolean" + }, + "takedownRegex": { + "description": "Regex used to decide that query or response should be taken down. Empty when query or response is kept.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRequestResponseTakedownResult": { + "id": "LearningGenaiRootRequestResponseTakedownResult", + "properties": { + "allowed": { + "description": "False when response has to be taken down per above config.", + "type": "boolean" + }, + "requestTakedownRegex": { + "description": "Regex used to match the request.", + "type": "string" + }, + "responseTakedownRegex": { + "description": "Regex used to decide that response should be taken down. Empty when response is kept.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecision": { + "description": "Holds the final routing decision, by storing the model_config_id. And individual scores each model got.", + "id": "LearningGenaiRootRoutingDecision", + "properties": { + "metadata": { + "$ref": "LearningGenaiRootRoutingDecisionMetadata" + }, + "modelConfigId": { + "description": "The selected model to route traffic to.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecisionMetadata": { + "description": "Debug metadata about the routing decision.", + "id": "LearningGenaiRootRoutingDecisionMetadata", + "properties": { + "scoreBasedRoutingMetadata": { + "$ref": "LearningGenaiRootRoutingDecisionMetadataScoreBased" + }, + "tokenLengthBasedRoutingMetadata": { + "$ref": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBased" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecisionMetadataScoreBased": { + "description": "If we are routing using scored based configuration, then the metadata about that is available in this proto.", + "id": "LearningGenaiRootRoutingDecisionMetadataScoreBased", + "properties": { + "matchedRule": { + "$ref": "LearningGenaiRootScoreBasedRoutingConfigRule", + "description": "The rule that was matched." + }, + "score": { + "$ref": "LearningGenaiRootScore", + "description": "The score that was generated by the router i.e. the model." + }, + "usedDefaultFallback": { + "description": "No rules were matched & therefore used the default fallback.", + "type": "boolean" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecisionMetadataTokenLengthBased": { + "id": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBased", + "properties": { + "modelInputTokenMetadata": { + "items": { + "$ref": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelInputTokenMetadata" + }, + "type": "array" + }, + "modelMaxTokenMetadata": { + "items": { + "$ref": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelMaxTokenMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelInputTokenMetadata": { + "id": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelInputTokenMetadata", + "properties": { + "computedInputTokenLength": { + "description": "The length computed by backends using the formatter & tokenizer specific to the model", + "format": "int32", + "type": "integer" + }, + "modelId": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelMaxTokenMetadata": { + "id": "LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelMaxTokenMetadata", + "properties": { + "maxNumInputTokens": { + "format": "int32", + "type": "integer" + }, + "maxNumOutputTokens": { + "format": "int32", + "type": "integer" + }, + "modelId": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootRuleOutput": { + "id": "LearningGenaiRootRuleOutput", + "properties": { + "decision": { + "enum": [ + "NO_MATCH", + "MATCH" + ], + "enumDescriptions": [ + "This rule was not matched. When used in a ClassifierOutput, this means that no rules were matched.", + "This is a generic \"match\" message, indicating that a rule was triggered. Usually you would use this for a categorization classifier." + ], + "type": "string" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootScore": { + "id": "LearningGenaiRootScore", + "properties": { + "calculationType": { + "$ref": "LearningGenaiRootCalculationType" + }, + "internalMetadata": { + "$ref": "LearningGenaiRootInternalMetadata", + "description": "The internal_metadata is intended to be used by internal processors and will be cleared before returns." + }, + "thresholdType": { + "$ref": "LearningGenaiRootThresholdType" + }, + "tokensAndLogprobPerDecodingStep": { + "$ref": "LearningGenaiRootTokensAndLogProbPerDecodingStep", + "description": "Top candidate tokens and log probabilities at each decoding step." + }, + "value": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootScoreBasedRoutingConfigRule": { + "id": "LearningGenaiRootScoreBasedRoutingConfigRule", + "properties": { + "equalOrGreaterThan": { + "$ref": "LearningGenaiRootScore", + "description": "NOTE: Hardest examples have smaller values in their routing scores." + }, + "lessThan": { + "$ref": "LearningGenaiRootScore" + }, + "modelConfigId": { + "description": "This model_config_id points to ModelConfig::id which allows us to find the ModelConfig to route to. This is part of the banks specified in the ModelBankConfig.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootScoredSimilarityTakedownPhrase": { + "description": "Proto containing the results from the Universal Sentence Encoder / Other models", + "id": "LearningGenaiRootScoredSimilarityTakedownPhrase", + "properties": { + "phrase": { + "$ref": "LearningGenaiRootSimilarityTakedownPhrase" + }, + "similarityScore": { + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootScoredToken": { + "description": "A token with its own score.", + "id": "LearningGenaiRootScoredToken", + "properties": { + "endTokenScore": { + "description": "Each end_token_score is a logprob for how well the completion would end at a particular token. See http://google3/labs/language/aida/config/proto/model_config.proto;l=376;rcl=573039459", + "format": "float", + "type": "number" + }, + "score": { + "description": "Each score is the logprob for the token in model response.", + "format": "float", + "type": "number" + }, + "token": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootSimilarityTakedownPhrase": { + "description": "Each SimilarityTakedownPhrase treats a logical group of blocked and allowed phrases together along with a corresponding punt If the closest matching response is of the allowed type, we allow the response If the closest matching response is of the blocked type, we block the response. eg: Blocked phrase - \"All lives matter\"", + "id": "LearningGenaiRootSimilarityTakedownPhrase", + "properties": { + "blockedPhrase": { + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootSimilarityTakedownResult": { + "id": "LearningGenaiRootSimilarityTakedownResult", + "properties": { + "allowed": { + "description": "False when query or response should be taken down by any of the takedown rules, true otherwise.", + "type": "boolean" + }, + "scoredPhrases": { + "description": "List of similar phrases with score. Set only if allowed=false.", + "items": { + "$ref": "LearningGenaiRootScoredSimilarityTakedownPhrase" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootTakedownResult": { + "id": "LearningGenaiRootTakedownResult", + "properties": { + "allowed": { + "description": "False when query or response should be taken down by any of the takedown rules, true otherwise.", + "type": "boolean" + }, + "regexTakedownResult": { + "$ref": "LearningGenaiRootRegexTakedownResult" + }, + "requestResponseTakedownResult": { + "$ref": "LearningGenaiRootRequestResponseTakedownResult" + }, + "similarityTakedownResult": { + "$ref": "LearningGenaiRootSimilarityTakedownResult" + } + }, + "type": "object" + }, + "LearningGenaiRootThresholdType": { + "description": "The type of score that bundled with a threshold, and will not be attending the final score calculation. How each score type uses the threshold can be implementation details.", + "id": "LearningGenaiRootThresholdType", + "properties": { + "scoreType": { + "enum": [ + "TYPE_UNKNOWN", + "TYPE_SAFE", + "TYPE_POLICY", + "TYPE_GENERATION" + ], + "enumDescriptions": [ + "Unknown scorer type.", + "Safety scorer.", + "Policy scorer.", + "Generation scorer." + ], + "type": "string" + }, + "threshold": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "LearningGenaiRootTokensAndLogProbPerDecodingStep": { + "description": "Results of RandomSamplingParams::top_k_logprob_per_decoding_step.", + "id": "LearningGenaiRootTokensAndLogProbPerDecodingStep", + "properties": { + "chosenCandidates": { + "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.", + "items": { + "$ref": "LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate" + }, + "type": "array" + }, + "topCandidates": { + "description": "Length = total number of decoding steps.", + "items": { + "$ref": "LearningGenaiRootTokensAndLogProbPerDecodingStepTopCandidates" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate": { + "description": "A candidate at a decoding step.", + "id": "LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate", + "properties": { + "logProbability": { + "description": "The candidate's log probability.", + "format": "float", + "type": "number" + }, + "token": { + "description": "The candidate’s token value.", + "type": "string" + } + }, + "type": "object" + }, + "LearningGenaiRootTokensAndLogProbPerDecodingStepTopCandidates": { + "description": "Candidates with top log probabilities at each decoding step.", + "id": "LearningGenaiRootTokensAndLogProbPerDecodingStepTopCandidates", + "properties": { + "candidates": { + "description": "Sorted by log probability in descending order.", + "items": { + "$ref": "LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootToxicityResult": { + "description": "A model can generate multiple signals and this captures all the generated signals for a single message.", + "id": "LearningGenaiRootToxicityResult", + "properties": { + "signals": { + "items": { + "$ref": "LearningGenaiRootToxicitySignal" + }, + "type": "array" + } + }, + "type": "object" + }, + "LearningGenaiRootToxicitySignal": { + "description": "Proto to capture a signal generated by the toxicity model.", + "id": "LearningGenaiRootToxicitySignal", + "properties": { + "allowed": { + "type": "boolean" + }, + "label": { + "enum": [ + "LABEL_UNSPECIFIED", + "NOT_SENSITIVE", + "SENSITIVE", + "ACCIDENTS_DISASTERS", + "ADULT", + "COMPUTER_SECURITY", + "CONTROVERSIAL_SOCIAL_ISSUES", + "DEATH_TRAGEDY", + "DRUGS", + "IDENTITY_ETHNICITY", + "FINANCIAL_HARDSHIP", + "FIREARMS_WEAPONS", + "HEALTH", + "INSULT", + "LEGAL", + "MENTAL_HEALTH", + "POLITICS", + "RELIGION_BELIEFS", + "SAFETY", + "SELF_HARM", + "SPECIAL_NEEDS", + "TERRORISM", + "TOXIC", + "TROUBLED_RELATIONSHIP", + "VIOLENCE_ABUSE", + "VULGAR", + "WAR_CONFLICT" + ], + "enumDescriptions": [ + "Default label.", + "Input is not sensitive.", + "Input is sensitive.", + "Input is related to accidents or disasters.", + "Input contains adult content.", + "Input is related to computer security.", + "Input contains controversial social issues.", + "Input is related to death tragedy.", + "Input is related to drugs.", + "Input is related to identity or ethnicity.", + "Input is related to financial hardship.", + "Input is related to firearms or weapons.", + "Input contains health related information.", + "Input may be an insult.", + "Input is related to legal content.", + "Input contains mental health related information.", + "Input is related to politics.", + "Input is related to religions or beliefs.", + "Input is related to safety.", + "Input is related to self-harm.", + "Input is related to special needs.", + "Input is related to terrorism.", + "Input is toxic.", + "Input is related to troubled relationships.", + "Input contains content about violence or abuse.", + "Input is vulgar.", + "Input is related to war and conflict." + ], + "type": "string" + }, + "score": { + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "LearningServingLlmMessageMetadata": { + "description": "LINT.IfChange This metadata contains additional information required for debugging.", + "id": "LearningServingLlmMessageMetadata", + "properties": { + "classifierSummary": { + "$ref": "LearningGenaiRootClassifierOutputSummary", + "description": "Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not." + }, + "currentStreamTextLength": { + "format": "uint32", + "type": "integer" + }, + "deleted": { + "description": "Whether the corresponding message has been deleted.", + "type": "boolean" + }, + "filterMeta": { + "description": "Metadata for filters that triggered.", + "items": { + "$ref": "LearningGenaiRootFilterMetadata" + }, + "type": "array" + }, + "finalMessageScore": { + "$ref": "LearningGenaiRootScore", + "description": "This score is finally used for ranking the message. This will be same as the score present in `Message.score` field." + }, + "finishReason": { + "description": "NOT YET IMPLEMENTED.", + "enum": [ + "UNSPECIFIED", + "RETURN", + "STOP", + "MAX_TOKENS", + "FILTER" + ], + "enumDescriptions": [ + "", + "Return all the tokens back. This typically implies no filtering or stop sequence was triggered.", + "Finished due to provided stop sequence.", + "Model has emitted the maximum number of tokens as specified by max_decoding_steps.", + "Finished due to triggering some post-processing filter." + ], + "type": "string" + }, + "groundingMetadata": { + "$ref": "LearningGenaiRootGroundingMetadata" + }, + "isFallback": { + "description": "Applies to Response message only. Indicates whether the message is a fallback and the response would have otherwise been empty.", + "type": "boolean" + }, + "langidResult": { + "$ref": "NlpSaftLangIdResult", + "description": "Result from nlp_saft DetectLanguage method. Currently the predicted language code and language probability is used." + }, + "language": { + "description": "Detected language.", + "type": "string" + }, + "lmPrefix": { + "description": "The LM prefix used to generate this response.", + "type": "string" + }, + "originalText": { + "description": "The original text generated by LLM. This is the raw output for debugging purposes.", + "type": "string" + }, + "perStreamDecodedTokenCount": { + "description": "NOT YET IMPLEMENTED. Applies to streaming only. Number of tokens decoded / emitted by the model as part of this stream. This may be different from token_count, which contains number of tokens returned in this response after any response rewriting / truncation.", + "format": "int32", + "type": "integer" + }, + "raiOutputs": { + "description": "Results of running RAI on the query or this response candidate. One output per rai_config. It will be populated regardless of whether the threshold is exceeded or not.", + "items": { + "$ref": "LearningGenaiRootRAIOutput" + }, + "type": "array" + }, + "recitationResult": { + "$ref": "LearningGenaiRecitationRecitationResult", + "description": "Recitation Results. It will be populated as long as Recitation processing is enabled, regardless of recitation outcome." + }, + "returnTokenCount": { + "description": "NOT YET IMPLEMENTED. Number of tokens returned as part of this candidate.", + "format": "int32", + "type": "integer" + }, + "scores": { + "description": "All the different scores for a message are logged here.", + "items": { + "$ref": "LearningGenaiRootScore" + }, + "type": "array" + }, + "streamTerminated": { + "description": "Whether the response is terminated during streaming return. Only used for streaming requests.", + "type": "boolean" + }, + "totalDecodedTokenCount": { + "description": "NOT YET IMPLEMENTED. Aggregated number of total tokens decoded so far. For streaming, this is sum of all the tokens decoded so far i.e. aggregated count.", + "format": "int32", + "type": "integer" + }, + "translatedUserPrompts": { + "description": "Translated user-prompt used for RAI post processing. This is for internal processing only. We will translate in pre-processor and pass the translated text to the post processor using this field. It will be empty if non of the signals requested need translation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "vertexRaiResult": { + "$ref": "CloudAiNlLlmProtoServiceRaiResult", + "description": "The metadata from Vertex SafetyCat processors" + } + }, + "type": "object" + }, + "NlpSaftLangIdLocalesResult": { + "id": "NlpSaftLangIdLocalesResult", + "properties": { + "predictions": { + "description": "List of locales in which the text would be considered acceptable. Sorted in descending order according to each locale's respective likelihood. For example, if a Portuguese text is acceptable in both Brazil and Portugal, but is more strongly associated with Brazil, then the predictions would be [\"pt-BR\", \"pt-PT\"], in that order. May be empty, indicating that the model did not predict any acceptable locales.", + "items": { + "$ref": "NlpSaftLangIdLocalesResultLocale" + }, + "type": "array" + } + }, + "type": "object" + }, + "NlpSaftLangIdLocalesResultLocale": { + "id": "NlpSaftLangIdLocalesResultLocale", + "properties": { + "languageCode": { + "description": "A BCP 47 language code that includes region information. For example, \"pt-BR\" or \"pt-PT\". This field will always be populated.", + "type": "string" + } + }, + "type": "object" + }, + "NlpSaftLangIdResult": { + "id": "NlpSaftLangIdResult", + "properties": { + "modelVersion": { + "description": "The version of the model used to create these annotations.", + "enum": [ + "VERSION_UNSPECIFIED", + "INDEXING_20181017", + "INDEXING_20191206", + "INDEXING_20200313", + "INDEXING_20210618", + "STANDARD_20220516" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "predictions": { + "description": "This field stores the n-best list of possible BCP 47 language code strings for a given input sorted in descending order according to each code's respective probability.", + "items": { + "$ref": "NlpSaftLanguageSpan" + }, + "type": "array" + }, + "spanPredictions": { + "description": "This field stores language predictions of subspans of the input, when available. Each LanguageSpanSequence is a sequence of LanguageSpans. A particular sequence of LanguageSpans has an associated probability, and need not necessarily cover the entire input. If no language could be predicted for any span, then this field may be empty.", + "items": { + "$ref": "NlpSaftLanguageSpanSequence" + }, + "type": "array" + } + }, + "type": "object" + }, + "NlpSaftLanguageSpan": { + "id": "NlpSaftLanguageSpan", + "properties": { + "end": { + "format": "int32", + "type": "integer" + }, + "languageCode": { + "description": "A BCP 47 language code for this span.", + "type": "string" + }, + "locales": { + "$ref": "NlpSaftLangIdLocalesResult", + "description": "Optional field containing any information that was predicted about the specific locale(s) of the span." + }, + "probability": { + "description": "A probability associated with this prediction.", + "format": "float", + "type": "number" + }, + "start": { + "description": "Start and end byte offsets, inclusive, within the given input string. A value of -1 implies that this field is not set. Both fields must either be set with a nonnegative value or both are unset. If both are unset then this LanguageSpan applies to the entire input.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "NlpSaftLanguageSpanSequence": { + "id": "NlpSaftLanguageSpanSequence", + "properties": { + "languageSpans": { + "description": "A sequence of LanguageSpan objects, each assigning a language to a subspan of the input.", + "items": { + "$ref": "NlpSaftLanguageSpan" + }, + "type": "array" + }, + "probability": { + "description": "The probability of this sequence of LanguageSpans.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "Proto2BridgeMessageSet": { + "description": "This is proto2's version of MessageSet.", + "id": "Proto2BridgeMessageSet", + "properties": {}, + "type": "object" + }, + "UtilStatusProto": { + "description": "Wire-format for a Status object", + "id": "UtilStatusProto", + "properties": { + "canonicalCode": { + "description": "The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be.", + "format": "int32", + "type": "integer" + }, + "code": { + "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto", + "format": "int32", + "type": "integer" + }, + "message": { + "description": "Detail message", + "type": "string" + }, + "messageSet": { + "$ref": "Proto2BridgeMessageSet", + "description": "message_set associates an arbitrary proto message with the status." + }, + "space": { + "description": "The following are usually only present when code != 0 Space to which this status belongs", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index b68516b8cb..ec433606d6 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -331,6 +331,10 @@ export namespace aiplatform_v1 { * The reason why the model stopped generating tokens. */ finishReason?: string | null; + /** + * Grounding metadata. Combine with the facts list from response to generate grounding citations for this choice. + */ + groundingMetadata?: Schema$LearningGenaiRootGroundingMetadata; /** * Index of the candidate. */ @@ -391,6 +395,27 @@ export namespace aiplatform_v1 { */ role?: string | null; } + /** + * A condense version of WorldFact (assistant/boq/lamda/factuality/proto/factuality.proto) to propagate the essential information about the fact used in factuality to the upstream caller. + */ + export interface Schema$CloudAiNlLlmProtoServiceFact { + /** + * Query that is used to retrieve this fact. + */ + query?: string | null; + /** + * If present, the summary/snippet of the fact. + */ + summary?: string | null; + /** + * If present, it refers to the title of this fact. + */ + title?: string | null; + /** + * If present, this URL links to the webpage of the fact. + */ + url?: string | null; + } /** * Function call details. */ @@ -422,6 +447,14 @@ export namespace aiplatform_v1 { * Possible candidate responses to the conversation up until this point. */ candidates?: Schema$CloudAiNlLlmProtoServiceCandidate[]; + /** + * Debug information containing message metadata. Clients should not consume this field, and this is only populated for Flow Runner path. + */ + debugMetadata?: Schema$CloudAiNlLlmProtoServiceMessageMetadata; + /** + * External facts retrieved for factuality/grounding. + */ + facts?: Schema$CloudAiNlLlmProtoServiceFact[]; /** * 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. */ @@ -435,6 +468,20 @@ export namespace aiplatform_v1 { */ usageMetadata?: Schema$CloudAiNlLlmProtoServiceUsageMetadata; } + export interface Schema$CloudAiNlLlmProtoServiceMessageMetadata { + /** + * Filter metadata of the input messages. + */ + inputFilterInfo?: Schema$LearningServingLlmMessageMetadata; + /** + * This score is generated by the router model to decide which model to use + */ + modelRoutingDecision?: Schema$LearningGenaiRootRoutingDecision; + /** + * Filter metadata of the output messages. + */ + outputFilterInfo?: Schema$LearningServingLlmMessageMetadata[]; + } /** * A single part of a message. */ @@ -502,11 +549,28 @@ export namespace aiplatform_v1 { * The end offset of the video. */ endOffset?: string | null; + /** + * Internal only model level metadata. + */ + modelLevelMetaData?: Schema$CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata; /** * The start offset of the video. */ startOffset?: string | null; } + /** + * Internal only fields + */ + export interface Schema$CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata { + /** + * Frame rate to decode from this video. + */ + fps?: number | null; + /** + * Number of frames to decode from this video. + */ + numFrames?: number | null; + } /** * Content filter results for a prompt sent in the request. */ @@ -524,6 +588,68 @@ export namespace aiplatform_v1 { */ safetyRatings?: Schema$CloudAiNlLlmProtoServiceSafetyRating[]; } + /** + * The RAI results for a given text. + */ + export interface Schema$CloudAiNlLlmProtoServiceRaiResult { + /** + * Recitation result from Aida recitation checker. + */ + aidaRecitationResult?: Schema$LanguageLabsAidaTrustRecitationProtoRecitationResult; + /** + * Use `triggered_blocklist`. + */ + blocked?: boolean | null; + /** + * The error codes indicate which RAI filters block the response. + */ + errorCodes?: number[] | null; + /** + * Whether the text should be filtered and not shown to the end user. This is determined based on a combination of `triggered_recitation`, `triggered_blocklist`, `language_filter_result`, and `triggered_safety_filter`. + */ + filtered?: boolean | null; + /** + * Language filter result from SAFT LangId. + */ + languageFilterResult?: Schema$LearningGenaiRootLanguageFilterResult; + /** + * The RAI signals for the text. + */ + raiSignals?: Schema$CloudAiNlLlmProtoServiceRaiSignal[]; + /** + * Whether the text triggered the blocklist. + */ + triggeredBlocklist?: boolean | null; + /** + * Whether the text should be blocked by the recitation result from Aida recitation checker. It is determined from aida_recitation_result. + */ + triggeredRecitation?: boolean | null; + /** + * Whether the text triggered the safety filter. Currently, this is due to CSAI triggering or one of four categories (derogatory, sexual, toxic, violent) having a score over the filter threshold. + */ + triggeredSafetyFilter?: boolean | null; + } + /** + * An RAI signal for a single category. + */ + export interface Schema$CloudAiNlLlmProtoServiceRaiSignal { + /** + * The confidence level for the RAI category. + */ + confidence?: string | null; + /** + * Whether the category is flagged as being present. Currently, this is set to true if score \>= 0.5. + */ + flagged?: boolean | null; + /** + * The RAI category. + */ + raiCategory?: string | null; + /** + * The score for the category, in the range [0.0, 1.0]. + */ + score?: number | null; + } /** * Safety rating corresponding to the generated content. */ @@ -1859,6 +1985,10 @@ export namespace aiplatform_v1 { * 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-/`. */ pipelineJobId?: string | null; + /** + * Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines. + */ + preflightValidations?: boolean | null; } /** * Details of operations that perform create FeatureGroup. @@ -3111,7 +3241,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1Explanation { /** - * 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. 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. + * 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. */ attributions?: Schema$GoogleCloudAiplatformV1Attribution[]; /** @@ -4386,10 +4516,6 @@ export namespace aiplatform_v1 { * 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. */ contents?: Schema$GoogleCloudAiplatformV1Content[]; - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string | null; /** * Optional. Generation config. */ @@ -4932,6 +5058,10 @@ export namespace aiplatform_v1 { * Output only. The ip address used to send match gRPC requests. */ matchGrpcAddress?: string | null; + /** + * Output only. PscAutomatedEndpoints is populated if private service connect is enabled if PscAutomatedConfig is set. + */ + pscAutomatedEndpoints?: Schema$GoogleCloudAiplatformV1PscAutomatedEndpoints[]; /** * Output only. The name of the service attachment resource. Populated if private service connect is enabled. */ @@ -6051,7 +6181,7 @@ export namespace aiplatform_v1 { */ metadataSchemaUri?: string | null; /** - * Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model. + * 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. */ modelSourceInfo?: Schema$GoogleCloudAiplatformV1ModelSourceInfo; /** @@ -7467,6 +7597,10 @@ export namespace aiplatform_v1 { * The runtime config of a PipelineJob. */ export interface Schema$GoogleCloudAiplatformV1PipelineJobRuntimeConfig { + /** + * Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview + */ + defaultRuntime?: Schema$GoogleCloudAiplatformV1PipelineJobRuntimeConfigDefaultRuntime; /** * 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. */ @@ -7492,6 +7626,15 @@ export namespace aiplatform_v1 { */ parameterValues?: {[key: string]: any} | null; } + /** + * The default runtime for the PipelineJob. + */ + export interface Schema$GoogleCloudAiplatformV1PipelineJobRuntimeConfigDefaultRuntime { + /** + * Persistent resource based runtime detail. + */ + persistentResourceRuntimeDetail?: Schema$GoogleCloudAiplatformV1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail; + } /** * The type of an input artifact. */ @@ -7501,6 +7644,15 @@ export namespace aiplatform_v1 { */ artifactId?: string | null; } + /** + * Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview + */ + export interface Schema$GoogleCloudAiplatformV1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail { + /** + * Persistent resource name. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` + */ + persistentResourceName?: string | null; + } /** * The runtime detail of a task execution. */ @@ -7815,6 +7967,23 @@ export namespace aiplatform_v1 { */ command?: string[] | null; } + /** + * PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig. + */ + export interface Schema$GoogleCloudAiplatformV1PscAutomatedEndpoints { + /** + * Ip Address created by the automated forwarding rule. + */ + matchAddress?: string | null; + /** + * Corresponding network in pscAutomationConfigs. + */ + network?: string | null; + /** + * Corresponding project_id in pscAutomationConfigs + */ + projectId?: string | null; + } /** * A Model Garden Publisher Model. */ @@ -7876,6 +8045,10 @@ export namespace aiplatform_v1 { * Optional. Open fine-tuning pipeline of the PublisherModel. */ openFineTuningPipeline?: Schema$GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences; + /** + * Optional. Open fine-tuning pipelines of the PublisherModel. + */ + openFineTuningPipelines?: Schema$GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines; /** * Optional. Open in Generation AI Studio. */ @@ -7888,6 +8061,10 @@ export namespace aiplatform_v1 { * Optional. Open notebook of the PublisherModel. */ openNotebook?: Schema$GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences; + /** + * Optional. Open notebooks of the PublisherModel. + */ + openNotebooks?: Schema$GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks; /** * Optional. Open prompt-tuning pipeline of the PublisherModel. */ @@ -7942,6 +8119,24 @@ export namespace aiplatform_v1 { */ title?: string | null; } + /** + * Open fine tuning pipelines. + */ + export interface Schema$GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines { + /** + * Required. Regional resource references to fine tuning pipelines. + */ + fineTuningPipelines?: Schema$GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences[]; + } + /** + * Open notebooks. + */ + export interface Schema$GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks { + /** + * Required. Regional resource references to notebooks. + */ + notebooks?: Schema$GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences[]; + } /** * The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. */ @@ -7955,7 +8150,19 @@ export namespace aiplatform_v1 { ]: Schema$GoogleCloudAiplatformV1PublisherModelResourceReference; } | null; /** - * Required. The title of the regional resource reference. + * Optional. Description of the resource. + */ + resourceDescription?: string | null; + /** + * Optional. Title of the resource. + */ + resourceTitle?: string | null; + /** + * Optional. Use case (CUJ) of the resource. + */ + resourceUseCase?: string | null; + /** + * Required. */ title?: string | null; } @@ -9528,7 +9735,7 @@ export namespace aiplatform_v1 { */ enterpriseDatastore?: string | null; /** - * The grounding text passed inline with the Predict API. It can support up to 1 million token context. + * The grounding text passed inline with the Predict API. It can support up to 1 million bytes. */ inlineContext?: string | null; /** @@ -11449,6 +11656,15 @@ export namespace aiplatform_v1 { */ featureSelector?: Schema$GoogleCloudAiplatformV1FeatureSelector; } + /** + * Request message for PredictionService.StreamRawPredict. + */ + export interface Schema$GoogleCloudAiplatformV1StreamRawPredictRequest { + /** + * The prediction input. Supports HTTP headers and arbitrary data payload. + */ + httpBody?: Schema$GoogleApiHttpBody; + } /** * A list of string values. */ @@ -12857,7 +13073,7 @@ export namespace aiplatform_v1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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). */ role?: string | null; } @@ -13086,373 +13302,2255 @@ export namespace aiplatform_v1 { */ metricEntries?: Schema$IntelligenceCloudAutomlXpsMetricEntry[]; } - - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - } - } - - export class Resource$Projects$Locations { - context: APIRequestContext; - batchPredictionJobs: Resource$Projects$Locations$Batchpredictionjobs; - customJobs: Resource$Projects$Locations$Customjobs; - dataLabelingJobs: Resource$Projects$Locations$Datalabelingjobs; - datasets: Resource$Projects$Locations$Datasets; - deploymentResourcePools: Resource$Projects$Locations$Deploymentresourcepools; - endpoints: Resource$Projects$Locations$Endpoints; - featureGroups: Resource$Projects$Locations$Featuregroups; - featureOnlineStores: Resource$Projects$Locations$Featureonlinestores; - featurestores: Resource$Projects$Locations$Featurestores; - hyperparameterTuningJobs: Resource$Projects$Locations$Hyperparametertuningjobs; - indexEndpoints: Resource$Projects$Locations$Indexendpoints; - indexes: Resource$Projects$Locations$Indexes; - metadataStores: Resource$Projects$Locations$Metadatastores; - migratableResources: Resource$Projects$Locations$Migratableresources; - modelDeploymentMonitoringJobs: Resource$Projects$Locations$Modeldeploymentmonitoringjobs; - models: Resource$Projects$Locations$Models; - nasJobs: Resource$Projects$Locations$Nasjobs; - notebookRuntimes: Resource$Projects$Locations$Notebookruntimes; - notebookRuntimeTemplates: Resource$Projects$Locations$Notebookruntimetemplates; - operations: Resource$Projects$Locations$Operations; - pipelineJobs: Resource$Projects$Locations$Pipelinejobs; - publishers: Resource$Projects$Locations$Publishers; - schedules: Resource$Projects$Locations$Schedules; - specialistPools: Resource$Projects$Locations$Specialistpools; - studies: Resource$Projects$Locations$Studies; - tensorboards: Resource$Projects$Locations$Tensorboards; - trainingPipelines: Resource$Projects$Locations$Trainingpipelines; - constructor(context: APIRequestContext) { - this.context = context; - this.batchPredictionJobs = - new Resource$Projects$Locations$Batchpredictionjobs(this.context); - this.customJobs = new Resource$Projects$Locations$Customjobs( - this.context - ); - this.dataLabelingJobs = new Resource$Projects$Locations$Datalabelingjobs( - this.context - ); - this.datasets = new Resource$Projects$Locations$Datasets(this.context); - this.deploymentResourcePools = - new Resource$Projects$Locations$Deploymentresourcepools(this.context); - this.endpoints = new Resource$Projects$Locations$Endpoints(this.context); - this.featureGroups = new Resource$Projects$Locations$Featuregroups( - this.context - ); - this.featureOnlineStores = - new Resource$Projects$Locations$Featureonlinestores(this.context); - this.featurestores = new Resource$Projects$Locations$Featurestores( - this.context - ); - this.hyperparameterTuningJobs = - new Resource$Projects$Locations$Hyperparametertuningjobs(this.context); - this.indexEndpoints = new Resource$Projects$Locations$Indexendpoints( - this.context - ); - this.indexes = new Resource$Projects$Locations$Indexes(this.context); - this.metadataStores = new Resource$Projects$Locations$Metadatastores( - this.context - ); - this.migratableResources = - new Resource$Projects$Locations$Migratableresources(this.context); - this.modelDeploymentMonitoringJobs = - new Resource$Projects$Locations$Modeldeploymentmonitoringjobs( - this.context - ); - this.models = new Resource$Projects$Locations$Models(this.context); - this.nasJobs = new Resource$Projects$Locations$Nasjobs(this.context); - this.notebookRuntimes = new Resource$Projects$Locations$Notebookruntimes( - this.context - ); - this.notebookRuntimeTemplates = - new Resource$Projects$Locations$Notebookruntimetemplates(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.pipelineJobs = new Resource$Projects$Locations$Pipelinejobs( - this.context - ); - this.publishers = new Resource$Projects$Locations$Publishers( - this.context - ); - this.schedules = new Resource$Projects$Locations$Schedules(this.context); - this.specialistPools = new Resource$Projects$Locations$Specialistpools( - this.context - ); - this.studies = new Resource$Projects$Locations$Studies(this.context); - this.tensorboards = new Resource$Projects$Locations$Tensorboards( - this.context - ); - this.trainingPipelines = - new Resource$Projects$Locations$Trainingpipelines(this.context); - } - + /** + * The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30 + */ + export interface Schema$LanguageLabsAidaTrustRecitationProtoDocAttribution { + amarnaId?: string | null; + arxivId?: string | null; + author?: string | null; + bibkey?: string | null; /** - * Gets information about a location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * ID of the paper in bioarxiv like ddoi.org/{biorxiv_id\} eg: https://doi.org/10.1101/343517 */ - get( - params: Params$Resource$Projects$Locations$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - + biorxivId?: string | null; + bookTitle?: string | null; /** - * Lists information about the supported locations for this service. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The Oceanographers full-view books dataset uses a 'volume id' as the unique ID of a book. There is a deterministic function from a volume id to a URL under the books.google.com domain. Marked as 'optional' since a volume ID of zero is potentially possible and we want to distinguish that from the volume ID not being set. */ - list( - params: Params$Resource$Projects$Locations$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } + bookVolumeId?: string | null; + category?: string | null; + conversationId?: string | null; + /** + * The dataset this document comes from. + */ + dataset?: string | null; + filepath?: string | null; + geminiId?: string | null; + gnewsArticleTitle?: string | null; + goodallExampleId?: string | null; + /** + * Whether the document is opted out. + */ + isOptOut?: boolean | null; + isPrompt?: boolean | null; + lamdaExampleId?: string | null; + license?: string | null; + meenaConversationId?: string | null; + /** + * Natural (not programming) language of the document. Language code as defined by http://www.unicode.org/reports/tr35/#Identifiers and https://tools.ietf.org/html/bcp47. Currently applicable to full-view books. Use docinfo-util.h to set & read language fields. See go/iii. + */ + naturalLanguageCode?: string | null; + /** + * True if this doc has no attribution information available. We use an explicit field for this instead of just implicitly leaving all the DocAttribution fields blank to distinguish a case where a bug/oversight has left the attribution information empty vs when we really have no attribution information available. + */ + noAttribution?: boolean | null; + podcastUtteranceId?: string | null; + publicationDate?: Schema$GoogleTypeDate; + /** + * This field is for opt-out experiment only, MUST never be used during actual production/serving. + */ + qualityScoreExperimentOnly?: number | null; + /** + * Github repository + */ + repo?: string | null; + /** + * URL of a webdoc + */ + url?: string | null; + volumeId?: string | null; + /** + * Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset. + */ + wikipediaArticleTitle?: string | null; + /** + * The unique video id from Youtube. Example: AkoGsW52Ir0 + */ + youtubeVideoId?: string | null; } - - export interface Params$Resource$Projects$Locations$Get - extends StandardParameters { + /** + * The recitation result for one input + */ + export interface Schema$LanguageLabsAidaTrustRecitationProtoRecitationResult { + dynamicSegmentResults?: Schema$LanguageLabsAidaTrustRecitationProtoSegmentResult[]; /** - * Resource name for the location. + * The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK \> CITE \> NO_ACTION. */ - name?: string; + recitationAction?: string | null; + trainingSegmentResults?: Schema$LanguageLabsAidaTrustRecitationProtoSegmentResult[]; } - export interface Params$Resource$Projects$Locations$List - extends StandardParameters { + /** + * The recitation result for each segment in a given input. + */ + export interface Schema$LanguageLabsAidaTrustRecitationProtoSegmentResult { /** - * 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). + * The dataset the segment came from. */ - filter?: string; + attributionDataset?: string | null; /** - * The resource that owns the locations collection, if applicable. + * human-friendly string that contains information from doc_attribution which could be shown by clients */ - name?: string; + displayAttributionMessage?: string | null; /** - * The maximum number of results to return. If not set, the service selects a default. + * populated when recitation_action == CITE */ - pageSize?: number; + docAttribution?: Schema$LanguageLabsAidaTrustRecitationProtoDocAttribution; /** - * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * number of documents that contained this segment */ - pageToken?: string; + docOccurrences?: number | null; + endIndex?: number | null; + /** + * The raw text in the given input that is corresponding to the segment. It will be available only when 'return_segment_raw_text' is enabled in the request options. + */ + rawText?: string | null; + segmentRecitationAction?: string | null; + /** + * The segment boundary start (inclusive) and end index (exclusive) in the given text. In the streaming RPC, the indexes always start from the beginning of the first text in the entire stream. The indexes are measured in UTF-16 code units. + */ + startIndex?: number | null; } - - export class Resource$Projects$Locations$Batchpredictionjobs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - + /** + * The recitation result for one stream input + */ + export interface Schema$LanguageLabsAidaTrustRecitationProtoStreamRecitationResult { /** - * 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. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The recitation result against the given dynamic data source. */ - cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, - options: StreamMethodOptions - ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, - options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: + dynamicSegmentResults?: Schema$LanguageLabsAidaTrustRecitationProtoSegmentResult[]; + /** + * Last index of input text fully checked for recitation in the entire streaming context. Would return `-1` if no Input was checked for recitation. + */ + fullyCheckedTextIndex?: number | null; + /** + * The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK \> CITE \> NO_ACTION. + */ + recitationAction?: string | null; + /** + * The recitation result against model training data. + */ + trainingSegmentResults?: Schema$LanguageLabsAidaTrustRecitationProtoSegmentResult[]; + } + /** + * The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30 + */ + export interface Schema$LearningGenaiRecitationDocAttribution { + amarnaId?: string | null; + arxivId?: string | null; + author?: string | null; + bibkey?: string | null; + /** + * ID of the paper in bioarxiv like ddoi.org/{biorxiv_id\} eg: https://doi.org/10.1101/343517 + */ + biorxivId?: string | null; + bookTitle?: string | null; + /** + * The Oceanographers full-view books dataset uses a 'volume id' as the unique ID of a book. There is a deterministic function from a volume id to a URL under the books.google.com domain. Marked as 'optional' since a volume ID of zero is potentially possible and we want to distinguish that from the volume ID not being set. + */ + bookVolumeId?: string | null; + conversationId?: string | null; + /** + * The dataset this document comes from. + */ + dataset?: string | null; + filepath?: string | null; + geminiId?: string | null; + gnewsArticleTitle?: string | null; + goodallExampleId?: string | null; + /** + * Whether the document is opted out. + */ + isOptOut?: boolean | null; + /** + * When true, this attribution came from the user's prompt. + */ + isPrompt?: boolean | null; + lamdaExampleId?: string | null; + license?: string | null; + meenaConversationId?: string | null; + /** + * Natural (not programming) language of the document. Language code as defined by http://www.unicode.org/reports/tr35/#Identifiers and https://tools.ietf.org/html/bcp47. Currently applicable to full-view books. Use docinfo-util.h to set & read language fields. See go/iii. + */ + naturalLanguageCode?: string | null; + /** + * True if this doc has no attribution information available. We use an explicit field for this instead of just implicitly leaving all the DocAttribution fields blank to distinguish a case where a bug/oversight has left the attribution information empty vs when we really have no attribution information available. + */ + noAttribution?: boolean | null; + podcastUtteranceId?: string | null; + publicationDate?: Schema$GoogleTypeDate; + /** + * This field is for opt-out experiment only, MUST never be used during actual production/serving. + */ + qualityScoreExperimentOnly?: number | null; + /** + * Github repository + */ + repo?: string | null; + /** + * URL of a webdoc + */ + url?: string | null; + volumeId?: string | null; + /** + * Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset. + */ + wikipediaArticleTitle?: string | null; + youtubeVideoId?: string | null; + } + /** + * The recitation result for one input + */ + export interface Schema$LearningGenaiRecitationRecitationResult { + dynamicSegmentResults?: Schema$LearningGenaiRecitationSegmentResult[]; + /** + * The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK \> CITE \> NO_ACTION. + */ + recitationAction?: string | null; + trainingSegmentResults?: Schema$LearningGenaiRecitationSegmentResult[]; + } + /** + * The recitation result for each segment in a given input. + */ + export interface Schema$LearningGenaiRecitationSegmentResult { + /** + * The dataset the segment came from. + */ + attributionDataset?: string | null; + /** + * human-friendly string that contains information from doc_attribution which could be shown by clients + */ + displayAttributionMessage?: string | null; + /** + * populated when recitation_action == CITE + */ + docAttribution?: Schema$LearningGenaiRecitationDocAttribution; + /** + * number of documents that contained this segment + */ + docOccurrences?: number | null; + endIndex?: number | null; + /** + * The raw text in the given input that is corresponding to the segment. It will be available only when 'return_segment_raw_text' is enabled in the request options. + */ + rawText?: string | null; + segmentRecitationAction?: string | null; + /** + * The segment boundary start (inclusive) and end index (exclusive) in the given text. In the streaming RPC, the indexes always start from the beginning of the first text in the entire stream. The indexes are measured in UTF-16 code units. + */ + startIndex?: number | null; + } + /** + * The type used for final weights calculation. + */ + export interface Schema$LearningGenaiRootCalculationType { + scoreType?: string | null; + weights?: number | null; + } + export interface Schema$LearningGenaiRootClassifierOutput { + /** + * If set, this is the output of the first matching rule. + */ + ruleOutput?: Schema$LearningGenaiRootRuleOutput; + /** + * outputs of all matching rule. + */ + ruleOutputs?: Schema$LearningGenaiRootRuleOutput[]; + /** + * The results of data_providers and metrics. + */ + state?: Schema$LearningGenaiRootClassifierState; + } + export interface Schema$LearningGenaiRootClassifierOutputSummary { + metrics?: Schema$LearningGenaiRootMetricOutput[]; + /** + * Output of the first matching rule. + */ + ruleOutput?: Schema$LearningGenaiRootRuleOutput; + /** + * outputs of all matching rule. + */ + ruleOutputs?: Schema$LearningGenaiRootRuleOutput[]; + } + /** + * DataProviderOutput and MetricOutput can be saved between calls to the Classifier framework. For instance, you can run the query classifier, get outputs from those metrics, then use them in a result classifier as well. Example rule based on this idea: and_rules { rule { metric_name: 'query_safesearch_v2' ... \} rule { metric_name: 'response_safesearch_v2' ... \} \} + */ + export interface Schema$LearningGenaiRootClassifierState { + dataProviderOutput?: Schema$LearningGenaiRootDataProviderOutput[]; + metricOutput?: Schema$LearningGenaiRootMetricOutput[]; + } + export interface Schema$LearningGenaiRootDataProviderOutput { + name?: string | null; + /** + * If set, this DataProvider failed and this is the error message. + */ + status?: Schema$UtilStatusProto; + } + export interface Schema$LearningGenaiRootFilterMetadata { + /** + * Filter confidence. + */ + confidence?: string | null; + /** + * Debug info for the message. + */ + debugInfo?: Schema$LearningGenaiRootFilterMetadataFilterDebugInfo; + /** + * A fallback message chosen by the applied filter. + */ + fallback?: string | null; + /** + * Additional info for the filter. + */ + info?: string | null; + /** + * Name of the filter that triggered. + */ + name?: string | null; + /** + * Filter reason. + */ + reason?: string | null; + /** + * The input query or generated response that is getting filtered. + */ + text?: string | null; + } + export interface Schema$LearningGenaiRootFilterMetadataFilterDebugInfo { + classifierOutput?: Schema$LearningGenaiRootClassifierOutput; + defaultMetadata?: string | null; + languageFilterResult?: Schema$LearningGenaiRootLanguageFilterResult; + /** + * Safety filter output information for LLM Root RAI harm check. + */ + raiOutput?: Schema$LearningGenaiRootRAIOutput; + raiResult?: Schema$CloudAiNlLlmProtoServiceRaiResult; + raiSignal?: Schema$CloudAiNlLlmProtoServiceRaiSignal; + streamRecitationResult?: Schema$LanguageLabsAidaTrustRecitationProtoStreamRecitationResult; + takedownResult?: Schema$LearningGenaiRootTakedownResult; + toxicityResult?: Schema$LearningGenaiRootToxicityResult; + } + export interface Schema$LearningGenaiRootGroundingMetadata { + citations?: Schema$LearningGenaiRootGroundingMetadataCitation[]; + /** + * True if grounding is cancelled, for example, no facts being retrieved. + */ + groundingCancelled?: boolean | null; + searchQueries?: string[] | null; + } + export interface Schema$LearningGenaiRootGroundingMetadataCitation { + /** + * Index in the prediction output where the citation ends (exclusive). Must be \> start_index and < len(output). + */ + endIndex?: number | null; + /** + * Index of the fact supporting this claim. Should be within the range of the `world_facts` in the GenerateResponse. + */ + factIndex?: number | null; + /** + * Confidence score of this entailment. Value is [0,1] with 1 is the most confidence. + */ + score?: number | null; + /** + * Index in the prediction output where the citation starts (inclusive). Must be \>= 0 and < end_index. + */ + startIndex?: number | null; + } + export interface Schema$LearningGenaiRootHarm { + /** + * Please do not use, this is still under development. + */ + contextualDangerous?: boolean | null; + csam?: boolean | null; + fringe?: boolean | null; + grailImageHarmType?: Schema$LearningGenaiRootHarmGrailImageHarmType; + grailTextHarmType?: Schema$LearningGenaiRootHarmGrailTextHarmType; + imageCsam?: boolean | null; + imagePedo?: boolean | null; + /** + * Image signals + */ + imagePorn?: boolean | null; + imageViolence?: boolean | null; + pqc?: boolean | null; + safetycat?: Schema$LearningGenaiRootHarmSafetyCatCategories; + spii?: Schema$LearningGenaiRootHarmSpiiFilter; + threshold?: number | null; + videoFrameCsam?: boolean | null; + videoFramePedo?: boolean | null; + /** + * Video frame signals + */ + videoFramePorn?: boolean | null; + videoFrameViolence?: boolean | null; + } + /** + * Harm type for images + */ + export interface Schema$LearningGenaiRootHarmGrailImageHarmType { + imageHarmType?: string[] | null; + } + /** + * Harm type for text + */ + export interface Schema$LearningGenaiRootHarmGrailTextHarmType { + harmType?: string[] | null; + } + export interface Schema$LearningGenaiRootHarmSafetyCatCategories { + categories?: string[] | null; + } + export interface Schema$LearningGenaiRootHarmSpiiFilter { + usBankRoutingMicr?: boolean | null; + usEmployerIdentificationNumber?: boolean | null; + usSocialSecurityNumber?: boolean | null; + } + export interface Schema$LearningGenaiRootInternalMetadata { + scoredTokens?: Schema$LearningGenaiRootScoredToken[]; + } + export interface Schema$LearningGenaiRootLanguageFilterResult { + /** + * False when query or response should be filtered out due to unsupported language. + */ + allowed?: boolean | null; + /** + * Language of the query or response. + */ + detectedLanguage?: string | null; + /** + * Probability of the language predicted as returned by LangID. + */ + detectedLanguageProbability?: number | null; + } + export interface Schema$LearningGenaiRootMetricOutput { + debug?: string | null; + /** + * Name of the metric. + */ + name?: string | null; + numericValue?: number | null; + status?: Schema$UtilStatusProto; + stringValue?: string | null; + } + /** + * This is per harm. + */ + export interface Schema$LearningGenaiRootRAIOutput { + allowed?: boolean | null; + harm?: Schema$LearningGenaiRootHarm; + name?: string | null; + score?: number | null; + } + export interface Schema$LearningGenaiRootRegexTakedownResult { + /** + * False when query or response should be taken down due to match with a blocked regex, true otherwise. + */ + allowed?: boolean | null; + /** + * Regex used to decide that query or response should be taken down. Empty when query or response is kept. + */ + takedownRegex?: string | null; + } + export interface Schema$LearningGenaiRootRequestResponseTakedownResult { + /** + * False when response has to be taken down per above config. + */ + allowed?: boolean | null; + /** + * Regex used to match the request. + */ + requestTakedownRegex?: string | null; + /** + * Regex used to decide that response should be taken down. Empty when response is kept. + */ + responseTakedownRegex?: string | null; + } + /** + * Holds the final routing decision, by storing the model_config_id. And individual scores each model got. + */ + export interface Schema$LearningGenaiRootRoutingDecision { + metadata?: Schema$LearningGenaiRootRoutingDecisionMetadata; + /** + * The selected model to route traffic to. + */ + modelConfigId?: string | null; + } + /** + * Debug metadata about the routing decision. + */ + export interface Schema$LearningGenaiRootRoutingDecisionMetadata { + scoreBasedRoutingMetadata?: Schema$LearningGenaiRootRoutingDecisionMetadataScoreBased; + tokenLengthBasedRoutingMetadata?: Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBased; + } + /** + * If we are routing using scored based configuration, then the metadata about that is available in this proto. + */ + export interface Schema$LearningGenaiRootRoutingDecisionMetadataScoreBased { + /** + * The rule that was matched. + */ + matchedRule?: Schema$LearningGenaiRootScoreBasedRoutingConfigRule; + /** + * The score that was generated by the router i.e. the model. + */ + score?: Schema$LearningGenaiRootScore; + /** + * No rules were matched & therefore used the default fallback. + */ + usedDefaultFallback?: boolean | null; + } + export interface Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBased { + modelInputTokenMetadata?: Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelInputTokenMetadata[]; + modelMaxTokenMetadata?: Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelMaxTokenMetadata[]; + } + export interface Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelInputTokenMetadata { + /** + * The length computed by backends using the formatter & tokenizer specific to the model + */ + computedInputTokenLength?: number | null; + modelId?: string | null; + } + export interface Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelMaxTokenMetadata { + maxNumInputTokens?: number | null; + maxNumOutputTokens?: number | null; + modelId?: string | null; + } + export interface Schema$LearningGenaiRootRuleOutput { + decision?: string | null; + name?: string | null; + } + export interface Schema$LearningGenaiRootScore { + calculationType?: Schema$LearningGenaiRootCalculationType; + /** + * The internal_metadata is intended to be used by internal processors and will be cleared before returns. + */ + internalMetadata?: Schema$LearningGenaiRootInternalMetadata; + thresholdType?: Schema$LearningGenaiRootThresholdType; + /** + * Top candidate tokens and log probabilities at each decoding step. + */ + tokensAndLogprobPerDecodingStep?: Schema$LearningGenaiRootTokensAndLogProbPerDecodingStep; + value?: number | null; + } + export interface Schema$LearningGenaiRootScoreBasedRoutingConfigRule { + /** + * NOTE: Hardest examples have smaller values in their routing scores. + */ + equalOrGreaterThan?: Schema$LearningGenaiRootScore; + lessThan?: Schema$LearningGenaiRootScore; + /** + * This model_config_id points to ModelConfig::id which allows us to find the ModelConfig to route to. This is part of the banks specified in the ModelBankConfig. + */ + modelConfigId?: string | null; + } + /** + * Proto containing the results from the Universal Sentence Encoder / Other models + */ + export interface Schema$LearningGenaiRootScoredSimilarityTakedownPhrase { + phrase?: Schema$LearningGenaiRootSimilarityTakedownPhrase; + similarityScore?: number | null; + } + /** + * A token with its own score. + */ + export interface Schema$LearningGenaiRootScoredToken { + /** + * Each end_token_score is a logprob for how well the completion would end at a particular token. See http://google3/labs/language/aida/config/proto/model_config.proto;l=376;rcl=573039459 + */ + endTokenScore?: number | null; + /** + * Each score is the logprob for the token in model response. + */ + score?: number | null; + token?: string | null; + } + /** + * Each SimilarityTakedownPhrase treats a logical group of blocked and allowed phrases together along with a corresponding punt If the closest matching response is of the allowed type, we allow the response If the closest matching response is of the blocked type, we block the response. eg: Blocked phrase - "All lives matter" + */ + export interface Schema$LearningGenaiRootSimilarityTakedownPhrase { + blockedPhrase?: string | null; + } + export interface Schema$LearningGenaiRootSimilarityTakedownResult { + /** + * False when query or response should be taken down by any of the takedown rules, true otherwise. + */ + allowed?: boolean | null; + /** + * List of similar phrases with score. Set only if allowed=false. + */ + scoredPhrases?: Schema$LearningGenaiRootScoredSimilarityTakedownPhrase[]; + } + export interface Schema$LearningGenaiRootTakedownResult { + /** + * False when query or response should be taken down by any of the takedown rules, true otherwise. + */ + allowed?: boolean | null; + regexTakedownResult?: Schema$LearningGenaiRootRegexTakedownResult; + requestResponseTakedownResult?: Schema$LearningGenaiRootRequestResponseTakedownResult; + similarityTakedownResult?: Schema$LearningGenaiRootSimilarityTakedownResult; + } + /** + * The type of score that bundled with a threshold, and will not be attending the final score calculation. How each score type uses the threshold can be implementation details. + */ + export interface Schema$LearningGenaiRootThresholdType { + scoreType?: string | null; + threshold?: number | null; + } + /** + * Results of RandomSamplingParams::top_k_logprob_per_decoding_step. + */ + export interface Schema$LearningGenaiRootTokensAndLogProbPerDecodingStep { + /** + * Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. + */ + chosenCandidates?: Schema$LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate[]; + /** + * Length = total number of decoding steps. + */ + topCandidates?: Schema$LearningGenaiRootTokensAndLogProbPerDecodingStepTopCandidates[]; + } + /** + * A candidate at a decoding step. + */ + export interface Schema$LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate { + /** + * The candidate's log probability. + */ + logProbability?: number | null; + /** + * The candidate’s token value. + */ + token?: string | null; + } + /** + * Candidates with top log probabilities at each decoding step. + */ + export interface Schema$LearningGenaiRootTokensAndLogProbPerDecodingStepTopCandidates { + /** + * Sorted by log probability in descending order. + */ + candidates?: Schema$LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate[]; + } + /** + * A model can generate multiple signals and this captures all the generated signals for a single message. + */ + export interface Schema$LearningGenaiRootToxicityResult { + signals?: Schema$LearningGenaiRootToxicitySignal[]; + } + /** + * Proto to capture a signal generated by the toxicity model. + */ + export interface Schema$LearningGenaiRootToxicitySignal { + allowed?: boolean | null; + label?: string | null; + score?: number | null; + } + /** + * LINT.IfChange This metadata contains additional information required for debugging. + */ + export interface Schema$LearningServingLlmMessageMetadata { + /** + * Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. + */ + classifierSummary?: Schema$LearningGenaiRootClassifierOutputSummary; + currentStreamTextLength?: number | null; + /** + * Whether the corresponding message has been deleted. + */ + deleted?: boolean | null; + /** + * Metadata for filters that triggered. + */ + filterMeta?: Schema$LearningGenaiRootFilterMetadata[]; + /** + * This score is finally used for ranking the message. This will be same as the score present in `Message.score` field. + */ + finalMessageScore?: Schema$LearningGenaiRootScore; + /** + * NOT YET IMPLEMENTED. + */ + finishReason?: string | null; + groundingMetadata?: Schema$LearningGenaiRootGroundingMetadata; + /** + * Applies to Response message only. Indicates whether the message is a fallback and the response would have otherwise been empty. + */ + isFallback?: boolean | null; + /** + * Result from nlp_saft DetectLanguage method. Currently the predicted language code and language probability is used. + */ + langidResult?: Schema$NlpSaftLangIdResult; + /** + * Detected language. + */ + language?: string | null; + /** + * The LM prefix used to generate this response. + */ + lmPrefix?: string | null; + /** + * The original text generated by LLM. This is the raw output for debugging purposes. + */ + originalText?: string | null; + /** + * NOT YET IMPLEMENTED. Applies to streaming only. Number of tokens decoded / emitted by the model as part of this stream. This may be different from token_count, which contains number of tokens returned in this response after any response rewriting / truncation. + */ + perStreamDecodedTokenCount?: number | null; + /** + * Results of running RAI on the query or this response candidate. One output per rai_config. It will be populated regardless of whether the threshold is exceeded or not. + */ + raiOutputs?: Schema$LearningGenaiRootRAIOutput[]; + /** + * Recitation Results. It will be populated as long as Recitation processing is enabled, regardless of recitation outcome. + */ + recitationResult?: Schema$LearningGenaiRecitationRecitationResult; + /** + * NOT YET IMPLEMENTED. Number of tokens returned as part of this candidate. + */ + returnTokenCount?: number | null; + /** + * All the different scores for a message are logged here. + */ + scores?: Schema$LearningGenaiRootScore[]; + /** + * Whether the response is terminated during streaming return. Only used for streaming requests. + */ + streamTerminated?: boolean | null; + /** + * NOT YET IMPLEMENTED. Aggregated number of total tokens decoded so far. For streaming, this is sum of all the tokens decoded so far i.e. aggregated count. + */ + totalDecodedTokenCount?: number | null; + /** + * Translated user-prompt used for RAI post processing. This is for internal processing only. We will translate in pre-processor and pass the translated text to the post processor using this field. It will be empty if non of the signals requested need translation. + */ + translatedUserPrompts?: string[] | null; + /** + * The metadata from Vertex SafetyCat processors + */ + vertexRaiResult?: Schema$CloudAiNlLlmProtoServiceRaiResult; + } + export interface Schema$NlpSaftLangIdLocalesResult { + /** + * List of locales in which the text would be considered acceptable. Sorted in descending order according to each locale's respective likelihood. For example, if a Portuguese text is acceptable in both Brazil and Portugal, but is more strongly associated with Brazil, then the predictions would be ["pt-BR", "pt-PT"], in that order. May be empty, indicating that the model did not predict any acceptable locales. + */ + predictions?: Schema$NlpSaftLangIdLocalesResultLocale[]; + } + export interface Schema$NlpSaftLangIdLocalesResultLocale { + /** + * A BCP 47 language code that includes region information. For example, "pt-BR" or "pt-PT". This field will always be populated. + */ + languageCode?: string | null; + } + export interface Schema$NlpSaftLangIdResult { + /** + * The version of the model used to create these annotations. + */ + modelVersion?: string | null; + /** + * This field stores the n-best list of possible BCP 47 language code strings for a given input sorted in descending order according to each code's respective probability. + */ + predictions?: Schema$NlpSaftLanguageSpan[]; + /** + * This field stores language predictions of subspans of the input, when available. Each LanguageSpanSequence is a sequence of LanguageSpans. A particular sequence of LanguageSpans has an associated probability, and need not necessarily cover the entire input. If no language could be predicted for any span, then this field may be empty. + */ + spanPredictions?: Schema$NlpSaftLanguageSpanSequence[]; + } + export interface Schema$NlpSaftLanguageSpan { + end?: number | null; + /** + * A BCP 47 language code for this span. + */ + languageCode?: string | null; + /** + * Optional field containing any information that was predicted about the specific locale(s) of the span. + */ + locales?: Schema$NlpSaftLangIdLocalesResult; + /** + * A probability associated with this prediction. + */ + probability?: number | null; + /** + * Start and end byte offsets, inclusive, within the given input string. A value of -1 implies that this field is not set. Both fields must either be set with a nonnegative value or both are unset. If both are unset then this LanguageSpan applies to the entire input. + */ + start?: number | null; + } + export interface Schema$NlpSaftLanguageSpanSequence { + /** + * A sequence of LanguageSpan objects, each assigning a language to a subspan of the input. + */ + languageSpans?: Schema$NlpSaftLanguageSpan[]; + /** + * The probability of this sequence of LanguageSpans. + */ + probability?: number | null; + } + /** + * This is proto2's version of MessageSet. + */ + export interface Schema$Proto2BridgeMessageSet {} + /** + * Wire-format for a Status object + */ + export interface Schema$UtilStatusProto { + /** + * The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be. + */ + canonicalCode?: number | null; + /** + * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto + */ + code?: number | null; + /** + * Detail message + */ + message?: string | null; + /** + * message_set associates an arbitrary proto message with the status. + */ + messageSet?: Schema$Proto2BridgeMessageSet; + /** + * The following are usually only present when code != 0 Space to which this status belongs + */ + space?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + batchPredictionJobs: Resource$Projects$Locations$Batchpredictionjobs; + customJobs: Resource$Projects$Locations$Customjobs; + dataLabelingJobs: Resource$Projects$Locations$Datalabelingjobs; + datasets: Resource$Projects$Locations$Datasets; + deploymentResourcePools: Resource$Projects$Locations$Deploymentresourcepools; + endpoints: Resource$Projects$Locations$Endpoints; + featureGroups: Resource$Projects$Locations$Featuregroups; + featureOnlineStores: Resource$Projects$Locations$Featureonlinestores; + featurestores: Resource$Projects$Locations$Featurestores; + hyperparameterTuningJobs: Resource$Projects$Locations$Hyperparametertuningjobs; + indexEndpoints: Resource$Projects$Locations$Indexendpoints; + indexes: Resource$Projects$Locations$Indexes; + metadataStores: Resource$Projects$Locations$Metadatastores; + migratableResources: Resource$Projects$Locations$Migratableresources; + modelDeploymentMonitoringJobs: Resource$Projects$Locations$Modeldeploymentmonitoringjobs; + models: Resource$Projects$Locations$Models; + nasJobs: Resource$Projects$Locations$Nasjobs; + notebookRuntimes: Resource$Projects$Locations$Notebookruntimes; + notebookRuntimeTemplates: Resource$Projects$Locations$Notebookruntimetemplates; + operations: Resource$Projects$Locations$Operations; + pipelineJobs: Resource$Projects$Locations$Pipelinejobs; + publishers: Resource$Projects$Locations$Publishers; + schedules: Resource$Projects$Locations$Schedules; + specialistPools: Resource$Projects$Locations$Specialistpools; + studies: Resource$Projects$Locations$Studies; + tensorboards: Resource$Projects$Locations$Tensorboards; + trainingPipelines: Resource$Projects$Locations$Trainingpipelines; + constructor(context: APIRequestContext) { + this.context = context; + this.batchPredictionJobs = + new Resource$Projects$Locations$Batchpredictionjobs(this.context); + this.customJobs = new Resource$Projects$Locations$Customjobs( + this.context + ); + this.dataLabelingJobs = new Resource$Projects$Locations$Datalabelingjobs( + this.context + ); + this.datasets = new Resource$Projects$Locations$Datasets(this.context); + this.deploymentResourcePools = + new Resource$Projects$Locations$Deploymentresourcepools(this.context); + this.endpoints = new Resource$Projects$Locations$Endpoints(this.context); + this.featureGroups = new Resource$Projects$Locations$Featuregroups( + this.context + ); + this.featureOnlineStores = + new Resource$Projects$Locations$Featureonlinestores(this.context); + this.featurestores = new Resource$Projects$Locations$Featurestores( + this.context + ); + this.hyperparameterTuningJobs = + new Resource$Projects$Locations$Hyperparametertuningjobs(this.context); + this.indexEndpoints = new Resource$Projects$Locations$Indexendpoints( + this.context + ); + this.indexes = new Resource$Projects$Locations$Indexes(this.context); + this.metadataStores = new Resource$Projects$Locations$Metadatastores( + this.context + ); + this.migratableResources = + new Resource$Projects$Locations$Migratableresources(this.context); + this.modelDeploymentMonitoringJobs = + new Resource$Projects$Locations$Modeldeploymentmonitoringjobs( + this.context + ); + this.models = new Resource$Projects$Locations$Models(this.context); + this.nasJobs = new Resource$Projects$Locations$Nasjobs(this.context); + this.notebookRuntimes = new Resource$Projects$Locations$Notebookruntimes( + this.context + ); + this.notebookRuntimeTemplates = + new Resource$Projects$Locations$Notebookruntimetemplates(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.pipelineJobs = new Resource$Projects$Locations$Pipelinejobs( + this.context + ); + this.publishers = new Resource$Projects$Locations$Publishers( + this.context + ); + this.schedules = new Resource$Projects$Locations$Schedules(this.context); + this.specialistPools = new Resource$Projects$Locations$Specialistpools( + this.context + ); + this.studies = new Resource$Projects$Locations$Studies(this.context); + this.tensorboards = new Resource$Projects$Locations$Tensorboards( + this.context + ); + this.trainingPipelines = + new Resource$Projects$Locations$Trainingpipelines(this.context); + } + + /** + * Gets information about a location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * 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). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Batchpredictionjobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batchpredictionjobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a BatchPredictionJob. Can only be called on jobs that already finished. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batchpredictionjobs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a BatchPredictionJob + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batchpredictionjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists BatchPredictionJobs in a Location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batchpredictionjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelBatchPredictionJobRequest; + } + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchPredictionJob; + } + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Delete + extends StandardParameters { + /** + * Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Get + extends StandardParameters { + /** + * Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$List + extends StandardParameters { + /** + * 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:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Customjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Customjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Customjobs$Operations( + this.context + ); + } + + /** + * 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`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Customjobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customjobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customjobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a CustomJob. A created CustomJob right away will be attempted to be run. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Customjobs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customjobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/customJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a CustomJob. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Customjobs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customjobs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customjobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customjobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a CustomJob. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Customjobs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists CustomJobs in a Location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Customjobs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Customjobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Customjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Customjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Customjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/customJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Customjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the CustomJob to cancel. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelCustomJobRequest; + } + export interface Params$Resource$Projects$Locations$Customjobs$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CustomJob; + } + export interface Params$Resource$Projects$Locations$Customjobs$Delete + extends StandardParameters { + /** + * Required. The name of the CustomJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Customjobs$Get + extends StandardParameters { + /** + * Required. The name of the CustomJob resource. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Customjobs$List + extends StandardParameters { + /** + * 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:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Customjobs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customjobs$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: | BodyResponseCallback | BodyResponseCallback ): @@ -13460,13 +15558,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; options = {}; } @@ -13500,65 +15598,61 @@ export namespace aiplatform_v1 { } /** - * Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + delete( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + delete( + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Customjobs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; options = {}; } @@ -13571,69 +15665,64 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a BatchPredictionJob. Can only be called on jobs that already finished. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + get( + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Delete + | Params$Resource$Projects$Locations$Customjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13649,13 +15738,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Get; options = {}; } @@ -13669,7 +15758,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), @@ -13689,65 +15778,65 @@ export namespace aiplatform_v1 { } /** - * Gets a BatchPredictionJob + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + list( + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + list( + params?: Params$Resource$Projects$Locations$Customjobs$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + list( + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Customjobs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$List; options = {}; } @@ -13760,7 +15849,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -13771,77 +15863,77 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists BatchPredictionJobs in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + wait( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + wait( + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + wait( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Customjobs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$List; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$List; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; options = {}; } @@ -13854,106 +15946,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Cancel extends StandardParameters { /** - * Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelBatchPredictionJobRequest; } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchPredictionJob; - } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Delete + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Delete extends StandardParameters { /** - * Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Get + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Get extends StandardParameters { /** - * Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$List + export interface Params$Resource$Projects$Locations$Customjobs$Operations$List extends StandardParameters { /** - * 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:*` + * The standard list filter. */ filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. + * The standard list page token. */ pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Wait + extends StandardParameters { /** - * Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` + * The name of the operation resource to wait on. */ - parent?: string; + name?: string; /** - * Mask specifying which fields to read. + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - readMask?: string; + timeout?: string; } - export class Resource$Projects$Locations$Customjobs { + export class Resource$Projects$Locations$Datalabelingjobs { context: APIRequestContext; - operations: Resource$Projects$Locations$Customjobs$Operations; + operations: Resource$Projects$Locations$Datalabelingjobs$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Customjobs$Operations( - this.context - ); + this.operations = + new Resource$Projects$Locations$Datalabelingjobs$Operations( + this.context + ); } /** - * 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`. + * Cancels a DataLabelingJob. Success of cancellation is not guaranteed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13961,31 +16039,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Customjobs$Cancel, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Cancel + | Params$Resource$Projects$Locations$Datalabelingjobs$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14001,12 +16079,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Cancel; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Cancel; + params = + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; options = {}; } @@ -14040,7 +16119,7 @@ export namespace aiplatform_v1 { } /** - * Creates a CustomJob. A created CustomJob right away will be attempted to be run. + * Creates a DataLabelingJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14048,56 +16127,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Customjobs$Create, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Customjobs$Create, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Customjobs$Create, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Customjobs$Create, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Customjobs$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Create; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Create; + params = + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Create; options = {}; } @@ -14110,7 +16190,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/customJobs').replace( + url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -14124,19 +16204,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a CustomJob. + * Deletes a DataLabelingJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14144,27 +16224,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Customjobs$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Customjobs$Delete, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Customjobs$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Customjobs$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Customjobs$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, callback: BodyResponseCallback ): void; delete( @@ -14172,7 +16252,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Delete + | Params$Resource$Projects$Locations$Datalabelingjobs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14188,12 +16268,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Delete; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Delete; + params = + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; options = {}; } @@ -14227,7 +16308,7 @@ export namespace aiplatform_v1 { } /** - * Gets a CustomJob. + * Gets a DataLabelingJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14235,56 +16316,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Customjobs$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Customjobs$Get, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Customjobs$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Customjobs$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Customjobs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Get; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Get; + params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$Get; options = {}; } @@ -14308,19 +16389,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists CustomJobs in a Location. + * Lists DataLabelingJobs in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14328,56 +16409,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Customjobs$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Customjobs$List, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Customjobs$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Customjobs$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Customjobs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$List; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$List; + params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$List; options = {}; } @@ -14390,7 +16471,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/customJobs').replace( + url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -14404,81 +16485,85 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Customjobs$Cancel + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Cancel extends StandardParameters { /** - * Required. The name of the CustomJob to cancel. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` */ name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelCustomJobRequest; + requestBody?: Schema$GoogleCloudAiplatformV1CancelDataLabelingJobRequest; } - export interface Params$Resource$Projects$Locations$Customjobs$Create + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Create extends StandardParameters { /** - * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` + * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1CustomJob; + requestBody?: Schema$GoogleCloudAiplatformV1DataLabelingJob; } - export interface Params$Resource$Projects$Locations$Customjobs$Delete + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Delete extends StandardParameters { /** - * Required. The name of the CustomJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Customjobs$Get + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Get extends StandardParameters { /** - * Required. The name of the CustomJob resource. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Customjobs$List + export interface Params$Resource$Projects$Locations$Datalabelingjobs$List extends StandardParameters { /** * 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:*` */ filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + */ + orderBy?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project\}/locations/{location\}` + * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** - * Mask specifying which fields to read. + * 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. */ readMask?: string; } - export class Resource$Projects$Locations$Customjobs$Operations { + export class Resource$Projects$Locations$Datalabelingjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -14493,31 +16578,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Cancel + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14533,13 +16618,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; options = {}; } @@ -14581,31 +16666,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Delete + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14621,13 +16706,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; options = {}; } @@ -14669,27 +16754,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -14697,7 +16782,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Get + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14713,13 +16798,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; options = {}; } @@ -14761,27 +16846,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Customjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$List, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Customjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Customjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Customjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -14789,7 +16874,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$List + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14805,13 +16890,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List; options = {}; } @@ -14858,27 +16943,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -14886,7 +16971,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Wait + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14902,13 +16987,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; options = {}; } @@ -14942,28 +17027,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Cancel + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Delete + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Get + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$List + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List extends StandardParameters { /** * The standard list filter. @@ -14982,7 +17067,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Wait + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -14994,73 +17079,458 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datalabelingjobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datalabelingjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datalabelingjobs$Operations( - this.context + export class Resource$Projects$Locations$Datasets { + context: APIRequestContext; + annotationSpecs: Resource$Projects$Locations$Datasets$Annotationspecs; + dataItems: Resource$Projects$Locations$Datasets$Dataitems; + datasetVersions: Resource$Projects$Locations$Datasets$Datasetversions; + operations: Resource$Projects$Locations$Datasets$Operations; + savedQueries: Resource$Projects$Locations$Datasets$Savedqueries; + constructor(context: APIRequestContext) { + this.context = context; + this.annotationSpecs = + new Resource$Projects$Locations$Datasets$Annotationspecs(this.context); + this.dataItems = new Resource$Projects$Locations$Datasets$Dataitems( + this.context + ); + this.datasetVersions = + new Resource$Projects$Locations$Datasets$Datasetversions(this.context); + this.operations = new Resource$Projects$Locations$Datasets$Operations( + this.context + ); + this.savedQueries = new Resource$Projects$Locations$Datasets$Savedqueries( + this.context + ); + } + + /** + * Creates a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Datasets$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Datasets$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datasets$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/datasets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Datasets$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Exports data from a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + export( + params: Params$Resource$Projects$Locations$Datasets$Export, + options: StreamMethodOptions + ): GaxiosPromise; + export( + params?: Params$Resource$Projects$Locations$Datasets$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Datasets$Export, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Datasets$Export, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Datasets$Export, + callback: BodyResponseCallback + ): void; + export( + callback: BodyResponseCallback + ): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Export + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Datasets$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datasets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datasets$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datasets$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datasets$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters ); + } } /** - * Cancels a DataLabelingJob. Success of cancellation is not guaranteed. + * Imports data into a Dataset. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + import( + params: Params$Resource$Projects$Locations$Datasets$Import, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + import( + params?: Params$Resource$Projects$Locations$Datasets$Import, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datasets$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datasets$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datasets$Import, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + import( + callback: BodyResponseCallback + ): void; + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; + params = {} as Params$Resource$Projects$Locations$Datasets$Import; options = {}; } @@ -15073,7 +17543,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:import').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options @@ -15084,75 +17554,74 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a DataLabelingJob. + * Lists Datasets in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + list( + params: Params$Resource$Projects$Locations$Datasets$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + list( + params?: Params$Resource$Projects$Locations$Datasets$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + list( + params: Params$Resource$Projects$Locations$Datasets$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Create; + {}) as Params$Resource$Projects$Locations$Datasets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Create; + params = {} as Params$Resource$Projects$Locations$Datasets$List; options = {}; } @@ -15165,11 +17634,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( + url: (rootUrl + '/v1/{+parent}/datasets').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), @@ -15179,77 +17648,76 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a DataLabelingJob. + * Updates a Dataset. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + patch( + params?: Params$Resource$Projects$Locations$Datasets$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; + params = {} as Params$Resource$Projects$Locations$Datasets$Patch; options = {}; } @@ -15263,7 +17731,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', }, options ), @@ -15273,74 +17741,77 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a DataLabelingJob. + * Searches DataItems in a Dataset. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + searchDataItems( + params?: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + ): GaxiosPromise; + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, - callback: BodyResponseCallback + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + searchDataItems( + callback: BodyResponseCallback ): void; - get( + searchDataItems( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Searchdataitems + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Searchdataitems; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$Get; + params = + {} as Params$Resource$Projects$Locations$Datasets$Searchdataitems; options = {}; } @@ -15353,87 +17824,260 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+dataset}:searchDataItems').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataset'], + pathParams: ['dataset'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Create + extends StandardParameters { /** - * Lists DataLabelingJobs in a Location. + * Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Dataset; + } + export interface Params$Resource$Projects$Locations$Datasets$Delete + extends StandardParameters { + /** + * Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Export + extends StandardParameters { + /** + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExportDataRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Get + extends StandardParameters { + /** + * Required. The name of the Dataset resource. + */ + name?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Import + extends StandardParameters { + /** + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ImportDataRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$List + extends StandardParameters { + /** + * 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"` + */ + filter?: string; + /** + * 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` + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Patch + extends StandardParameters { + /** + * Output only. The resource name of the Dataset. + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Dataset; + } + export interface Params$Resource$Projects$Locations$Datasets$Searchdataitems + extends StandardParameters { + /** + * 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. + */ + annotationFilters?: string[]; + /** + * An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=. + */ + annotationsFilter?: string; + /** + * 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. + */ + annotationsLimit?: number; + /** + * 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)` + */ + dataItemFilter?: string; + /** + * 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. + */ + dataLabelingJob?: string; + /** + * Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + dataset?: string; + /** + * Mask specifying which fields of DataItemView to read. + */ + fieldMask?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * 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. + */ + 'orderByAnnotation.orderBy'?: string; + /** + * Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering. + */ + 'orderByAnnotation.savedQuery'?: string; + /** + * A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderByDataItem?: string; + /** + * Requested page size. Server may return fewer results than requested. Default and maximum page size is 100. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * 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. + */ + savedQuery?: string; + } + + export class Resource$Projects$Locations$Datasets$Annotationspecs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datasets$Annotationspecs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datasets$Annotationspecs$Operations( + this.context + ); + } + + /** + * Gets an AnnotationSpec. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$List, + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$List, + get( + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$List, + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$List; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$List; + params = + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; options = {}; } @@ -15446,99 +18090,42 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Cancel - extends StandardParameters { - /** - * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelDataLabelingJobRequest; - } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Create - extends StandardParameters { - /** - * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DataLabelingJob; - } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Delete - extends StandardParameters { - /** - * Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Get + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get extends StandardParameters { /** - * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + * Required. The name of the AnnotationSpec resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/annotationSpecs/{annotation_spec\}` */ name?: string; - } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$List - extends StandardParameters { - /** - * 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:*` - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; /** - * 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. + * Mask specifying which fields to read. */ readMask?: string; } - export class Resource$Projects$Locations$Datalabelingjobs$Operations { + export class Resource$Projects$Locations$Datasets$Annotationspecs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -15553,31 +18140,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15593,13 +18180,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; options = {}; } @@ -15641,31 +18228,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15681,13 +18268,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; options = {}; } @@ -15729,27 +18316,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -15757,7 +18344,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15773,13 +18360,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; options = {}; } @@ -15821,27 +18408,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -15849,7 +18436,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15865,13 +18452,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; options = {}; } @@ -15918,27 +18505,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -15946,7 +18533,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15962,13 +18549,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; options = {}; } @@ -16002,28 +18589,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List extends StandardParameters { /** * The standard list filter. @@ -16042,7 +18629,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -16054,89 +18641,82 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets { + export class Resource$Projects$Locations$Datasets$Dataitems { context: APIRequestContext; - annotationSpecs: Resource$Projects$Locations$Datasets$Annotationspecs; - dataItems: Resource$Projects$Locations$Datasets$Dataitems; - datasetVersions: Resource$Projects$Locations$Datasets$Datasetversions; - operations: Resource$Projects$Locations$Datasets$Operations; - savedQueries: Resource$Projects$Locations$Datasets$Savedqueries; + annotations: Resource$Projects$Locations$Datasets$Dataitems$Annotations; + operations: Resource$Projects$Locations$Datasets$Dataitems$Operations; constructor(context: APIRequestContext) { this.context = context; - this.annotationSpecs = - new Resource$Projects$Locations$Datasets$Annotationspecs(this.context); - this.dataItems = new Resource$Projects$Locations$Datasets$Dataitems( - this.context - ); - this.datasetVersions = - new Resource$Projects$Locations$Datasets$Datasetversions(this.context); - this.operations = new Resource$Projects$Locations$Datasets$Operations( - this.context - ); - this.savedQueries = new Resource$Projects$Locations$Datasets$Savedqueries( - this.context - ); + this.annotations = + new Resource$Projects$Locations$Datasets$Dataitems$Annotations( + this.context + ); + this.operations = + new Resource$Projects$Locations$Datasets$Dataitems$Operations( + this.context + ); } /** - * Creates a Dataset. + * Lists DataItems in a Dataset. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datasets$Create, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datasets$Create, + list( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Create; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Create; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$List; options = {}; } @@ -16149,11 +18729,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasets').replace( + url: (rootUrl + '/v1/{+parent}/dataItems').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), @@ -16163,256 +18743,117 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$List + extends StandardParameters { /** - * Deletes a Dataset. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The standard list filter. */ - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datasets$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - + filter?: string; /** - * Exports data from a Dataset. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. */ - export( - params: Params$Resource$Projects$Locations$Datasets$Export, - options: StreamMethodOptions - ): GaxiosPromise; - export( - params?: Params$Resource$Projects$Locations$Datasets$Export, - options?: MethodOptions - ): GaxiosPromise; - export( - params: Params$Resource$Projects$Locations$Datasets$Export, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - export( - params: Params$Resource$Projects$Locations$Datasets$Export, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - export( - params: Params$Resource$Projects$Locations$Datasets$Export, - callback: BodyResponseCallback - ): void; - export( - callback: BodyResponseCallback - ): void; - export( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Export - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Export; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Export; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + export class Resource$Projects$Locations$Datasets$Dataitems$Annotations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations( + this.context ); - } else { - return createAPIRequest(parameters); - } } /** - * Gets a Dataset. + * Lists Annotations belongs to a dataitem * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datasets$Get, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datasets$Get, + list( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Get; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List; options = {}; } @@ -16425,87 +18866,122 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/annotations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List + extends StandardParameters { /** - * Imports data into a Dataset. + * The standard list filter. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/dataItems/{data_item\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datasets$Import, + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datasets$Import, + cancel( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datasets$Import, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datasets$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Datasets$Import, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + callback: BodyResponseCallback ): void; - import( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Import; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Import; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; options = {}; } @@ -16518,7 +18994,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:import').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options @@ -16529,74 +19005,71 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Datasets in a Location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$List, + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datasets$List, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$List; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$List; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; options = {}; } @@ -16609,90 +19082,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Dataset. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datasets$Patch, + get( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Patch; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Patch; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; options = {}; } @@ -16706,7 +19175,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', }, options ), @@ -16716,77 +19185,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Searches DataItems in a Dataset. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - searchDataItems( - params?: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + list( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options?: MethodOptions - ): GaxiosPromise; - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + callback: BodyResponseCallback ): void; - searchDataItems( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - searchDataItems( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Searchdataitems - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Searchdataitems; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Searchdataitems; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List; options = {}; } @@ -16799,7 +19266,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+dataset}:searchDataItems').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -16808,251 +19275,82 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['dataset'], - pathParams: ['dataset'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datasets$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Dataset; - } - export interface Params$Resource$Projects$Locations$Datasets$Delete - extends StandardParameters { - /** - * Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Export - extends StandardParameters { - /** - * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExportDataRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Get - extends StandardParameters { - /** - * Required. The name of the Dataset resource. - */ - name?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Import - extends StandardParameters { - /** - * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ImportDataRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$List - extends StandardParameters { - /** - * 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"` - */ - filter?: string; - /** - * 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` - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Patch - extends StandardParameters { - /** - * Output only. The resource name of the Dataset. - */ - name?: string; - /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Dataset; - } - export interface Params$Resource$Projects$Locations$Datasets$Searchdataitems - extends StandardParameters { - /** - * 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. - */ - annotationFilters?: string[]; - /** - * An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=. - */ - annotationsFilter?: string; - /** - * 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. - */ - annotationsLimit?: number; - /** - * 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)` - */ - dataItemFilter?: string; - /** - * 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. - */ - dataLabelingJob?: string; - /** - * Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - dataset?: string; - /** - * Mask specifying which fields of DataItemView to read. - */ - fieldMask?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * 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. - */ - 'orderByAnnotation.orderBy'?: string; - /** - * Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering. - */ - 'orderByAnnotation.savedQuery'?: string; - /** - * A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderByDataItem?: string; - /** - * Requested page size. Server may return fewer results than requested. Default and maximum page size is 100. - */ - pageSize?: number; - /** - * 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. - */ - pageToken?: string; - /** - * 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. - */ - savedQuery?: string; - } - - export class Resource$Projects$Locations$Datasets$Annotationspecs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datasets$Annotationspecs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datasets$Annotationspecs$Operations( - this.context - ); - } /** - * Gets an AnnotationSpec. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, + wait( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - get( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; options = {}; } @@ -17065,8 +19363,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), @@ -17076,31 +19374,69 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel extends StandardParameters { /** - * Required. The name of the AnnotationSpec resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/annotationSpecs/{annotation_spec\}` + * The name of the operation resource to be cancelled. */ name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete + extends StandardParameters { /** - * Mask specifying which fields to read. + * The name of the operation resource to be deleted. */ - readMask?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Datasets$Annotationspecs$Operations { + export class Resource$Projects$Locations$Datasets$Dataitems$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -17115,31 +19451,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -17155,13 +19491,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; options = {}; } @@ -17203,31 +19539,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -17243,13 +19579,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; options = {}; } @@ -17291,27 +19627,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -17319,7 +19655,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -17335,13 +19671,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; options = {}; } @@ -17383,27 +19719,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, callback: BodyResponseCallback ): void; list( @@ -17411,7 +19747,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -17427,13 +19763,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; options = {}; } @@ -17480,27 +19816,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -17508,7 +19844,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -17524,13 +19860,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; options = {}; } @@ -17564,28 +19900,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List extends StandardParameters { /** * The standard list filter. @@ -17604,7 +19940,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -17616,82 +19952,72 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets$Dataitems { + export class Resource$Projects$Locations$Datasets$Datasetversions { context: APIRequestContext; - annotations: Resource$Projects$Locations$Datasets$Dataitems$Annotations; - operations: Resource$Projects$Locations$Datasets$Dataitems$Operations; constructor(context: APIRequestContext) { this.context = context; - this.annotations = - new Resource$Projects$Locations$Datasets$Dataitems$Annotations( - this.context - ); - this.operations = - new Resource$Projects$Locations$Datasets$Dataitems$Operations( - this.context - ); } /** - * Lists DataItems in a Dataset. + * Create a version from a Dataset. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + create( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$List; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$List; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; options = {}; } @@ -17704,11 +20030,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataItems').replace( + url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), @@ -17718,117 +20044,358 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; /** - * The standard list page token. + * Deletes a Dataset version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - pageToken?: string; + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** - * Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * Gets a Dataset version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - parent?: string; + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** - * Mask specifying which fields to read. + * Lists DatasetVersions in a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - readMask?: string; - } + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Datasetversions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Datasets$Dataitems$Annotations { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations( - this.context + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Lists Annotations belongs to a dataitem + * Restores a dataset version. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, + restore( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, + ): GaxiosPromise; + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, - callback: BodyResponseCallback + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + restore( + callback: BodyResponseCallback ): void; - list( + restore( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; options = {}; } @@ -17841,7 +20408,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/annotations').replace( + url: (rootUrl + '/v1/{+name}:restore').replace( /([^:]\/)\/+/g, '$1' ), @@ -17850,52 +20417,87 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Create extends StandardParameters { /** - * The standard list filter. + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Get + extends StandardParameters { + /** + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$List + extends StandardParameters { + /** + * Optional. The standard list filter. */ filter?: string; /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. */ orderBy?: string; /** - * The standard list page size. + * Optional. The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * Optional. The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/dataItems/{data_item\}` + * Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` */ parent?: string; /** - * Mask specifying which fields to read. + * Optional. Mask specifying which fields to read. */ readMask?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore + extends StandardParameters { + /** + * Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + } - export class Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations { + export class Resource$Projects$Locations$Datasets$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -17910,31 +20512,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel + | Params$Resource$Projects$Locations$Datasets$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -17950,13 +20552,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; options = {}; } @@ -17998,31 +20600,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete + | Params$Resource$Projects$Locations$Datasets$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18038,13 +20640,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Operations$Delete; options = {}; } @@ -18086,27 +20688,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -18114,7 +20716,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get + | Params$Resource$Projects$Locations$Datasets$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18130,13 +20732,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Operations$Get; options = {}; } @@ -18178,27 +20780,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params?: Params$Resource$Projects$Locations$Datasets$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Operations$List, callback: BodyResponseCallback ): void; list( @@ -18206,7 +20808,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List + | Params$Resource$Projects$Locations$Datasets$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18222,13 +20824,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List; + {} as Params$Resource$Projects$Locations$Datasets$Operations$List; options = {}; } @@ -18275,27 +20877,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + params?: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -18303,7 +20905,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait + | Params$Resource$Projects$Locations$Datasets$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18319,13 +20921,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datasets$Operations$Wait; options = {}; } @@ -18359,28 +20961,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel + export interface Params$Resource$Projects$Locations$Datasets$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete + export interface Params$Resource$Projects$Locations$Datasets$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get + export interface Params$Resource$Projects$Locations$Datasets$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List + export interface Params$Resource$Projects$Locations$Datasets$Operations$List extends StandardParameters { /** * The standard list filter. @@ -18399,7 +21001,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait + export interface Params$Resource$Projects$Locations$Datasets$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -18411,7 +21013,243 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets$Dataitems$Operations { + export class Resource$Projects$Locations$Datasets$Savedqueries { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datasets$Savedqueries$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datasets$Savedqueries$Operations( + this.context + ); + } + + /** + * Deletes a SavedQuery. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists SavedQueries in a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Savedqueries$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/savedQueries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete + extends StandardParameters { + /** + * Required. The resource name of the SavedQuery to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Datasets$Savedqueries$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -18426,31 +21264,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18466,13 +21304,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; options = {}; } @@ -18514,31 +21352,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18554,13 +21392,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; options = {}; } @@ -18602,27 +21440,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -18630,7 +21468,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18646,13 +21484,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; options = {}; } @@ -18694,27 +21532,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, callback: BodyResponseCallback ): void; list( @@ -18722,7 +21560,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18738,13 +21576,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; options = {}; } @@ -18791,27 +21629,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -18819,7 +21657,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18835,13 +21673,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; options = {}; } @@ -18875,28 +21713,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List extends StandardParameters { /** * The standard list filter. @@ -18915,7 +21753,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -18927,14 +21765,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets$Datasetversions { + export class Resource$Projects$Locations$Deploymentresourcepools { context: APIRequestContext; + operations: Resource$Projects$Locations$Deploymentresourcepools$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Deploymentresourcepools$Operations( + this.context + ); } /** - * Create a version from a Dataset. + * Create a DeploymentResourcePool. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18942,27 +21785,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, callback: BodyResponseCallback ): void; create( @@ -18970,7 +21813,7 @@ export namespace aiplatform_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Create + | Params$Resource$Projects$Locations$Deploymentresourcepools$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18986,13 +21829,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; options = {}; } @@ -19005,7 +21848,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( + url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( /([^:]\/)\/+/g, '$1' ), @@ -19029,7 +21872,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a Dataset version. + * Delete a DeploymentResourcePool. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19037,27 +21880,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, callback: BodyResponseCallback ): void; delete( @@ -19065,7 +21908,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + | Params$Resource$Projects$Locations$Deploymentresourcepools$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19081,13 +21924,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; options = {}; } @@ -19121,7 +21964,7 @@ export namespace aiplatform_v1 { } /** - * Gets a Dataset version. + * Get a DeploymentResourcePool. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19129,57 +21972,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; options = {}; } @@ -19203,19 +22046,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists DatasetVersions in a Dataset. + * List DeploymentResourcePools in a location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19223,57 +22066,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$List; options = {}; } @@ -19286,7 +22129,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( + url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( /([^:]\/)\/+/g, '$1' ), @@ -19300,77 +22143,77 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Restores a dataset version. + * List DeployedModels that have been deployed on this DeploymentResourcePool. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, options: StreamMethodOptions ): GaxiosPromise; - restore( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + queryDeployedModels( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, options?: MethodOptions - ): GaxiosPromise; - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + ): GaxiosPromise; + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, - callback: BodyResponseCallback + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + callback: BodyResponseCallback ): void; - restore( - callback: BodyResponseCallback + queryDeployedModels( + callback: BodyResponseCallback ): void; - restore( + queryDeployedModels( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels; options = {}; } @@ -19383,96 +22226,89 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:restore').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+deploymentResourcePool}:queryDeployedModels' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['deploymentResourcePool'], + pathParams: ['deploymentResourcePool'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Create + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Create extends StandardParameters { /** - * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; + requestBody?: Schema$GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest; } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Delete extends StandardParameters { /** - * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Get + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Get extends StandardParameters { /** - * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` */ name?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$List + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$List extends StandardParameters { /** - * Optional. The standard list filter. - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * Optional. The standard list page size. + * The maximum number of DeploymentResourcePools to return. The service may return fewer than this value. */ pageSize?: number; /** - * Optional. The standard list page token. + * 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. */ pageToken?: string; /** - * Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels extends StandardParameters { /** - * Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` */ - name?: string; + deploymentResourcePool?: string; + /** + * The maximum number of DeployedModels to return. The service may return fewer than this value. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; } - export class Resource$Projects$Locations$Datasets$Operations { + export class Resource$Projects$Locations$Deploymentresourcepools$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -19487,31 +22323,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Cancel + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19527,13 +22363,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; options = {}; } @@ -19575,31 +22411,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Delete + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19615,13 +22451,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Delete; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; options = {}; } @@ -19663,27 +22499,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -19691,7 +22527,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Get + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19707,13 +22543,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Get; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Get; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; options = {}; } @@ -19755,27 +22591,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datasets$Operations$List, + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, callback: BodyResponseCallback ): void; list( @@ -19783,7 +22619,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$List + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19799,13 +22635,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$List; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$List; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; options = {}; } @@ -19852,27 +22688,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -19880,7 +22716,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Wait + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19896,13 +22732,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Wait; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; options = {}; } @@ -19936,28 +22772,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Cancel + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Delete + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Get + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Operations$List + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List extends StandardParameters { /** * The standard list filter. @@ -19976,7 +22812,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Wait + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -19988,77 +22824,76 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets$Savedqueries { + export class Resource$Projects$Locations$Endpoints { context: APIRequestContext; - operations: Resource$Projects$Locations$Datasets$Savedqueries$Operations; + operations: Resource$Projects$Locations$Endpoints$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Datasets$Savedqueries$Operations( - this.context - ); + this.operations = new Resource$Projects$Locations$Endpoints$Operations( + this.context + ); } /** - * Deletes a SavedQuery. + * Return a list of tokens based on the input text. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, + computeTokens( + params?: Params$Resource$Projects$Locations$Endpoints$Computetokens, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, + ): GaxiosPromise; + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, - callback: BodyResponseCallback + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + computeTokens( + callback: BodyResponseCallback ): void; - delete( + computeTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Computetokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; + {}) as Params$Resource$Projects$Locations$Endpoints$Computetokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; + {} as Params$Resource$Projects$Locations$Endpoints$Computetokens; options = {}; } @@ -20071,86 +22906,90 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists SavedQueries in a Dataset. + * Perform a token counting. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + countTokens( + params?: Params$Resource$Projects$Locations$Endpoints$Counttokens, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + ): GaxiosPromise; + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, - callback: BodyResponseCallback + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + countTokens( + callback: BodyResponseCallback ): void; - list( + countTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Counttokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$List; + {}) as Params$Resource$Projects$Locations$Endpoints$Counttokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$List; + params = {} as Params$Resource$Projects$Locations$Endpoints$Counttokens; options = {}; } @@ -20163,129 +23002,90 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/savedQueries').replace( + url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete - extends StandardParameters { - /** - * Required. The resource name of the SavedQuery to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Datasets$Savedqueries$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * Creates an Endpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Endpoints$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Endpoints$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Endpoints$Create; options = {}; } @@ -20298,28 +23098,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/endpoints').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes an Endpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -20327,123 +23130,35 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params: Params$Resource$Projects$Locations$Endpoints$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params?: Params$Resource$Projects$Locations$Endpoints$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params: Params$Resource$Projects$Locations$Endpoints$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + params: Params$Resource$Projects$Locations$Endpoints$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Endpoints$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get + | Params$Resource$Projects$Locations$Endpoints$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -20459,13 +23174,12 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; + {}) as Params$Resource$Projects$Locations$Endpoints$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Endpoints$Delete; options = {}; } @@ -20479,7 +23193,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), @@ -20499,65 +23213,64 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deploys a Model into this Endpoint, creating a DeployedModel within it. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + deployModel( + params?: Params$Resource$Projects$Locations$Endpoints$Deploymodel, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + ): GaxiosPromise; + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, - callback: BodyResponseCallback + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + deployModel( + callback: BodyResponseCallback ): void; - list( + deployModel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Deploymodel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; + {}) as Params$Resource$Projects$Locations$Endpoints$Deploymodel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; + params = {} as Params$Resource$Projects$Locations$Endpoints$Deploymodel; options = {}; } @@ -20570,91 +23283,89 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+endpoint}:deployModel').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Perform an unary online prediction request for Vertex first-party products and frameworks. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + directPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Directpredict, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + ): GaxiosPromise; + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, - callback: BodyResponseCallback + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + directPredict( + callback: BodyResponseCallback ): void; - wait( + directPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Directpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Endpoints$Directpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; + {} as Params$Resource$Projects$Locations$Endpoints$Directpredict; options = {}; } @@ -20667,150 +23378,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:directPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Deploymentresourcepools { - context: APIRequestContext; - operations: Resource$Projects$Locations$Deploymentresourcepools$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Deploymentresourcepools$Operations( - this.context + return createAPIRequest( + parameters ); + } } /** - * Create a DeploymentResourcePool. + * Perform an online prediction request through gRPC. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, + directRawPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, + ): GaxiosPromise; + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, - callback: BodyResponseCallback + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + directRawPredict( + callback: BodyResponseCallback ): void; - create( + directRawPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Directrawpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; + {}) as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; + {} as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; options = {}; } @@ -20823,7 +23475,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( + url: (rootUrl + '/v1/{+endpoint}:directRawPredict').replace( /([^:]\/)\/+/g, '$1' ), @@ -20832,80 +23484,81 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Delete a DeploymentResourcePool. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + explain( + params?: Params$Resource$Projects$Locations$Endpoints$Explain, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + ): GaxiosPromise; + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, - callback: BodyResponseCallback + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + explain( + callback: BodyResponseCallback ): void; - delete( + explain( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Explain + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; + {}) as Params$Resource$Projects$Locations$Endpoints$Explain; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; + params = {} as Params$Resource$Projects$Locations$Endpoints$Explain; options = {}; } @@ -20918,28 +23571,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}:explain').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Get a DeploymentResourcePool. + * Gets an Endpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -20947,57 +23605,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + params: Params$Resource$Projects$Locations$Endpoints$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + params?: Params$Resource$Projects$Locations$Endpoints$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + params: Params$Resource$Projects$Locations$Endpoints$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + params: Params$Resource$Projects$Locations$Endpoints$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Endpoints$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; + {}) as Params$Resource$Projects$Locations$Endpoints$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; + params = {} as Params$Resource$Projects$Locations$Endpoints$Get; options = {}; } @@ -21021,19 +23678,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * List DeploymentResourcePools in a location. + * Lists Endpoints in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21041,57 +23698,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + params: Params$Resource$Projects$Locations$Endpoints$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + params?: Params$Resource$Projects$Locations$Endpoints$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + params: Params$Resource$Projects$Locations$Endpoints$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + params: Params$Resource$Projects$Locations$Endpoints$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Endpoints$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$List; + {}) as Params$Resource$Projects$Locations$Endpoints$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$List; + params = {} as Params$Resource$Projects$Locations$Endpoints$List; options = {}; } @@ -21104,7 +23760,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( + url: (rootUrl + '/v1/{+parent}/endpoints').replace( /([^:]\/)\/+/g, '$1' ), @@ -21118,233 +23774,171 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * List DeployedModels that have been deployed on this DeploymentResourcePool. + * 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). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, options: StreamMethodOptions ): GaxiosPromise; - queryDeployedModels( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + mutateDeployedModel( + params?: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, options?: MethodOptions - ): GaxiosPromise; - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + ): GaxiosPromise; + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, - callback: BodyResponseCallback + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + callback: BodyResponseCallback ): void; - queryDeployedModels( - callback: BodyResponseCallback + mutateDeployedModel( + callback: BodyResponseCallback ): void; - queryDeployedModels( + mutateDeployedModel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels; + {}) as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels; + {} as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; options = {}; } if (typeof optionsOrCallback === 'function') { callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1/{+deploymentResourcePool}:queryDeployedModels' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['deploymentResourcePool'], - pathParams: ['deploymentResourcePool'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Create - extends StandardParameters { - /** - * Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Delete - extends StandardParameters { - /** - * Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Get - extends StandardParameters { - /** - * Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$List - extends StandardParameters { - /** - * The maximum number of DeploymentResourcePools to return. The service may return fewer than this value. - */ - pageSize?: number; - /** - * 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. - */ - pageToken?: string; - /** - * Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels - extends StandardParameters { - /** - * Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - */ - deploymentResourcePool?: string; - /** - * The maximum number of DeployedModels to return. The service may return fewer than this value. - */ - pageSize?: number; - /** - * 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. - */ - pageToken?: string; - } + options = {}; + } - export class Resource$Projects$Locations$Deploymentresourcepools$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:mutateDeployedModel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * Updates an Endpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + patch( + params: Params$Resource$Projects$Locations$Endpoints$Patch, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + patch( + params?: Params$Resource$Projects$Locations$Endpoints$Patch, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Endpoints$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Endpoints$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Endpoints$Patch, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Endpoints$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Endpoints$Patch; options = {}; } @@ -21357,8 +23951,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), @@ -21368,71 +23962,76 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Perform an online prediction. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + predict( + params?: Params$Resource$Projects$Locations$Endpoints$Predict, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + ): GaxiosPromise; + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, - callback: BodyResponseCallback + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + predict( + callback: BodyResponseCallback + ): void; + predict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Predict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Endpoints$Predict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Endpoints$Predict; options = {}; } @@ -21445,86 +24044,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}:predict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + rawPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Rawpredict, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + ): GaxiosPromise; + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, - callback: BodyResponseCallback + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + callback: BodyResponseCallback ): void; - get( + rawPredict(callback: BodyResponseCallback): void; + rawPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Rawpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; + {}) as Params$Resource$Projects$Locations$Endpoints$Rawpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Endpoints$Rawpredict; options = {}; } @@ -21537,86 +24136,89 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+endpoint}:rawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Perform a server-side streaming online prediction request for Vertex LLM streaming. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + serverStreamingPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + ): GaxiosPromise; + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, - callback: BodyResponseCallback + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + serverStreamingPredict( + callback: BodyResponseCallback ): void; - list( + serverStreamingPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; + {}) as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; + {} as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; options = {}; } @@ -21629,91 +24231,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+endpoint}:serverStreamingPredict').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Generate content with multimodal inputs with streaming support. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + streamGenerateContent( + params?: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + ): GaxiosPromise; + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, - callback: BodyResponseCallback + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + streamGenerateContent( + callback: BodyResponseCallback ): void; - wait( + streamGenerateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; + {} as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; options = {}; } @@ -21726,149 +24328,88 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Endpoints { - context: APIRequestContext; - operations: Resource$Projects$Locations$Endpoints$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Endpoints$Operations( - this.context - ); - } /** - * Return a list of tokens based on the input text. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, options: StreamMethodOptions ): GaxiosPromise; - computeTokens( - params?: Params$Resource$Projects$Locations$Endpoints$Computetokens, + streamRawPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, options?: MethodOptions - ): GaxiosPromise; - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + ): GaxiosPromise; + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, - callback: BodyResponseCallback + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + callback: BodyResponseCallback ): void; - computeTokens( - callback: BodyResponseCallback + streamRawPredict( + callback: BodyResponseCallback ): void; - computeTokens( + streamRawPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Computetokens - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Streamrawpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Computetokens; + {}) as Params$Resource$Projects$Locations$Endpoints$Streamrawpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Computetokens; + {} as Params$Resource$Projects$Locations$Endpoints$Streamrawpredict; options = {}; } @@ -21881,7 +24422,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( + url: (rootUrl + '/v1/{+endpoint}:streamRawPredict').replace( /([^:]\/)\/+/g, '$1' ), @@ -21895,76 +24436,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform a token counting. + * Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, options: StreamMethodOptions ): GaxiosPromise; - countTokens( - params?: Params$Resource$Projects$Locations$Endpoints$Counttokens, + undeployModel( + params?: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, options?: MethodOptions - ): GaxiosPromise; - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + ): GaxiosPromise; + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, - callback: BodyResponseCallback + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + callback: BodyResponseCallback ): void; - countTokens( - callback: BodyResponseCallback + undeployModel( + callback: BodyResponseCallback ): void; - countTokens( + undeployModel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Counttokens - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Undeploymodel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Counttokens; + {}) as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Counttokens; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; options = {}; } @@ -21977,7 +24517,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( + url: (rootUrl + '/v1/{+endpoint}:undeployModel').replace( /([^:]\/)\/+/g, '$1' ), @@ -21991,76 +24531,308 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Endpoints$Computetokens + extends StandardParameters { /** - * Creates an Endpoint. + * Required. The name of the Endpoint requested to get lists of tokens and token ids. + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Counttokens + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Create + extends StandardParameters { + /** + * 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. + */ + endpointId?: string; + /** + * Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; + } + export interface Params$Resource$Projects$Locations$Endpoints$Delete + extends StandardParameters { + /** + * Required. The name of the Endpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Deploymodel + extends StandardParameters { + /** + * Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeployModelRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Directpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DirectPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Directrawpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DirectRawPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Explain + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExplainRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Get + extends StandardParameters { + /** + * Required. The name of the Endpoint resource. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$List + extends StandardParameters { + /** + * 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"`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` + */ + filter?: string; + /** + * 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`. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel + extends StandardParameters { + /** + * Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1MutateDeployedModelRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Patch + extends StandardParameters { + /** + * Output only. The resource name of the Endpoint. + */ + name?: string; + /** + * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; + } + export interface Params$Resource$Projects$Locations$Endpoints$Predict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Rawpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RawPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamingPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent + extends StandardParameters { + /** + * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Streamrawpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamRawPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Undeploymodel + extends StandardParameters { + /** + * Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UndeployModelRequest; + } + + export class Resource$Projects$Locations$Endpoints$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Endpoints$Create, + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Endpoints$Create, + cancel( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Endpoints$Create, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Endpoints$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Endpoints$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Create; + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Create; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; options = {}; } @@ -22073,31 +24845,28 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/endpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes an Endpoint. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22105,56 +24874,53 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Endpoints$Delete, + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Endpoints$Delete, + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Endpoints$Delete, + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Endpoints$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Endpoints$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Delete; + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Delete; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; options = {}; } @@ -22178,53 +24944,53 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deploys a Model into this Endpoint, creating a DeployedModel within it. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - deployModel( - params?: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + get( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Get, options?: MethodOptions ): GaxiosPromise; - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, callback: BodyResponseCallback ): void; - deployModel( + get( callback: BodyResponseCallback ): void; - deployModel( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Deploymodel + | Params$Resource$Projects$Locations$Endpoints$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -22240,12 +25006,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Deploymodel; + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Deploymodel; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Get; options = {}; } @@ -22258,17 +25025,14 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:deployModel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -22282,65 +25046,65 @@ export namespace aiplatform_v1 { } /** - * Perform an unary online prediction request for Vertex first-party products and frameworks. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - directPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Directpredict, + list( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$List, options?: MethodOptions - ): GaxiosPromise; - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + callback: BodyResponseCallback ): void; - directPredict( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - directPredict( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Directpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Directpredict; + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Directpredict; + {} as Params$Resource$Projects$Locations$Endpoints$Operations$List; options = {}; } @@ -22353,91 +25117,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:directPredict').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Perform an online prediction request through gRPC. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - directRawPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + wait( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + callback: BodyResponseCallback ): void; - directRawPredict( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - directRawPredict( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Directrawpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; options = {}; } @@ -22450,90 +25214,151 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:directRawPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Cancel + extends StandardParameters { /** - * 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. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featuregroups { + context: APIRequestContext; + features: Resource$Projects$Locations$Featuregroups$Features; + operations: Resource$Projects$Locations$Featuregroups$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.features = new Resource$Projects$Locations$Featuregroups$Features( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featuregroups$Operations(this.context); + } + + /** + * Creates a new FeatureGroup in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, options: StreamMethodOptions ): GaxiosPromise; - explain( - params?: Params$Resource$Projects$Locations$Endpoints$Explain, + create( + params?: Params$Resource$Projects$Locations$Featuregroups$Create, options?: MethodOptions - ): GaxiosPromise; - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + callback: BodyResponseCallback ): void; - explain( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - explain( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Explain - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Explain; + {}) as Params$Resource$Projects$Locations$Featuregroups$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Explain; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Create; options = {}; } @@ -22546,7 +25371,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:explain').replace( + url: (rootUrl + '/v1/{+parent}/featureGroups').replace( /([^:]\/)\/+/g, '$1' ), @@ -22555,81 +25380,79 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets an Endpoint. + * Deletes a single FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Endpoints$Get, + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Endpoints$Get, + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Endpoints$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Endpoints$Get, + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Endpoints$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Get; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Delete; options = {}; } @@ -22643,7 +25466,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), @@ -22653,76 +25476,74 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Endpoints in a Location. + * Gets details of a single FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Endpoints$List, + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Endpoints$List, + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Endpoints$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Endpoints$List, + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Endpoints$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$List; + {}) as Params$Resource$Projects$Locations$Featuregroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$List; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Get; options = {}; } @@ -22735,91 +25556,87 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/endpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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). + * Lists FeatureGroups in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, options: StreamMethodOptions ): GaxiosPromise; - mutateDeployedModel( - params?: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + list( + params?: Params$Resource$Projects$Locations$Featuregroups$List, options?: MethodOptions - ): GaxiosPromise; - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, + callback: BodyResponseCallback ): void; - mutateDeployedModel( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - mutateDeployedModel( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; + {}) as Params$Resource$Projects$Locations$Featuregroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; + params = {} as Params$Resource$Projects$Locations$Featuregroups$List; options = {}; } @@ -22832,31 +25649,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:mutateDeployedModel').replace( + url: (rootUrl + '/v1/{+parent}/featureGroups').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Updates an Endpoint. + * Updates the parameters of a single FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22864,56 +25683,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Endpoints$Patch, + params: Params$Resource$Projects$Locations$Featuregroups$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Endpoints$Patch, + params?: Params$Resource$Projects$Locations$Featuregroups$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Endpoints$Patch, + params: Params$Resource$Projects$Locations$Featuregroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Endpoints$Patch, + params: Params$Resource$Projects$Locations$Featuregroups$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Endpoints$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Patch; + {}) as Params$Resource$Projects$Locations$Featuregroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Patch; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Patch; options = {}; } @@ -22937,76 +25756,161 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Featuregroups$Create + extends StandardParameters { /** - * Perform an online prediction. + * 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 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. + */ + featureGroupId?: string; + /** + * Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}'` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Delete + extends StandardParameters { + /** + * 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.) + */ + force?: boolean; + /** + * Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Get + extends StandardParameters { + /** + * Required. The name of the FeatureGroup resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$List + extends StandardParameters { + /** + * 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". + */ + filter?: string; + /** + * 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` + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureGroupAdminService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureGroupAdminService.ListFeatureGroups must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Patch + extends StandardParameters { + /** + * Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` + */ + name?: string; + /** + * 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` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; + } + + export class Resource$Projects$Locations$Featuregroups$Features { + context: APIRequestContext; + operations: Resource$Projects$Locations$Featuregroups$Features$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Featuregroups$Features$Operations( + this.context + ); + } + + /** + * Creates a new Feature in a given FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, options: StreamMethodOptions ): GaxiosPromise; - predict( - params?: Params$Resource$Projects$Locations$Endpoints$Predict, + create( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Create, options?: MethodOptions - ): GaxiosPromise; - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + callback: BodyResponseCallback ): void; - predict( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - predict( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Predict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Predict; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Predict; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Create; options = {}; } @@ -23019,7 +25923,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predict').replace( + url: (rootUrl + '/v1/{+parent}/features').replace( /([^:]\/)\/+/g, '$1' ), @@ -23028,77 +25932,80 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * 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. + * Deletes a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, options: StreamMethodOptions ): GaxiosPromise; - rawPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, options?: MethodOptions - ): GaxiosPromise; - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + callback: BodyResponseCallback ): void; - rawPredict(callback: BodyResponseCallback): void; - rawPredict( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Rawpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Rawpredict; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Rawpredict; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; options = {}; } @@ -23111,89 +26018,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:rawPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Perform a server-side streaming online prediction request for Vertex LLM streaming. + * Gets details of a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, options: StreamMethodOptions ): GaxiosPromise; - serverStreamingPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Get, options?: MethodOptions - ): GaxiosPromise; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + callback: BodyResponseCallback ): void; - serverStreamingPredict( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - serverStreamingPredict( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Get; options = {}; } @@ -23206,91 +26110,88 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:serverStreamingPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Generate content with multimodal inputs with streaming support. + * Lists Features in a given FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, options: StreamMethodOptions ): GaxiosPromise; - streamGenerateContent( - params?: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + list( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$List, options?: MethodOptions - ): GaxiosPromise; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + callback: BodyResponseCallback ): void; - streamGenerateContent( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - streamGenerateContent( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$List; options = {}; } @@ -23303,69 +26204,69 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( + url: (rootUrl + '/v1/{+parent}/features').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. + * Updates the parameters of a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, options: StreamMethodOptions ): GaxiosPromise; - undeployModel( - params?: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + patch( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, options?: MethodOptions ): GaxiosPromise; - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, callback: BodyResponseCallback ): void; - undeployModel( + patch( callback: BodyResponseCallback ): void; - undeployModel( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Undeploymodel + | Params$Resource$Projects$Locations$Featuregroups$Features$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23381,13 +26282,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; options = {}; } @@ -23400,17 +26301,14 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:undeployModel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -23424,316 +26322,88 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Endpoints$Computetokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to get lists of tokens and token ids. - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Counttokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Create + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Create extends StandardParameters { /** - * 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. + * 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. */ - endpointId?: string; + featureId?: string; /** - * Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project\}/locations/{location\}` + * 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\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; + requestBody?: Schema$GoogleCloudAiplatformV1Feature; } - export interface Params$Resource$Projects$Locations$Endpoints$Delete + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Delete extends StandardParameters { /** - * Required. The name of the Endpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * 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\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Deploymodel - extends StandardParameters { - /** - * Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DeployModelRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Directpredict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DirectPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Directrawpredict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DirectRawPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Explain - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExplainRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Get + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Get extends StandardParameters { /** - * Required. The name of the Endpoint resource. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * 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\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$List + export interface Params$Resource$Projects$Locations$Featuregroups$Features$List extends StandardParameters { /** - * 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"`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * 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. */ filter?: string; /** - * 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`. + * 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. + */ + latestStatsCount?: number; + /** + * 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` */ orderBy?: string; /** - * Optional. The standard list page size. + * 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. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call. + * 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. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project\}/locations/{location\}` + * 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\}` */ parent?: string; /** - * Optional. Mask specifying which fields to read. + * Mask specifying which fields to read. */ readMask?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel - extends StandardParameters { - /** - * Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1MutateDeployedModelRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Patch + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Patch extends StandardParameters { /** - * Output only. The resource name of the Endpoint. + * 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. */ name?: string; /** - * Required. The update mask applies to the resource. See google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; - } - export interface Params$Resource$Projects$Locations$Endpoints$Predict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Rawpredict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RawPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamingPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent - extends StandardParameters { - /** - * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Undeploymodel - extends StandardParameters { - /** - * Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1UndeployModelRequest; - } - - export class Resource$Projects$Locations$Endpoints$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, - options: StreamMethodOptions - ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, - options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + * 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 FeatureRegistry Feature) + */ + updateMask?: string; - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Feature; + } + + export class Resource$Projects$Locations$Featuregroups$Features$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** @@ -23745,31 +26415,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Delete + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23785,13 +26455,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; options = {}; } @@ -23833,27 +26503,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -23861,7 +26531,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Get + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23877,13 +26547,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; options = {}; } @@ -23924,36 +26594,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$List, + listWait( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, options?: MethodOptions ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, callback: BodyResponseCallback ): void; - list( + listWait( callback: BodyResponseCallback ): void; - list( + listWait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$List + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23969,13 +26639,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$List; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$List; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; options = {}; } @@ -23988,10 +26658,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -24022,27 +26689,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -24050,7 +26717,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Wait + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -24066,13 +26733,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; options = {}; } @@ -24106,28 +26773,21 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Delete + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Get + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$List + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait extends StandardParameters { /** * The standard list filter. @@ -24146,7 +26806,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Wait + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -24158,115 +26818,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Featuregroups { + export class Resource$Projects$Locations$Featuregroups$Operations { context: APIRequestContext; - features: Resource$Projects$Locations$Featuregroups$Features; - operations: Resource$Projects$Locations$Featuregroups$Operations; constructor(context: APIRequestContext) { this.context = context; - this.features = new Resource$Projects$Locations$Featuregroups$Features( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featuregroups$Operations(this.context); - } - - /** - * Creates a new FeatureGroup in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featuregroups$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/featureGroups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } } /** - * Deletes a single FeatureGroup. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24274,56 +26833,53 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Delete, + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Delete; + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Delete; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; options = {}; } @@ -24347,17 +26903,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single FeatureGroup. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24365,56 +26921,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Get, + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Get; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; options = {}; } @@ -24438,76 +26995,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists FeatureGroups in a given project and location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Featuregroups$List, + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featuregroups$List, + listWait( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featuregroups$List, + ): GaxiosPromise; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$List, + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$List, - callback: BodyResponseCallback + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + listWait( + callback: BodyResponseCallback ): void; - list( + listWait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$List; + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$List; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; options = {}; } @@ -24520,69 +27076,66 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureGroups').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single FeatureGroup. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Featuregroups$Patch, + wait( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, callback: BodyResponseCallback ): void; - patch( + wait( callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Patch + | Params$Resource$Projects$Locations$Featuregroups$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -24598,12 +27151,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Patch; + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Patch; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; options = {}; } @@ -24616,8 +27170,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), @@ -24637,93 +27191,69 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Featuregroups$Create - extends StandardParameters { - /** - * 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 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. - */ - featureGroupId?: string; - /** - * Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}'` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Delete + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Delete extends StandardParameters { /** - * 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.) - */ - force?: boolean; - /** - * Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Get + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Get extends StandardParameters { /** - * Required. The name of the FeatureGroup resource. + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$List + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait extends StandardParameters { /** - * 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". + * The standard list filter. */ filter?: string; /** - * 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` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * 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. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous FeatureGroupAdminService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureGroupAdminService.ListFeatureGroups must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; - /** - * Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Patch + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Wait extends StandardParameters { /** - * Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` + * The name of the operation resource to wait on. */ name?: string; /** - * 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` - */ - updateMask?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; + timeout?: string; } - export class Resource$Projects$Locations$Featuregroups$Features { + export class Resource$Projects$Locations$Featureonlinestores { context: APIRequestContext; - operations: Resource$Projects$Locations$Featuregroups$Features$Operations; + featureViews: Resource$Projects$Locations$Featureonlinestores$Featureviews; + operations: Resource$Projects$Locations$Featureonlinestores$Operations; constructor(context: APIRequestContext) { this.context = context; + this.featureViews = + new Resource$Projects$Locations$Featureonlinestores$Featureviews( + this.context + ); this.operations = - new Resource$Projects$Locations$Featuregroups$Features$Operations( + new Resource$Projects$Locations$Featureonlinestores$Operations( this.context ); } /** - * Creates a new Feature in a given FeatureGroup. + * Creates a new FeatureOnlineStore in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24731,27 +27261,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + params?: Params$Resource$Projects$Locations$Featureonlinestores$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, callback: BodyResponseCallback ): void; create( @@ -24759,7 +27289,7 @@ export namespace aiplatform_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Create + | Params$Resource$Projects$Locations$Featureonlinestores$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -24775,13 +27305,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Create; options = {}; } @@ -24794,7 +27324,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features').replace( + url: (rootUrl + '/v1/{+parent}/featureOnlineStores').replace( /([^:]\/)\/+/g, '$1' ), @@ -24818,7 +27348,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a single Feature. + * Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24826,27 +27356,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + params?: Params$Resource$Projects$Locations$Featureonlinestores$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, callback: BodyResponseCallback ): void; delete( @@ -24854,7 +27384,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Delete + | Params$Resource$Projects$Locations$Featureonlinestores$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -24870,13 +27400,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Delete; options = {}; } @@ -24910,7 +27440,7 @@ export namespace aiplatform_v1 { } /** - * Gets details of a single Feature. + * Gets details of a single FeatureOnlineStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24918,57 +27448,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + params?: Params$Resource$Projects$Locations$Featureonlinestores$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Get; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Get; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Get; options = {}; } @@ -24992,19 +27522,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Features in a given FeatureGroup. + * Lists FeatureOnlineStores in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -25012,57 +27542,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + params: Params$Resource$Projects$Locations$Featureonlinestores$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$List, + params?: Params$Resource$Projects$Locations$Featureonlinestores$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + params: Params$Resource$Projects$Locations$Featureonlinestores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + params: Params$Resource$Projects$Locations$Featureonlinestores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$List; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$List; + {} as Params$Resource$Projects$Locations$Featureonlinestores$List; options = {}; } @@ -25075,7 +27605,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features').replace( + url: (rootUrl + '/v1/{+parent}/featureOnlineStores').replace( /([^:]\/)\/+/g, '$1' ), @@ -25089,19 +27619,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single Feature. + * Updates the parameters of a single FeatureOnlineStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -25109,27 +27639,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + params?: Params$Resource$Projects$Locations$Featureonlinestores$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, callback: BodyResponseCallback ): void; patch( @@ -25137,7 +27667,7 @@ export namespace aiplatform_v1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Patch + | Params$Resource$Projects$Locations$Featureonlinestores$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25153,13 +27683,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Patch; options = {}; } @@ -25193,146 +27723,156 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Create + export interface Params$Resource$Projects$Locations$Featureonlinestores$Create extends StandardParameters { /** - * 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. + * 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. */ - featureId?: string; + featureOnlineStoreId?: string; /** - * 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\}` + * Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; + requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Delete + export interface Params$Resource$Projects$Locations$Featureonlinestores$Delete extends StandardParameters { /** - * 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\}` + * 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.) + */ + force?: boolean; + /** + * Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Get + export interface Params$Resource$Projects$Locations$Featureonlinestores$Get extends StandardParameters { /** - * 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\}` + * Required. The name of the FeatureOnlineStore resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$List + export interface Params$Resource$Projects$Locations$Featureonlinestores$List extends StandardParameters { /** - * 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. + * 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". */ filter?: string; /** - * 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. - */ - latestStatsCount?: number; - /** - * 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` + * 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` */ orderBy?: string; /** - * 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. + * 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. */ pageSize?: number; /** - * 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. + * 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. */ pageToken?: string; /** - * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Patch + export interface Params$Resource$Projects$Locations$Featureonlinestores$Patch extends StandardParameters { /** - * 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. + * Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` */ name?: string; /** - * 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 FeatureRegistry Feature) + * 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: * `big_query_source` * `labels` * `sync_config` */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; + requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; } - export class Resource$Projects$Locations$Featuregroups$Features$Operations { + export class Resource$Projects$Locations$Featureonlinestores$Featureviews { context: APIRequestContext; + featureViewSyncs: Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs; + operations: Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations; constructor(context: APIRequestContext) { this.context = context; + this.featureViewSyncs = + new Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations( + this.context + ); } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a new FeatureView in a given FeatureOnlineStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; options = {}; } @@ -25345,64 +27885,67 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/featureViews').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a single FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25418,13 +27961,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; options = {}; } @@ -25438,7 +27981,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), @@ -25458,65 +28001,65 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Fetch feature values under a FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - listWait( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + fetchFeatureValues( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, options?: MethodOptions - ): GaxiosPromise; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + ): GaxiosPromise; + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, - callback: BodyResponseCallback + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + callback: BodyResponseCallback ): void; - listWait( - callback: BodyResponseCallback + fetchFeatureValues( + callback: BodyResponseCallback ): void; - listWait( + fetchFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; options = {}; } @@ -25529,88 +28072,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+featureView}:fetchFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['featureView'], + pathParams: ['featureView'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Gets details of a single FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - wait( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; options = {}; } @@ -25623,8 +28169,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), @@ -25634,123 +28180,77 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featuregroups$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Lists FeatureViews in a given FeatureOnlineStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; options = {}; } @@ -25763,64 +28263,69 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/featureViews').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Updates the parameters of a single FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, callback: BodyResponseCallback ): void; - get( + patch( callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Get + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25836,13 +28341,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; options = {}; } @@ -25856,7 +28361,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', }, options ), @@ -25876,65 +28381,65 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Triggers on-demand sync for the FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, options: StreamMethodOptions ): GaxiosPromise; - listWait( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + sync( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, options?: MethodOptions - ): GaxiosPromise; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + ): GaxiosPromise; + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, - callback: BodyResponseCallback + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + callback: BodyResponseCallback ): void; - listWait( - callback: BodyResponseCallback + sync( + callback: BodyResponseCallback ): void; - listWait( + sync( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; options = {}; } @@ -25947,88 +28452,196 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+featureView}:sync').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['featureView'], + pathParams: ['featureView'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create + extends StandardParameters { /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * 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. + */ + featureViewId?: string; + /** + * Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + parent?: string; + /** + * Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. + */ + runSyncImmediately?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete + extends StandardParameters { + /** + * Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues + extends StandardParameters { + /** + * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FetchFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get + extends StandardParameters { + /** + * Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List + extends StandardParameters { + /** + * 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. + */ + filter?: string; + /** + * 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` + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch + extends StandardParameters { + /** + * Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + /** + * 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` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync + extends StandardParameters { + /** + * Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SyncFeatureViewRequest; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single FeatureViewSync. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - wait( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; options = {}; } @@ -26041,8 +28654,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), @@ -26052,137 +28665,77 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featureonlinestores { - context: APIRequestContext; - featureViews: Resource$Projects$Locations$Featureonlinestores$Featureviews; - operations: Resource$Projects$Locations$Featureonlinestores$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.featureViews = - new Resource$Projects$Locations$Featureonlinestores$Featureviews( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featureonlinestores$Operations( - this.context + return createAPIRequest( + parameters ); + } } /** - * Creates a new FeatureOnlineStore in a given project and location. + * Lists FeatureViewSyncs in a given FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Create, + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Create; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Create; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; options = {}; } @@ -26195,11 +28748,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureOnlineStores').replace( + url: (rootUrl + '/v1/{+parent}/featureViewSyncs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), @@ -26209,17 +28762,57 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get + extends StandardParameters { /** - * Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews. + * Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List + extends StandardParameters { + /** + * 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. + */ + filter?: string; + /** + * 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` + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -26227,57 +28820,53 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; options = {}; } @@ -26301,17 +28890,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single FeatureOnlineStore. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -26319,57 +28908,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Get, + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Get; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Get; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; options = {}; } @@ -26393,77 +28982,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists FeatureOnlineStores in a given project and location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$List, + listWait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, + ): GaxiosPromise; + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, - callback: BodyResponseCallback + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + listWait( + callback: BodyResponseCallback ): void; - list( + listWait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$List; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$List; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; options = {}; } @@ -26476,69 +29063,66 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureOnlineStores').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single FeatureOnlineStore. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + wait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, callback: BodyResponseCallback ): void; - patch( + wait( callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Patch + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -26554,13 +29138,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; options = {}; } @@ -26573,8 +29157,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), @@ -26594,156 +29178,113 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Create - extends StandardParameters { - /** - * 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. - */ - featureOnlineStoreId?: string; - /** - * Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}'` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Delete + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete extends StandardParameters { /** - * 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.) - */ - force?: boolean; - /** - * Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Get + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get extends StandardParameters { /** - * Required. The name of the FeatureOnlineStore resource. + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$List + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait extends StandardParameters { /** - * 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". + * The standard list filter. */ filter?: string; /** - * 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` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * 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. + * The standard list page size. */ pageSize?: number; /** - * 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. + * The standard list page token. */ pageToken?: string; - /** - * Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Patch + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait extends StandardParameters { /** - * Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` + * The name of the operation resource to wait on. */ name?: string; /** - * 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: * `big_query_source` * `labels` * `sync_config` - */ - updateMask?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; + timeout?: string; } - export class Resource$Projects$Locations$Featureonlinestores$Featureviews { + export class Resource$Projects$Locations$Featureonlinestores$Operations { context: APIRequestContext; - featureViewSyncs: Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs; - operations: Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations; constructor(context: APIRequestContext) { this.context = context; - this.featureViewSyncs = - new Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations( - this.context - ); } /** - * Creates a new FeatureView in a given FeatureOnlineStore. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; options = {}; } @@ -26756,67 +29297,64 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureViews').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single FeatureView. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -26832,13 +29370,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; options = {}; } @@ -26852,7 +29390,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), @@ -26872,65 +29410,65 @@ export namespace aiplatform_v1 { } /** - * Fetch feature values under a FeatureView. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, options: StreamMethodOptions ): GaxiosPromise; - fetchFeatureValues( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + listWait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, options?: MethodOptions - ): GaxiosPromise; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + ): GaxiosPromise; + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, - callback: BodyResponseCallback + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + callback: BodyResponseCallback ): void; - fetchFeatureValues( - callback: BodyResponseCallback + listWait( + callback: BodyResponseCallback ): void; - fetchFeatureValues( + listWait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; options = {}; } @@ -26943,91 +29481,88 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+featureView}:fetchFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets details of a single FeatureView. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + wait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - get( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; options = {}; } @@ -27040,8 +29575,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), @@ -27051,77 +29586,133 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete + extends StandardParameters { /** - * Lists FeatureViews in a given FeatureOnlineStore. + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featurestores { + context: APIRequestContext; + entityTypes: Resource$Projects$Locations$Featurestores$Entitytypes; + operations: Resource$Projects$Locations$Featurestores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.entityTypes = + new Resource$Projects$Locations$Featurestores$Entitytypes(this.context); + this.operations = + new Resource$Projects$Locations$Featurestores$Operations(this.context); + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + batchReadFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + ): GaxiosPromise; + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, - callback: BodyResponseCallback + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + batchReadFeatureValues( + callback: BodyResponseCallback ): void; - list( + batchReadFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + {} as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; options = {}; } @@ -27134,69 +29725,66 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureViews').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1/{+featurestore}:batchReadFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['featurestore'], + pathParams: ['featurestore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single FeatureView. + * Creates a new Featurestore in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + create( + params?: Params$Resource$Projects$Locations$Featurestores$Create, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch + | Params$Resource$Projects$Locations$Featurestores$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -27212,13 +29800,12 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + {}) as Params$Resource$Projects$Locations$Featurestores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + params = {} as Params$Resource$Projects$Locations$Featurestores$Create; options = {}; } @@ -27231,14 +29818,17 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/featurestores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -27252,65 +29842,64 @@ export namespace aiplatform_v1 { } /** - * Triggers on-demand sync for the FeatureView. + * Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, options: StreamMethodOptions ): GaxiosPromise; - sync( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Delete, options?: MethodOptions - ): GaxiosPromise; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, + callback: BodyResponseCallback ): void; - sync( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - sync( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; + {}) as Params$Resource$Projects$Locations$Featurestores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; + params = {} as Params$Resource$Projects$Locations$Featurestores$Delete; options = {}; } @@ -27323,196 +29912,177 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+featureView}:sync').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create - extends StandardParameters { - /** - * 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. - */ - featureViewId?: string; - /** - * Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - */ - parent?: string; - /** - * Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. - */ - runSyncImmediately?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete - extends StandardParameters { - /** - * Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues - extends StandardParameters { - /** - * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FetchFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get - extends StandardParameters { - /** - * Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List - extends StandardParameters { - /** - * 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. - */ - filter?: string; - /** - * 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` - */ - orderBy?: string; - /** - * 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. - */ - pageSize?: number; - /** - * 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. - */ - pageToken?: string; - /** - * Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch - extends StandardParameters { - /** - * Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - name?: string; - /** - * 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` - */ - updateMask?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync - extends StandardParameters { - /** - * Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * Gets details of a single Featurestore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - featureView?: string; + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Featurestores$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SyncFeatureViewRequest; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featurestores$Get; + options = {}; + } - export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Gets details of a single FeatureViewSync. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - get( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; options = {}; } @@ -27525,30 +30095,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists FeatureViewSyncs in a given FeatureView. + * Lists Featurestores in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -27556,57 +30127,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + params: Params$Resource$Projects$Locations$Featurestores$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + params?: Params$Resource$Projects$Locations$Featurestores$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + params: Params$Resource$Projects$Locations$Featurestores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + params: Params$Resource$Projects$Locations$Featurestores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; + {}) as Params$Resource$Projects$Locations$Featurestores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; + params = {} as Params$Resource$Projects$Locations$Featurestores$List; options = {}; } @@ -27619,7 +30189,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureViewSyncs').replace( + url: (rootUrl + '/v1/{+parent}/featurestores').replace( /([^:]\/)\/+/g, '$1' ), @@ -27633,111 +30203,76 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get - extends StandardParameters { - /** - * Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List - extends StandardParameters { - /** - * 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. - */ - filter?: string; - /** - * 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` - */ - orderBy?: string; - /** - * 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. - */ - pageSize?: number; - /** - * 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. - */ - pageToken?: string; - /** - * Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Updates the parameters of a single Featurestore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Featurestores$Patch; options = {}; } @@ -27751,7 +30286,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', }, options ), @@ -27761,75 +30296,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Searches Features matching a query in a given project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + searchFeatures( + params?: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + ): GaxiosPromise; + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, - callback: BodyResponseCallback + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + searchFeatures( + callback: BodyResponseCallback ): void; - get( + searchFeatures( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Searchfeatures + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; options = {}; } @@ -27842,86 +30377,88 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1/{+location}/featurestores:searchFeatures' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - listWait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + callback: BodyResponseCallback ): void; - listWait( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - listWait( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; + {}) as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; + {} as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; options = {}; } @@ -27934,88 +30471,89 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - wait( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; options = {}; } @@ -28028,134 +30566,251 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete + export interface Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + */ + featurestore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchReadFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Create + extends StandardParameters { + /** + * 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. + */ + featurestoreId?: string; + /** + * Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; + } + export interface Params$Resource$Projects$Locations$Featurestores$Delete + extends StandardParameters { + /** + * 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.) + */ + force?: boolean; + /** + * Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Get + extends StandardParameters { + /** + * Required. The name of the Featurestore resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Getiampolicy + extends StandardParameters { + /** + * 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). + */ + 'options.requestedPolicyVersion'?: number; + /** + * 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. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$List extends StandardParameters { /** - * The name of the operation resource to be deleted. + * 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". */ - name?: string; + filter?: string; + /** + * 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` + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get + export interface Params$Resource$Projects$Locations$Featurestores$Patch extends StandardParameters { /** - * The name of the operation resource. + * Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` */ name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait - extends StandardParameters { /** - * The standard list filter. + * 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` */ - filter?: string; + updateMask?: string; + /** - * The name of the operation's parent resource. + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; + } + export interface Params$Resource$Projects$Locations$Featurestores$Searchfeatures + extends StandardParameters { /** - * The standard list page size. + * Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + /** + * 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. */ pageSize?: number; /** - * The standard list page token. + * 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. */ pageToken?: string; + /** + * 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. + */ + query?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait + export interface Params$Resource$Projects$Locations$Featurestores$Setiampolicy extends StandardParameters { /** - * The name of the operation resource to wait on. + * 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. */ - name?: string; + resource?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Testiampermissions + extends StandardParameters { + /** + * 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). + */ + permissions?: string[]; + /** + * 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. + */ + resource?: string; } - export class Resource$Projects$Locations$Featureonlinestores$Operations { + export class Resource$Projects$Locations$Featurestores$Entitytypes { context: APIRequestContext; + features: Resource$Projects$Locations$Featurestores$Entitytypes$Features; + operations: Resource$Projects$Locations$Featurestores$Entitytypes$Operations; constructor(context: APIRequestContext) { this.context = context; + this.features = + new Resource$Projects$Locations$Featurestores$Entitytypes$Features( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featurestores$Entitytypes$Operations( + this.context + ); } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a new EntityType in a given Featurestore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; options = {}; } @@ -28168,64 +30823,67 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/entityTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -28241,13 +30899,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; options = {}; } @@ -28261,7 +30919,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), @@ -28281,65 +30939,65 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - listWait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + deleteFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options?: MethodOptions - ): GaxiosPromise; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + ): GaxiosPromise; + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, - callback: BodyResponseCallback + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + callback: BodyResponseCallback ): void; - listWait( - callback: BodyResponseCallback + deleteFeatureValues( + callback: BodyResponseCallback ): void; - listWait( + deleteFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; options = {}; } @@ -28352,66 +31010,67 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+entityType}:deleteFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Exports Feature values from all the entities of a target EntityType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + exportFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, options?: MethodOptions ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, callback: BodyResponseCallback ): void; - wait( + exportFeatureValues( callback: BodyResponseCallback ): void; - wait( + exportFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -28427,13 +31086,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; options = {}; } @@ -28446,14 +31105,17 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+entityType}:exportFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { @@ -28465,125 +31127,67 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featurestores { - context: APIRequestContext; - entityTypes: Resource$Projects$Locations$Featurestores$Entitytypes; - operations: Resource$Projects$Locations$Featurestores$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.entityTypes = - new Resource$Projects$Locations$Featurestores$Entitytypes(this.context); - this.operations = - new Resource$Projects$Locations$Featurestores$Operations(this.context); - } /** - * 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. + * Gets details of a single EntityType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options: StreamMethodOptions ): GaxiosPromise; - batchReadFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options?: MethodOptions - ): GaxiosPromise; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + callback: BodyResponseCallback ): void; - batchReadFeatureValues( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - batchReadFeatureValues( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; options = {}; } @@ -28596,87 +31200,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+featurestore}:batchReadFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['featurestore'], - pathParams: ['featurestore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a new Featurestore in a given project and location. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Featurestores$Create, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featurestores$Create, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featurestores$Create, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Create, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - create( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Create; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; options = {}; } @@ -28689,7 +31292,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featurestores').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -28698,58 +31301,58 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Delete, + importFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, callback: BodyResponseCallback ): void; - delete( + importFeatureValues( callback: BodyResponseCallback ): void; - delete( + importFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Delete + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -28765,12 +31368,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Delete; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; options = {}; } @@ -28783,14 +31387,17 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+entityType}:importFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { @@ -28804,64 +31411,65 @@ export namespace aiplatform_v1 { } /** - * Gets details of a single Featurestore. + * Lists EntityTypes in a given Featurestore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featurestores$Get, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Get, + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featurestores$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Get, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Get; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; options = {}; } @@ -28874,86 +31482,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/entityTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Updates the parameters of a single EntityType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - getIamPolicy( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; options = {}; } @@ -28966,88 +31579,88 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists Featurestores in a given project and location. + * Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Featurestores$List, + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featurestores$List, + readFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featurestores$List, + ): GaxiosPromise; + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$List, + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$List, - callback: BodyResponseCallback + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + readFeatureValues( + callback: BodyResponseCallback ): void; - list( + readFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$List; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; options = {}; } @@ -29060,90 +31673,89 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featurestores').replace( + url: (rootUrl + '/v1/{+entityType}:readFeatureValues').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single Featurestore. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Patch, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - patch( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Patch; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Patch; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; options = {}; } @@ -29156,86 +31768,89 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Searches Features matching a query in a given project. + * Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - searchFeatures( - params?: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + streamingReadFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, options?: MethodOptions - ): GaxiosPromise; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + ): GaxiosPromise; + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, - callback: BodyResponseCallback + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + callback: BodyResponseCallback ): void; - searchFeatures( - callback: BodyResponseCallback + streamingReadFeatureValues( + callback: BodyResponseCallback ): void; - searchFeatures( + streamingReadFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Searchfeatures - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; options = {}; } @@ -29249,87 +31864,89 @@ export namespace aiplatform_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/{+location}/featurestores:searchFeatures' + rootUrl + '/v1/{+entityType}:streamingReadFeatureValues' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - setIamPolicy( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; options = {}; } @@ -29342,7 +31959,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), @@ -29356,75 +31973,77 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + writeFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + ): GaxiosPromise; + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, - callback: BodyResponseCallback + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + writeFeatureValues( + callback: BodyResponseCallback ): void; - testIamPermissions( + writeFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; options = {}; } @@ -29437,7 +32056,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+entityType}:writeFeatureValues').replace( /([^:]\/)\/+/g, '$1' ), @@ -29446,70 +32065,82 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create extends StandardParameters { /** - * Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * 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. */ - featurestore?: string; + entityTypeId?: string; + /** + * Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchReadFeatureValuesRequest; + requestBody?: Schema$GoogleCloudAiplatformV1EntityType; } - export interface Params$Resource$Projects$Locations$Featurestores$Create + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete extends StandardParameters { /** - * 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. + * 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.) */ - featurestoreId?: string; + force?: boolean; /** - * Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` */ - parent?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues + extends StandardParameters { + /** + * 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\}` + */ + entityType?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; + requestBody?: Schema$GoogleCloudAiplatformV1DeleteFeatureValuesRequest; } - export interface Params$Resource$Projects$Locations$Featurestores$Delete + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues extends StandardParameters { /** - * 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.) + * Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` */ - force?: boolean; + entityType?: string; + /** - * Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1ExportFeatureValuesRequest; } - export interface Params$Resource$Projects$Locations$Featurestores$Get + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get extends StandardParameters { /** - * Required. The name of the Featurestore resource. + * Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Getiampolicy + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy extends StandardParameters { /** * 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). @@ -29520,26 +32151,38 @@ export namespace aiplatform_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$List + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues extends StandardParameters { /** - * 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". + * 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\}` + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ImportFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$List + extends StandardParameters { + /** + * 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. */ filter?: string; /** - * 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` + * 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` */ orderBy?: string; /** - * 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. + * 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. */ pageSize?: number; /** - * 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. + * 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. */ pageToken?: string; /** - * Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` */ parent?: string; /** @@ -29547,54 +32190,59 @@ export namespace aiplatform_v1 { */ readMask?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Patch + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch extends StandardParameters { /** - * Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * 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. */ name?: string; /** - * 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` + * 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` */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; + requestBody?: Schema$GoogleCloudAiplatformV1EntityType; } - export interface Params$Resource$Projects$Locations$Featurestores$Searchfeatures + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues extends StandardParameters { /** - * Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` + * 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?: string; + entityType?: string; + /** - * 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. + * Request body metadata */ - pageSize?: number; + requestBody?: Schema$GoogleCloudAiplatformV1ReadFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy + extends StandardParameters { /** - * 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. + * 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. */ - pageToken?: string; + resource?: string; + /** - * 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. + * Request body metadata */ - query?: string; + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Featurestores$Setiampolicy + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues extends StandardParameters { /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Required. 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`. */ - resource?: string; + entityType?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + requestBody?: Schema$GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest; } - export interface Params$Resource$Projects$Locations$Featurestores$Testiampermissions + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions extends StandardParameters { /** * 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). @@ -29605,25 +32253,127 @@ export namespace aiplatform_v1 { */ resource?: string; } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues + extends StandardParameters { + /** + * 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`. + */ + entityType?: string; - export class Resource$Projects$Locations$Featurestores$Entitytypes { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1WriteFeatureValuesRequest; + } + + export class Resource$Projects$Locations$Featurestores$Entitytypes$Features { context: APIRequestContext; - features: Resource$Projects$Locations$Featurestores$Entitytypes$Features; - operations: Resource$Projects$Locations$Featurestores$Entitytypes$Operations; + operations: Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations; constructor(context: APIRequestContext) { this.context = context; - this.features = - new Resource$Projects$Locations$Featurestores$Entitytypes$Features( - this.context - ); this.operations = - new Resource$Projects$Locations$Featurestores$Entitytypes$Operations( + new Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations( this.context ); } /** - * Creates a new EntityType in a given Featurestore. + * Creates a batch of Features in a given EntityType. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + options: StreamMethodOptions + ): GaxiosPromise; + batchCreate( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + options?: MethodOptions + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + callback: BodyResponseCallback + ): void; + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/features:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new Feature in a given EntityType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -29631,27 +32381,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, callback: BodyResponseCallback ): void; create( @@ -29659,7 +32409,7 @@ export namespace aiplatform_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -29675,13 +32425,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; options = {}; } @@ -29694,7 +32444,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entityTypes').replace( + url: (rootUrl + '/v1/{+parent}/features').replace( /([^:]\/)\/+/g, '$1' ), @@ -29718,7 +32468,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed. + * Deletes a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -29726,27 +32476,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, callback: BodyResponseCallback ): void; delete( @@ -29754,7 +32504,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -29770,13 +32520,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; options = {}; } @@ -29810,65 +32560,65 @@ export namespace aiplatform_v1 { } /** - * 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. + * Gets details of a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options: StreamMethodOptions ): GaxiosPromise; - deleteFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options?: MethodOptions - ): GaxiosPromise; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + callback: BodyResponseCallback ): void; - deleteFeatureValues( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - deleteFeatureValues( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; options = {}; } @@ -29881,184 +32631,372 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:deleteFeatureValues').replace( + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Features in a given EntityType. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/features').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Exports Feature values from all the entities of a target EntityType. + * Updates the parameters of a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, options: StreamMethodOptions ): GaxiosPromise; - exportFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, options?: MethodOptions - ): GaxiosPromise; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + callback: BodyResponseCallback ): void; - exportFeatureValues( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - exportFeatureValues( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; options = {}; } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate + extends StandardParameters { + /** + * Required. The resource name of the EntityType to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateFeaturesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create + extends StandardParameters { + /** + * 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. + */ + featureId?: string; + /** + * 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\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Feature; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete + extends StandardParameters { + /** + * 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\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get + extends StandardParameters { + /** + * 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\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List + extends StandardParameters { + /** + * 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. + */ + filter?: string; + /** + * 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. + */ + latestStatsCount?: number; + /** + * 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` + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * 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\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch + extends StandardParameters { + /** + * 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. + */ + name?: string; + /** + * 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 FeatureRegistry Feature) + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Feature; + } - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+entityType}:exportFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['entityType'], - pathParams: ['entityType'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets details of a single EntityType. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + cancel( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; options = {}; } @@ -30071,8 +33009,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), @@ -30082,75 +33020,71 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + callback: BodyResponseCallback ): void; - getIamPolicy( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; options = {}; } @@ -30163,67 +33097,64 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - importFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options?: MethodOptions ): GaxiosPromise; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, callback: BodyResponseCallback ): void; - importFeatureValues( + get( callback: BodyResponseCallback ): void; - importFeatureValues( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -30239,13 +33170,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; options = {}; } @@ -30258,17 +33189,14 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:importFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -30282,7 +33210,7 @@ export namespace aiplatform_v1 { } /** - * Lists EntityTypes in a given Featurestore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -30290,57 +33218,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; options = {}; } @@ -30353,7 +33281,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entityTypes').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -30362,82 +33290,82 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single EntityType. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + wait( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; options = {}; } @@ -30450,8 +33378,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), @@ -30461,77 +33389,130 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel + extends StandardParameters { /** - * Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featurestores$Entitytypes$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - readFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + cancel( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readFeatureValues( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + callback: BodyResponseCallback ): void; - readFeatureValues( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; options = {}; } @@ -30544,89 +33525,82 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:readFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + callback: BodyResponseCallback ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy - | BodyResponseCallback + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; options = {}; } @@ -30639,89 +33613,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - streamingReadFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; options = {}; } @@ -30734,90 +33705,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+entityType}:streamingReadFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * 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. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; options = {}; } @@ -30830,91 +33797,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * 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. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - writeFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + wait( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + callback: BodyResponseCallback ): void; - writeFeatureValues( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - writeFeatureValues( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; options = {}; } @@ -30927,382 +33894,141 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:writeFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create - extends StandardParameters { - /** - * 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. - */ - entityTypeId?: string; - /** - * Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EntityType; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel extends StandardParameters { /** - * 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.) - */ - force?: boolean; - /** - * Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues - extends StandardParameters { - /** - * 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\}` - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DeleteFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues - extends StandardParameters { - /** - * Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExportFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete extends StandardParameters { /** - * Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy - extends StandardParameters { - /** - * 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). - */ - 'options.requestedPolicyVersion'?: number; - /** - * 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. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get extends StandardParameters { /** - * 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\}` - */ - entityType?: string; - - /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudAiplatformV1ImportFeatureValuesRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$List + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List extends StandardParameters { /** - * 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. + * The standard list filter. */ filter?: string; /** - * 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` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * 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. + * The standard list page size. */ pageSize?: number; /** - * 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. + * The standard list page token. */ pageToken?: string; - /** - * Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait extends StandardParameters { /** - * 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. + * The name of the operation resource to wait on. */ name?: string; /** - * 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` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EntityType; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues - extends StandardParameters { - /** - * 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`. - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ReadFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy - extends StandardParameters { - /** - * 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. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues - extends StandardParameters { - /** - * 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`. - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions - extends StandardParameters { - /** - * 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). - */ - permissions?: string[]; - /** - * 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. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues - extends StandardParameters { - /** - * 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`. - */ - entityType?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1WriteFeatureValuesRequest; + timeout?: string; } - export class Resource$Projects$Locations$Featurestores$Entitytypes$Features { + export class Resource$Projects$Locations$Featurestores$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations( - this.context - ); - } - - /** - * Creates a batch of Features in a given EntityType. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, - options: StreamMethodOptions - ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, - options?: MethodOptions - ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, - callback: BodyResponseCallback - ): void; - batchCreate( - callback: BodyResponseCallback - ): void; - batchCreate( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/features:batchCreate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } } /** - * Creates a new Feature in a given EntityType. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + cancel( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; options = {}; } @@ -31315,31 +34041,28 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single Feature. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -31347,57 +34070,53 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; options = {}; } @@ -31421,17 +34140,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single Feature. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -31439,57 +34158,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Get; options = {}; } @@ -31513,19 +34232,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Features in a given EntityType. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -31533,57 +34250,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + params?: Params$Resource$Projects$Locations$Featurestores$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$List; options = {}; } @@ -31596,7 +34313,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -31605,82 +34322,82 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single Feature. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + wait( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; options = {}; } @@ -31693,8 +34410,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), @@ -31704,116 +34421,81 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate - extends StandardParameters { - /** - * Required. The resource name of the EntityType to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateFeaturesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Cancel extends StandardParameters { /** - * 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. - */ - featureId?: string; - /** - * 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\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; + name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Delete extends StandardParameters { /** - * 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\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Get extends StandardParameters { /** - * 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\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List + export interface Params$Resource$Projects$Locations$Featurestores$Operations$List extends StandardParameters { /** - * 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. + * The standard list filter. */ filter?: string; /** - * 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. - */ - latestStatsCount?: number; - /** - * 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` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * 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. + * The standard list page size. */ pageSize?: number; /** - * 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. + * The standard list page token. */ pageToken?: string; - /** - * 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\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Wait extends StandardParameters { /** - * 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. + * The name of the operation resource to wait on. */ name?: string; /** - * 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 FeatureRegistry Feature) - */ - updateMask?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; + timeout?: string; } - export class Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations { + export class Resource$Projects$Locations$Hyperparametertuningjobs { context: APIRequestContext; + operations: Resource$Projects$Locations$Hyperparametertuningjobs$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Hyperparametertuningjobs$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -31821,31 +34503,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -31861,13 +34543,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; options = {}; } @@ -31901,7 +34583,104 @@ export namespace aiplatform_v1 { } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a HyperparameterTuningJob + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a HyperparameterTuningJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -31909,53 +34688,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; options = {}; } @@ -31979,17 +34762,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a HyperparameterTuningJob * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -31997,57 +34780,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; options = {}; } @@ -32071,17 +34854,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists HyperparameterTuningJobs in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -32089,57 +34874,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; options = {}; } @@ -32152,7 +34937,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -32161,168 +34946,86 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel + extends StandardParameters { /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` */ - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, - options: StreamMethodOptions - ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, - options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, - callback: BodyResponseCallback - ): void; - wait( - callback: BodyResponseCallback - ): void; - wait( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + name?: string; - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest; } - - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1HyperparameterTuningJob; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$List extends StandardParameters { /** - * The standard list filter. + * 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:*` */ filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. */ pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait - extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Mask specifying which fields to read. */ - timeout?: string; + readMask?: string; } - export class Resource$Projects$Locations$Featurestores$Entitytypes$Operations { + export class Resource$Projects$Locations$Hyperparametertuningjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -32337,31 +35040,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -32377,13 +35080,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; options = {}; } @@ -32425,31 +35128,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -32465,13 +35168,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; options = {}; } @@ -32513,27 +35216,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -32541,7 +35244,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -32557,13 +35260,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; options = {}; } @@ -32605,27 +35308,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -32633,7 +35336,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -32649,13 +35352,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; options = {}; } @@ -32702,27 +35405,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -32730,7 +35433,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -32746,13 +35449,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; options = {}; } @@ -32786,28 +35489,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List extends StandardParameters { /** * The standard list filter. @@ -32826,7 +35529,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -32838,68 +35541,74 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Featurestores$Operations { + export class Resource$Projects$Locations$Indexendpoints { context: APIRequestContext; + operations: Resource$Projects$Locations$Indexendpoints$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Indexendpoints$Operations(this.context); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * Creates an IndexEndpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Indexendpoints$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Cancel - | BodyResponseCallback + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Create; options = {}; } @@ -32912,28 +35621,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes an IndexEndpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -32941,53 +35653,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + params?: Params$Resource$Projects$Locations$Indexendpoints$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Delete; options = {}; } @@ -33011,53 +35726,53 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + deployIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, callback: BodyResponseCallback ): void; - get( + deployIndex( callback: BodyResponseCallback ): void; - get( + deployIndex( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Get + | Params$Resource$Projects$Locations$Indexendpoints$Deployindex | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -33073,13 +35788,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Get; + {} as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; options = {}; } @@ -33092,14 +35807,17 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+indexEndpoint}:deployIndex').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { @@ -33113,65 +35831,65 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Finds the nearest neighbors of each vector within the request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$List, + findNeighbors( + params?: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + ): GaxiosPromise; + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, - callback: BodyResponseCallback + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + findNeighbors( + callback: BodyResponseCallback ): void; - list( + findNeighbors( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Findneighbors + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$List; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$List; + {} as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; options = {}; } @@ -33184,91 +35902,90 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+indexEndpoint}:findNeighbors').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Gets an IndexEndpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + get( + params?: Params$Resource$Projects$Locations$Indexendpoints$Get, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - wait( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Get; options = {}; } @@ -33281,8 +35998,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), @@ -33292,135 +36009,76 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Hyperparametertuningjobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Hyperparametertuningjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Hyperparametertuningjobs$Operations( - this.context + return createAPIRequest( + parameters ); + } } /** - * 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`. + * Lists IndexEndpoints in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + list( + params?: Params$Resource$Projects$Locations$Indexendpoints$List, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; + {}) as Params$Resource$Projects$Locations$Indexendpoints$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$List; options = {}; } @@ -33433,86 +36091,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a HyperparameterTuningJob + * Update an existing DeployedIndex under an IndexEndpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + mutateDeployedIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + ): GaxiosPromise; + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, - callback: BodyResponseCallback + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + mutateDeployedIndex( + callback: BodyResponseCallback ): void; - create( + mutateDeployedIndex( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; + {} as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; options = {}; } @@ -33525,7 +36188,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( + url: (rootUrl + '/v1/{+indexEndpoint}:mutateDeployedIndex').replace( /([^:]\/)\/+/g, '$1' ), @@ -33534,82 +36197,79 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a HyperparameterTuningJob. + * Updates an IndexEndpoint. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + patch( + params?: Params$Resource$Projects$Locations$Indexendpoints$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Patch; options = {}; } @@ -33623,7 +36283,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', }, options ), @@ -33633,75 +36293,77 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a HyperparameterTuningJob + * Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + readIndexDatapoints( + params?: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + ): GaxiosPromise; + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, - callback: BodyResponseCallback + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + readIndexDatapoints( + callback: BodyResponseCallback ): void; - get( + readIndexDatapoints( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; + {} as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; options = {}; } @@ -33714,88 +36376,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+indexEndpoint}:readIndexDatapoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists HyperparameterTuningJobs in a Location. + * Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + undeployIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + ): GaxiosPromise; + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, - callback: BodyResponseCallback + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + undeployIndex( + callback: BodyResponseCallback ): void; - list( + undeployIndex( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Undeployindex + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; + {} as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; options = {}; } @@ -33808,95 +36473,157 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( + url: (rootUrl + '/v1/{+indexEndpoint}:undeployIndex').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel + export interface Params$Resource$Projects$Locations$Indexendpoints$Create extends StandardParameters { /** - * Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest; + requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create + export interface Params$Resource$Projects$Locations$Indexendpoints$Delete extends StandardParameters { /** - * Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` */ - parent?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Deployindex + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1HyperparameterTuningJob; + requestBody?: Schema$GoogleCloudAiplatformV1DeployIndexRequest; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete + export interface Params$Resource$Projects$Locations$Indexendpoints$Findneighbors extends StandardParameters { /** - * Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` */ - name?: string; + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FindNeighborsRequest; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get + export interface Params$Resource$Projects$Locations$Indexendpoints$Get extends StandardParameters { /** - * Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$List + export interface Params$Resource$Projects$Locations$Indexendpoints$List extends StandardParameters { /** - * 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:*` + * 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"` */ filter?: string; /** - * The standard list page size. + * Optional. The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. + * Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. */ pageToken?: string; /** - * Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** - * Mask specifying which fields to read. + * Optional. Mask specifying which fields to read. */ readMask?: string; } + export interface Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; - export class Resource$Projects$Locations$Hyperparametertuningjobs$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeployedIndex; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Patch + extends StandardParameters { + /** + * Output only. The resource name of the IndexEndpoint. + */ + name?: string; + /** + * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints + extends StandardParameters { + /** + * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReadIndexDatapointsRequest; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Undeployindex + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UndeployIndexRequest; + } + + export class Resource$Projects$Locations$Indexendpoints$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -33911,31 +36638,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -33951,13 +36678,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; options = {}; } @@ -33999,31 +36726,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -34039,13 +36766,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; options = {}; } @@ -34087,27 +36814,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -34115,7 +36842,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -34131,13 +36858,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; options = {}; } @@ -34179,27 +36906,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, callback: BodyResponseCallback ): void; list( @@ -34207,7 +36934,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List + | Params$Resource$Projects$Locations$Indexendpoints$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -34223,13 +36950,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; options = {}; } @@ -34276,27 +37003,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -34304,7 +37031,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -34320,13 +37047,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; options = {}; } @@ -34360,28 +37087,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$List extends StandardParameters { /** * The standard list filter. @@ -34400,7 +37127,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -34412,17 +37139,18 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Indexendpoints { + export class Resource$Projects$Locations$Indexes { context: APIRequestContext; - operations: Resource$Projects$Locations$Indexendpoints$Operations; + operations: Resource$Projects$Locations$Indexes$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Indexendpoints$Operations(this.context); + this.operations = new Resource$Projects$Locations$Indexes$Operations( + this.context + ); } /** - * Creates an IndexEndpoint. + * Creates an Index. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -34430,27 +37158,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + params: Params$Resource$Projects$Locations$Indexes$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Indexendpoints$Create, + params?: Params$Resource$Projects$Locations$Indexes$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + params: Params$Resource$Projects$Locations$Indexes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + params: Params$Resource$Projects$Locations$Indexes$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + params: Params$Resource$Projects$Locations$Indexes$Create, callback: BodyResponseCallback ): void; create( @@ -34458,7 +37186,101 @@ export namespace aiplatform_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Create + | Params$Resource$Projects$Locations$Indexes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/indexes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Indexes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -34474,12 +37296,103 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Create; + {}) as Params$Resource$Projects$Locations$Indexes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an Index. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Indexes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Indexes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Indexes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Indexes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Indexes$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Create; + params = {} as Params$Resource$Projects$Locations$Indexes$Get; options = {}; } @@ -34492,88 +37405,87 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes an IndexEndpoint. + * Lists Indexes in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + list( + params: Params$Resource$Projects$Locations$Indexes$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Indexendpoints$Delete, + list( + params?: Params$Resource$Projects$Locations$Indexes$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Indexes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + list( + params: Params$Resource$Projects$Locations$Indexes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Indexes$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Delete; + {}) as Params$Resource$Projects$Locations$Indexes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Delete; + params = {} as Params$Resource$Projects$Locations$Indexes$List; options = {}; } @@ -34586,64 +37498,69 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/indexes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed. + * Updates an Index. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, options: StreamMethodOptions ): GaxiosPromise; - deployIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + patch( + params?: Params$Resource$Projects$Locations$Indexes$Patch, options?: MethodOptions ): GaxiosPromise; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, callback: BodyResponseCallback ): void; - deployIndex( + patch( callback: BodyResponseCallback ): void; - deployIndex( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Deployindex + | Params$Resource$Projects$Locations$Indexes$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -34659,13 +37576,12 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; + {}) as Params$Resource$Projects$Locations$Indexes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; + params = {} as Params$Resource$Projects$Locations$Indexes$Patch; options = {}; } @@ -34678,17 +37594,14 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:deployIndex').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -34702,65 +37615,65 @@ export namespace aiplatform_v1 { } /** - * Finds the nearest neighbors of each vector within the request. + * Remove Datapoints from an Index. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options: StreamMethodOptions ): GaxiosPromise; - findNeighbors( - params?: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + removeDatapoints( + params?: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options?: MethodOptions - ): GaxiosPromise; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + ): GaxiosPromise; + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, - callback: BodyResponseCallback + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + callback: BodyResponseCallback ): void; - findNeighbors( - callback: BodyResponseCallback + removeDatapoints( + callback: BodyResponseCallback ): void; - findNeighbors( + removeDatapoints( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Findneighbors - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Removedatapoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; + {}) as Params$Resource$Projects$Locations$Indexes$Removedatapoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; + {} as Params$Resource$Projects$Locations$Indexes$Removedatapoints; options = {}; } @@ -34773,7 +37686,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:findNeighbors').replace( + url: (rootUrl + '/v1/{+index}:removeDatapoints').replace( /([^:]\/)\/+/g, '$1' ), @@ -34782,81 +37695,82 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['index'], + pathParams: ['index'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets an IndexEndpoint. + * Add/update Datapoints into an Index. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Indexendpoints$Get, + upsertDatapoints( + params?: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, + ): GaxiosPromise; + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, - callback: BodyResponseCallback + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + upsertDatapoints( + callback: BodyResponseCallback ): void; - get( + upsertDatapoints( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Upsertdatapoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Get; + {}) as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Get; + params = + {} as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; options = {}; } @@ -34869,87 +37783,184 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+index}:upsertDatapoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['index'], + pathParams: ['index'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Indexes$Create + extends StandardParameters { /** - * Lists IndexEndpoints in a Location. + * Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Index; + } + export interface Params$Resource$Projects$Locations$Indexes$Delete + extends StandardParameters { + /** + * Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Get + extends StandardParameters { + /** + * Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Patch + extends StandardParameters { + /** + * Output only. The resource name of the Index. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Index; + } + export interface Params$Resource$Projects$Locations$Indexes$Removedatapoints + extends StandardParameters { + /** + * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + index?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RemoveDatapointsRequest; + } + export interface Params$Resource$Projects$Locations$Indexes$Upsertdatapoints + extends StandardParameters { + /** + * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + index?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UpsertDatapointsRequest; + } + + export class Resource$Projects$Locations$Indexes$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Indexendpoints$List, + cancel( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$List; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$List; + params = + {} as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; options = {}; } @@ -34962,91 +37973,82 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Update an existing DeployedIndex under an IndexEndpoint. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - mutateDeployedIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + delete( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - mutateDeployedIndex( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + callback: BodyResponseCallback ): void; - mutateDeployedIndex( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; + {} as Params$Resource$Projects$Locations$Indexes$Operations$Delete; options = {}; } @@ -35059,88 +38061,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:mutateDeployedIndex').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates an IndexEndpoint. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Indexendpoints$Patch, + get( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Patch; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Patch; + params = + {} as Params$Resource$Projects$Locations$Indexes$Operations$Get; options = {}; } @@ -35154,7 +38154,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', }, options ), @@ -35164,77 +38164,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - readIndexDatapoints( - params?: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + list( + params?: Params$Resource$Projects$Locations$Indexes$Operations$List, options?: MethodOptions - ): GaxiosPromise; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, + callback: BodyResponseCallback ): void; - readIndexDatapoints( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - readIndexDatapoints( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; + {} as Params$Resource$Projects$Locations$Indexes$Operations$List; options = {}; } @@ -35247,69 +38245,69 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:readIndexDatapoints').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - undeployIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + wait( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options?: MethodOptions ): GaxiosPromise; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, callback: BodyResponseCallback ): void; - undeployIndex( + wait( callback: BodyResponseCallback ): void; - undeployIndex( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Undeployindex + | Params$Resource$Projects$Locations$Indexes$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -35325,13 +38323,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; + {} as Params$Resource$Projects$Locations$Indexes$Operations$Wait; options = {}; } @@ -35344,17 +38342,14 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:undeployIndex').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -35368,194 +38363,142 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Indexendpoints$Create + export interface Params$Resource$Projects$Locations$Indexes$Operations$Cancel extends StandardParameters { /** - * Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; + name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Delete + export interface Params$Resource$Projects$Locations$Indexes$Operations$Delete extends StandardParameters { /** - * Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Deployindex + export interface Params$Resource$Projects$Locations$Indexes$Operations$Get extends StandardParameters { /** - * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudAiplatformV1DeployIndexRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Findneighbors + export interface Params$Resource$Projects$Locations$Indexes$Operations$List extends StandardParameters { /** - * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata + * The standard list filter. */ - requestBody?: Schema$GoogleCloudAiplatformV1FindNeighborsRequest; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Get - extends StandardParameters { + filter?: string; /** - * Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * The name of the operation's parent resource. */ name?: string; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$List - extends StandardParameters { - /** - * 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"` - */ - filter?: string; /** - * Optional. The standard list page size. + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. + * The standard list page token. */ pageToken?: string; - /** - * Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex - extends StandardParameters { - /** - * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DeployedIndex; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Patch + export interface Params$Resource$Projects$Locations$Indexes$Operations$Wait extends StandardParameters { /** - * Output only. The resource name of the IndexEndpoint. + * The name of the operation resource to wait on. */ name?: string; /** - * Required. The update mask applies to the resource. See google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints - extends StandardParameters { - /** - * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ReadIndexDatapointsRequest; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Undeployindex - extends StandardParameters { - /** - * Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1UndeployIndexRequest; + timeout?: string; } - export class Resource$Projects$Locations$Indexendpoints$Operations { + export class Resource$Projects$Locations$Metadatastores { context: APIRequestContext; + artifacts: Resource$Projects$Locations$Metadatastores$Artifacts; + contexts: Resource$Projects$Locations$Metadatastores$Contexts; + executions: Resource$Projects$Locations$Metadatastores$Executions; + metadataSchemas: Resource$Projects$Locations$Metadatastores$Metadataschemas; + operations: Resource$Projects$Locations$Metadatastores$Operations; constructor(context: APIRequestContext) { this.context = context; + this.artifacts = new Resource$Projects$Locations$Metadatastores$Artifacts( + this.context + ); + this.contexts = new Resource$Projects$Locations$Metadatastores$Contexts( + this.context + ); + this.executions = + new Resource$Projects$Locations$Metadatastores$Executions(this.context); + this.metadataSchemas = + new Resource$Projects$Locations$Metadatastores$Metadataschemas( + this.context + ); + this.operations = + new Resource$Projects$Locations$Metadatastores$Operations(this.context); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * Initializes a MetadataStore, including allocation of resources. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Metadatastores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Create; options = {}; } @@ -35568,28 +38511,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/metadataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -35597,123 +38543,35 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Get + | Params$Resource$Projects$Locations$Metadatastores$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -35729,13 +38587,12 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Delete; options = {}; } @@ -35749,7 +38606,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), @@ -35769,65 +38626,64 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Retrieves a specific MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Get; options = {}; } @@ -35840,10 +38696,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -35854,77 +38707,76 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Lists MetadataStores for a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Metadatastores$List, options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Metadatastores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Metadatastores$List; options = {}; } @@ -35937,91 +38789,95 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/metadataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel + export interface Params$Resource$Projects$Locations$Metadatastores$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * 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.) */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete - extends StandardParameters { + metadataStoreId?: string; /** - * The name of the operation resource to be deleted. + * Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1MetadataStore; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Delete extends StandardParameters { /** - * The name of the operation resource. + * Deprecated: Field is no longer supported. + */ + force?: boolean; + /** + * Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$List + export interface Params$Resource$Projects$Locations$Metadatastores$Get extends StandardParameters { /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. + * Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$List + extends StandardParameters { /** - * The standard list page size. + * The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. */ pageSize?: number; /** - * The standard list page token. + * 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.) */ pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` */ - timeout?: string; + parent?: string; } - export class Resource$Projects$Locations$Indexes { + export class Resource$Projects$Locations$Metadatastores$Artifacts { context: APIRequestContext; - operations: Resource$Projects$Locations$Indexes$Operations; + operations: Resource$Projects$Locations$Metadatastores$Artifacts$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Indexes$Operations( - this.context - ); + this.operations = + new Resource$Projects$Locations$Metadatastores$Artifacts$Operations( + this.context + ); } /** - * Creates an Index. + * Creates an Artifact associated with a MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -36029,56 +38885,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Indexes$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Indexes$Create, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Indexes$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Indexes$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Indexes$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Create; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; options = {}; } @@ -36091,7 +38948,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexes').replace( + url: (rootUrl + '/v1/{+parent}/artifacts').replace( /([^:]\/)\/+/g, '$1' ), @@ -36105,17 +38962,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. + * Deletes an Artifact. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -36123,27 +38982,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Indexes$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, callback: BodyResponseCallback ): void; delete( @@ -36151,7 +39010,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Delete + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36167,12 +39026,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Delete; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; options = {}; } @@ -36206,7 +39066,7 @@ export namespace aiplatform_v1 { } /** - * Gets an Index. + * Retrieves a specific Artifact. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -36214,56 +39074,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Indexes$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Indexes$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Indexes$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexes$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Get; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; options = {}; } @@ -36287,19 +39148,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Indexes in a Location. + * Lists Artifacts in the MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -36307,56 +39168,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Indexes$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Indexes$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Indexes$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexes$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$List; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; options = {}; } @@ -36369,7 +39231,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexes').replace( + url: (rootUrl + '/v1/{+parent}/artifacts').replace( /([^:]\/)\/+/g, '$1' ), @@ -36383,19 +39245,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an Index. + * Updates a stored Artifact. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -36403,56 +39265,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Indexes$Patch, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Patch; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Patch; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; options = {}; } @@ -36476,75 +39339,77 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Remove Datapoints from an Index. + * Purges Artifacts. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options: StreamMethodOptions ): GaxiosPromise; - removeDatapoints( - params?: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + purge( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options?: MethodOptions - ): GaxiosPromise; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + callback: BodyResponseCallback ): void; - removeDatapoints( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - removeDatapoints( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Removedatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Removedatapoints; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Removedatapoints; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; options = {}; } @@ -36557,7 +39422,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+index}:removeDatapoints').replace( + url: (rootUrl + '/v1/{+parent}/artifacts:purge').replace( /([^:]\/)\/+/g, '$1' ), @@ -36566,82 +39431,80 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['index'], - pathParams: ['index'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Add/update Datapoints into an Index. + * Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options: StreamMethodOptions ): GaxiosPromise; - upsertDatapoints( - params?: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + queryArtifactLineageSubgraph( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options?: MethodOptions - ): GaxiosPromise; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + ): GaxiosPromise; + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, - callback: BodyResponseCallback + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + callback: BodyResponseCallback ): void; - upsertDatapoints( - callback: BodyResponseCallback + queryArtifactLineageSubgraph( + callback: BodyResponseCallback ): void; - upsertDatapoints( + queryArtifactLineageSubgraph( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Upsertdatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; options = {}; } @@ -36654,123 +39517,137 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+index}:upsertDatapoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1/{+artifact}:queryArtifactLineageSubgraph' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['index'], - pathParams: ['index'], + requiredParams: ['artifact'], + pathParams: ['artifact'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Indexes$Create + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create extends StandardParameters { /** - * Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` + * 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.) + */ + artifactId?: string; + /** + * Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Index; + requestBody?: Schema$GoogleCloudAiplatformV1Artifact; } - export interface Params$Resource$Projects$Locations$Indexes$Delete + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete extends StandardParameters { /** - * Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * 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. + */ + etag?: string; + /** + * Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get extends StandardParameters { /** - * Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$List + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$List extends StandardParameters { /** - * The standard list filter. + * 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`. */ filter?: string; /** - * The standard list page size. + * 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. + */ + orderBy?: string; + /** + * The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. + * 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.) */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` + * Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Patch + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch extends StandardParameters { /** - * Output only. The resource name of the Index. + * If set to true, and the Artifact is not found, a new Artifact is created. + */ + allowMissing?: boolean; + /** + * Output only. The resource name of the Artifact. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + * Optional. A FieldMask indicating which fields should be updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Index; + requestBody?: Schema$GoogleCloudAiplatformV1Artifact; } - export interface Params$Resource$Projects$Locations$Indexes$Removedatapoints + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge extends StandardParameters { /** - * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ - index?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1RemoveDatapointsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1PurgeArtifactsRequest; } - export interface Params$Resource$Projects$Locations$Indexes$Upsertdatapoints + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph extends StandardParameters { /** - * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * 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. */ - index?: string; - + artifact?: string; /** - * Request body metadata + * 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`. */ - requestBody?: Schema$GoogleCloudAiplatformV1UpsertDatapointsRequest; + filter?: string; + /** + * 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. + */ + maxHops?: number; } - export class Resource$Projects$Locations$Indexes$Operations { + export class Resource$Projects$Locations$Metadatastores$Artifacts$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -36785,31 +39662,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; cancel( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Cancel + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36825,13 +39702,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; options = {}; } @@ -36873,31 +39750,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Delete + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36913,13 +39790,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; options = {}; } @@ -36961,27 +39838,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -36989,7 +39866,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Get + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -37005,13 +39882,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; options = {}; } @@ -37053,27 +39930,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Indexes$Operations$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, callback: BodyResponseCallback ): void; list( @@ -37081,7 +39958,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$List + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -37097,13 +39974,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; options = {}; } @@ -37150,27 +40027,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; wait( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options?: MethodOptions ): GaxiosPromise; wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -37178,7 +40055,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Wait + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -37194,13 +40071,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Wait; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; options = {}; } @@ -37234,28 +40111,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Cancel + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Delete + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$List + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List extends StandardParameters { /** * The standard list filter. @@ -37274,7 +40151,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Wait + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -37286,30 +40163,212 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Metadatastores { + export class Resource$Projects$Locations$Metadatastores$Contexts { context: APIRequestContext; - artifacts: Resource$Projects$Locations$Metadatastores$Artifacts; - contexts: Resource$Projects$Locations$Metadatastores$Contexts; - executions: Resource$Projects$Locations$Metadatastores$Executions; - metadataSchemas: Resource$Projects$Locations$Metadatastores$Metadataschemas; + operations: Resource$Projects$Locations$Metadatastores$Contexts$Operations; constructor(context: APIRequestContext) { this.context = context; - this.artifacts = new Resource$Projects$Locations$Metadatastores$Artifacts( - this.context - ); - this.contexts = new Resource$Projects$Locations$Metadatastores$Contexts( - this.context - ); - this.executions = - new Resource$Projects$Locations$Metadatastores$Executions(this.context); - this.metadataSchemas = - new Resource$Projects$Locations$Metadatastores$Metadataschemas( + this.operations = + new Resource$Projects$Locations$Metadatastores$Contexts$Operations( this.context ); } /** - * Initializes a MetadataStore, including allocation of resources. + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + options: StreamMethodOptions + ): GaxiosPromise; + addContextArtifactsAndExecutions( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + options?: MethodOptions + ): GaxiosPromise; + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + callback: BodyResponseCallback + ): void; + addContextArtifactsAndExecutions( + callback: BodyResponseCallback + ): void; + addContextArtifactsAndExecutions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+context}:addContextArtifactsAndExecutions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['context'], + pathParams: ['context'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options: StreamMethodOptions + ): GaxiosPromise; + addContextChildren( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options?: MethodOptions + ): GaxiosPromise; + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + callback: BodyResponseCallback + ): void; + addContextChildren( + callback: BodyResponseCallback + ): void; + addContextChildren( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+context}:addContextChildren').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['context'], + pathParams: ['context'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a Context associated with a MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -37317,56 +40376,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Metadatastores$Create, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Create; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; options = {}; } @@ -37379,7 +40439,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataStores').replace( + url: (rootUrl + '/v1/{+parent}/contexts').replace( /([^:]\/)\/+/g, '$1' ), @@ -37393,17 +40453,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). + * Deletes a stored Context. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -37411,27 +40473,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, callback: BodyResponseCallback ): void; delete( @@ -37439,28 +40501,215 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Delete + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a specific Context. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Contexts on the MetadataStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Delete; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; options = {}; } @@ -37473,85 +40722,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/contexts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Retrieves a specific MetadataStore. + * Updates a stored Context. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Get, + patch( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Get; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; options = {}; } @@ -37565,7 +40820,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', }, options ), @@ -37575,76 +40830,77 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists MetadataStores for a Location. + * Purges Contexts. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$List, + purge( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$List, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - list( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$List; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; options = {}; } @@ -37657,11 +40913,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataStores').replace( + url: (rootUrl + '/v1/{+parent}/contexts:purge').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), @@ -37671,134 +40927,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Metadatastores$Create - extends StandardParameters { - /** - * 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.) - */ - metadataStoreId?: string; - /** - * Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1MetadataStore; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Delete - extends StandardParameters { - /** - * Deprecated: Field is no longer supported. - */ - force?: boolean; - /** - * Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Get - extends StandardParameters { - /** - * Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$List - extends StandardParameters { - /** - * The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. - */ - pageSize?: number; - /** - * 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.) - */ - pageToken?: string; - /** - * Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Metadatastores$Artifacts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates an Artifact associated with a MetadataStore. + * Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + queryContextLineageSubgraph( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + ): GaxiosPromise; + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, - callback: BodyResponseCallback + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + queryContextLineageSubgraph( + callback: BodyResponseCallback ): void; - create( + queryContextLineageSubgraph( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; options = {}; } @@ -37811,91 +41008,90 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/artifacts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1/{+context}:queryContextLineageSubgraph' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['context'], + pathParams: ['context'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes an Artifact. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + removeContextChildren( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + ): GaxiosPromise; + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, - callback: BodyResponseCallback + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + removeContextChildren( + callback: BodyResponseCallback ): void; - delete( + removeContextChildren( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; options = {}; } @@ -37908,86 +41104,231 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+context}:removeContextChildren').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['context'], + pathParams: ['context'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions + extends StandardParameters { /** - * Retrieves a specific Artifact. + * Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + context?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren + extends StandardParameters { + /** + * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + context?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AddContextChildrenRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Create + extends StandardParameters { + /** + * 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.) + */ + contextId?: string; + /** + * Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Context; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete + extends StandardParameters { + /** + * 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. + */ + etag?: string; + /** + * The force deletion semantics is still undefined. Users should not use this field. + */ + force?: boolean; + /** + * Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Get + extends StandardParameters { + /** + * Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$List + extends StandardParameters { + /** + * 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`. + */ + filter?: string; + /** + * 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. + */ + orderBy?: string; + /** + * The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + */ + pageSize?: number; + /** + * 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.) + */ + pageToken?: string; + /** + * Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch + extends StandardParameters { + /** + * If set to true, and the Context is not found, a new Context is created. + */ + allowMissing?: boolean; + /** + * Immutable. The resource name of the Context. + */ + name?: string; + /** + * Optional. A FieldMask indicating which fields should be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Context; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge + extends StandardParameters { + /** + * Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PurgeContextsRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph + extends StandardParameters { + /** + * 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. + */ + context?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren + extends StandardParameters { + /** + * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + context?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RemoveContextChildrenRequest; + } + + export class Resource$Projects$Locations$Metadatastores$Contexts$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; options = {}; } @@ -38000,8 +41341,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), @@ -38011,77 +41352,71 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Artifacts in the MetadataStore. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; options = {}; } @@ -38094,91 +41429,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/artifacts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a stored Artifact. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; options = {}; } @@ -38192,7 +41522,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', }, options ), @@ -38202,77 +41532,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Purges Artifacts. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - purge( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; options = {}; } @@ -38285,89 +41613,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/artifacts:purge').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - queryArtifactLineageSubgraph( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; options = {}; } @@ -38380,298 +41710,150 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+artifact}:queryArtifactLineageSubgraph' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: ['artifact'], - pathParams: ['artifact'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel extends StandardParameters { /** - * 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.) - */ - artifactId?: string; - /** - * Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1Artifact; + name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete extends StandardParameters { /** - * 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. - */ - etag?: string; - /** - * Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get extends StandardParameters { /** - * Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$List + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List extends StandardParameters { /** - * 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`. + * The standard list filter. */ filter?: string; /** - * 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. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + * The standard list page size. */ pageSize?: number; /** - * 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.) + * The standard list page token. */ pageToken?: string; - /** - * Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait extends StandardParameters { /** - * If set to true, and the Artifact is not found, a new Artifact is created. - */ - allowMissing?: boolean; - /** - * Output only. The resource name of the Artifact. + * The name of the operation resource to wait on. */ name?: string; /** - * Optional. A FieldMask indicating which fields should be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Artifact; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge - extends StandardParameters { - /** - * Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PurgeArtifactsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph - extends StandardParameters { - /** - * 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. - */ - artifact?: string; - /** - * 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`. - */ - filter?: string; - /** - * 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. + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - maxHops?: number; + timeout?: string; } - export class Resource$Projects$Locations$Metadatastores$Contexts { + export class Resource$Projects$Locations$Metadatastores$Executions { context: APIRequestContext; + operations: Resource$Projects$Locations$Metadatastores$Executions$Operations; constructor(context: APIRequestContext) { this.context = context; - } - - /** - * 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. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, - options: StreamMethodOptions - ): GaxiosPromise; - addContextArtifactsAndExecutions( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, - options?: MethodOptions - ): GaxiosPromise; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, - callback: BodyResponseCallback - ): void; - addContextArtifactsAndExecutions( - callback: BodyResponseCallback - ): void; - addContextArtifactsAndExecutions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1/{+context}:addContextArtifactsAndExecutions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['context'], - pathParams: ['context'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters + this.operations = + new Resource$Projects$Locations$Metadatastores$Executions$Operations( + this.context ); - } } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, options: StreamMethodOptions ): GaxiosPromise; - addContextChildren( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + addExecutionEvents( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, options?: MethodOptions - ): GaxiosPromise; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + ): GaxiosPromise; + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, - callback: BodyResponseCallback + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + callback: BodyResponseCallback ): void; - addContextChildren( - callback: BodyResponseCallback + addExecutionEvents( + callback: BodyResponseCallback ): void; - addContextChildren( + addExecutionEvents( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; options = {}; } @@ -38684,7 +41866,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+context}:addContextChildren').replace( + url: (rootUrl + '/v1/{+execution}:addExecutionEvents').replace( /([^:]\/)\/+/g, '$1' ), @@ -38693,24 +41875,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['context'], - pathParams: ['context'], + requiredParams: ['execution'], + pathParams: ['execution'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Context associated with a MetadataStore. + * Creates an Execution associated with a MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -38718,57 +41900,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; options = {}; } @@ -38781,7 +41963,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/contexts').replace( + url: (rootUrl + '/v1/{+parent}/executions').replace( /([^:]\/)\/+/g, '$1' ), @@ -38795,19 +41977,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a stored Context. + * Deletes an Execution. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -38815,27 +41997,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, callback: BodyResponseCallback ): void; delete( @@ -38843,7 +42025,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete + | Params$Resource$Projects$Locations$Metadatastores$Executions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -38859,13 +42041,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; options = {}; } @@ -38899,7 +42081,7 @@ export namespace aiplatform_v1 { } /** - * Retrieves a specific Context. + * Retrieves a specific Execution. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -38907,57 +42089,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; options = {}; } @@ -38981,19 +42163,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Contexts on the MetadataStore. + * Lists Executions in the MetadataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -39001,57 +42183,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$List; options = {}; } @@ -39064,7 +42246,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/contexts').replace( + url: (rootUrl + '/v1/{+parent}/executions').replace( /([^:]\/)\/+/g, '$1' ), @@ -39078,19 +42260,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a stored Context. + * Updates a stored Execution. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -39098,57 +42280,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; options = {}; } @@ -39172,19 +42354,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Purges Contexts. + * Purges Executions. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -39192,27 +42374,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options: StreamMethodOptions ): GaxiosPromise; purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options?: MethodOptions ): GaxiosPromise; purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, callback: BodyResponseCallback ): void; purge( @@ -39220,7 +42402,7 @@ export namespace aiplatform_v1 { ): void; purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge + | Params$Resource$Projects$Locations$Metadatastores$Executions$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -39236,13 +42418,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; options = {}; } @@ -39255,7 +42437,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/contexts:purge').replace( + url: (rootUrl + '/v1/{+parent}/executions:purge').replace( /([^:]\/)\/+/g, '$1' ), @@ -39279,43 +42461,43 @@ export namespace aiplatform_v1 { } /** - * Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. + * Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options: StreamMethodOptions ): GaxiosPromise; - queryContextLineageSubgraph( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + queryExecutionInputsAndOutputs( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options?: MethodOptions ): GaxiosPromise; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( + queryExecutionInputsAndOutputs( callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( + queryExecutionInputsAndOutputs( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph + | Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -39331,13 +42513,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; options = {}; } @@ -39351,15 +42533,15 @@ export namespace aiplatform_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/{+context}:queryContextLineageSubgraph' + rootUrl + '/v1/{+execution}:queryExecutionInputsAndOutputs' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['context'], - pathParams: ['context'], + requiredParams: ['execution'], + pathParams: ['execution'], context: this.context, }; if (callback) { @@ -39373,171 +42555,58 @@ export namespace aiplatform_v1 { ); } } - - /** - * 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. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - options: StreamMethodOptions - ): GaxiosPromise; - removeContextChildren( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - options?: MethodOptions - ): GaxiosPromise; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - callback: BodyResponseCallback - ): void; - removeContextChildren( - callback: BodyResponseCallback - ): void; - removeContextChildren( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+context}:removeContextChildren').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['context'], - pathParams: ['context'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions - extends StandardParameters { - /** - * Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - */ - context?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents extends StandardParameters { /** - * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` */ - context?: string; + execution?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1AddContextChildrenRequest; + requestBody?: Schema$GoogleCloudAiplatformV1AddExecutionEventsRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Create + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Create extends StandardParameters { /** - * 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.) + * 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.) */ - contextId?: string; + executionId?: string; /** - * Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Context; + requestBody?: Schema$GoogleCloudAiplatformV1Execution; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Delete extends StandardParameters { /** - * 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. + * 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. */ etag?: string; /** - * The force deletion semantics is still undefined. Users should not use this field. - */ - force?: boolean; - /** - * Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Get extends StandardParameters { /** - * Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$List + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$List extends StandardParameters { /** - * 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`. + * 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`. */ filter?: string; /** @@ -39545,26 +42614,26 @@ export namespace aiplatform_v1 { */ orderBy?: string; /** - * The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + * The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. */ pageSize?: number; /** - * 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.) + * 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.) */ pageToken?: string; /** - * Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Patch extends StandardParameters { /** - * If set to true, and the Context is not found, a new Context is created. + * If set to true, and the Execution is not found, a new Execution is created. */ allowMissing?: boolean; /** - * Immutable. The resource name of the Context. + * Output only. The resource name of the Execution. */ name?: string; /** @@ -39575,106 +42644,270 @@ export namespace aiplatform_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Context; + requestBody?: Schema$GoogleCloudAiplatformV1Execution; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Purge extends StandardParameters { /** - * Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1PurgeContextsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1PurgeExecutionsRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs extends StandardParameters { /** - * 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. + * 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\}` */ - context?: string; + execution?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren - extends StandardParameters { + + export class Resource$Projects$Locations$Metadatastores$Executions$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + /** - * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - context?: string; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RemoveContextChildrenRequest; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + options = {}; + } - export class Resource$Projects$Locations$Metadatastores$Executions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * 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. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - addExecutionEvents( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + callback: BodyResponseCallback ): void; - addExecutionEvents( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - addExecutionEvents( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; options = {}; } @@ -39687,91 +42920,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+execution}:addExecutionEvents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['execution'], - pathParams: ['execution'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates an Execution associated with a MetadataStore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; options = {}; } @@ -39784,69 +43012,69 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/executions').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes an Execution. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, callback: BodyResponseCallback ): void; - delete( + wait( callback: BodyResponseCallback ): void; - delete( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Delete + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -39862,13 +43090,13 @@ export namespace aiplatform_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; options = {}; } @@ -39881,8 +43109,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), @@ -39900,67 +43128,126 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel + extends StandardParameters { /** - * Retrieves a specific Execution. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Metadatastores$Metadataschemas { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a MetadataSchema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + create( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + create( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; options = {}; } @@ -39973,88 +43260,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Executions in the MetadataStore. + * Retrieves a specific MetadataSchema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; options = {}; } @@ -40067,91 +43357,88 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/executions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a stored Execution. + * Lists MetadataSchemas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; options = {}; } @@ -40164,88 +43451,137 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create + extends StandardParameters { /** - * Purges Executions. + * 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.) + */ + metadataSchemaId?: string; + /** + * Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1MetadataSchema; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get + extends StandardParameters { + /** + * Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List + extends StandardParameters { + /** + * A query to filter available MetadataSchemas for matching results. + */ + filter?: string; + /** + * The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + */ + pageSize?: number; + /** + * 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.) + */ + pageToken?: string; + /** + * Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Metadatastores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + callback: BodyResponseCallback ): void; - purge( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; options = {}; } @@ -40258,89 +43594,82 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/executions:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - queryExecutionInputsAndOutputs( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; options = {}; } @@ -40353,206 +43682,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+execution}:queryExecutionInputsAndOutputs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['execution'], - pathParams: ['execution'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents - extends StandardParameters { - /** - * Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - */ - execution?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AddExecutionEventsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Create - extends StandardParameters { - /** - * 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.) - */ - executionId?: string; - /** - * Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Execution; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Delete - extends StandardParameters { - /** - * 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. - */ - etag?: string; - /** - * Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Get - extends StandardParameters { - /** - * Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$List - extends StandardParameters { - /** - * 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`. - */ - filter?: string; - /** - * 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. - */ - orderBy?: string; - /** - * The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. - */ - pageSize?: number; - /** - * 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.) - */ - pageToken?: string; - /** - * Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Patch - extends StandardParameters { - /** - * If set to true, and the Execution is not found, a new Execution is created. - */ - allowMissing?: boolean; - /** - * Output only. The resource name of the Execution. - */ - name?: string; - /** - * Optional. A FieldMask indicating which fields should be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Execution; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Purge - extends StandardParameters { - /** - * Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PurgeExecutionsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs - extends StandardParameters { - /** - * 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\}` - */ - execution?: string; - } - - export class Resource$Projects$Locations$Metadatastores$Metadataschemas { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a MetadataSchema. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; options = {}; } @@ -40565,91 +43774,86 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Retrieves a specific MetadataSchema. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$List; options = {}; } @@ -40662,7 +43866,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -40673,77 +43880,77 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists MetadataSchemas. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; options = {}; } @@ -40756,73 +43963,77 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel extends StandardParameters { /** - * 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.) - */ - metadataSchemaId?: string; - /** - * Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * The name of the operation resource to be cancelled. */ - parent?: string; - + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Delete + extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be deleted. */ - requestBody?: Schema$GoogleCloudAiplatformV1MetadataSchema; + name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Get extends StandardParameters { /** - * Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$List extends StandardParameters { /** - * A query to filter available MetadataSchemas for matching results. + * The standard list filter. */ filter?: string; /** - * The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100. + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. */ pageSize?: number; /** - * 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.) + * The standard list page token. */ pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + extends StandardParameters { /** - * Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * The name of the operation resource to wait on. */ - parent?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } export class Resource$Projects$Locations$Migratableresources { @@ -49030,6 +52241,10 @@ export namespace aiplatform_v1 { * 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-/`. */ pipelineJobId?: string; + /** + * Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines. + */ + preflightValidations?: boolean; /** * Request body metadata @@ -50186,6 +53401,98 @@ export namespace aiplatform_v1 { ); } } + + /** + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + options: StreamMethodOptions + ): GaxiosPromise; + streamRawPredict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + options?: MethodOptions + ): GaxiosPromise; + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + callback: BodyResponseCallback + ): void; + streamRawPredict( + callback: BodyResponseCallback + ): void; + streamRawPredict( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:streamRawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Publishers$Models$Computetokens @@ -50260,6 +53567,18 @@ export namespace aiplatform_v1 { */ requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; } + export interface Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamRawPredictRequest; + } export class Resource$Projects$Locations$Schedules { context: APIRequestContext; diff --git a/src/apis/aiplatform/v1beta1.ts b/src/apis/aiplatform/v1beta1.ts index f77d6801de..bd4aa8d720 100644 --- a/src/apis/aiplatform/v1beta1.ts +++ b/src/apis/aiplatform/v1beta1.ts @@ -331,6 +331,10 @@ export namespace aiplatform_v1beta1 { * The reason why the model stopped generating tokens. */ finishReason?: string | null; + /** + * Grounding metadata. Combine with the facts list from response to generate grounding citations for this choice. + */ + groundingMetadata?: Schema$LearningGenaiRootGroundingMetadata; /** * Index of the candidate. */ @@ -391,6 +395,27 @@ export namespace aiplatform_v1beta1 { */ role?: string | null; } + /** + * A condense version of WorldFact (assistant/boq/lamda/factuality/proto/factuality.proto) to propagate the essential information about the fact used in factuality to the upstream caller. + */ + export interface Schema$CloudAiNlLlmProtoServiceFact { + /** + * Query that is used to retrieve this fact. + */ + query?: string | null; + /** + * If present, the summary/snippet of the fact. + */ + summary?: string | null; + /** + * If present, it refers to the title of this fact. + */ + title?: string | null; + /** + * If present, this URL links to the webpage of the fact. + */ + url?: string | null; + } /** * Function call details. */ @@ -422,6 +447,14 @@ export namespace aiplatform_v1beta1 { * Possible candidate responses to the conversation up until this point. */ candidates?: Schema$CloudAiNlLlmProtoServiceCandidate[]; + /** + * Debug information containing message metadata. Clients should not consume this field, and this is only populated for Flow Runner path. + */ + debugMetadata?: Schema$CloudAiNlLlmProtoServiceMessageMetadata; + /** + * External facts retrieved for factuality/grounding. + */ + facts?: Schema$CloudAiNlLlmProtoServiceFact[]; /** * 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. */ @@ -435,6 +468,20 @@ export namespace aiplatform_v1beta1 { */ usageMetadata?: Schema$CloudAiNlLlmProtoServiceUsageMetadata; } + export interface Schema$CloudAiNlLlmProtoServiceMessageMetadata { + /** + * Filter metadata of the input messages. + */ + inputFilterInfo?: Schema$LearningServingLlmMessageMetadata; + /** + * This score is generated by the router model to decide which model to use + */ + modelRoutingDecision?: Schema$LearningGenaiRootRoutingDecision; + /** + * Filter metadata of the output messages. + */ + outputFilterInfo?: Schema$LearningServingLlmMessageMetadata[]; + } /** * A single part of a message. */ @@ -502,11 +549,28 @@ export namespace aiplatform_v1beta1 { * The end offset of the video. */ endOffset?: string | null; + /** + * Internal only model level metadata. + */ + modelLevelMetaData?: Schema$CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata; /** * The start offset of the video. */ startOffset?: string | null; } + /** + * Internal only fields + */ + export interface Schema$CloudAiNlLlmProtoServicePartVideoMetadataModelLevelMetadata { + /** + * Frame rate to decode from this video. + */ + fps?: number | null; + /** + * Number of frames to decode from this video. + */ + numFrames?: number | null; + } /** * Content filter results for a prompt sent in the request. */ @@ -524,6 +588,68 @@ export namespace aiplatform_v1beta1 { */ safetyRatings?: Schema$CloudAiNlLlmProtoServiceSafetyRating[]; } + /** + * The RAI results for a given text. + */ + export interface Schema$CloudAiNlLlmProtoServiceRaiResult { + /** + * Recitation result from Aida recitation checker. + */ + aidaRecitationResult?: Schema$LanguageLabsAidaTrustRecitationProtoRecitationResult; + /** + * Use `triggered_blocklist`. + */ + blocked?: boolean | null; + /** + * The error codes indicate which RAI filters block the response. + */ + errorCodes?: number[] | null; + /** + * Whether the text should be filtered and not shown to the end user. This is determined based on a combination of `triggered_recitation`, `triggered_blocklist`, `language_filter_result`, and `triggered_safety_filter`. + */ + filtered?: boolean | null; + /** + * Language filter result from SAFT LangId. + */ + languageFilterResult?: Schema$LearningGenaiRootLanguageFilterResult; + /** + * The RAI signals for the text. + */ + raiSignals?: Schema$CloudAiNlLlmProtoServiceRaiSignal[]; + /** + * Whether the text triggered the blocklist. + */ + triggeredBlocklist?: boolean | null; + /** + * Whether the text should be blocked by the recitation result from Aida recitation checker. It is determined from aida_recitation_result. + */ + triggeredRecitation?: boolean | null; + /** + * Whether the text triggered the safety filter. Currently, this is due to CSAI triggering or one of four categories (derogatory, sexual, toxic, violent) having a score over the filter threshold. + */ + triggeredSafetyFilter?: boolean | null; + } + /** + * An RAI signal for a single category. + */ + export interface Schema$CloudAiNlLlmProtoServiceRaiSignal { + /** + * The confidence level for the RAI category. + */ + confidence?: string | null; + /** + * Whether the category is flagged as being present. Currently, this is set to true if score \>= 0.5. + */ + flagged?: boolean | null; + /** + * The RAI category. + */ + raiCategory?: string | null; + /** + * The score for the category, in the range [0.0, 1.0]. + */ + score?: number | null; + } /** * Safety rating corresponding to the generated content. */ @@ -1798,15 +1924,6 @@ export namespace aiplatform_v1beta1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; } - /** - * Details of ExtensionRegistryService.CreateExtensionDeployment operation. - */ - export interface Schema$GoogleCloudAiplatformV1beta1CreateExtensionDeploymentOperationMetadata { - /** - * The common part of the operation metadata. - */ - genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; - } /** * Details of operations that perform create FeatureGroup. */ @@ -1917,6 +2034,10 @@ export namespace aiplatform_v1beta1 { * Operation metadata for PersistentResource. */ genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; + /** + * Progress Message for Create LRO + */ + progressMessage?: string | null; } /** * Request message for PipelineService.CreatePipelineJob. @@ -1934,6 +2055,10 @@ export namespace aiplatform_v1beta1 { * 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-/`. */ pipelineJobId?: string | null; + /** + * Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines. + */ + preflightValidations?: boolean | null; } /** * Details of operations that perform create FeatureGroup. @@ -3239,7 +3364,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1Explanation { /** - * 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. 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. + * 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. */ attributions?: Schema$GoogleCloudAiplatformV1beta1Attribution[]; /** @@ -3923,11 +4048,11 @@ export namespace aiplatform_v1beta1 { minNodeCount?: number | null; } /** - * The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type or enable EmbeddingManagement. Will use public endpoint by default. + * The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type or enable EmbeddingManagement. Will use public endpoint by default. Note, for EmbeddingManagement use case, only [DedicatedServingEndpoint.public_endpoint_domain_name] is available now. */ export interface Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint { /** - * Optional. Private service connect config. 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. + * 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. */ privateServiceConnectConfig?: Schema$GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig; /** @@ -4640,10 +4765,6 @@ export namespace aiplatform_v1beta1 { * 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. */ contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string | null; /** * Optional. Generation config. */ @@ -5195,6 +5316,10 @@ export namespace aiplatform_v1beta1 { * Output only. The ip address used to send match gRPC requests. */ matchGrpcAddress?: string | null; + /** + * Output only. PscAutomatedEndpoints is populated if private service connect is enabled if PscAutomatedConfig is set. + */ + pscAutomatedEndpoints?: Schema$GoogleCloudAiplatformV1beta1PscAutomatedEndpoints[]; /** * Output only. The name of the service attachment resource. Populated if private service connect is enabled. */ @@ -6346,7 +6471,7 @@ export namespace aiplatform_v1beta1 { */ metadataSchemaUri?: string | null; /** - * Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model. + * 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. */ modelSourceInfo?: Schema$GoogleCloudAiplatformV1beta1ModelSourceInfo; /** @@ -7914,6 +8039,10 @@ export namespace aiplatform_v1beta1 { * The runtime config of a PipelineJob. */ export interface Schema$GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig { + /** + * Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview + */ + defaultRuntime?: Schema$GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigDefaultRuntime; /** * 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. */ @@ -7941,6 +8070,15 @@ export namespace aiplatform_v1beta1 { */ parameterValues?: {[key: string]: any} | null; } + /** + * The default runtime for the PipelineJob. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigDefaultRuntime { + /** + * Persistent resource based runtime detail. + */ + persistentResourceRuntimeDetail?: Schema$GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail; + } /** * The type of an input artifact. */ @@ -7950,6 +8088,15 @@ export namespace aiplatform_v1beta1 { */ artifactId?: string | null; } + /** + * Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview + */ + export interface Schema$GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail { + /** + * Persistent resource name. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` + */ + persistentResourceName?: string | null; + } /** * The runtime detail of a task execution. */ @@ -8264,6 +8411,23 @@ export namespace aiplatform_v1beta1 { */ command?: string[] | null; } + /** + * PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PscAutomatedEndpoints { + /** + * Ip Address created by the automated forwarding rule. + */ + matchAddress?: string | null; + /** + * Corresponding network in pscAutomationConfigs. + */ + network?: string | null; + /** + * Corresponding project_id in pscAutomationConfigs + */ + projectId?: string | null; + } /** * A Model Garden Publisher Model. */ @@ -8329,6 +8493,10 @@ export namespace aiplatform_v1beta1 { * Optional. Open fine-tuning pipeline of the PublisherModel. */ openFineTuningPipeline?: Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences; + /** + * Optional. Open fine-tuning pipelines of the PublisherModel. + */ + openFineTuningPipelines?: Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines; /** * Optional. Open in Generation AI Studio. */ @@ -8341,6 +8509,10 @@ export namespace aiplatform_v1beta1 { * Optional. Open notebook of the PublisherModel. */ openNotebook?: Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences; + /** + * Optional. Open notebooks of the PublisherModel. + */ + openNotebooks?: Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenNotebooks; /** * Optional. Open prompt-tuning pipeline of the PublisherModel. */ @@ -8395,6 +8567,24 @@ export namespace aiplatform_v1beta1 { */ title?: string | null; } + /** + * Open fine tuning pipelines. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines { + /** + * Required. Regional resource references to fine tuning pipelines. + */ + fineTuningPipelines?: Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences[]; + } + /** + * Open notebooks. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenNotebooks { + /** + * Required. Regional resource references to notebooks. + */ + notebooks?: Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences[]; + } /** * The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. */ @@ -8408,7 +8598,19 @@ export namespace aiplatform_v1beta1 { ]: Schema$GoogleCloudAiplatformV1beta1PublisherModelResourceReference; } | null; /** - * Required. The title of the regional resource reference. + * Optional. Description of the resource. + */ + resourceDescription?: string | null; + /** + * Optional. Title of the resource. + */ + resourceTitle?: string | null; + /** + * Optional. Use case (CUJ) of the resource. + */ + resourceUseCase?: string | null; + /** + * Required. */ title?: string | null; } @@ -8811,15 +9013,6 @@ export namespace aiplatform_v1beta1 { */ viewCount?: string | null; } - /** - * Details of operations that perform reboot PersistentResource. - */ - export interface Schema$GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata { - /** - * Operation metadata for PersistentResource. - */ - genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; - } /** * Request message for MetadataService.DeleteContextChildrenRequest. */ @@ -8868,7 +9061,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1ReportExecutionEventResponse {} /** - * LINT.IfChange(report_event_message_types) Request message for NotebookInternalService.ReportRuntimeEvent. + * Request message for NotebookInternalService.ReportRuntimeEvent. */ export interface Schema$GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest { /** @@ -13194,6 +13387,10 @@ export namespace aiplatform_v1beta1 { * Operation metadata for PersistentResource. */ genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; + /** + * Progress Message for Update LRO + */ + progressMessage?: string | null; } /** * Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool. @@ -13492,7 +13689,7 @@ export namespace aiplatform_v1beta1 { */ members?: string[] | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + * 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). */ role?: string | null; } @@ -13748,377 +13945,1190 @@ export namespace aiplatform_v1beta1 { */ metricEntries?: Schema$IntelligenceCloudAutomlXpsMetricEntry[]; } - - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - } - } - - export class Resource$Projects$Locations { - context: APIRequestContext; - batchPredictionJobs: Resource$Projects$Locations$Batchpredictionjobs; - customJobs: Resource$Projects$Locations$Customjobs; - dataLabelingJobs: Resource$Projects$Locations$Datalabelingjobs; - datasets: Resource$Projects$Locations$Datasets; - deploymentResourcePools: Resource$Projects$Locations$Deploymentresourcepools; - edgeDevices: Resource$Projects$Locations$Edgedevices; - endpoints: Resource$Projects$Locations$Endpoints; - exampleStores: Resource$Projects$Locations$Examplestores; - extensionControllers: Resource$Projects$Locations$Extensioncontrollers; - extensions: Resource$Projects$Locations$Extensions; - featureGroups: Resource$Projects$Locations$Featuregroups; - featureOnlineStores: Resource$Projects$Locations$Featureonlinestores; - featurestores: Resource$Projects$Locations$Featurestores; - hyperparameterTuningJobs: Resource$Projects$Locations$Hyperparametertuningjobs; - indexEndpoints: Resource$Projects$Locations$Indexendpoints; - indexes: Resource$Projects$Locations$Indexes; - metadataStores: Resource$Projects$Locations$Metadatastores; - migratableResources: Resource$Projects$Locations$Migratableresources; - modelDeploymentMonitoringJobs: Resource$Projects$Locations$Modeldeploymentmonitoringjobs; - modelMonitors: Resource$Projects$Locations$Modelmonitors; - models: Resource$Projects$Locations$Models; - nasJobs: Resource$Projects$Locations$Nasjobs; - notebookExecutionJobs: Resource$Projects$Locations$Notebookexecutionjobs; - notebookRuntimes: Resource$Projects$Locations$Notebookruntimes; - notebookRuntimeTemplates: Resource$Projects$Locations$Notebookruntimetemplates; - operations: Resource$Projects$Locations$Operations; - persistentResources: Resource$Projects$Locations$Persistentresources; - pipelineJobs: Resource$Projects$Locations$Pipelinejobs; - publishers: Resource$Projects$Locations$Publishers; - schedules: Resource$Projects$Locations$Schedules; - solvers: Resource$Projects$Locations$Solvers; - specialistPools: Resource$Projects$Locations$Specialistpools; - studies: Resource$Projects$Locations$Studies; - tensorboards: Resource$Projects$Locations$Tensorboards; - trainingPipelines: Resource$Projects$Locations$Trainingpipelines; - constructor(context: APIRequestContext) { - this.context = context; - this.batchPredictionJobs = - new Resource$Projects$Locations$Batchpredictionjobs(this.context); - this.customJobs = new Resource$Projects$Locations$Customjobs( - this.context - ); - this.dataLabelingJobs = new Resource$Projects$Locations$Datalabelingjobs( - this.context - ); - this.datasets = new Resource$Projects$Locations$Datasets(this.context); - this.deploymentResourcePools = - new Resource$Projects$Locations$Deploymentresourcepools(this.context); - this.edgeDevices = new Resource$Projects$Locations$Edgedevices( - this.context - ); - this.endpoints = new Resource$Projects$Locations$Endpoints(this.context); - this.exampleStores = new Resource$Projects$Locations$Examplestores( - this.context - ); - this.extensionControllers = - new Resource$Projects$Locations$Extensioncontrollers(this.context); - this.extensions = new Resource$Projects$Locations$Extensions( - this.context - ); - this.featureGroups = new Resource$Projects$Locations$Featuregroups( - this.context - ); - this.featureOnlineStores = - new Resource$Projects$Locations$Featureonlinestores(this.context); - this.featurestores = new Resource$Projects$Locations$Featurestores( - this.context - ); - this.hyperparameterTuningJobs = - new Resource$Projects$Locations$Hyperparametertuningjobs(this.context); - this.indexEndpoints = new Resource$Projects$Locations$Indexendpoints( - this.context - ); - this.indexes = new Resource$Projects$Locations$Indexes(this.context); - this.metadataStores = new Resource$Projects$Locations$Metadatastores( - this.context - ); - this.migratableResources = - new Resource$Projects$Locations$Migratableresources(this.context); - this.modelDeploymentMonitoringJobs = - new Resource$Projects$Locations$Modeldeploymentmonitoringjobs( - this.context - ); - this.modelMonitors = new Resource$Projects$Locations$Modelmonitors( - this.context - ); - this.models = new Resource$Projects$Locations$Models(this.context); - this.nasJobs = new Resource$Projects$Locations$Nasjobs(this.context); - this.notebookExecutionJobs = - new Resource$Projects$Locations$Notebookexecutionjobs(this.context); - this.notebookRuntimes = new Resource$Projects$Locations$Notebookruntimes( - this.context - ); - this.notebookRuntimeTemplates = - new Resource$Projects$Locations$Notebookruntimetemplates(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.persistentResources = - new Resource$Projects$Locations$Persistentresources(this.context); - this.pipelineJobs = new Resource$Projects$Locations$Pipelinejobs( - this.context - ); - this.publishers = new Resource$Projects$Locations$Publishers( - this.context - ); - this.schedules = new Resource$Projects$Locations$Schedules(this.context); - this.solvers = new Resource$Projects$Locations$Solvers(this.context); - this.specialistPools = new Resource$Projects$Locations$Specialistpools( - this.context - ); - this.studies = new Resource$Projects$Locations$Studies(this.context); - this.tensorboards = new Resource$Projects$Locations$Tensorboards( - this.context - ); - this.trainingPipelines = - new Resource$Projects$Locations$Trainingpipelines(this.context); - } - + /** + * The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30 + */ + export interface Schema$LanguageLabsAidaTrustRecitationProtoDocAttribution { + amarnaId?: string | null; + arxivId?: string | null; + author?: string | null; + bibkey?: string | null; /** - * Gets information about a location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * ID of the paper in bioarxiv like ddoi.org/{biorxiv_id\} eg: https://doi.org/10.1101/343517 */ - get( - params: Params$Resource$Projects$Locations$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - + biorxivId?: string | null; + bookTitle?: string | null; /** - * Lists information about the supported locations for this service. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The Oceanographers full-view books dataset uses a 'volume id' as the unique ID of a book. There is a deterministic function from a volume id to a URL under the books.google.com domain. Marked as 'optional' since a volume ID of zero is potentially possible and we want to distinguish that from the volume ID not being set. */ - list( - params: Params$Resource$Projects$Locations$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Get - extends StandardParameters { + bookVolumeId?: string | null; + category?: string | null; + conversationId?: string | null; /** - * Resource name for the location. + * The dataset this document comes from. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$List - extends StandardParameters { + dataset?: string | null; + filepath?: string | null; + geminiId?: string | null; + gnewsArticleTitle?: string | null; + goodallExampleId?: string | null; /** - * 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). + * Whether the document is opted out. */ - filter?: string; + isOptOut?: boolean | null; + isPrompt?: boolean | null; + lamdaExampleId?: string | null; + license?: string | null; + meenaConversationId?: string | null; /** - * The resource that owns the locations collection, if applicable. + * Natural (not programming) language of the document. Language code as defined by http://www.unicode.org/reports/tr35/#Identifiers and https://tools.ietf.org/html/bcp47. Currently applicable to full-view books. Use docinfo-util.h to set & read language fields. See go/iii. */ - name?: string; + naturalLanguageCode?: string | null; /** - * The maximum number of results to return. If not set, the service selects a default. + * True if this doc has no attribution information available. We use an explicit field for this instead of just implicitly leaving all the DocAttribution fields blank to distinguish a case where a bug/oversight has left the attribution information empty vs when we really have no attribution information available. */ - pageSize?: number; + noAttribution?: boolean | null; + podcastUtteranceId?: string | null; + publicationDate?: Schema$GoogleTypeDate; /** - * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * This field is for opt-out experiment only, MUST never be used during actual production/serving. */ - pageToken?: string; + qualityScoreExperimentOnly?: number | null; + /** + * Github repository + */ + repo?: string | null; + /** + * URL of a webdoc + */ + url?: string | null; + volumeId?: string | null; + /** + * Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset. + */ + wikipediaArticleTitle?: string | null; + /** + * The unique video id from Youtube. Example: AkoGsW52Ir0 + */ + youtubeVideoId?: string | null; } - - export class Resource$Projects$Locations$Batchpredictionjobs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - + /** + * The recitation result for one input + */ + export interface Schema$LanguageLabsAidaTrustRecitationProtoRecitationResult { + dynamicSegmentResults?: Schema$LanguageLabsAidaTrustRecitationProtoSegmentResult[]; /** - * 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. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK \> CITE \> NO_ACTION. */ - cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, - options: StreamMethodOptions - ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, - options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, - options: StreamMethodOptions | BodyResponseCallback, + recitationAction?: string | null; + trainingSegmentResults?: Schema$LanguageLabsAidaTrustRecitationProtoSegmentResult[]; + } + /** + * The recitation result for each segment in a given input. + */ + export interface Schema$LanguageLabsAidaTrustRecitationProtoSegmentResult { + /** + * The dataset the segment came from. + */ + attributionDataset?: string | null; + /** + * human-friendly string that contains information from doc_attribution which could be shown by clients + */ + displayAttributionMessage?: string | null; + /** + * populated when recitation_action == CITE + */ + docAttribution?: Schema$LanguageLabsAidaTrustRecitationProtoDocAttribution; + /** + * number of documents that contained this segment + */ + docOccurrences?: number | null; + endIndex?: number | null; + /** + * The raw text in the given input that is corresponding to the segment. It will be available only when 'return_segment_raw_text' is enabled in the request options. + */ + rawText?: string | null; + segmentRecitationAction?: string | null; + /** + * The segment boundary start (inclusive) and end index (exclusive) in the given text. In the streaming RPC, the indexes always start from the beginning of the first text in the entire stream. The indexes are measured in UTF-16 code units. + */ + startIndex?: number | null; + } + /** + * The recitation result for one stream input + */ + export interface Schema$LanguageLabsAidaTrustRecitationProtoStreamRecitationResult { + /** + * The recitation result against the given dynamic data source. + */ + dynamicSegmentResults?: Schema$LanguageLabsAidaTrustRecitationProtoSegmentResult[]; + /** + * Last index of input text fully checked for recitation in the entire streaming context. Would return `-1` if no Input was checked for recitation. + */ + fullyCheckedTextIndex?: number | null; + /** + * The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK \> CITE \> NO_ACTION. + */ + recitationAction?: string | null; + /** + * The recitation result against model training data. + */ + trainingSegmentResults?: Schema$LanguageLabsAidaTrustRecitationProtoSegmentResult[]; + } + /** + * The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30 + */ + export interface Schema$LearningGenaiRecitationDocAttribution { + amarnaId?: string | null; + arxivId?: string | null; + author?: string | null; + bibkey?: string | null; + /** + * ID of the paper in bioarxiv like ddoi.org/{biorxiv_id\} eg: https://doi.org/10.1101/343517 + */ + biorxivId?: string | null; + bookTitle?: string | null; + /** + * The Oceanographers full-view books dataset uses a 'volume id' as the unique ID of a book. There is a deterministic function from a volume id to a URL under the books.google.com domain. Marked as 'optional' since a volume ID of zero is potentially possible and we want to distinguish that from the volume ID not being set. + */ + bookVolumeId?: string | null; + conversationId?: string | null; + /** + * The dataset this document comes from. + */ + dataset?: string | null; + filepath?: string | null; + geminiId?: string | null; + gnewsArticleTitle?: string | null; + goodallExampleId?: string | null; + /** + * Whether the document is opted out. + */ + isOptOut?: boolean | null; + /** + * When true, this attribution came from the user's prompt. + */ + isPrompt?: boolean | null; + lamdaExampleId?: string | null; + license?: string | null; + meenaConversationId?: string | null; + /** + * Natural (not programming) language of the document. Language code as defined by http://www.unicode.org/reports/tr35/#Identifiers and https://tools.ietf.org/html/bcp47. Currently applicable to full-view books. Use docinfo-util.h to set & read language fields. See go/iii. + */ + naturalLanguageCode?: string | null; + /** + * True if this doc has no attribution information available. We use an explicit field for this instead of just implicitly leaving all the DocAttribution fields blank to distinguish a case where a bug/oversight has left the attribution information empty vs when we really have no attribution information available. + */ + noAttribution?: boolean | null; + podcastUtteranceId?: string | null; + publicationDate?: Schema$GoogleTypeDate; + /** + * This field is for opt-out experiment only, MUST never be used during actual production/serving. + */ + qualityScoreExperimentOnly?: number | null; + /** + * Github repository + */ + repo?: string | null; + /** + * URL of a webdoc + */ + url?: string | null; + volumeId?: string | null; + /** + * Wikipedia article title. The Wikipedia TFDS dataset includes article titles but not URLs. While a URL is to the best of our knowledge a deterministic function of the title, we store the original title to reflect the information in the original dataset. + */ + wikipediaArticleTitle?: string | null; + youtubeVideoId?: string | null; + } + /** + * The recitation result for one input + */ + export interface Schema$LearningGenaiRecitationRecitationResult { + dynamicSegmentResults?: Schema$LearningGenaiRecitationSegmentResult[]; + /** + * The recitation action for one given input. When its segments contain different actions, the overall action will be returned in the precedence of BLOCK \> CITE \> NO_ACTION. + */ + recitationAction?: string | null; + trainingSegmentResults?: Schema$LearningGenaiRecitationSegmentResult[]; + } + /** + * The recitation result for each segment in a given input. + */ + export interface Schema$LearningGenaiRecitationSegmentResult { + /** + * The dataset the segment came from. + */ + attributionDataset?: string | null; + /** + * human-friendly string that contains information from doc_attribution which could be shown by clients + */ + displayAttributionMessage?: string | null; + /** + * populated when recitation_action == CITE + */ + docAttribution?: Schema$LearningGenaiRecitationDocAttribution; + /** + * number of documents that contained this segment + */ + docOccurrences?: number | null; + endIndex?: number | null; + /** + * The raw text in the given input that is corresponding to the segment. It will be available only when 'return_segment_raw_text' is enabled in the request options. + */ + rawText?: string | null; + segmentRecitationAction?: string | null; + /** + * The segment boundary start (inclusive) and end index (exclusive) in the given text. In the streaming RPC, the indexes always start from the beginning of the first text in the entire stream. The indexes are measured in UTF-16 code units. + */ + startIndex?: number | null; + } + /** + * The type used for final weights calculation. + */ + export interface Schema$LearningGenaiRootCalculationType { + scoreType?: string | null; + weights?: number | null; + } + export interface Schema$LearningGenaiRootClassifierOutput { + /** + * If set, this is the output of the first matching rule. + */ + ruleOutput?: Schema$LearningGenaiRootRuleOutput; + /** + * outputs of all matching rule. + */ + ruleOutputs?: Schema$LearningGenaiRootRuleOutput[]; + /** + * The results of data_providers and metrics. + */ + state?: Schema$LearningGenaiRootClassifierState; + } + export interface Schema$LearningGenaiRootClassifierOutputSummary { + metrics?: Schema$LearningGenaiRootMetricOutput[]; + /** + * Output of the first matching rule. + */ + ruleOutput?: Schema$LearningGenaiRootRuleOutput; + /** + * outputs of all matching rule. + */ + ruleOutputs?: Schema$LearningGenaiRootRuleOutput[]; + } + /** + * DataProviderOutput and MetricOutput can be saved between calls to the Classifier framework. For instance, you can run the query classifier, get outputs from those metrics, then use them in a result classifier as well. Example rule based on this idea: and_rules { rule { metric_name: 'query_safesearch_v2' ... \} rule { metric_name: 'response_safesearch_v2' ... \} \} + */ + export interface Schema$LearningGenaiRootClassifierState { + dataProviderOutput?: Schema$LearningGenaiRootDataProviderOutput[]; + metricOutput?: Schema$LearningGenaiRootMetricOutput[]; + } + export interface Schema$LearningGenaiRootDataProviderOutput { + name?: string | null; + /** + * If set, this DataProvider failed and this is the error message. + */ + status?: Schema$UtilStatusProto; + } + export interface Schema$LearningGenaiRootFilterMetadata { + /** + * Filter confidence. + */ + confidence?: string | null; + /** + * Debug info for the message. + */ + debugInfo?: Schema$LearningGenaiRootFilterMetadataFilterDebugInfo; + /** + * A fallback message chosen by the applied filter. + */ + fallback?: string | null; + /** + * Additional info for the filter. + */ + info?: string | null; + /** + * Name of the filter that triggered. + */ + name?: string | null; + /** + * Filter reason. + */ + reason?: string | null; + /** + * The input query or generated response that is getting filtered. + */ + text?: string | null; + } + export interface Schema$LearningGenaiRootFilterMetadataFilterDebugInfo { + classifierOutput?: Schema$LearningGenaiRootClassifierOutput; + defaultMetadata?: string | null; + languageFilterResult?: Schema$LearningGenaiRootLanguageFilterResult; + /** + * Safety filter output information for LLM Root RAI harm check. + */ + raiOutput?: Schema$LearningGenaiRootRAIOutput; + raiResult?: Schema$CloudAiNlLlmProtoServiceRaiResult; + raiSignal?: Schema$CloudAiNlLlmProtoServiceRaiSignal; + streamRecitationResult?: Schema$LanguageLabsAidaTrustRecitationProtoStreamRecitationResult; + takedownResult?: Schema$LearningGenaiRootTakedownResult; + toxicityResult?: Schema$LearningGenaiRootToxicityResult; + } + export interface Schema$LearningGenaiRootGroundingMetadata { + citations?: Schema$LearningGenaiRootGroundingMetadataCitation[]; + /** + * True if grounding is cancelled, for example, no facts being retrieved. + */ + groundingCancelled?: boolean | null; + searchQueries?: string[] | null; + } + export interface Schema$LearningGenaiRootGroundingMetadataCitation { + /** + * Index in the prediction output where the citation ends (exclusive). Must be \> start_index and < len(output). + */ + endIndex?: number | null; + /** + * Index of the fact supporting this claim. Should be within the range of the `world_facts` in the GenerateResponse. + */ + factIndex?: number | null; + /** + * Confidence score of this entailment. Value is [0,1] with 1 is the most confidence. + */ + score?: number | null; + /** + * Index in the prediction output where the citation starts (inclusive). Must be \>= 0 and < end_index. + */ + startIndex?: number | null; + } + export interface Schema$LearningGenaiRootHarm { + /** + * Please do not use, this is still under development. + */ + contextualDangerous?: boolean | null; + csam?: boolean | null; + fringe?: boolean | null; + grailImageHarmType?: Schema$LearningGenaiRootHarmGrailImageHarmType; + grailTextHarmType?: Schema$LearningGenaiRootHarmGrailTextHarmType; + imageCsam?: boolean | null; + imagePedo?: boolean | null; + /** + * Image signals + */ + imagePorn?: boolean | null; + imageViolence?: boolean | null; + pqc?: boolean | null; + safetycat?: Schema$LearningGenaiRootHarmSafetyCatCategories; + spii?: Schema$LearningGenaiRootHarmSpiiFilter; + threshold?: number | null; + videoFrameCsam?: boolean | null; + videoFramePedo?: boolean | null; + /** + * Video frame signals + */ + videoFramePorn?: boolean | null; + videoFrameViolence?: boolean | null; + } + /** + * Harm type for images + */ + export interface Schema$LearningGenaiRootHarmGrailImageHarmType { + imageHarmType?: string[] | null; + } + /** + * Harm type for text + */ + export interface Schema$LearningGenaiRootHarmGrailTextHarmType { + harmType?: string[] | null; + } + export interface Schema$LearningGenaiRootHarmSafetyCatCategories { + categories?: string[] | null; + } + export interface Schema$LearningGenaiRootHarmSpiiFilter { + usBankRoutingMicr?: boolean | null; + usEmployerIdentificationNumber?: boolean | null; + usSocialSecurityNumber?: boolean | null; + } + export interface Schema$LearningGenaiRootInternalMetadata { + scoredTokens?: Schema$LearningGenaiRootScoredToken[]; + } + export interface Schema$LearningGenaiRootLanguageFilterResult { + /** + * False when query or response should be filtered out due to unsupported language. + */ + allowed?: boolean | null; + /** + * Language of the query or response. + */ + detectedLanguage?: string | null; + /** + * Probability of the language predicted as returned by LangID. + */ + detectedLanguageProbability?: number | null; + } + export interface Schema$LearningGenaiRootMetricOutput { + debug?: string | null; + /** + * Name of the metric. + */ + name?: string | null; + numericValue?: number | null; + status?: Schema$UtilStatusProto; + stringValue?: string | null; + } + /** + * This is per harm. + */ + export interface Schema$LearningGenaiRootRAIOutput { + allowed?: boolean | null; + harm?: Schema$LearningGenaiRootHarm; + name?: string | null; + score?: number | null; + } + export interface Schema$LearningGenaiRootRegexTakedownResult { + /** + * False when query or response should be taken down due to match with a blocked regex, true otherwise. + */ + allowed?: boolean | null; + /** + * Regex used to decide that query or response should be taken down. Empty when query or response is kept. + */ + takedownRegex?: string | null; + } + export interface Schema$LearningGenaiRootRequestResponseTakedownResult { + /** + * False when response has to be taken down per above config. + */ + allowed?: boolean | null; + /** + * Regex used to match the request. + */ + requestTakedownRegex?: string | null; + /** + * Regex used to decide that response should be taken down. Empty when response is kept. + */ + responseTakedownRegex?: string | null; + } + /** + * Holds the final routing decision, by storing the model_config_id. And individual scores each model got. + */ + export interface Schema$LearningGenaiRootRoutingDecision { + metadata?: Schema$LearningGenaiRootRoutingDecisionMetadata; + /** + * The selected model to route traffic to. + */ + modelConfigId?: string | null; + } + /** + * Debug metadata about the routing decision. + */ + export interface Schema$LearningGenaiRootRoutingDecisionMetadata { + scoreBasedRoutingMetadata?: Schema$LearningGenaiRootRoutingDecisionMetadataScoreBased; + tokenLengthBasedRoutingMetadata?: Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBased; + } + /** + * If we are routing using scored based configuration, then the metadata about that is available in this proto. + */ + export interface Schema$LearningGenaiRootRoutingDecisionMetadataScoreBased { + /** + * The rule that was matched. + */ + matchedRule?: Schema$LearningGenaiRootScoreBasedRoutingConfigRule; + /** + * The score that was generated by the router i.e. the model. + */ + score?: Schema$LearningGenaiRootScore; + /** + * No rules were matched & therefore used the default fallback. + */ + usedDefaultFallback?: boolean | null; + } + export interface Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBased { + modelInputTokenMetadata?: Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelInputTokenMetadata[]; + modelMaxTokenMetadata?: Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelMaxTokenMetadata[]; + } + export interface Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelInputTokenMetadata { + /** + * The length computed by backends using the formatter & tokenizer specific to the model + */ + computedInputTokenLength?: number | null; + modelId?: string | null; + } + export interface Schema$LearningGenaiRootRoutingDecisionMetadataTokenLengthBasedModelMaxTokenMetadata { + maxNumInputTokens?: number | null; + maxNumOutputTokens?: number | null; + modelId?: string | null; + } + export interface Schema$LearningGenaiRootRuleOutput { + decision?: string | null; + name?: string | null; + } + export interface Schema$LearningGenaiRootScore { + calculationType?: Schema$LearningGenaiRootCalculationType; + /** + * The internal_metadata is intended to be used by internal processors and will be cleared before returns. + */ + internalMetadata?: Schema$LearningGenaiRootInternalMetadata; + thresholdType?: Schema$LearningGenaiRootThresholdType; + /** + * Top candidate tokens and log probabilities at each decoding step. + */ + tokensAndLogprobPerDecodingStep?: Schema$LearningGenaiRootTokensAndLogProbPerDecodingStep; + value?: number | null; + } + export interface Schema$LearningGenaiRootScoreBasedRoutingConfigRule { + /** + * NOTE: Hardest examples have smaller values in their routing scores. + */ + equalOrGreaterThan?: Schema$LearningGenaiRootScore; + lessThan?: Schema$LearningGenaiRootScore; + /** + * This model_config_id points to ModelConfig::id which allows us to find the ModelConfig to route to. This is part of the banks specified in the ModelBankConfig. + */ + modelConfigId?: string | null; + } + /** + * Proto containing the results from the Universal Sentence Encoder / Other models + */ + export interface Schema$LearningGenaiRootScoredSimilarityTakedownPhrase { + phrase?: Schema$LearningGenaiRootSimilarityTakedownPhrase; + similarityScore?: number | null; + } + /** + * A token with its own score. + */ + export interface Schema$LearningGenaiRootScoredToken { + /** + * Each end_token_score is a logprob for how well the completion would end at a particular token. See http://google3/labs/language/aida/config/proto/model_config.proto;l=376;rcl=573039459 + */ + endTokenScore?: number | null; + /** + * Each score is the logprob for the token in model response. + */ + score?: number | null; + token?: string | null; + } + /** + * Each SimilarityTakedownPhrase treats a logical group of blocked and allowed phrases together along with a corresponding punt If the closest matching response is of the allowed type, we allow the response If the closest matching response is of the blocked type, we block the response. eg: Blocked phrase - "All lives matter" + */ + export interface Schema$LearningGenaiRootSimilarityTakedownPhrase { + blockedPhrase?: string | null; + } + export interface Schema$LearningGenaiRootSimilarityTakedownResult { + /** + * False when query or response should be taken down by any of the takedown rules, true otherwise. + */ + allowed?: boolean | null; + /** + * List of similar phrases with score. Set only if allowed=false. + */ + scoredPhrases?: Schema$LearningGenaiRootScoredSimilarityTakedownPhrase[]; + } + export interface Schema$LearningGenaiRootTakedownResult { + /** + * False when query or response should be taken down by any of the takedown rules, true otherwise. + */ + allowed?: boolean | null; + regexTakedownResult?: Schema$LearningGenaiRootRegexTakedownResult; + requestResponseTakedownResult?: Schema$LearningGenaiRootRequestResponseTakedownResult; + similarityTakedownResult?: Schema$LearningGenaiRootSimilarityTakedownResult; + } + /** + * The type of score that bundled with a threshold, and will not be attending the final score calculation. How each score type uses the threshold can be implementation details. + */ + export interface Schema$LearningGenaiRootThresholdType { + scoreType?: string | null; + threshold?: number | null; + } + /** + * Results of RandomSamplingParams::top_k_logprob_per_decoding_step. + */ + export interface Schema$LearningGenaiRootTokensAndLogProbPerDecodingStep { + /** + * Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. + */ + chosenCandidates?: Schema$LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate[]; + /** + * Length = total number of decoding steps. + */ + topCandidates?: Schema$LearningGenaiRootTokensAndLogProbPerDecodingStepTopCandidates[]; + } + /** + * A candidate at a decoding step. + */ + export interface Schema$LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate { + /** + * The candidate's log probability. + */ + logProbability?: number | null; + /** + * The candidate’s token value. + */ + token?: string | null; + } + /** + * Candidates with top log probabilities at each decoding step. + */ + export interface Schema$LearningGenaiRootTokensAndLogProbPerDecodingStepTopCandidates { + /** + * Sorted by log probability in descending order. + */ + candidates?: Schema$LearningGenaiRootTokensAndLogProbPerDecodingStepCandidate[]; + } + /** + * A model can generate multiple signals and this captures all the generated signals for a single message. + */ + export interface Schema$LearningGenaiRootToxicityResult { + signals?: Schema$LearningGenaiRootToxicitySignal[]; + } + /** + * Proto to capture a signal generated by the toxicity model. + */ + export interface Schema$LearningGenaiRootToxicitySignal { + allowed?: boolean | null; + label?: string | null; + score?: number | null; + } + /** + * LINT.IfChange This metadata contains additional information required for debugging. + */ + export interface Schema$LearningServingLlmMessageMetadata { + /** + * Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. + */ + classifierSummary?: Schema$LearningGenaiRootClassifierOutputSummary; + currentStreamTextLength?: number | null; + /** + * Whether the corresponding message has been deleted. + */ + deleted?: boolean | null; + /** + * Metadata for filters that triggered. + */ + filterMeta?: Schema$LearningGenaiRootFilterMetadata[]; + /** + * This score is finally used for ranking the message. This will be same as the score present in `Message.score` field. + */ + finalMessageScore?: Schema$LearningGenaiRootScore; + /** + * NOT YET IMPLEMENTED. + */ + finishReason?: string | null; + groundingMetadata?: Schema$LearningGenaiRootGroundingMetadata; + /** + * Applies to Response message only. Indicates whether the message is a fallback and the response would have otherwise been empty. + */ + isFallback?: boolean | null; + /** + * Result from nlp_saft DetectLanguage method. Currently the predicted language code and language probability is used. + */ + langidResult?: Schema$NlpSaftLangIdResult; + /** + * Detected language. + */ + language?: string | null; + /** + * The LM prefix used to generate this response. + */ + lmPrefix?: string | null; + /** + * The original text generated by LLM. This is the raw output for debugging purposes. + */ + originalText?: string | null; + /** + * NOT YET IMPLEMENTED. Applies to streaming only. Number of tokens decoded / emitted by the model as part of this stream. This may be different from token_count, which contains number of tokens returned in this response after any response rewriting / truncation. + */ + perStreamDecodedTokenCount?: number | null; + /** + * Results of running RAI on the query or this response candidate. One output per rai_config. It will be populated regardless of whether the threshold is exceeded or not. + */ + raiOutputs?: Schema$LearningGenaiRootRAIOutput[]; + /** + * Recitation Results. It will be populated as long as Recitation processing is enabled, regardless of recitation outcome. + */ + recitationResult?: Schema$LearningGenaiRecitationRecitationResult; + /** + * NOT YET IMPLEMENTED. Number of tokens returned as part of this candidate. + */ + returnTokenCount?: number | null; + /** + * All the different scores for a message are logged here. + */ + scores?: Schema$LearningGenaiRootScore[]; + /** + * Whether the response is terminated during streaming return. Only used for streaming requests. + */ + streamTerminated?: boolean | null; + /** + * NOT YET IMPLEMENTED. Aggregated number of total tokens decoded so far. For streaming, this is sum of all the tokens decoded so far i.e. aggregated count. + */ + totalDecodedTokenCount?: number | null; + /** + * Translated user-prompt used for RAI post processing. This is for internal processing only. We will translate in pre-processor and pass the translated text to the post processor using this field. It will be empty if non of the signals requested need translation. + */ + translatedUserPrompts?: string[] | null; + /** + * The metadata from Vertex SafetyCat processors + */ + vertexRaiResult?: Schema$CloudAiNlLlmProtoServiceRaiResult; + } + export interface Schema$NlpSaftLangIdLocalesResult { + /** + * List of locales in which the text would be considered acceptable. Sorted in descending order according to each locale's respective likelihood. For example, if a Portuguese text is acceptable in both Brazil and Portugal, but is more strongly associated with Brazil, then the predictions would be ["pt-BR", "pt-PT"], in that order. May be empty, indicating that the model did not predict any acceptable locales. + */ + predictions?: Schema$NlpSaftLangIdLocalesResultLocale[]; + } + export interface Schema$NlpSaftLangIdLocalesResultLocale { + /** + * A BCP 47 language code that includes region information. For example, "pt-BR" or "pt-PT". This field will always be populated. + */ + languageCode?: string | null; + } + export interface Schema$NlpSaftLangIdResult { + /** + * The version of the model used to create these annotations. + */ + modelVersion?: string | null; + /** + * This field stores the n-best list of possible BCP 47 language code strings for a given input sorted in descending order according to each code's respective probability. + */ + predictions?: Schema$NlpSaftLanguageSpan[]; + /** + * This field stores language predictions of subspans of the input, when available. Each LanguageSpanSequence is a sequence of LanguageSpans. A particular sequence of LanguageSpans has an associated probability, and need not necessarily cover the entire input. If no language could be predicted for any span, then this field may be empty. + */ + spanPredictions?: Schema$NlpSaftLanguageSpanSequence[]; + } + export interface Schema$NlpSaftLanguageSpan { + end?: number | null; + /** + * A BCP 47 language code for this span. + */ + languageCode?: string | null; + /** + * Optional field containing any information that was predicted about the specific locale(s) of the span. + */ + locales?: Schema$NlpSaftLangIdLocalesResult; + /** + * A probability associated with this prediction. + */ + probability?: number | null; + /** + * Start and end byte offsets, inclusive, within the given input string. A value of -1 implies that this field is not set. Both fields must either be set with a nonnegative value or both are unset. If both are unset then this LanguageSpan applies to the entire input. + */ + start?: number | null; + } + export interface Schema$NlpSaftLanguageSpanSequence { + /** + * A sequence of LanguageSpan objects, each assigning a language to a subspan of the input. + */ + languageSpans?: Schema$NlpSaftLanguageSpan[]; + /** + * The probability of this sequence of LanguageSpans. + */ + probability?: number | null; + } + /** + * This is proto2's version of MessageSet. + */ + export interface Schema$Proto2BridgeMessageSet {} + /** + * Wire-format for a Status object + */ + export interface Schema$UtilStatusProto { + /** + * The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be. + */ + canonicalCode?: number | null; + /** + * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto + */ + code?: number | null; + /** + * Detail message + */ + message?: string | null; + /** + * message_set associates an arbitrary proto message with the status. + */ + messageSet?: Schema$Proto2BridgeMessageSet; + /** + * The following are usually only present when code != 0 Space to which this status belongs + */ + space?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + batchPredictionJobs: Resource$Projects$Locations$Batchpredictionjobs; + customJobs: Resource$Projects$Locations$Customjobs; + dataLabelingJobs: Resource$Projects$Locations$Datalabelingjobs; + datasets: Resource$Projects$Locations$Datasets; + deploymentResourcePools: Resource$Projects$Locations$Deploymentresourcepools; + edgeDevices: Resource$Projects$Locations$Edgedevices; + endpoints: Resource$Projects$Locations$Endpoints; + exampleStores: Resource$Projects$Locations$Examplestores; + extensionControllers: Resource$Projects$Locations$Extensioncontrollers; + extensions: Resource$Projects$Locations$Extensions; + featureGroups: Resource$Projects$Locations$Featuregroups; + featureOnlineStores: Resource$Projects$Locations$Featureonlinestores; + featurestores: Resource$Projects$Locations$Featurestores; + hyperparameterTuningJobs: Resource$Projects$Locations$Hyperparametertuningjobs; + indexEndpoints: Resource$Projects$Locations$Indexendpoints; + indexes: Resource$Projects$Locations$Indexes; + metadataStores: Resource$Projects$Locations$Metadatastores; + migratableResources: Resource$Projects$Locations$Migratableresources; + modelDeploymentMonitoringJobs: Resource$Projects$Locations$Modeldeploymentmonitoringjobs; + modelMonitors: Resource$Projects$Locations$Modelmonitors; + models: Resource$Projects$Locations$Models; + nasJobs: Resource$Projects$Locations$Nasjobs; + notebookExecutionJobs: Resource$Projects$Locations$Notebookexecutionjobs; + notebookRuntimes: Resource$Projects$Locations$Notebookruntimes; + notebookRuntimeTemplates: Resource$Projects$Locations$Notebookruntimetemplates; + operations: Resource$Projects$Locations$Operations; + persistentResources: Resource$Projects$Locations$Persistentresources; + pipelineJobs: Resource$Projects$Locations$Pipelinejobs; + publishers: Resource$Projects$Locations$Publishers; + reasoningEngines: Resource$Projects$Locations$Reasoningengines; + schedules: Resource$Projects$Locations$Schedules; + solvers: Resource$Projects$Locations$Solvers; + specialistPools: Resource$Projects$Locations$Specialistpools; + studies: Resource$Projects$Locations$Studies; + tensorboards: Resource$Projects$Locations$Tensorboards; + trainingPipelines: Resource$Projects$Locations$Trainingpipelines; + constructor(context: APIRequestContext) { + this.context = context; + this.batchPredictionJobs = + new Resource$Projects$Locations$Batchpredictionjobs(this.context); + this.customJobs = new Resource$Projects$Locations$Customjobs( + this.context + ); + this.dataLabelingJobs = new Resource$Projects$Locations$Datalabelingjobs( + this.context + ); + this.datasets = new Resource$Projects$Locations$Datasets(this.context); + this.deploymentResourcePools = + new Resource$Projects$Locations$Deploymentresourcepools(this.context); + this.edgeDevices = new Resource$Projects$Locations$Edgedevices( + this.context + ); + this.endpoints = new Resource$Projects$Locations$Endpoints(this.context); + this.exampleStores = new Resource$Projects$Locations$Examplestores( + this.context + ); + this.extensionControllers = + new Resource$Projects$Locations$Extensioncontrollers(this.context); + this.extensions = new Resource$Projects$Locations$Extensions( + this.context + ); + this.featureGroups = new Resource$Projects$Locations$Featuregroups( + this.context + ); + this.featureOnlineStores = + new Resource$Projects$Locations$Featureonlinestores(this.context); + this.featurestores = new Resource$Projects$Locations$Featurestores( + this.context + ); + this.hyperparameterTuningJobs = + new Resource$Projects$Locations$Hyperparametertuningjobs(this.context); + this.indexEndpoints = new Resource$Projects$Locations$Indexendpoints( + this.context + ); + this.indexes = new Resource$Projects$Locations$Indexes(this.context); + this.metadataStores = new Resource$Projects$Locations$Metadatastores( + this.context + ); + this.migratableResources = + new Resource$Projects$Locations$Migratableresources(this.context); + this.modelDeploymentMonitoringJobs = + new Resource$Projects$Locations$Modeldeploymentmonitoringjobs( + this.context + ); + this.modelMonitors = new Resource$Projects$Locations$Modelmonitors( + this.context + ); + this.models = new Resource$Projects$Locations$Models(this.context); + this.nasJobs = new Resource$Projects$Locations$Nasjobs(this.context); + this.notebookExecutionJobs = + new Resource$Projects$Locations$Notebookexecutionjobs(this.context); + this.notebookRuntimes = new Resource$Projects$Locations$Notebookruntimes( + this.context + ); + this.notebookRuntimeTemplates = + new Resource$Projects$Locations$Notebookruntimetemplates(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.persistentResources = + new Resource$Projects$Locations$Persistentresources(this.context); + this.pipelineJobs = new Resource$Projects$Locations$Pipelinejobs( + this.context + ); + this.publishers = new Resource$Projects$Locations$Publishers( + this.context + ); + this.reasoningEngines = new Resource$Projects$Locations$Reasoningengines( + this.context + ); + this.schedules = new Resource$Projects$Locations$Schedules(this.context); + this.solvers = new Resource$Projects$Locations$Solvers(this.context); + this.specialistPools = new Resource$Projects$Locations$Specialistpools( + this.context + ); + this.studies = new Resource$Projects$Locations$Studies(this.context); + this.tensorboards = new Resource$Projects$Locations$Tensorboards( + this.context + ); + this.trainingPipelines = + new Resource$Projects$Locations$Trainingpipelines(this.context); + } + + /** + * Gets information about a location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * 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). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Batchpredictionjobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( @@ -30351,7 +31361,7 @@ export namespace aiplatform_v1beta1 { */ featureOnlineStoreId?: string; /** - * Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}'` + * Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` */ parent?: string; @@ -41194,6 +42204,7 @@ export namespace aiplatform_v1beta1 { contexts: Resource$Projects$Locations$Metadatastores$Contexts; executions: Resource$Projects$Locations$Metadatastores$Executions; metadataSchemas: Resource$Projects$Locations$Metadatastores$Metadataschemas; + operations: Resource$Projects$Locations$Metadatastores$Operations; constructor(context: APIRequestContext) { this.context = context; this.artifacts = new Resource$Projects$Locations$Metadatastores$Artifacts( @@ -41208,6 +42219,8 @@ export namespace aiplatform_v1beta1 { new Resource$Projects$Locations$Metadatastores$Metadataschemas( this.context ); + this.operations = + new Resource$Projects$Locations$Metadatastores$Operations(this.context); } /** @@ -41637,8 +42650,13 @@ export namespace aiplatform_v1beta1 { export class Resource$Projects$Locations$Metadatastores$Artifacts { context: APIRequestContext; + operations: Resource$Projects$Locations$Metadatastores$Artifacts$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Metadatastores$Artifacts$Operations( + this.context + ); } /** @@ -42412,10 +43430,537 @@ export namespace aiplatform_v1beta1 { maxHops?: number; } + export class Resource$Projects$Locations$Metadatastores$Artifacts$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + export class Resource$Projects$Locations$Metadatastores$Contexts { context: APIRequestContext; + operations: Resource$Projects$Locations$Metadatastores$Contexts$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Metadatastores$Contexts$Operations( + this.context + ); } /** @@ -43476,44 +45021,571 @@ export namespace aiplatform_v1beta1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1Context; + requestBody?: Schema$GoogleCloudAiplatformV1beta1Context; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge + extends StandardParameters { + /** + * Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1PurgeContextsRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph + extends StandardParameters { + /** + * 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. + */ + context?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren + extends StandardParameters { + /** + * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + context?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest; + } + + export class Resource$Projects$Locations$Metadatastores$Contexts$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List extends StandardParameters { /** - * Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * The standard list filter. */ - parent?: string; - + filter?: string; /** - * Request body metadata + * The name of the operation's parent resource. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1PurgeContextsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph - extends StandardParameters { + name?: string; /** - * 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. + * The standard list page size. */ - context?: string; + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait extends StandardParameters { /** - * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * The name of the operation resource to wait on. */ - context?: string; - + name?: string; /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest; + timeout?: string; } export class Resource$Projects$Locations$Metadatastores$Executions { context: APIRequestContext; + operations: Resource$Projects$Locations$Metadatastores$Executions$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Metadatastores$Executions$Operations( + this.context + ); } /** @@ -44388,6 +46460,528 @@ export namespace aiplatform_v1beta1 { execution?: string; } + export class Resource$Projects$Locations$Metadatastores$Executions$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + export class Resource$Projects$Locations$Metadatastores$Metadataschemas { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -44726,6 +47320,528 @@ export namespace aiplatform_v1beta1 { parent?: string; } + export class Resource$Projects$Locations$Metadatastores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + export class Resource$Projects$Locations$Migratableresources { context: APIRequestContext; operations: Resource$Projects$Locations$Migratableresources$Operations; @@ -55537,6 +58653,10 @@ export namespace aiplatform_v1beta1 { * 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-/`. */ pipelineJobId?: string; + /** + * Optional. Whether to do component level validations before job creation. Currently we only support Google First Party Component/Pipelines. + */ + preflightValidations?: boolean; /** * Request body metadata @@ -56877,6 +59997,540 @@ export namespace aiplatform_v1beta1 { requestBody?: Schema$GoogleCloudAiplatformV1beta1GenerateContentRequest; } + export class Resource$Projects$Locations$Reasoningengines { + context: APIRequestContext; + operations: Resource$Projects$Locations$Reasoningengines$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Reasoningengines$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Reasoningengines$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + export class Resource$Projects$Locations$Schedules { context: APIRequestContext; operations: Resource$Projects$Locations$Schedules$Operations;