Method: projects.locations.studies.trials.complete

Marks a Trial as complete.

HTTP request

POST https://{service-endpoint}/v1beta1/{name}:complete

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

Path parameters

Parameters
name

string

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

Request body

The request body contains data with the following structure:

JSON representation
{
  "finalMeasurement": {
    object (Measurement)
  },
  "trialInfeasible": boolean,
  "infeasibleReason": string
}
Fields
finalMeasurement

object (Measurement)

Optional. If provided, it will be used as the completed Trial's finalMeasurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement

trialInfeasible

boolean

Optional. True if the Trial cannot be run with the given Parameter, and finalMeasurement will be ignored.

infeasibleReason

string

Optional. A human readable reason why the trial was infeasible. This should only be provided if trialInfeasible is true.

Response body

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

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 name resource:

  • aiplatform.trials.update

For more information, see the IAM documentation.