Package com.google.cloud.aiplatform.v1

Interface ModelEvaluationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ModelEvaluation, ModelEvaluation.Builder
@Generated public interface ModelEvaluationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAnnotationSchemaUri()
    Points to a YAML file stored on Google Cloud Storage describing [EvaluatedDataItemView.predictions][], [EvaluatedDataItemView.ground_truths][], [EvaluatedAnnotation.predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions], and [EvaluatedAnnotation.ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
    com.google.protobuf.ByteString
    getAnnotationSchemaUriBytes()
    Points to a YAML file stored on Google Cloud Storage describing [EvaluatedDataItemView.predictions][], [EvaluatedDataItemView.ground_truths][], [EvaluatedAnnotation.predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions], and [EvaluatedAnnotation.ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
    com.google.protobuf.Timestamp
    getCreateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Output only.
    String
    getDataItemSchemaUri()
    Points to a YAML file stored on Google Cloud Storage describing [EvaluatedDataItemView.data_item_payload][] and [EvaluatedAnnotation.data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
    com.google.protobuf.ByteString
    getDataItemSchemaUriBytes()
    Points to a YAML file stored on Google Cloud Storage describing [EvaluatedDataItemView.data_item_payload][] and [EvaluatedAnnotation.data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
    String
    getDisplayName()
    The display name of the ModelEvaluation.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    The display name of the ModelEvaluation.
    ModelEvaluation.ModelEvaluationExplanationSpec
    getExplanationSpecs(int index)
    Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used for explaining the predicted values on the evaluated data.
    int
    getExplanationSpecsCount()
    Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used for explaining the predicted values on the evaluated data.
    List<ModelEvaluation.ModelEvaluationExplanationSpec>
    getExplanationSpecsList()
    Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used for explaining the predicted values on the evaluated data.
    ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder
    getExplanationSpecsOrBuilder(int index)
    Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used for explaining the predicted values on the evaluated data.
    List<? extends ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder>
    getExplanationSpecsOrBuilderList()
    Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used for explaining the predicted values on the evaluated data.
    com.google.protobuf.Value
    getMetadata()
    The metadata of the ModelEvaluation.
    com.google.protobuf.ValueOrBuilder
    getMetadataOrBuilder()
    The metadata of the ModelEvaluation.
    com.google.protobuf.Value
    getMetrics()
    Evaluation metrics of the Model.
    com.google.protobuf.ValueOrBuilder
    getMetricsOrBuilder()
    Evaluation metrics of the Model.
    String
    getMetricsSchemaUri()
    Points to a YAML file stored on Google Cloud Storage describing the [metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this ModelEvaluation.
    com.google.protobuf.ByteString
    getMetricsSchemaUriBytes()
    Points to a YAML file stored on Google Cloud Storage describing the [metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this ModelEvaluation.
    ModelExplanation
    getModelExplanation()
    Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses.
    ModelExplanationOrBuilder
    getModelExplanationOrBuilder()
    Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses.
    String
    getName()
    Output only.
    com.google.protobuf.ByteString
    getNameBytes()
    Output only.
    String
    getSliceDimensions(int index)
    All possible [dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension] of ModelEvaluationSlices.
    com.google.protobuf.ByteString
    getSliceDimensionsBytes(int index)
    All possible [dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension] of ModelEvaluationSlices.
    int
    getSliceDimensionsCount()
    All possible [dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension] of ModelEvaluationSlices.
    List<String>
    getSliceDimensionsList()
    All possible [dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension] of ModelEvaluationSlices.
    boolean
    hasCreateTime()
    Output only.
    boolean
    hasMetadata()
    The metadata of the ModelEvaluation.
    boolean
    hasMetrics()
    Evaluation metrics of the Model.
    boolean
    hasModelExplanation()
    Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • 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.

    • getDisplayName

      String getDisplayName()
       The display name of the ModelEvaluation.
      string display_name = 10;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       The display name of the ModelEvaluation.
      string display_name = 10;
      Returns:
      The bytes for displayName.

    • getMetricsSchemaUri

      String getMetricsSchemaUri()
       Points to a YAML file stored on Google Cloud Storage describing the
 [metrics][google.cloud.aiplatform.v1.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;
      Returns:
      The metricsSchemaUri.

    • getMetricsSchemaUriBytes

      com.google.protobuf.ByteString getMetricsSchemaUriBytes()
       Points to a YAML file stored on Google Cloud Storage describing the
 [metrics][google.cloud.aiplatform.v1.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;
      Returns:
      The bytes for metricsSchemaUri.

    • hasMetrics

      boolean hasMetrics()
       Evaluation metrics of the Model. The schema of the metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.metrics_schema_uri]
      .google.protobuf.Value metrics = 3;
      Returns:
      Whether the metrics field is set.

    • getMetrics

      com.google.protobuf.Value getMetrics()
       Evaluation metrics of the Model. The schema of the metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.metrics_schema_uri]
      .google.protobuf.Value metrics = 3;
      Returns:
      The metrics.

    • getMetricsOrBuilder

      com.google.protobuf.ValueOrBuilder getMetricsOrBuilder()
       Evaluation metrics of the Model. The schema of the metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluation.metrics_schema_uri]
      .google.protobuf.Value metrics = 3;

    • 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()
       All possible
 [dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension]
 of ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
 request, in the form of `slice.dimension = <dimension>`.
      repeated string slice_dimensions = 5;
      Returns:
      A list containing the sliceDimensions.

    • getSliceDimensionsCount

      int getSliceDimensionsCount()
       All possible
 [dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension]
 of ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
 request, in the form of `slice.dimension = <dimension>`.
      repeated string slice_dimensions = 5;
      Returns:
      The count of sliceDimensions.

    • getSliceDimensions

      String getSliceDimensions(int index)
       All possible
 [dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension]
 of ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
 request, in the form of `slice.dimension = <dimension>`.
      repeated string slice_dimensions = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The sliceDimensions at the given index.

    • getSliceDimensionsBytes

      com.google.protobuf.ByteString getSliceDimensionsBytes(int index)
       All possible
 [dimensions][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.dimension]
 of ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]
 request, in the form of `slice.dimension = <dimension>`.
      repeated string slice_dimensions = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the sliceDimensions at the given index.

    • getDataItemSchemaUri

      String getDataItemSchemaUri()
       Points to a YAML file stored on Google Cloud Storage describing
 [EvaluatedDataItemView.data_item_payload][] and
 [EvaluatedAnnotation.data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
 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).

 This field is not populated if there are neither EvaluatedDataItemViews nor
 EvaluatedAnnotations under this ModelEvaluation.
      string data_item_schema_uri = 6;
      Returns:
      The dataItemSchemaUri.

    • getDataItemSchemaUriBytes

      com.google.protobuf.ByteString getDataItemSchemaUriBytes()
       Points to a YAML file stored on Google Cloud Storage describing
 [EvaluatedDataItemView.data_item_payload][] and
 [EvaluatedAnnotation.data_item_payload][google.cloud.aiplatform.v1.EvaluatedAnnotation.data_item_payload].
 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).

 This field is not populated if there are neither EvaluatedDataItemViews nor
 EvaluatedAnnotations under this ModelEvaluation.
      string data_item_schema_uri = 6;
      Returns:
      The bytes for dataItemSchemaUri.

    • getAnnotationSchemaUri

      String getAnnotationSchemaUri()
       Points to a YAML file stored on Google Cloud Storage describing
 [EvaluatedDataItemView.predictions][],
 [EvaluatedDataItemView.ground_truths][],
 [EvaluatedAnnotation.predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions],
 and
 [EvaluatedAnnotation.ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
 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).

 This field is not populated if there are neither EvaluatedDataItemViews nor
 EvaluatedAnnotations under this ModelEvaluation.
      string annotation_schema_uri = 7;
      Returns:
      The annotationSchemaUri.

    • getAnnotationSchemaUriBytes

      com.google.protobuf.ByteString getAnnotationSchemaUriBytes()
       Points to a YAML file stored on Google Cloud Storage describing
 [EvaluatedDataItemView.predictions][],
 [EvaluatedDataItemView.ground_truths][],
 [EvaluatedAnnotation.predictions][google.cloud.aiplatform.v1.EvaluatedAnnotation.predictions],
 and
 [EvaluatedAnnotation.ground_truths][google.cloud.aiplatform.v1.EvaluatedAnnotation.ground_truths].
 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).

 This field is not populated if there are neither EvaluatedDataItemViews nor
 EvaluatedAnnotations under this ModelEvaluation.
      string annotation_schema_uri = 7;
      Returns:
      The bytes for annotationSchemaUri.

    • hasModelExplanation

      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:
      Whether the modelExplanation field is set.

    • getModelExplanation

      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:
      The modelExplanation.

    • getModelExplanationOrBuilder

      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;

    • getExplanationSpecsList

      List<ModelEvaluation.ModelEvaluationExplanationSpec> getExplanationSpecsList()
       Describes the values of
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used
 for explaining the predicted values on the evaluated data.
      repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;

    • getExplanationSpecs

      ModelEvaluation.ModelEvaluationExplanationSpec getExplanationSpecs(int index)
       Describes the values of
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used
 for explaining the predicted values on the evaluated data.
      repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;

    • getExplanationSpecsCount

      int getExplanationSpecsCount()
       Describes the values of
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used
 for explaining the predicted values on the evaluated data.
      repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;

    • getExplanationSpecsOrBuilderList

      List<? extends ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder> getExplanationSpecsOrBuilderList()
       Describes the values of
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used
 for explaining the predicted values on the evaluated data.
      repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;

    • getExplanationSpecsOrBuilder

      ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder getExplanationSpecsOrBuilder(int index)
       Describes the values of
 [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used
 for explaining the predicted values on the evaluated data.
      repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;

    • hasMetadata

      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", "row_based_metrics_path".
      .google.protobuf.Value metadata = 11;
      Returns:
      Whether the metadata field is set.

    • getMetadata

      com.google.protobuf.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", "row_based_metrics_path".
      .google.protobuf.Value metadata = 11;
      Returns:
      The metadata.

    • getMetadataOrBuilder

      com.google.protobuf.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", "row_based_metrics_path".
      .google.protobuf.Value metadata = 11;