Package com.google.cloud.aiplatform.v1beta1

Class EvaluatedAnnotation

  • All Implemented Interfaces:
    EvaluatedAnnotationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class EvaluatedAnnotation
extends com.google.protobuf.GeneratedMessageV3
implements EvaluatedAnnotationOrBuilder
     True positive, false positive, or false negative.

 EvaluatedAnnotation is only available under ModelEvaluationSlice with slice
 of `annotationSpec` dimension.
    Protobuf type google.cloud.aiplatform.v1beta1.EvaluatedAnnotation
    See Also:
    Serialized Form

    • Field Detail

      • PREDICTIONS_FIELD_NUMBER

        public static final int PREDICTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GROUND_TRUTHS_FIELD_NUMBER

        public static final int GROUND_TRUTHS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DATA_ITEM_PAYLOAD_FIELD_NUMBER

        public static final int DATA_ITEM_PAYLOAD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EVALUATED_DATA_ITEM_VIEW_ID_FIELD_NUMBER

        public static final int EVALUATED_DATA_ITEM_VIEW_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPLANATIONS_FIELD_NUMBER

        public static final int EXPLANATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ERROR_ANALYSIS_ANNOTATIONS_FIELD_NUMBER

        public static final int ERROR_ANALYSIS_ANNOTATIONS_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

      • getTypeValue

        public int getTypeValue()
         Output only. Type of the EvaluatedAnnotation.
        .google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.EvaluatedAnnotationType type = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTypeValue in interface EvaluatedAnnotationOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getPredictionsList

        public List<com.google.protobuf.Value> getPredictionsList()
         Output only. The model predicted annotations.

 For true positive, there is one and only one prediction, which matches the
 only one ground truth annotation in
 [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths].

 For false positive, there is one and only one prediction, which doesn't
 match any ground truth annotation of the corresponding
 [data_item_view_id][EvaluatedAnnotation.data_item_view_id].

 For false negative, there are zero or more predictions which are similar to
 the only ground truth annotation in
 [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths]
 but not enough for a match.

 The schema of the prediction is stored in
 [ModelEvaluation.annotation_schema_uri][]
        repeated .google.protobuf.Value predictions = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPredictionsList in interface EvaluatedAnnotationOrBuilder

      • getPredictionsOrBuilderList

        public List<? extends com.google.protobuf.ValueOrBuilder> getPredictionsOrBuilderList()
         Output only. The model predicted annotations.

 For true positive, there is one and only one prediction, which matches the
 only one ground truth annotation in
 [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths].

 For false positive, there is one and only one prediction, which doesn't
 match any ground truth annotation of the corresponding
 [data_item_view_id][EvaluatedAnnotation.data_item_view_id].

 For false negative, there are zero or more predictions which are similar to
 the only ground truth annotation in
 [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths]
 but not enough for a match.

 The schema of the prediction is stored in
 [ModelEvaluation.annotation_schema_uri][]
        repeated .google.protobuf.Value predictions = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPredictionsOrBuilderList in interface EvaluatedAnnotationOrBuilder

      • getPredictionsCount

        public int getPredictionsCount()
         Output only. The model predicted annotations.

 For true positive, there is one and only one prediction, which matches the
 only one ground truth annotation in
 [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths].

 For false positive, there is one and only one prediction, which doesn't
 match any ground truth annotation of the corresponding
 [data_item_view_id][EvaluatedAnnotation.data_item_view_id].

 For false negative, there are zero or more predictions which are similar to
 the only ground truth annotation in
 [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths]
 but not enough for a match.

 The schema of the prediction is stored in
 [ModelEvaluation.annotation_schema_uri][]
        repeated .google.protobuf.Value predictions = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPredictionsCount in interface EvaluatedAnnotationOrBuilder

      • getPredictions

        public com.google.protobuf.Value getPredictions​(int index)
         Output only. The model predicted annotations.

 For true positive, there is one and only one prediction, which matches the
 only one ground truth annotation in
 [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths].

 For false positive, there is one and only one prediction, which doesn't
 match any ground truth annotation of the corresponding
 [data_item_view_id][EvaluatedAnnotation.data_item_view_id].

 For false negative, there are zero or more predictions which are similar to
 the only ground truth annotation in
 [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths]
 but not enough for a match.

 The schema of the prediction is stored in
 [ModelEvaluation.annotation_schema_uri][]
        repeated .google.protobuf.Value predictions = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPredictions in interface EvaluatedAnnotationOrBuilder

      • getPredictionsOrBuilder

        public com.google.protobuf.ValueOrBuilder getPredictionsOrBuilder​(int index)
         Output only. The model predicted annotations.

 For true positive, there is one and only one prediction, which matches the
 only one ground truth annotation in
 [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths].

 For false positive, there is one and only one prediction, which doesn't
 match any ground truth annotation of the corresponding
 [data_item_view_id][EvaluatedAnnotation.data_item_view_id].

 For false negative, there are zero or more predictions which are similar to
 the only ground truth annotation in
 [ground_truths][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.ground_truths]
 but not enough for a match.

 The schema of the prediction is stored in
 [ModelEvaluation.annotation_schema_uri][]
        repeated .google.protobuf.Value predictions = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPredictionsOrBuilder in interface EvaluatedAnnotationOrBuilder

      • getGroundTruthsList

        public List<com.google.protobuf.Value> getGroundTruthsList()
         Output only. The ground truth Annotations, i.e. the Annotations that exist
 in the test data the Model is evaluated on.

 For true positive, there is one and only one ground truth annotation, which
 matches the only prediction in
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].

 For false positive, there are zero or more ground truth annotations that
 are similar to the only prediction in
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions],
 but not enough for a match.

 For false negative, there is one and only one ground truth annotation,
 which doesn't match any predictions created by the model.

 The schema of the ground truth is stored in
 [ModelEvaluation.annotation_schema_uri][]
        repeated .google.protobuf.Value ground_truths = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getGroundTruthsList in interface EvaluatedAnnotationOrBuilder

      • getGroundTruthsOrBuilderList

        public List<? extends com.google.protobuf.ValueOrBuilder> getGroundTruthsOrBuilderList()
         Output only. The ground truth Annotations, i.e. the Annotations that exist
 in the test data the Model is evaluated on.

 For true positive, there is one and only one ground truth annotation, which
 matches the only prediction in
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].

 For false positive, there are zero or more ground truth annotations that
 are similar to the only prediction in
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions],
 but not enough for a match.

 For false negative, there is one and only one ground truth annotation,
 which doesn't match any predictions created by the model.

 The schema of the ground truth is stored in
 [ModelEvaluation.annotation_schema_uri][]
        repeated .google.protobuf.Value ground_truths = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getGroundTruthsOrBuilderList in interface EvaluatedAnnotationOrBuilder

      • getGroundTruthsCount

        public int getGroundTruthsCount()
         Output only. The ground truth Annotations, i.e. the Annotations that exist
 in the test data the Model is evaluated on.

 For true positive, there is one and only one ground truth annotation, which
 matches the only prediction in
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].

 For false positive, there are zero or more ground truth annotations that
 are similar to the only prediction in
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions],
 but not enough for a match.

 For false negative, there is one and only one ground truth annotation,
 which doesn't match any predictions created by the model.

 The schema of the ground truth is stored in
 [ModelEvaluation.annotation_schema_uri][]
        repeated .google.protobuf.Value ground_truths = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getGroundTruthsCount in interface EvaluatedAnnotationOrBuilder

      • getGroundTruths

        public com.google.protobuf.Value getGroundTruths​(int index)
         Output only. The ground truth Annotations, i.e. the Annotations that exist
 in the test data the Model is evaluated on.

 For true positive, there is one and only one ground truth annotation, which
 matches the only prediction in
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].

 For false positive, there are zero or more ground truth annotations that
 are similar to the only prediction in
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions],
 but not enough for a match.

 For false negative, there is one and only one ground truth annotation,
 which doesn't match any predictions created by the model.

 The schema of the ground truth is stored in
 [ModelEvaluation.annotation_schema_uri][]
        repeated .google.protobuf.Value ground_truths = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getGroundTruths in interface EvaluatedAnnotationOrBuilder

      • getGroundTruthsOrBuilder

        public com.google.protobuf.ValueOrBuilder getGroundTruthsOrBuilder​(int index)
         Output only. The ground truth Annotations, i.e. the Annotations that exist
 in the test data the Model is evaluated on.

 For true positive, there is one and only one ground truth annotation, which
 matches the only prediction in
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].

 For false positive, there are zero or more ground truth annotations that
 are similar to the only prediction in
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions],
 but not enough for a match.

 For false negative, there is one and only one ground truth annotation,
 which doesn't match any predictions created by the model.

 The schema of the ground truth is stored in
 [ModelEvaluation.annotation_schema_uri][]
        repeated .google.protobuf.Value ground_truths = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getGroundTruthsOrBuilder in interface EvaluatedAnnotationOrBuilder

      • hasDataItemPayload

        public boolean hasDataItemPayload()
         Output only. The data item payload that the Model predicted this
 EvaluatedAnnotation on.
        .google.protobuf.Value data_item_payload = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDataItemPayload in interface EvaluatedAnnotationOrBuilder
        Returns:
        Whether the dataItemPayload field is set.

      • getDataItemPayload

        public com.google.protobuf.Value getDataItemPayload()
         Output only. The data item payload that the Model predicted this
 EvaluatedAnnotation on.
        .google.protobuf.Value data_item_payload = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDataItemPayload in interface EvaluatedAnnotationOrBuilder
        Returns:
        The dataItemPayload.

      • getDataItemPayloadOrBuilder

        public com.google.protobuf.ValueOrBuilder getDataItemPayloadOrBuilder()
         Output only. The data item payload that the Model predicted this
 EvaluatedAnnotation on.
        .google.protobuf.Value data_item_payload = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDataItemPayloadOrBuilder in interface EvaluatedAnnotationOrBuilder

      • getEvaluatedDataItemViewId

        public String getEvaluatedDataItemViewId()
         Output only. ID of the EvaluatedDataItemView under the same ancestor
 ModelEvaluation. The EvaluatedDataItemView consists of all ground truths
 and predictions on
 [data_item_payload][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.data_item_payload].
        string evaluated_data_item_view_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEvaluatedDataItemViewId in interface EvaluatedAnnotationOrBuilder
        Returns:
        The evaluatedDataItemViewId.

      • getEvaluatedDataItemViewIdBytes

        public com.google.protobuf.ByteString getEvaluatedDataItemViewIdBytes()
         Output only. ID of the EvaluatedDataItemView under the same ancestor
 ModelEvaluation. The EvaluatedDataItemView consists of all ground truths
 and predictions on
 [data_item_payload][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.data_item_payload].
        string evaluated_data_item_view_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEvaluatedDataItemViewIdBytes in interface EvaluatedAnnotationOrBuilder
        Returns:
        The bytes for evaluatedDataItemViewId.

      • getExplanationsList

        public List<EvaluatedAnnotationExplanation> getExplanationsList()
         Explanations of
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
 Each element of the explanations indicates the explanation for one
 explanation Method.

 The attributions list in the
 [EvaluatedAnnotationExplanation.explanation][google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation.explanation]
 object corresponds to the
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions]
 list. For example, the second element in the attributions list explains the
 second element in the predictions list.
        repeated .google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation explanations = 8;
        Specified by:
        getExplanationsList in interface EvaluatedAnnotationOrBuilder

      • getExplanationsOrBuilderList

        public List<? extends EvaluatedAnnotationExplanationOrBuilder> getExplanationsOrBuilderList()
         Explanations of
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
 Each element of the explanations indicates the explanation for one
 explanation Method.

 The attributions list in the
 [EvaluatedAnnotationExplanation.explanation][google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation.explanation]
 object corresponds to the
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions]
 list. For example, the second element in the attributions list explains the
 second element in the predictions list.
        repeated .google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation explanations = 8;
        Specified by:
        getExplanationsOrBuilderList in interface EvaluatedAnnotationOrBuilder

      • getExplanationsCount

        public int getExplanationsCount()
         Explanations of
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
 Each element of the explanations indicates the explanation for one
 explanation Method.

 The attributions list in the
 [EvaluatedAnnotationExplanation.explanation][google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation.explanation]
 object corresponds to the
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions]
 list. For example, the second element in the attributions list explains the
 second element in the predictions list.
        repeated .google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation explanations = 8;
        Specified by:
        getExplanationsCount in interface EvaluatedAnnotationOrBuilder

      • getExplanations

        public EvaluatedAnnotationExplanation getExplanations​(int index)
         Explanations of
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
 Each element of the explanations indicates the explanation for one
 explanation Method.

 The attributions list in the
 [EvaluatedAnnotationExplanation.explanation][google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation.explanation]
 object corresponds to the
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions]
 list. For example, the second element in the attributions list explains the
 second element in the predictions list.
        repeated .google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation explanations = 8;
        Specified by:
        getExplanations in interface EvaluatedAnnotationOrBuilder

      • getExplanationsOrBuilder

        public EvaluatedAnnotationExplanationOrBuilder getExplanationsOrBuilder​(int index)
         Explanations of
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
 Each element of the explanations indicates the explanation for one
 explanation Method.

 The attributions list in the
 [EvaluatedAnnotationExplanation.explanation][google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation.explanation]
 object corresponds to the
 [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions]
 list. For example, the second element in the attributions list explains the
 second element in the predictions list.
        repeated .google.cloud.aiplatform.v1beta1.EvaluatedAnnotationExplanation explanations = 8;
        Specified by:
        getExplanationsOrBuilder in interface EvaluatedAnnotationOrBuilder

      • getErrorAnalysisAnnotationsCount

        public int getErrorAnalysisAnnotationsCount()
         Annotations of model error analysis results.
        repeated .google.cloud.aiplatform.v1beta1.ErrorAnalysisAnnotation error_analysis_annotations = 9;
        Specified by:
        getErrorAnalysisAnnotationsCount in interface EvaluatedAnnotationOrBuilder

      • 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 EvaluatedAnnotation parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<EvaluatedAnnotation> 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 EvaluatedAnnotation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder