com.google.cloud.aiplatform.v1beta1

Interface EvaluatedAnnotationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

EvaluatedAnnotation, EvaluatedAnnotation.Builder

public interface EvaluatedAnnotationOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Value	getDataItemPayload() Output only.
com.google.protobuf.ValueOrBuilder	getDataItemPayloadOrBuilder() Output only.
ErrorAnalysisAnnotation	getErrorAnalysisAnnotations(int index) Annotations of model error analysis results.
int	getErrorAnalysisAnnotationsCount() Annotations of model error analysis results.
List<ErrorAnalysisAnnotation>	getErrorAnalysisAnnotationsList() Annotations of model error analysis results.
ErrorAnalysisAnnotationOrBuilder	getErrorAnalysisAnnotationsOrBuilder(int index) Annotations of model error analysis results.
List<? extends ErrorAnalysisAnnotationOrBuilder>	getErrorAnalysisAnnotationsOrBuilderList() Annotations of model error analysis results.
String	getEvaluatedDataItemViewId() Output only.
com.google.protobuf.ByteString	getEvaluatedDataItemViewIdBytes() Output only.
EvaluatedAnnotationExplanation	getExplanations(int index) Explanations of [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
int	getExplanationsCount() Explanations of [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
List<EvaluatedAnnotationExplanation>	getExplanationsList() Explanations of [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
EvaluatedAnnotationExplanationOrBuilder	getExplanationsOrBuilder(int index) Explanations of [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
List<? extends EvaluatedAnnotationExplanationOrBuilder>	getExplanationsOrBuilderList() Explanations of [predictions][google.cloud.aiplatform.v1beta1.EvaluatedAnnotation.predictions].
com.google.protobuf.Value	getGroundTruths(int index) Output only.
int	getGroundTruthsCount() Output only.
List<com.google.protobuf.Value>	getGroundTruthsList() Output only.
com.google.protobuf.ValueOrBuilder	getGroundTruthsOrBuilder(int index) Output only.
List<? extends com.google.protobuf.ValueOrBuilder>	getGroundTruthsOrBuilderList() Output only.
com.google.protobuf.Value	getPredictions(int index) Output only.
int	getPredictionsCount() Output only.
List<com.google.protobuf.Value>	getPredictionsList() Output only.
com.google.protobuf.ValueOrBuilder	getPredictionsOrBuilder(int index) Output only.
List<? extends com.google.protobuf.ValueOrBuilder>	getPredictionsOrBuilderList() Output only.
EvaluatedAnnotation.EvaluatedAnnotationType	getType() Output only.
int	getTypeValue() Output only.
boolean	hasDataItemPayload() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTypeValue

int getTypeValue()

 Output only. Type of the EvaluatedAnnotation.
 

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

Returns:

The enum numeric value on the wire for type.

getType

EvaluatedAnnotation.EvaluatedAnnotationType getType()

 Output only. Type of the EvaluatedAnnotation.
 

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

Returns:

The type.

getPredictionsList

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

getPredictions

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

getPredictionsCount

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

getPredictionsOrBuilderList

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

getPredictionsOrBuilder

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

getGroundTruthsList

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

getGroundTruths

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

getGroundTruthsCount

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

getGroundTruthsOrBuilderList

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

getGroundTruthsOrBuilder

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

hasDataItemPayload

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:

Whether the dataItemPayload field is set.

getDataItemPayload

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

Returns:

The dataItemPayload.

getDataItemPayloadOrBuilder

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

getEvaluatedDataItemViewId

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

Returns:

The evaluatedDataItemViewId.

getEvaluatedDataItemViewIdBytes

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

Returns:

The bytes for evaluatedDataItemViewId.

getExplanationsList

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;

getExplanations

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;

getExplanationsCount

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;

getExplanationsOrBuilderList

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;

getExplanationsOrBuilder

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;

getErrorAnalysisAnnotationsList

List<ErrorAnalysisAnnotation> getErrorAnalysisAnnotationsList()

 Annotations of model error analysis results.
 

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

getErrorAnalysisAnnotations

ErrorAnalysisAnnotation getErrorAnalysisAnnotations(int index)

 Annotations of model error analysis results.
 

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

getErrorAnalysisAnnotationsCount

int getErrorAnalysisAnnotationsCount()

 Annotations of model error analysis results.
 

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

getErrorAnalysisAnnotationsOrBuilderList

List<? extends ErrorAnalysisAnnotationOrBuilder> getErrorAnalysisAnnotationsOrBuilderList()

 Annotations of model error analysis results.
 

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

getErrorAnalysisAnnotationsOrBuilder

ErrorAnalysisAnnotationOrBuilder getErrorAnalysisAnnotationsOrBuilder(int index)

 Annotations of model error analysis results.
 

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