Post v1+parenttrials — aiplatform

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB

projects

Adds a user provided Trial to a Study.

post/v1/{+parent}/trials

Path parameters

parentstring required

Required. The resource name of the Study to create the Trial in. Format: projects/{project}/locations/{location}/studies/{study}

Request body

customJobstring

Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.

webAccessUrisobject

Output only. URIs for accessing interactive shells (one URI for each training node). Only available if this trial is part of a HyperparameterTuningJob and the job's trial_job_spec.enable_web_access field is true. The keys are names of each node used for the trial; for example, workerpool0-0 for the primary node, workerpool1-0 for the first node in the second worker pool, and workerpool1-1 for the second node in the second worker pool. The values are the URIs for each node's interactive shell.

clientIdstring

Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.

startTimestring google-datetime

Output only. Time when the Trial was started.

endTimestring google-datetime

Output only. Time when the Trial's status changed to SUCCEEDED or INFEASIBLE.

namestring

Output only. Resource name of the Trial assigned by the service.

idstring

Output only. The identifier of the Trial assigned by the service.

infeasibleReasonstring

Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is INFEASIBLE.

Output only. The detailed state of the Trial.

Response

Successful response