evaluations

Creates, updates, deletes, gets or lists a evaluations resource.

Overview

Name	evaluations
Type	Resource
Id	google.aiplatform.evaluations

Fields

Name	Datatype	Description
name	string	Output only. The resource name of the ModelEvaluation.
annotationSchemaUri	string	Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.predictions, EvaluatedDataItemView.ground_truths, EvaluatedAnnotation.predictions, and EvaluatedAnnotation.ground_truths. The schema is defined as an OpenAPI 3.0.2 Schema Object. This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.
createTime	string	Output only. Timestamp when this ModelEvaluation was created.
dataItemSchemaUri	string	Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.data_item_payload and EvaluatedAnnotation.data_item_payload. The schema is defined as an OpenAPI 3.0.2 Schema Object. This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation.
displayName	string	The display name of the ModelEvaluation.
explanationSpecs	array	Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.
metadata	any	The metadata of the ModelEvaluation. For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a structured value with keys of "pipeline_job_id", "evaluation_dataset_type", "evaluation_dataset_path", "row_based_metrics_path".
metrics	any	Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri
metricsSchemaUri	string	Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object.
modelExplanation	object	Aggregated explanation metrics for a Model over a set of instances.
sliceDimensions	array	All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension = .

Methods

Name	Accessible by	Required Params	Description
get	SELECT	evaluationsId, locationsId, modelsId, projectsId	Gets a ModelEvaluation.
list	SELECT	locationsId, modelsId, projectsId	Lists ModelEvaluations in a Model.
import	EXEC	locationsId, modelsId, projectsId	Imports an externally generated ModelEvaluation.

SELECT examples

Lists ModelEvaluations in a Model.

SELECT
name,
annotationSchemaUri,
createTime,
dataItemSchemaUri,
displayName,
explanationSpecs,
metadata,
metrics,
metricsSchemaUri,
modelExplanation,
sliceDimensions
FROM google.aiplatform.evaluations
WHERE locationsId = '{{ locationsId }}'
AND modelsId = '{{ modelsId }}'
AND projectsId = '{{ projectsId }}';