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
public static final int DATA_ITEM_PAYLOAD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ERROR_ANALYSIS_ANNOTATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int EVALUATED_DATA_ITEM_VIEW_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int EXPLANATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int GROUND_TRUTHS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PREDICTIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static EvaluatedAnnotation getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static EvaluatedAnnotation.Builder newBuilder()
public static EvaluatedAnnotation.Builder newBuilder(EvaluatedAnnotation prototype)
public static EvaluatedAnnotation parseDelimitedFrom(InputStream input)
public static EvaluatedAnnotation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EvaluatedAnnotation parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static EvaluatedAnnotation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EvaluatedAnnotation parseFrom(ByteString data)
public static EvaluatedAnnotation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EvaluatedAnnotation parseFrom(CodedInputStream input)
public static EvaluatedAnnotation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EvaluatedAnnotation parseFrom(InputStream input)
public static EvaluatedAnnotation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EvaluatedAnnotation parseFrom(ByteBuffer data)
public static EvaluatedAnnotation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<EvaluatedAnnotation> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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 |
|---|
| Type | Description |
Value | The dataItemPayload.
|
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];
public EvaluatedAnnotation getDefaultInstanceForType()
public ErrorAnalysisAnnotation getErrorAnalysisAnnotations(int index)
Annotations of model error analysis results.
repeated .google.cloud.aiplatform.v1.ErrorAnalysisAnnotation error_analysis_annotations = 9;
| Parameter |
|---|
| Name | Description |
index | int
|
public int getErrorAnalysisAnnotationsCount()
Annotations of model error analysis results.
repeated .google.cloud.aiplatform.v1.ErrorAnalysisAnnotation error_analysis_annotations = 9;
| Returns |
|---|
| Type | Description |
int | |
public List<ErrorAnalysisAnnotation> getErrorAnalysisAnnotationsList()
Annotations of model error analysis results.
repeated .google.cloud.aiplatform.v1.ErrorAnalysisAnnotation error_analysis_annotations = 9;
public ErrorAnalysisAnnotationOrBuilder getErrorAnalysisAnnotationsOrBuilder(int index)
Annotations of model error analysis results.
repeated .google.cloud.aiplatform.v1.ErrorAnalysisAnnotation error_analysis_annotations = 9;
| Parameter |
|---|
| Name | Description |
index | int
|
public List<? extends ErrorAnalysisAnnotationOrBuilder> getErrorAnalysisAnnotationsOrBuilderList()
Annotations of model error analysis results.
repeated .google.cloud.aiplatform.v1.ErrorAnalysisAnnotation error_analysis_annotations = 9;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1.ErrorAnalysisAnnotationOrBuilder> | |
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.
Can be passed in
GetEvaluatedDataItemView's[]
id.
string evaluated_data_item_view_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The evaluatedDataItemViewId.
|
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.
Can be passed in
GetEvaluatedDataItemView's[]
id.
string evaluated_data_item_view_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for evaluatedDataItemViewId.
|
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
int | |
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;
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1.EvaluatedAnnotationExplanationOrBuilder> | |
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 |
|---|
| Name | Description |
index | int
|
| Returns |
|---|
| Type | Description |
Value | |
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 |
|---|
| Type | Description |
int | |
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];
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
List<? extends com.google.protobuf.ValueOrBuilder> | |
public Parser<EvaluatedAnnotation> getParserForType()
Overrides
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 |
|---|
| Name | Description |
index | int
|
| Returns |
|---|
| Type | Description |
Value | |
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 |
|---|
| Type | Description |
int | |
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];
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
List<? extends com.google.protobuf.ValueOrBuilder> | |
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public EvaluatedAnnotation.EvaluatedAnnotationType getType()
Output only. Type of the EvaluatedAnnotation.
.google.cloud.aiplatform.v1.EvaluatedAnnotation.EvaluatedAnnotationType type = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getTypeValue()
Output only. Type of the EvaluatedAnnotation.
.google.cloud.aiplatform.v1.EvaluatedAnnotation.EvaluatedAnnotationType type = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for type.
|
public final UnknownFieldSet getUnknownFields()
Overrides
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 |
|---|
| Type | Description |
boolean | Whether the dataItemPayload field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public EvaluatedAnnotation.Builder newBuilderForType()
protected EvaluatedAnnotation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public EvaluatedAnnotation.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
