Agent Platform API (aiplatform:v1beta1)

2026-09-12

6 new methods

Additions

    Methods
  • aiplatform.projects.locations.monitoredAgents.clearTrainingData

      Parameter Order : name

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

      Description : Clears (purges) the trained model artifacts derived from a MonitoredAgent's data. The purged model is rebuilt by the next scheduled training run. To clear every MonitoredAgent in a location's scope, use the `-` wildcard agent segment for the name field: `projects/{project}/locations/{location}/monitoredAgents/-` This is the on-demand data-deletion path for customers who have deleted the underlying logs / observability data a model was trained on. It deletes only the derived model artifacts in the tenant project (it does NOT delete the scope, tenant project, or monitoring). To stop monitoring an agent entirely, disable it via DisableMonitoredAgent. See go/aad-clear-training-data.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:clearTrainingData

      Parameters :

        name

          Type : string

          Description : Required. The MonitoredAgent whose trained model artifacts to purge. Use the `-` wildcard agent segment to purge every MonitoredAgent in the scope. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`

          Required : Yes

          Location : path

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

      Path : v1beta1/{+name}:clearTrainingData

      HTTP Method : POST

  • aiplatform.projects.locations.evaluationExperiments.patch

      Parameter Order : name

      Parameters :

        updateMask

          Description : Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.

          Type : string

          Format : google-fieldmask

          Location : query

        name

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

          Location : path

          Type : string

          Required : Yes

          Description : Identifier. The resource name of the EvaluationExperiment. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`

      Path : v1beta1/{+name}

      Description : Updates an Evaluation Experiment.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationExperiments/{evaluationExperimentsId}

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

      HTTP Method : PATCH

  • aiplatform.projects.locations.evaluationExperiments.list

      Path : v1beta1/{+parent}/evaluationExperiments

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

      HTTP Method : GET

      Parameter Order : parent

      Parameters :

        pageSize

          Type : integer

          Location : query

          Description : Optional. The maximum number of Evaluation Experiments to return.

          Format : int32

        parent

          Type : string

          Location : path

          Required : Yes

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

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

        orderBy

          Location : query

          Description : Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.

          Type : string

        filter

          Type : string

          Location : query

          Description : Optional. Filter expression that matches a subset of the EvaluationExperiments to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).

        pageToken

          Location : query

          Description : Optional. A page token, received from a previous `ListEvaluationExperiments` call. Provide this to retrieve the subsequent page.

          Type : string

      Description : Lists Evaluation Experiments.

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

  • aiplatform.projects.locations.evaluationExperiments.delete

      Parameter Order : name

      HTTP Method : DELETE

      Description : Deletes an Evaluation Experiment.

      Parameters :

        name

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

          Location : path

          Description : Required. The name of the EvaluationExperiment resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationExperiments/{evaluation_experiment}`

          Required : Yes

          Type : string

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

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationExperiments/{evaluationExperimentsId}

      Path : v1beta1/{+name}

  • aiplatform.projects.locations.evaluationExperiments.create

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

      Path : v1beta1/{+parent}/evaluationExperiments

      HTTP Method : POST

      Parameter Order : parent

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

      Description : Creates an Evaluation Experiment.

      Parameters :

        parent

          Required : Yes

          Type : string

          Location : path

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

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

  • aiplatform.projects.locations.evaluationExperiments.get

      Parameter Order : name

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationExperiments/{evaluationExperimentsId}

      Parameters :

        name

          Location : path

          Type : string

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

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

          Required : Yes

      HTTP Method : GET

      Path : v1beta1/{+name}

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

      Description : Gets an Evaluation Experiment.