Method: projects.locations.studies.trials.suggest

Adds one or more Trials to a Study, with parameter values suggested by Vertex Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a [SuggestTrialsResponse][google.cloud.ml.v1.SuggestTrialsResponse].

HTTP request

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

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

Path parameters

Parameters
parent

string

Required. The project and location that the Study belongs to. Format: projects/{project}/locations/{location}/studies/{study}

Request body

The request body contains data with the following structure:

JSON representation
{
  "suggestionCount": integer,
  "clientId": string
}
Fields
suggestionCount

integer

Required. The number of suggestions requested.

clientId

string

Required. The identifier of the client that is requesting the suggestion.

If multiple SuggestTrialsRequests have the same clientId, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

Response body

If successful, the response body contains an instance of Operation.

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.create

For more information, see the IAM documentation.