Vertex AI API (aiplatform:v1beta1)

2026-04-05

8 new methods

Additions

    Methods
  • aiplatform.projects.locations.generateLossClusters

      Path : v1beta1/{+location}:generateLossClusters

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}:generateLossClusters

      HTTP Method : POST

      Parameters :

        location

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : location

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

      Description : Generates loss clusters from evaluation results. This is a statelss API method that would not modify the EvaluationSet resource.

  • aiplatform.projects.locations.onlineEvaluators.create

      Path : v1beta1/{+parent}/onlineEvaluators

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The parent resource where the OnlineEvaluator will be created. Format: projects/{project}/locations/{location}.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Creates an OnlineEvaluator in the given project and location.

  • aiplatform.projects.locations.onlineEvaluators.get

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the OnlineEvaluator to retrieve. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets details of an OnlineEvaluator.

  • aiplatform.projects.locations.onlineEvaluators.patch

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.

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

          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 fields of an OnlineEvaluator.

  • aiplatform.projects.locations.onlineEvaluators.delete

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the OnlineEvaluator to delete. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Deletes an OnlineEvaluator.

  • aiplatform.projects.locations.onlineEvaluators.list

      Path : v1beta1/{+parent}/onlineEvaluators

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent resource of the OnlineEvaluators to list. Format: projects/{project}/locations/{location}.

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

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. The maximum number of OnlineEvaluators to return. The service may return fewer than this value. If unspecified, at most 50 OnlineEvaluators will be returned. The maximum value is 100; values above 100 will be coerced to 100. Based on aip.dev/158.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A token identifying a page of results the server should return. Based on aip.dev/158.

          Location : query

          Type : string

        filter

          Description : Optional. Standard list filter. Supported fields: * `create_time` * `update_time` * `agent_resource` Example: `create_time>"2026-01-01T00:00:00-04:00"` where the timestamp is in RFC 3339 format) Based on aip.dev/160.

          Location : query

          Type : string

        orderBy

          Description : Optional. A comma-separated list of fields to order by. The default sorting order is ascending. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. Based on aip.dev/132.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Lists the OnlineEvaluators for the given project and location.

  • aiplatform.projects.locations.onlineEvaluators.activate

      Path : v1beta1/{+name}:activate

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}:activate

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the OnlineEvaluator to activate. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Activates an OnlineEvaluator.

  • aiplatform.projects.locations.onlineEvaluators.suspend

      Path : v1beta1/{+name}:suspend

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}:suspend

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the OnlineEvaluator to suspend. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations until it is activated again.