Class ModelEvaluation.Builder

  • All Implemented Interfaces:
    ModelEvaluationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ModelEvaluation

    public static final class ModelEvaluation.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
    implements ModelEvaluationOrBuilder
     A collection of metrics calculated by comparing Model's predictions on all of
     the test data against annotations from the test data.
     
    Protobuf type google.cloud.aiplatform.v1beta1.ModelEvaluation
    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
      • clear

        public ModelEvaluation.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
      • getDefaultInstanceForType

        public ModelEvaluation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public ModelEvaluation build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public ModelEvaluation buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public ModelEvaluation.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
      • setField

        public ModelEvaluation.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
      • clearField

        public ModelEvaluation.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
      • clearOneof

        public ModelEvaluation.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
      • setRepeatedField

        public ModelEvaluation.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        int index,
                                                        Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
      • addRepeatedField

        public ModelEvaluation.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
      • mergeFrom

        public ModelEvaluation.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ModelEvaluation.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
      • mergeFrom

        public ModelEvaluation.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ModelEvaluation.Builder>
        Throws:
        IOException
      • getName

        public String getName()
         Output only. The resource name of the ModelEvaluation.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface ModelEvaluationOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the ModelEvaluation.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface ModelEvaluationOrBuilder
        Returns:
        The bytes for name.
      • setName

        public ModelEvaluation.Builder setName​(String value)
         Output only. The resource name of the ModelEvaluation.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.
      • clearName

        public ModelEvaluation.Builder clearName()
         Output only. The resource name of the ModelEvaluation.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setNameBytes

        public ModelEvaluation.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Output only. The resource name of the ModelEvaluation.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.
      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         The display name of the ModelEvaluation.
         
        string display_name = 10;
        Specified by:
        getDisplayNameBytes in interface ModelEvaluationOrBuilder
        Returns:
        The bytes for displayName.
      • setDisplayName

        public ModelEvaluation.Builder setDisplayName​(String value)
         The display name of the ModelEvaluation.
         
        string display_name = 10;
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.
      • clearDisplayName

        public ModelEvaluation.Builder clearDisplayName()
         The display name of the ModelEvaluation.
         
        string display_name = 10;
        Returns:
        This builder for chaining.
      • setDisplayNameBytes

        public ModelEvaluation.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         The display name of the ModelEvaluation.
         
        string display_name = 10;
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.
      • getMetricsSchemaUri

        public String getMetricsSchemaUri()
         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;
        Specified by:
        getMetricsSchemaUri in interface ModelEvaluationOrBuilder
        Returns:
        The metricsSchemaUri.
      • getMetricsSchemaUriBytes

        public com.google.protobuf.ByteString getMetricsSchemaUriBytes()
         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;
        Specified by:
        getMetricsSchemaUriBytes in interface ModelEvaluationOrBuilder
        Returns:
        The bytes for metricsSchemaUri.
      • setMetricsSchemaUri

        public ModelEvaluation.Builder setMetricsSchemaUri​(String value)
         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;
        Parameters:
        value - The metricsSchemaUri to set.
        Returns:
        This builder for chaining.
      • clearMetricsSchemaUri

        public ModelEvaluation.Builder clearMetricsSchemaUri()
         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;
        Returns:
        This builder for chaining.
      • setMetricsSchemaUriBytes

        public ModelEvaluation.Builder setMetricsSchemaUriBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for metricsSchemaUri to set.
        Returns:
        This builder for chaining.
      • hasMetrics

        public boolean hasMetrics()
         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;
        Specified by:
        hasMetrics in interface ModelEvaluationOrBuilder
        Returns:
        Whether the metrics field is set.
      • getMetrics

        public com.google.protobuf.Value getMetrics()
         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;
        Specified by:
        getMetrics in interface ModelEvaluationOrBuilder
        Returns:
        The metrics.
      • setMetrics

        public ModelEvaluation.Builder setMetrics​(com.google.protobuf.Value value)
         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;
      • setMetrics

        public ModelEvaluation.Builder setMetrics​(com.google.protobuf.Value.Builder builderForValue)
         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;
      • mergeMetrics

        public ModelEvaluation.Builder mergeMetrics​(com.google.protobuf.Value value)
         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;
      • clearMetrics

        public ModelEvaluation.Builder clearMetrics()
         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;
      • getMetricsBuilder

        public com.google.protobuf.Value.Builder getMetricsBuilder()
         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;
      • getMetricsOrBuilder

        public com.google.protobuf.ValueOrBuilder getMetricsOrBuilder()
         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;
        Specified by:
        getMetricsOrBuilder in interface ModelEvaluationOrBuilder
      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this ModelEvaluation was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ModelEvaluationOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public 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];
        Specified by:
        getCreateTime in interface ModelEvaluationOrBuilder
        Returns:
        The createTime.
      • setCreateTime

        public ModelEvaluation.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         Output only. Timestamp when this ModelEvaluation was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • setCreateTime

        public ModelEvaluation.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. Timestamp when this ModelEvaluation was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • mergeCreateTime

        public ModelEvaluation.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         Output only. Timestamp when this ModelEvaluation was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • clearCreateTime

        public ModelEvaluation.Builder clearCreateTime()
         Output only. Timestamp when this ModelEvaluation was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         Output only. Timestamp when this ModelEvaluation was created.
         
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      • getCreateTimeOrBuilder

        public 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];
        Specified by:
        getCreateTimeOrBuilder in interface ModelEvaluationOrBuilder
      • getSliceDimensionsList

        public com.google.protobuf.ProtocolStringList getSliceDimensionsList()
         All possible
         [dimensions][google.cloud.aiplatform.v1beta1.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;
        Specified by:
        getSliceDimensionsList in interface ModelEvaluationOrBuilder
        Returns:
        A list containing the sliceDimensions.
      • getSliceDimensionsCount

        public int getSliceDimensionsCount()
         All possible
         [dimensions][google.cloud.aiplatform.v1beta1.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;
        Specified by:
        getSliceDimensionsCount in interface ModelEvaluationOrBuilder
        Returns:
        The count of sliceDimensions.
      • getSliceDimensions

        public String getSliceDimensions​(int index)
         All possible
         [dimensions][google.cloud.aiplatform.v1beta1.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;
        Specified by:
        getSliceDimensions in interface ModelEvaluationOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The sliceDimensions at the given index.
      • getSliceDimensionsBytes

        public com.google.protobuf.ByteString getSliceDimensionsBytes​(int index)
         All possible
         [dimensions][google.cloud.aiplatform.v1beta1.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;
        Specified by:
        getSliceDimensionsBytes in interface ModelEvaluationOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the sliceDimensions at the given index.
      • setSliceDimensions

        public ModelEvaluation.Builder setSliceDimensions​(int index,
                                                          String value)
         All possible
         [dimensions][google.cloud.aiplatform.v1beta1.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;
        Parameters:
        index - The index to set the value at.
        value - The sliceDimensions to set.
        Returns:
        This builder for chaining.
      • addSliceDimensions

        public ModelEvaluation.Builder addSliceDimensions​(String value)
         All possible
         [dimensions][google.cloud.aiplatform.v1beta1.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;
        Parameters:
        value - The sliceDimensions to add.
        Returns:
        This builder for chaining.
      • addAllSliceDimensions

        public ModelEvaluation.Builder addAllSliceDimensions​(Iterable<String> values)
         All possible
         [dimensions][google.cloud.aiplatform.v1beta1.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;
        Parameters:
        values - The sliceDimensions to add.
        Returns:
        This builder for chaining.
      • clearSliceDimensions

        public ModelEvaluation.Builder clearSliceDimensions()
         All possible
         [dimensions][google.cloud.aiplatform.v1beta1.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;
        Returns:
        This builder for chaining.
      • addSliceDimensionsBytes

        public ModelEvaluation.Builder addSliceDimensionsBytes​(com.google.protobuf.ByteString value)
         All possible
         [dimensions][google.cloud.aiplatform.v1beta1.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;
        Parameters:
        value - The bytes of the sliceDimensions to add.
        Returns:
        This builder for chaining.
      • hasModelExplanation

        public 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.v1beta1.ModelExplanation model_explanation = 8;
        Specified by:
        hasModelExplanation in interface ModelEvaluationOrBuilder
        Returns:
        Whether the modelExplanation field is set.
      • getModelExplanation

        public 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.v1beta1.ModelExplanation model_explanation = 8;
        Specified by:
        getModelExplanation in interface ModelEvaluationOrBuilder
        Returns:
        The modelExplanation.
      • setModelExplanation

        public ModelEvaluation.Builder setModelExplanation​(ModelExplanation value)
         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;
      • setModelExplanation

        public ModelEvaluation.Builder setModelExplanation​(ModelExplanation.Builder builderForValue)
         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;
      • mergeModelExplanation

        public ModelEvaluation.Builder mergeModelExplanation​(ModelExplanation value)
         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;
      • clearModelExplanation

        public ModelEvaluation.Builder clearModelExplanation()
         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;
      • getModelExplanationBuilder

        public ModelExplanation.Builder getModelExplanationBuilder()
         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;
      • getModelExplanationOrBuilder

        public 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.v1beta1.ModelExplanation model_explanation = 8;
        Specified by:
        getModelExplanationOrBuilder in interface ModelEvaluationOrBuilder
      • getExplanationSpecsCount

        public int getExplanationSpecsCount()
         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;
        Specified by:
        getExplanationSpecsCount in interface ModelEvaluationOrBuilder
      • getExplanationSpecs

        public ModelEvaluation.ModelEvaluationExplanationSpec getExplanationSpecs​(int index)
         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;
        Specified by:
        getExplanationSpecs in interface ModelEvaluationOrBuilder
      • setExplanationSpecs

        public ModelEvaluation.Builder setExplanationSpecs​(int index,
                                                           ModelEvaluation.ModelEvaluationExplanationSpec value)
         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;
      • setExplanationSpecs

        public ModelEvaluation.Builder setExplanationSpecs​(int index,
                                                           ModelEvaluation.ModelEvaluationExplanationSpec.Builder builderForValue)
         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;
      • addExplanationSpecs

        public ModelEvaluation.Builder addExplanationSpecs​(ModelEvaluation.ModelEvaluationExplanationSpec value)
         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;
      • addExplanationSpecs

        public ModelEvaluation.Builder addExplanationSpecs​(int index,
                                                           ModelEvaluation.ModelEvaluationExplanationSpec value)
         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;
      • addExplanationSpecs

        public ModelEvaluation.Builder addExplanationSpecs​(ModelEvaluation.ModelEvaluationExplanationSpec.Builder builderForValue)
         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;
      • addExplanationSpecs

        public ModelEvaluation.Builder addExplanationSpecs​(int index,
                                                           ModelEvaluation.ModelEvaluationExplanationSpec.Builder builderForValue)
         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;
      • addAllExplanationSpecs

        public ModelEvaluation.Builder addAllExplanationSpecs​(Iterable<? extends ModelEvaluation.ModelEvaluationExplanationSpec> values)
         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;
      • clearExplanationSpecs

        public ModelEvaluation.Builder clearExplanationSpecs()
         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;
      • removeExplanationSpecs

        public ModelEvaluation.Builder removeExplanationSpecs​(int index)
         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;
      • getExplanationSpecsBuilder

        public ModelEvaluation.ModelEvaluationExplanationSpec.Builder getExplanationSpecsBuilder​(int index)
         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;
      • addExplanationSpecsBuilder

        public ModelEvaluation.ModelEvaluationExplanationSpec.Builder addExplanationSpecsBuilder()
         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;
      • addExplanationSpecsBuilder

        public ModelEvaluation.ModelEvaluationExplanationSpec.Builder addExplanationSpecsBuilder​(int index)
         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;
      • getExplanationSpecsBuilderList

        public List<ModelEvaluation.ModelEvaluationExplanationSpec.Builder> getExplanationSpecsBuilderList()
         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;
      • hasMetadata

        public 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;
        Specified by:
        hasMetadata in interface ModelEvaluationOrBuilder
        Returns:
        Whether the metadata field is set.
      • getMetadata

        public 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".
         
        .google.protobuf.Value metadata = 11;
        Specified by:
        getMetadata in interface ModelEvaluationOrBuilder
        Returns:
        The metadata.
      • setMetadata

        public ModelEvaluation.Builder setMetadata​(com.google.protobuf.Value value)
         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;
      • setMetadata

        public ModelEvaluation.Builder setMetadata​(com.google.protobuf.Value.Builder builderForValue)
         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;
      • mergeMetadata

        public ModelEvaluation.Builder mergeMetadata​(com.google.protobuf.Value value)
         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;
      • clearMetadata

        public ModelEvaluation.Builder clearMetadata()
         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;
      • getMetadataBuilder

        public com.google.protobuf.Value.Builder getMetadataBuilder()
         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;
      • getMetadataOrBuilder

        public 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".
         
        .google.protobuf.Value metadata = 11;
        Specified by:
        getMetadataOrBuilder in interface ModelEvaluationOrBuilder
      • hasBiasConfigs

        public boolean hasBiasConfigs()
         Specify the configuration for bias detection.
         
        .google.cloud.aiplatform.v1beta1.ModelEvaluation.BiasConfig bias_configs = 12;
        Specified by:
        hasBiasConfigs in interface ModelEvaluationOrBuilder
        Returns:
        Whether the biasConfigs field is set.
      • clearBiasConfigs

        public ModelEvaluation.Builder clearBiasConfigs()
         Specify the configuration for bias detection.
         
        .google.cloud.aiplatform.v1beta1.ModelEvaluation.BiasConfig bias_configs = 12;
      • getBiasConfigsBuilder

        public ModelEvaluation.BiasConfig.Builder getBiasConfigsBuilder()
         Specify the configuration for bias detection.
         
        .google.cloud.aiplatform.v1beta1.ModelEvaluation.BiasConfig bias_configs = 12;
      • setUnknownFields

        public final ModelEvaluation.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>
      • mergeUnknownFields

        public final ModelEvaluation.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluation.Builder>