Method: projects.locations.studies.trials.listOptimalTrials

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

HTTP request

POST https://{service-endpoint}/v1beta1/{parent}/trials:listOptimalTrials

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The name of the Study that the optimal Trial belongs to.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for VizierService.ListOptimalTrials.

JSON representation
{
  "optimalTrials": [
    {
      object (Trial)
    }
  ]
}
Fields
optimalTrials[]

object (Trial)

The pareto-optimal Trials for multiple objective Study or the optimal trial for single objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.trials.list

For more information, see the IAM documentation.