Class EvaluatedAnnotation (3.19.0)

public final class EvaluatedAnnotation extends 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.v1.EvaluatedAnnotation

Static Fields

DATA_ITEM_PAYLOAD_FIELD_NUMBER

public static final int DATA_ITEM_PAYLOAD_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_ANALYSIS_ANNOTATIONS_FIELD_NUMBER

public static final int ERROR_ANALYSIS_ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

EVALUATED_DATA_ITEM_VIEW_ID_FIELD_NUMBER

public static final int EVALUATED_DATA_ITEM_VIEW_ID_FIELD_NUMBER
Field Value
TypeDescription
int

EXPLANATIONS_FIELD_NUMBER

public static final int EXPLANATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

GROUND_TRUTHS_FIELD_NUMBER

public static final int GROUND_TRUTHS_FIELD_NUMBER
Field Value
TypeDescription
int

PREDICTIONS_FIELD_NUMBER

public static final int PREDICTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static EvaluatedAnnotation getDefaultInstance()
Returns
TypeDescription
EvaluatedAnnotation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static EvaluatedAnnotation.Builder newBuilder()
Returns
TypeDescription
EvaluatedAnnotation.Builder

newBuilder(EvaluatedAnnotation prototype)

public static EvaluatedAnnotation.Builder newBuilder(EvaluatedAnnotation prototype)
Parameter
NameDescription
prototypeEvaluatedAnnotation
Returns
TypeDescription
EvaluatedAnnotation.Builder

parseDelimitedFrom(InputStream input)

public static EvaluatedAnnotation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluatedAnnotation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static EvaluatedAnnotation parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EvaluatedAnnotation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EvaluatedAnnotation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EvaluatedAnnotation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EvaluatedAnnotation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluatedAnnotation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static EvaluatedAnnotation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluatedAnnotation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static EvaluatedAnnotation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EvaluatedAnnotation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluatedAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<EvaluatedAnnotation> parser()
Returns
TypeDescription
Parser<EvaluatedAnnotation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDataItemPayload()

public 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];

Returns
TypeDescription
Value

The dataItemPayload.

getDataItemPayloadOrBuilder()

public 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];

Returns
TypeDescription
ValueOrBuilder

getDefaultInstanceForType()

public EvaluatedAnnotation getDefaultInstanceForType()
Returns
TypeDescription
EvaluatedAnnotation

getErrorAnalysisAnnotations(int index)

public ErrorAnalysisAnnotation getErrorAnalysisAnnotations(int index)

Annotations of model error analysis results.

repeated .google.cloud.aiplatform.v1.ErrorAnalysisAnnotation error_analysis_annotations = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
ErrorAnalysisAnnotation

getErrorAnalysisAnnotationsCount()

public int getErrorAnalysisAnnotationsCount()

Annotations of model error analysis results.

repeated .google.cloud.aiplatform.v1.ErrorAnalysisAnnotation error_analysis_annotations = 9;

Returns
TypeDescription
int

getErrorAnalysisAnnotationsList()

public List<ErrorAnalysisAnnotation> getErrorAnalysisAnnotationsList()

Annotations of model error analysis results.

repeated .google.cloud.aiplatform.v1.ErrorAnalysisAnnotation error_analysis_annotations = 9;

Returns
TypeDescription
List<ErrorAnalysisAnnotation>

getErrorAnalysisAnnotationsOrBuilder(int index)

public ErrorAnalysisAnnotationOrBuilder getErrorAnalysisAnnotationsOrBuilder(int index)

Annotations of model error analysis results.

repeated .google.cloud.aiplatform.v1.ErrorAnalysisAnnotation error_analysis_annotations = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
ErrorAnalysisAnnotationOrBuilder

getErrorAnalysisAnnotationsOrBuilderList()

public List<? extends ErrorAnalysisAnnotationOrBuilder> getErrorAnalysisAnnotationsOrBuilderList()

Annotations of model error analysis results.

repeated .google.cloud.aiplatform.v1.ErrorAnalysisAnnotation error_analysis_annotations = 9;

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.ErrorAnalysisAnnotationOrBuilder>

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.

string evaluated_data_item_view_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The evaluatedDataItemViewId.

getEvaluatedDataItemViewIdBytes()

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

string evaluated_data_item_view_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for evaluatedDataItemViewId.

getExplanations(int index)

public EvaluatedAnnotationExplanation getExplanations(int index)

Explanations of predictions. Each element of the explanations indicates the explanation for one explanation Method. The attributions list in the EvaluatedAnnotationExplanation.explanation object corresponds to the predictions list. For example, the second element in the attributions list explains the second element in the predictions list.

repeated .google.cloud.aiplatform.v1.EvaluatedAnnotationExplanation explanations = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
EvaluatedAnnotationExplanation

getExplanationsCount()

public int getExplanationsCount()

Explanations of predictions. Each element of the explanations indicates the explanation for one explanation Method. The attributions list in the EvaluatedAnnotationExplanation.explanation object corresponds to the predictions list. For example, the second element in the attributions list explains the second element in the predictions list.

repeated .google.cloud.aiplatform.v1.EvaluatedAnnotationExplanation explanations = 8;

Returns
TypeDescription
int

getExplanationsList()

public List<EvaluatedAnnotationExplanation> getExplanationsList()

Explanations of predictions. Each element of the explanations indicates the explanation for one explanation Method. The attributions list in the EvaluatedAnnotationExplanation.explanation object corresponds to the predictions list. For example, the second element in the attributions list explains the second element in the predictions list.

repeated .google.cloud.aiplatform.v1.EvaluatedAnnotationExplanation explanations = 8;

Returns
TypeDescription
List<EvaluatedAnnotationExplanation>

getExplanationsOrBuilder(int index)

public EvaluatedAnnotationExplanationOrBuilder getExplanationsOrBuilder(int index)

Explanations of predictions. Each element of the explanations indicates the explanation for one explanation Method. The attributions list in the EvaluatedAnnotationExplanation.explanation object corresponds to the predictions list. For example, the second element in the attributions list explains the second element in the predictions list.

repeated .google.cloud.aiplatform.v1.EvaluatedAnnotationExplanation explanations = 8;

Parameter
NameDescription
indexint
Returns
TypeDescription
EvaluatedAnnotationExplanationOrBuilder

getExplanationsOrBuilderList()

public List<? extends EvaluatedAnnotationExplanationOrBuilder> getExplanationsOrBuilderList()

Explanations of predictions. Each element of the explanations indicates the explanation for one explanation Method. The attributions list in the EvaluatedAnnotationExplanation.explanation object corresponds to the predictions list. For example, the second element in the attributions list explains the second element in the predictions list.

repeated .google.cloud.aiplatform.v1.EvaluatedAnnotationExplanation explanations = 8;

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.EvaluatedAnnotationExplanationOrBuilder>

getGroundTruths(int index)

public 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. For false positive, there are zero or more ground truth annotations that are similar to the only prediction in 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];

Parameter
NameDescription
indexint
Returns
TypeDescription
Value

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. For false positive, there are zero or more ground truth annotations that are similar to the only prediction in 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];

Returns
TypeDescription
int

getGroundTruthsList()

public List<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. For false positive, there are zero or more ground truth annotations that are similar to the only prediction in 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];

Returns
TypeDescription
List<Value>

getGroundTruthsOrBuilder(int index)

public 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. For false positive, there are zero or more ground truth annotations that are similar to the only prediction in 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];

Parameter
NameDescription
indexint
Returns
TypeDescription
ValueOrBuilder

getGroundTruthsOrBuilderList()

public List<? extends 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. For false positive, there are zero or more ground truth annotations that are similar to the only prediction in 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];

Returns
TypeDescription
List<? extends com.google.protobuf.ValueOrBuilder>

getParserForType()

public Parser<EvaluatedAnnotation> getParserForType()
Returns
TypeDescription
Parser<EvaluatedAnnotation>
Overrides

getPredictions(int index)

public 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. 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. For false negative, there are zero or more predictions which are similar to the only ground truth annotation in 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];

Parameter
NameDescription
indexint
Returns
TypeDescription
Value

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. 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. For false negative, there are zero or more predictions which are similar to the only ground truth annotation in 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];

Returns
TypeDescription
int

getPredictionsList()

public List<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. 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. For false negative, there are zero or more predictions which are similar to the only ground truth annotation in 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];

Returns
TypeDescription
List<Value>

getPredictionsOrBuilder(int index)

public 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. 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. For false negative, there are zero or more predictions which are similar to the only ground truth annotation in 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];

Parameter
NameDescription
indexint
Returns
TypeDescription
ValueOrBuilder

getPredictionsOrBuilderList()

public List<? extends 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. 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. For false negative, there are zero or more predictions which are similar to the only ground truth annotation in 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];

Returns
TypeDescription
List<? extends com.google.protobuf.ValueOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getType()

public EvaluatedAnnotation.EvaluatedAnnotationType getType()

Output only. Type of the EvaluatedAnnotation.

.google.cloud.aiplatform.v1.EvaluatedAnnotation.EvaluatedAnnotationType type = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
EvaluatedAnnotation.EvaluatedAnnotationType

The type.

getTypeValue()

public int getTypeValue()

Output only. Type of the EvaluatedAnnotation.

.google.cloud.aiplatform.v1.EvaluatedAnnotation.EvaluatedAnnotationType type = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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];

Returns
TypeDescription
boolean

Whether the dataItemPayload field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public EvaluatedAnnotation.Builder newBuilderForType()
Returns
TypeDescription
EvaluatedAnnotation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EvaluatedAnnotation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
EvaluatedAnnotation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public EvaluatedAnnotation.Builder toBuilder()
Returns
TypeDescription
EvaluatedAnnotation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException