Vertex AI API (aiplatform:v1beta1)

2024-02-17

4 new methods

Additions

    Methods
  • aiplatform.projects.locations.evaluationTasks.operations.list

      Parameters :

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

        pageSize

          Location : query

          Format : int32

          Type : integer

          Description : The standard list page size.

        name

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

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

          Type : string

          Required : Yes

          Location : path

        filter

          Type : string

          Description : The standard list filter.

          Location : query

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations

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

      HTTP Method : GET

      Path : v1beta1/{+name}/operations

      Parameter Order : name

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

  • aiplatform.projects.locations.evaluationTasks.operations.get

      Parameter Order : name

      Parameters :

        name

          Location : path

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

          Description : The name of the operation resource.

          Required : Yes

          Type : string

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

      HTTP Method : 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.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}

      Path : v1beta1/{+name}

  • aiplatform.projects.locations.evaluationTasks.operations.delete

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

      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`.

      HTTP Method : DELETE

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}

      Path : v1beta1/{+name}

      Parameters :

        name

          Required : Yes

          Type : string

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

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

          Location : path

  • aiplatform.projects.locations.evaluationTasks.operations.wait

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}:wait

      Parameters :

        name

          Required : Yes

          Type : string

          Location : path

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

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

        timeout

          Type : string

          Format : google-duration

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

          Location : query

      Parameter Order : name

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

      Path : v1beta1/{+name}:wait

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

      HTTP Method : POST