Package com.google.cloud.automl.v1

Class ModelEvaluation

  • All Implemented Interfaces:
    ModelEvaluationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ModelEvaluation
extends com.google.protobuf.GeneratedMessageV3
implements ModelEvaluationOrBuilder
     Evaluation results of a model.
    Protobuf type google.cloud.automl.v1.ModelEvaluation
    See Also:
    Serialized Form

    • Field Detail

      • CLASSIFICATION_EVALUATION_METRICS_FIELD_NUMBER

        public static final int CLASSIFICATION_EVALUATION_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSLATION_EVALUATION_METRICS_FIELD_NUMBER

        public static final int TRANSLATION_EVALUATION_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IMAGE_OBJECT_DETECTION_EVALUATION_METRICS_FIELD_NUMBER

        public static final int IMAGE_OBJECT_DETECTION_EVALUATION_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEXT_SENTIMENT_EVALUATION_METRICS_FIELD_NUMBER

        public static final int TEXT_SENTIMENT_EVALUATION_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEXT_EXTRACTION_EVALUATION_METRICS_FIELD_NUMBER

        public static final int TEXT_EXTRACTION_EVALUATION_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ANNOTATION_SPEC_ID_FIELD_NUMBER

        public static final int ANNOTATION_SPEC_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EVALUATED_EXAMPLE_COUNT_FIELD_NUMBER

        public static final int EVALUATED_EXAMPLE_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • hasClassificationEvaluationMetrics

        public boolean hasClassificationEvaluationMetrics()
         Model evaluation metrics for image, text, video and tables
 classification.
 Tables problem is considered a classification when the target column
 is CATEGORY DataType.
        .google.cloud.automl.v1.ClassificationEvaluationMetrics classification_evaluation_metrics = 8;
        Specified by:
        hasClassificationEvaluationMetrics in interface ModelEvaluationOrBuilder
        Returns:
        Whether the classificationEvaluationMetrics field is set.

      • getClassificationEvaluationMetrics

        public ClassificationEvaluationMetrics getClassificationEvaluationMetrics()
         Model evaluation metrics for image, text, video and tables
 classification.
 Tables problem is considered a classification when the target column
 is CATEGORY DataType.
        .google.cloud.automl.v1.ClassificationEvaluationMetrics classification_evaluation_metrics = 8;
        Specified by:
        getClassificationEvaluationMetrics in interface ModelEvaluationOrBuilder
        Returns:
        The classificationEvaluationMetrics.

      • hasTranslationEvaluationMetrics

        public boolean hasTranslationEvaluationMetrics()
         Model evaluation metrics for translation.
        .google.cloud.automl.v1.TranslationEvaluationMetrics translation_evaluation_metrics = 9;
        Specified by:
        hasTranslationEvaluationMetrics in interface ModelEvaluationOrBuilder
        Returns:
        Whether the translationEvaluationMetrics field is set.

      • hasImageObjectDetectionEvaluationMetrics

        public boolean hasImageObjectDetectionEvaluationMetrics()
         Model evaluation metrics for image object detection.
        .google.cloud.automl.v1.ImageObjectDetectionEvaluationMetrics image_object_detection_evaluation_metrics = 12;
        Specified by:
        hasImageObjectDetectionEvaluationMetrics in interface ModelEvaluationOrBuilder
        Returns:
        Whether the imageObjectDetectionEvaluationMetrics field is set.

      • hasTextSentimentEvaluationMetrics

        public boolean hasTextSentimentEvaluationMetrics()
         Evaluation metrics for text sentiment models.
        .google.cloud.automl.v1.TextSentimentEvaluationMetrics text_sentiment_evaluation_metrics = 11;
        Specified by:
        hasTextSentimentEvaluationMetrics in interface ModelEvaluationOrBuilder
        Returns:
        Whether the textSentimentEvaluationMetrics field is set.

      • hasTextExtractionEvaluationMetrics

        public boolean hasTextExtractionEvaluationMetrics()
         Evaluation metrics for text extraction models.
        .google.cloud.automl.v1.TextExtractionEvaluationMetrics text_extraction_evaluation_metrics = 13;
        Specified by:
        hasTextExtractionEvaluationMetrics in interface ModelEvaluationOrBuilder
        Returns:
        Whether the textExtractionEvaluationMetrics field is set.

      • getName

        public String getName()
         Output only. Resource name of the model evaluation.
 Format:
 `projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}`
        string name = 1;
        Specified by:
        getName in interface ModelEvaluationOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Resource name of the model evaluation.
 Format:
 `projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}`
        string name = 1;
        Specified by:
        getNameBytes in interface ModelEvaluationOrBuilder
        Returns:
        The bytes for name.

      • getAnnotationSpecId

        public String getAnnotationSpecId()
         Output only. The ID of the annotation spec that the model evaluation applies to. The
 The ID is empty for the overall model evaluation.
 For Tables annotation specs in the dataset do not exist and this ID is
 always not set, but for CLASSIFICATION
 [prediction_type-s][google.cloud.automl.v1.TablesModelMetadata.prediction_type]
 the
 [display_name][google.cloud.automl.v1.ModelEvaluation.display_name]
 field is used.
        string annotation_spec_id = 2;
        Specified by:
        getAnnotationSpecId in interface ModelEvaluationOrBuilder
        Returns:
        The annotationSpecId.

      • getAnnotationSpecIdBytes

        public com.google.protobuf.ByteString getAnnotationSpecIdBytes()
         Output only. The ID of the annotation spec that the model evaluation applies to. The
 The ID is empty for the overall model evaluation.
 For Tables annotation specs in the dataset do not exist and this ID is
 always not set, but for CLASSIFICATION
 [prediction_type-s][google.cloud.automl.v1.TablesModelMetadata.prediction_type]
 the
 [display_name][google.cloud.automl.v1.ModelEvaluation.display_name]
 field is used.
        string annotation_spec_id = 2;
        Specified by:
        getAnnotationSpecIdBytes in interface ModelEvaluationOrBuilder
        Returns:
        The bytes for annotationSpecId.

      • getDisplayName

        public String getDisplayName()
         Output only. The value of
 [display_name][google.cloud.automl.v1.AnnotationSpec.display_name]
 at the moment when the model was trained. Because this field returns a
 value at model training time, for different models trained from the same
 dataset, the values may differ, since display names could had been changed
 between the two model's trainings. For Tables CLASSIFICATION
 [prediction_type-s][google.cloud.automl.v1.TablesModelMetadata.prediction_type]
 distinct values of the target column at the moment of the model evaluation
 are populated here.
 The display_name is empty for the overall model evaluation.
        string display_name = 15;
        Specified by:
        getDisplayName in interface ModelEvaluationOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Output only. The value of
 [display_name][google.cloud.automl.v1.AnnotationSpec.display_name]
 at the moment when the model was trained. Because this field returns a
 value at model training time, for different models trained from the same
 dataset, the values may differ, since display names could had been changed
 between the two model's trainings. For Tables CLASSIFICATION
 [prediction_type-s][google.cloud.automl.v1.TablesModelMetadata.prediction_type]
 distinct values of the target column at the moment of the model evaluation
 are populated here.
 The display_name is empty for the overall model evaluation.
        string display_name = 15;
        Specified by:
        getDisplayNameBytes in interface ModelEvaluationOrBuilder
        Returns:
        The bytes for displayName.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this model evaluation was created.
        .google.protobuf.Timestamp create_time = 5;
        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 model evaluation was created.
        .google.protobuf.Timestamp create_time = 5;
        Specified by:
        getCreateTime in interface ModelEvaluationOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this model evaluation was created.
        .google.protobuf.Timestamp create_time = 5;
        Specified by:
        getCreateTimeOrBuilder in interface ModelEvaluationOrBuilder

      • getEvaluatedExampleCount

        public int getEvaluatedExampleCount()
         Output only. The number of examples used for model evaluation, i.e. for
 which ground truth from time of model creation is compared against the
 predicted annotations created by the model.
 For overall ModelEvaluation (i.e. with annotation_spec_id not set) this is
 the total number of all examples used for evaluation.
 Otherwise, this is the count of examples that according to the ground
 truth were annotated by the
 [annotation_spec_id][google.cloud.automl.v1.ModelEvaluation.annotation_spec_id].
        int32 evaluated_example_count = 6;
        Specified by:
        getEvaluatedExampleCount in interface ModelEvaluationOrBuilder
        Returns:
        The evaluatedExampleCount.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ModelEvaluation parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected ModelEvaluation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<ModelEvaluation> parser()

      • getParserForType

        public com.google.protobuf.Parser<ModelEvaluation> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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