slices

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

Overview

Name	slices
Type	Resource
Id	google.aiplatform.slices

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the ModelEvaluationSlice.
createTime	string (google-datetime)	Output only. Timestamp when this ModelEvaluationSlice was created.
metrics	any	Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri
metricsSchemaUri	string	Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.
modelExplanation	object	Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for tabular Models. (id: GoogleCloudAiplatformV1ModelExplanation)
slice	object	Output only. The slice of the test data that is used to evaluate the Model. (id: GoogleCloudAiplatformV1ModelEvaluationSliceSlice)

list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the ModelEvaluationSlice.
createTime	string (google-datetime)	Output only. Timestamp when this ModelEvaluationSlice was created.
metrics	any	Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri
metricsSchemaUri	string	Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.
modelExplanation	object	Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for tabular Models. (id: GoogleCloudAiplatformV1ModelExplanation)
slice	object	Output only. The slice of the test data that is used to evaluate the Model. (id: GoogleCloudAiplatformV1ModelEvaluationSliceSlice)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, modelsId, evaluationsId, slicesId		Gets a ModelEvaluationSlice.
list	select	projectsId, locationsId, modelsId, evaluationsId	filter, pageSize, pageToken, readMask	Lists ModelEvaluationSlices in a ModelEvaluation.
batch_import	exec	projectsId, locationsId, modelsId, evaluationsId, slicesId		Imports a list of externally generated EvaluatedAnnotations.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
evaluationsId	string
locationsId	string
modelsId	string
projectsId	string
slicesId	string
filter	string
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)

SELECT examples

get

Gets a ModelEvaluationSlice.

SELECT
name,
createTime,
metrics,
metricsSchemaUri,
modelExplanation,
slice
FROM google.aiplatform.slices
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND modelsId = '{{ modelsId }}' -- required
AND evaluationsId = '{{ evaluationsId }}' -- required
AND slicesId = '{{ slicesId }}' -- required;

list

Lists ModelEvaluationSlices in a ModelEvaluation.

SELECT
name,
createTime,
metrics,
metricsSchemaUri,
modelExplanation,
slice
FROM google.aiplatform.slices
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND modelsId = '{{ modelsId }}' -- required
AND evaluationsId = '{{ evaluationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND readMask = '{{ readMask }}';

Lifecycle Methods

batch_import

Imports a list of externally generated EvaluatedAnnotations.

EXEC google.aiplatform.slices.batch_import 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@modelsId='{{ modelsId }}' --required, 
@evaluationsId='{{ evaluationsId }}' --required, 
@slicesId='{{ slicesId }}' --required 
@@json=
'{
"evaluatedAnnotations": "{{ evaluatedAnnotations }}"
}';