com.google.cloud.aiplatform.v1beta1

Interface ModelEvaluationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ModelEvaluation, ModelEvaluation.Builder

public interface ModelEvaluationOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
ModelEvaluation.ModelEvaluationExplanationSpec	getExplanationSpecs(int index) Output only.
int	getExplanationSpecsCount() Output only.
List<ModelEvaluation.ModelEvaluationExplanationSpec>	getExplanationSpecsList() Output only.
ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder	getExplanationSpecsOrBuilder(int index) Output only.
List<? extends ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder>	getExplanationSpecsOrBuilderList() Output only.
com.google.protobuf.Value	getMetrics() Output only.
com.google.protobuf.ValueOrBuilder	getMetricsOrBuilder() Output only.
String	getMetricsSchemaUri() Output only.
com.google.protobuf.ByteString	getMetricsSchemaUriBytes() Output only.
ModelExplanation	getModelExplanation() Output only.
ModelExplanationOrBuilder	getModelExplanationOrBuilder() Output only.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
String	getSliceDimensions(int index) Output only.
com.google.protobuf.ByteString	getSliceDimensionsBytes(int index) Output only.
int	getSliceDimensionsCount() Output only.
List<String>	getSliceDimensionsList() Output only.
boolean	hasCreateTime() Output only.
boolean	hasMetrics() Output only.
boolean	hasModelExplanation() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. The resource name of the ModelEvaluation.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. The resource name of the ModelEvaluation.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for name.

getMetricsSchemaUri

String getMetricsSchemaUri()

 Output only. Points to a YAML file stored on Google Cloud Storage describing the
 [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics] of this ModelEvaluation. The schema is
 defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 

string metrics_schema_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The metricsSchemaUri.

getMetricsSchemaUriBytes

com.google.protobuf.ByteString getMetricsSchemaUriBytes()

 Output only. Points to a YAML file stored on Google Cloud Storage describing the
 [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics] of this ModelEvaluation. The schema is
 defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 

string metrics_schema_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for metricsSchemaUri.

hasMetrics

boolean hasMetrics()

 Output only. Evaluation metrics of the Model. The schema of the metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics_schema_uri]
 

.google.protobuf.Value metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the metrics field is set.

getMetrics

com.google.protobuf.Value getMetrics()

 Output only. Evaluation metrics of the Model. The schema of the metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics_schema_uri]
 

.google.protobuf.Value metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The metrics.

getMetricsOrBuilder

com.google.protobuf.ValueOrBuilder getMetricsOrBuilder()

 Output only. Evaluation metrics of the Model. The schema of the metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics_schema_uri]
 

.google.protobuf.Value metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when this ModelEvaluation was created.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when this ModelEvaluation was created.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when this ModelEvaluation was created.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

getSliceDimensionsList

List<String> getSliceDimensionsList()

 Output only. All possible [dimensions][ModelEvaluationSlice.slice.dimension] of
 ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices] request, in the form of
 `slice.dimension = <dimension>`.
 

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

A list containing the sliceDimensions.

getSliceDimensionsCount

int getSliceDimensionsCount()

 Output only. All possible [dimensions][ModelEvaluationSlice.slice.dimension] of
 ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices] request, in the form of
 `slice.dimension = <dimension>`.
 

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The count of sliceDimensions.

getSliceDimensions

String getSliceDimensions(int index)

 Output only. All possible [dimensions][ModelEvaluationSlice.slice.dimension] of
 ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices] request, in the form of
 `slice.dimension = <dimension>`.
 

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

index - The index of the element to return.

Returns:

The sliceDimensions at the given index.

getSliceDimensionsBytes

com.google.protobuf.ByteString getSliceDimensionsBytes(int index)

 Output only. All possible [dimensions][ModelEvaluationSlice.slice.dimension] of
 ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices] request, in the form of
 `slice.dimension = <dimension>`.
 

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the sliceDimensions at the given index.

hasModelExplanation

boolean hasModelExplanation()

 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 AutoML tabular Models.
 

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the modelExplanation field is set.

getModelExplanation

ModelExplanation getModelExplanation()

 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 AutoML tabular Models.
 

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The modelExplanation.

getModelExplanationOrBuilder

ModelExplanationOrBuilder getModelExplanationOrBuilder()

 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 AutoML tabular Models.
 

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

getExplanationSpecsList

List<ModelEvaluation.ModelEvaluationExplanationSpec> getExplanationSpecsList()

 Output only. Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are used for explaining
 the predicted values on the evaluated data.
 

repeated .google.cloud.aiplatform.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getExplanationSpecs

ModelEvaluation.ModelEvaluationExplanationSpec getExplanationSpecs(int index)

 Output only. Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are used for explaining
 the predicted values on the evaluated data.
 

repeated .google.cloud.aiplatform.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getExplanationSpecsCount

int getExplanationSpecsCount()

 Output only. Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are used for explaining
 the predicted values on the evaluated data.
 

repeated .google.cloud.aiplatform.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getExplanationSpecsOrBuilderList

List<? extends ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder> getExplanationSpecsOrBuilderList()

 Output only. Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are used for explaining
 the predicted values on the evaluated data.
 

repeated .google.cloud.aiplatform.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getExplanationSpecsOrBuilder

ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder getExplanationSpecsOrBuilder(int index)

 Output only. Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are used for explaining
 the predicted values on the evaluated data.
 

repeated .google.cloud.aiplatform.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];