Vertex AI API (aiplatform:v1beta1)

2025-06-22

26 new methods

Additions

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

      Path : v1beta1/{+name}/operations

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations

      HTTP Method : GET

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

      Parameter Order : name

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

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

  • aiplatform.projects.locations.evaluationItems.operations.get

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation resource.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : 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.evaluationItems.operations.delete

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}

      HTTP Method : DELETE

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

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

  • aiplatform.projects.locations.evaluationItems.operations.wait

      Path : v1beta1/{+name}:wait

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}:wait

      HTTP Method : POST

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

        timeout

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

          Location : query

          Type : string

          Format : google-duration

      Parameter Order : name

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

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

  • aiplatform.projects.locations.evaluationSets.operations.list

      Path : v1beta1/{+name}/operations

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations

      HTTP Method : GET

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

      Parameter Order : name

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

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

  • aiplatform.projects.locations.evaluationSets.operations.get

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation resource.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : 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.evaluationSets.operations.delete

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}

      HTTP Method : DELETE

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

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

  • aiplatform.projects.locations.evaluationSets.operations.wait

      Path : v1beta1/{+name}:wait

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}:wait

      HTTP Method : POST

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

        timeout

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

          Location : query

          Type : string

          Format : google-duration

      Parameter Order : name

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

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

  • aiplatform.projects.locations.evaluationRuns.operations.list

      Path : v1beta1/{+name}/operations

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations

      HTTP Method : GET

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

      Parameter Order : name

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

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

  • aiplatform.projects.locations.evaluationRuns.operations.get

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation resource.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : 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.evaluationRuns.operations.delete

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}

      HTTP Method : DELETE

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

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

  • aiplatform.projects.locations.evaluationRuns.operations.wait

      Path : v1beta1/{+name}:wait

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}:wait

      HTTP Method : POST

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

        timeout

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

          Location : query

          Type : string

          Format : google-duration

      Parameter Order : name

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

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

  • aiplatform.projects.locations.reasoningEngines.memories.create

      Path : v1beta1/{+parent}/memories

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Create a Memory.

  • aiplatform.projects.locations.reasoningEngines.memories.get

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Get a Memory.

  • aiplatform.projects.locations.reasoningEngines.memories.patch

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`

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

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Update a Memory.

  • aiplatform.projects.locations.reasoningEngines.memories.list

      Path : v1beta1/{+parent}/memories

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

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

          Location : path

          Required : Yes

          Type : string

        filter

          Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)

          Location : query

          Type : string

        pageSize

          Description : Optional. The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. The standard list page token.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : List Memories.

  • aiplatform.projects.locations.reasoningEngines.memories.delete

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Delete a Memory.

  • aiplatform.projects.locations.reasoningEngines.memories.generate

      Path : v1beta1/{+parent}/memories:generate

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:generate

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Generate memories.

  • aiplatform.projects.locations.reasoningEngines.memories.retrieve

      Path : v1beta1/{+parent}/memories:retrieve

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:retrieve

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Retrieve memories.

  • aiplatform.reasoningEngines.memories.create

      Path : v1beta1/{+parent}/memories

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/memories

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

          Pattern : ^reasoningEngines/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Create a Memory.

  • aiplatform.reasoningEngines.memories.get

      Path : v1beta1/{+name}

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`

          Pattern : ^reasoningEngines/[^/]+/memories/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Get a Memory.

  • aiplatform.reasoningEngines.memories.patch

      Path : v1beta1/{+name}

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`

          Pattern : ^reasoningEngines/[^/]+/memories/[^/]+$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Update a Memory.

  • aiplatform.reasoningEngines.memories.list

      Path : v1beta1/{+parent}/memories

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/memories

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

          Pattern : ^reasoningEngines/[^/]+$

          Location : path

          Required : Yes

          Type : string

        filter

          Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)

          Location : query

          Type : string

        pageSize

          Description : Optional. The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. The standard list page token.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : List Memories.

  • aiplatform.reasoningEngines.memories.delete

      Path : v1beta1/{+name}

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`

          Pattern : ^reasoningEngines/[^/]+/memories/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Delete a Memory.

  • aiplatform.reasoningEngines.memories.generate

      Path : v1beta1/{+parent}/memories:generate

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/memories:generate

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

          Pattern : ^reasoningEngines/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Generate memories.

  • aiplatform.reasoningEngines.memories.retrieve

      Path : v1beta1/{+parent}/memories:retrieve

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/memories:retrieve

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

          Pattern : ^reasoningEngines/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Retrieve memories.