Vertex AI API (aiplatform:v1)

2025-05-28

11 new methods

Additions

    Methods
  • aiplatform.endpoints.predictLongRunning

      Path : v1/{+endpoint}:predictLongRunning

      Flat Path : v1/endpoints/{endpointsId}:predictLongRunning

      HTTP Method : POST

      Parameters :

        endpoint

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

          Pattern : ^endpoints/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : endpoint

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
  • aiplatform.endpoints.fetchPredictOperation

      Path : v1/{+endpoint}:fetchPredictOperation

      Flat Path : v1/endpoints/{endpointsId}:fetchPredictOperation

      HTTP Method : POST

      Parameters :

        endpoint

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

          Pattern : ^endpoints/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : endpoint

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description : Fetch an asynchronous online prediction operation.

  • aiplatform.publishers.models.predictLongRunning

      Path : v1/{+endpoint}:predictLongRunning

      Flat Path : v1/publishers/{publishersId}/models/{modelsId}:predictLongRunning

      HTTP Method : POST

      Parameters :

        endpoint

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : endpoint

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
  • aiplatform.publishers.models.fetchPredictOperation

      Path : v1/{+endpoint}:fetchPredictOperation

      Flat Path : v1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation

      HTTP Method : POST

      Parameters :

        endpoint

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : endpoint

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description : Fetch an asynchronous online prediction operation.

  • aiplatform.reasoningEngines.query

      Path : v1/{+name}:query

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}:query

      HTTP Method : POST

      Parameters :

        name

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

          Pattern : ^reasoningEngines/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Queries using a reasoning engine.

  • aiplatform.reasoningEngines.streamQuery

      Path : v1/{+name}:streamQuery

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}:streamQuery

      HTTP Method : POST

      Parameters :

        name

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

          Pattern : ^reasoningEngines/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Streams queries using a reasoning engine.

  • aiplatform.reasoningEngines.create

      Path : v1/reasoningEngines

      Flat Path : v1/reasoningEngines

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`

          Location : query

          Type : string

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

      Description : Creates a reasoning engine.

  • aiplatform.reasoningEngines.get

      Path : v1/{+name}

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}

      HTTP Method : GET

      Parameters :

        name

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

          Pattern : ^reasoningEngines/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets a reasoning engine.

  • aiplatform.reasoningEngines.list

      Path : v1/reasoningEngines

      Flat Path : v1/reasoningEngines

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`

          Location : query

          Type : string

        filter

          Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).

          Location : query

          Type : string

        pageSize

          Description : Optional. The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. The standard list page token.

          Location : query

          Type : string

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

      Description : Lists reasoning engines in a location.

  • aiplatform.reasoningEngines.patch

      Path : v1/{+name}

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}

      HTTP Method : PATCH

      Parameters :

        name

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

          Pattern : ^reasoningEngines/[^/]+$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. Mask specifying which fields to update.

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Updates a reasoning engine.

  • aiplatform.reasoningEngines.delete

      Path : v1/{+name}

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}

      HTTP Method : DELETE

      Parameters :

        name

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

          Pattern : ^reasoningEngines/[^/]+$

          Location : path

          Required : Yes

          Type : string

        force

          Description : Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.

          Location : query

          Type : boolean

      Parameter Order : name

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

      Description : Deletes a reasoning engine.