- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface ModelEvaluationOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAnnotationSchemaUri()
public abstract String getAnnotationSchemaUri()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.
string annotation_schema_uri = 7;
| Returns | |
|---|---|
| Type | Description |
String | The annotationSchemaUri. |
getAnnotationSchemaUriBytes()
public abstract ByteString getAnnotationSchemaUriBytes()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.
string annotation_schema_uri = 7;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for annotationSchemaUri. |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Timestamp when this ModelEvaluation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp when this ModelEvaluation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getDataItemSchemaUri()
public abstract String getDataItemSchemaUri()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.
string data_item_schema_uri = 6;
| Returns | |
|---|---|
| Type | Description |
String | The dataItemSchemaUri. |
getDataItemSchemaUriBytes()
public abstract ByteString getDataItemSchemaUriBytes()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.
string data_item_schema_uri = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for dataItemSchemaUri. |
getDisplayName()
public abstract String getDisplayName()The display name of the ModelEvaluation.
string display_name = 10;
| Returns | |
|---|---|
| Type | Description |
String | The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()The display name of the ModelEvaluation.
string display_name = 10;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for displayName. |
getExplanationSpecs(int index)
public abstract ModelEvaluation.ModelEvaluationExplanationSpec getExplanationSpecs(int index)Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.
repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ModelEvaluation.ModelEvaluationExplanationSpec | |
getExplanationSpecsCount()
public abstract int getExplanationSpecsCount()Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.
repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
| Returns | |
|---|---|
| Type | Description |
int | |
getExplanationSpecsList()
public abstract List<ModelEvaluation.ModelEvaluationExplanationSpec> getExplanationSpecsList()Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.
repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
| Returns | |
|---|---|
| Type | Description |
List<ModelEvaluationExplanationSpec> | |
getExplanationSpecsOrBuilder(int index)
public abstract ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder getExplanationSpecsOrBuilder(int index)Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.
repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder | |
getExplanationSpecsOrBuilderList()
public abstract List<? extends ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder> getExplanationSpecsOrBuilderList()Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.
repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder> | |
getMetadata()
public abstract Value getMetadata()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".
.google.protobuf.Value metadata = 11;
| Returns | |
|---|---|
| Type | Description |
Value | The metadata. |
getMetadataOrBuilder()
public abstract ValueOrBuilder getMetadataOrBuilder()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".
.google.protobuf.Value metadata = 11;
| Returns | |
|---|---|
| Type | Description |
ValueOrBuilder | |
getMetrics()
public abstract Value getMetrics()Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri
.google.protobuf.Value metrics = 3;
| Returns | |
|---|---|
| Type | Description |
Value | The metrics. |
getMetricsOrBuilder()
public abstract ValueOrBuilder getMetricsOrBuilder()Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri
.google.protobuf.Value metrics = 3;
| Returns | |
|---|---|
| Type | Description |
ValueOrBuilder | |
getMetricsSchemaUri()
public abstract String getMetricsSchemaUri()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.
string metrics_schema_uri = 2;
| Returns | |
|---|---|
| Type | Description |
String | The metricsSchemaUri. |
getMetricsSchemaUriBytes()
public abstract ByteString getMetricsSchemaUriBytes()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.
string metrics_schema_uri = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for metricsSchemaUri. |
getModelExplanation()
public abstract ModelExplanation getModelExplanation()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.v1.ModelExplanation model_explanation = 8;
| Returns | |
|---|---|
| Type | Description |
ModelExplanation | The modelExplanation. |
getModelExplanationOrBuilder()
public abstract ModelExplanationOrBuilder getModelExplanationOrBuilder()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.v1.ModelExplanation model_explanation = 8;
| Returns | |
|---|---|
| Type | Description |
ModelExplanationOrBuilder | |
getName()
public abstract String getName()Output only. The resource name of the ModelEvaluation.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes()Output only. The resource name of the ModelEvaluation.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getSliceDimensions(int index)
public abstract String getSliceDimensions(int index) All possible dimensions of
ModelEvaluationSlices. The dimensions can be used as the filter of the
ModelService.ListModelEvaluationSlices
request, in the form of slice.dimension = <dimension>.
repeated string slice_dimensions = 5;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The sliceDimensions at the given index. |
getSliceDimensionsBytes(int index)
public abstract ByteString getSliceDimensionsBytes(int index) All possible dimensions of
ModelEvaluationSlices. The dimensions can be used as the filter of the
ModelService.ListModelEvaluationSlices
request, in the form of slice.dimension = <dimension>.
repeated string slice_dimensions = 5;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the sliceDimensions at the given index. |
getSliceDimensionsCount()
public abstract int getSliceDimensionsCount() All possible dimensions of
ModelEvaluationSlices. The dimensions can be used as the filter of the
ModelService.ListModelEvaluationSlices
request, in the form of slice.dimension = <dimension>.
repeated string slice_dimensions = 5;
| Returns | |
|---|---|
| Type | Description |
int | The count of sliceDimensions. |
getSliceDimensionsList()
public abstract List<String> getSliceDimensionsList() All possible dimensions of
ModelEvaluationSlices. The dimensions can be used as the filter of the
ModelService.ListModelEvaluationSlices
request, in the form of slice.dimension = <dimension>.
repeated string slice_dimensions = 5;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the sliceDimensions. |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Timestamp when this ModelEvaluation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the createTime field is set. |
hasMetadata()
public abstract boolean hasMetadata()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".
.google.protobuf.Value metadata = 11;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the metadata field is set. |
hasMetrics()
public abstract boolean hasMetrics()Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri
.google.protobuf.Value metrics = 3;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the metrics field is set. |
hasModelExplanation()
public abstract boolean hasModelExplanation()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.v1.ModelExplanation model_explanation = 8;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the modelExplanation field is set. |