Vertex AI API (aiplatform:v1beta1)

2025-05-28

19 new methods

Additions

    Methods
  • aiplatform.projects.locations.indexes.import

      Path : v1beta1/{+name}:import

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:import

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the Index resource to import data to. Format: `projects/{project}/locations/{location}/indexes/{index}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Imports an Index from an external source (e.g., BigQuery).

  • aiplatform.endpoints.predictLongRunning

      Path : v1beta1/{+endpoint}:predictLongRunning

      Flat Path : v1beta1/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 : v1beta1/{+endpoint}:fetchPredictOperation

      Flat Path : v1beta1/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 : v1beta1/{+endpoint}:predictLongRunning

      Flat Path : v1beta1/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 : v1beta1/{+endpoint}:fetchPredictOperation

      Flat Path : v1beta1/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 : v1beta1/{+name}:query

      Flat Path : v1beta1/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 : v1beta1/{+name}:streamQuery

      Flat Path : v1beta1/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 : v1beta1/reasoningEngines

      Flat Path : v1beta1/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 : v1beta1/{+name}

      Flat Path : v1beta1/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 : v1beta1/reasoningEngines

      Flat Path : v1beta1/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 : v1beta1/{+name}

      Flat Path : v1beta1/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 : v1beta1/{+name}

      Flat Path : v1beta1/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.

  • aiplatform.reasoningEngines.sessions.create

      Path : v1beta1/{+parent}/sessions

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

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The resource name of the location to create the session in. 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 : Creates a new Session.

  • aiplatform.reasoningEngines.sessions.get

      Path : v1beta1/{+name}

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}

      HTTP Method : GET

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets details of the specific Session.

  • aiplatform.reasoningEngines.sessions.list

      Path : v1beta1/{+parent}/sessions

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

      HTTP Method : GET

      Parameters :

        parent

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

          Pattern : ^reasoningEngines/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.

          Location : query

          Type : string

        filter

          Description : Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.

          Location : query

          Type : string

        orderBy

          Description : Optional. 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` Example: `create_time desc`.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Lists Sessions in a given reasoning engine.

  • aiplatform.reasoningEngines.sessions.patch

      Path : v1beta1/{+name}

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.

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

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Updates the specific Session.

  • aiplatform.reasoningEngines.sessions.delete

      Path : v1beta1/{+name}

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}

      HTTP Method : DELETE

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Deletes details of the specific Session.

  • aiplatform.reasoningEngines.sessions.appendEvent

      Path : v1beta1/{+name}:appendEvent

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Appends an event to a given session.

  • aiplatform.reasoningEngines.sessions.events.list

      Path : v1beta1/{+parent}/events

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

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

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Lists Events in a given session.