GOgoogle
projects

POST /v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns

Creates an Evaluation Run.

Request

  • Base URL
    https://aiplatform.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required

Request body

completionTimestring google-datetime

Output only. Time when the evaluation run was completed.

createTimestring google-datetime

Output only. Time when the evaluation run was created.

displayNamestring

Required. The display name of the Evaluation Run.

evaluationSetSnapshotstring

Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset.

inferenceConfigsobject

Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters.

labelsobject

Optional. Labels for the evaluation run.

metadataunknown
namestring

Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}

serviceAccountstring

Optional. The service account to run the evaluation run as. If set, the run uses this service account to access Google Cloud resources. Access is limited to the IAM permissions that you grant to the service account. Must be provided if an inference config sets harbor_run_config, data_agent_config. If no inference config requires this field, setting it returns an error. The caller must have the iam.serviceAccounts.actAs permission on this service account, and the project's Vertex AI Service Agent must have the roles/iam.serviceAccountTokenCreator role on it.

state'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED' | 'INFERENCE' | 'GENERATING_RUBRICS' | 'GENERATING_LOSS_CLUSTERS'

Output only. The state of the evaluation run.

Response

Successful response

completionTimestring google-datetime

Output only. Time when the evaluation run was completed.

createTimestring google-datetime

Output only. Time when the evaluation run was created.

displayNamestring

Required. The display name of the Evaluation Run.

evaluationSetSnapshotstring

Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset.

inferenceConfigsobject

Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters.

labelsobject

Optional. Labels for the evaluation run.

metadataunknown
namestring

Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}

serviceAccountstring

Optional. The service account to run the evaluation run as. If set, the run uses this service account to access Google Cloud resources. Access is limited to the IAM permissions that you grant to the service account. Must be provided if an inference config sets harbor_run_config, data_agent_config. If no inference config requires this field, setting it returns an error. The caller must have the iam.serviceAccounts.actAs permission on this service account, and the project's Vertex AI Service Agent must have the roles/iam.serviceAccountTokenCreator role on it.

state'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED' | 'INFERENCE' | 'GENERATING_RUBRICS' | 'GENERATING_LOSS_CLUSTERS'

Output only. The state of the evaluation run.

Changes

No recorded changes to this operation across all 8 revisions of this API.