Vertex AI API (aiplatform:v1beta1)

2023-12-05

11 new methods

Additions

    Methods
  • aiplatform.projects.locations.notebookRuntimes.upgrade

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$

          Type: string

          Description: Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

          Required: Yes

          Location: path

      HTTP Method: POST

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade

      Description: Upgrades a NotebookRuntime.

      Parameter Order: name

      Path: v1beta1/{+name}:upgrade

  • aiplatform.projects.locations.publishers.models.streamGenerateContent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: model

      HTTP Method: POST

      Description: Generate content with multimodal inputs with streaming support.

      Path: v1beta1/{+model}:streamGenerateContent

      Parameters:

        model

          Description: Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`

          Location: path

          Required: Yes

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent

  • aiplatform.projects.locations.exampleStores.operations.list

      Parameters:

        pageSize

          Description: The standard list page size.

          Type: integer

          Location: query

          Format: int32

        name

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$

          Description: The name of the operation's parent resource.

          Location: path

        filter

          Description: The standard list filter.

          Type: string

          Location: query

        pageToken

          Description: The standard list page token.

          Type: string

          Location: query

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Path: v1beta1/{+name}/operations

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • aiplatform.projects.locations.exampleStores.operations.cancel

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+name}:cancel

      Parameter Order: name

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:cancel

      Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

      Parameters:

        name

          Required: Yes

          Description: The name of the operation resource to be cancelled.

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$

      HTTP Method: POST

  • aiplatform.projects.locations.exampleStores.operations.delete

      Path: v1beta1/{+name}

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}

      Parameter Order: name

      Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

      Parameters:

        name

          Required: Yes

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$

          Location: path

          Description: The name of the operation resource to be deleted.

      HTTP Method: DELETE

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • aiplatform.projects.locations.exampleStores.operations.get

      Parameter Order: name

      Parameters:

        name

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$

          Description: The name of the operation resource.

          Required: Yes

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}

      HTTP Method: GET

      Path: v1beta1/{+name}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

  • aiplatform.projects.locations.exampleStores.operations.wait

      Path: v1beta1/{+name}:wait

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:wait

      Parameters:

        name

          Location: path

          Required: Yes

          Type: string

          Description: The name of the operation resource to wait on.

          Pattern: ^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$

        timeout

          Type: string

          Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

          Location: query

          Format: google-duration

      HTTP Method: POST

      Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • aiplatform.projects.locations.pipelineJobs.batchCancel

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel

      Parameter Order: parent

      Path: v1beta1/{+parent}/pipelineJobs:batchCancel

      HTTP Method: POST

      Description: Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.

      Parameters:

        parent

          Location: path

          Required: Yes

          Type: string

          Description: Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`

          Pattern: ^projects/[^/]+/locations/[^/]+$

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • aiplatform.projects.locations.endpoints.streamGenerateContent

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent

      HTTP Method: POST

      Description: Generate content with multimodal inputs with streaming support.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+model}:streamGenerateContent

      Parameter Order: model

      Parameters:

        model

          Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$

          Description: Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`

          Location: path

          Required: Yes

          Type: string

  • aiplatform.projects.locations.endpoints.directPredict

      Description: Perform an unary online prediction request for Vertex first-party products and frameworks.

      Path: v1beta1/{+endpoint}:directPredict

      HTTP Method: POST

      Parameters:

        endpoint

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$

          Location: path

          Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`

          Type: string

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict

      Parameter Order: endpoint

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • aiplatform.projects.locations.endpoints.directRawPredict

      Parameters:

        endpoint

          Type: string

          Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`

          Required: Yes

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: endpoint

      HTTP Method: POST

      Description: Perform an online prediction request through gRPC.

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict

      Path: v1beta1/{+endpoint}:directRawPredict