Interface EvaluatedAnnotationOrBuilder (3.42.0)

Version 3.42.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public interface EvaluatedAnnotationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataItemPayload()

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

getDataItemPayloadOrBuilder()

public abstract 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
Type	Description
ValueOrBuilder

getErrorAnalysisAnnotations(int index)

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

Returns
Type	Description
ErrorAnalysisAnnotation

getErrorAnalysisAnnotationsCount()

public abstract int getErrorAnalysisAnnotationsCount()

Annotations of model error analysis results.

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

Returns
Type	Description
int

getErrorAnalysisAnnotationsList()

public abstract List<ErrorAnalysisAnnotation> getErrorAnalysisAnnotationsList()

Annotations of model error analysis results.

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

Returns
Type	Description
List<ErrorAnalysisAnnotation>

getErrorAnalysisAnnotationsOrBuilder(int index)

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

Returns
Type	Description
ErrorAnalysisAnnotationOrBuilder

getErrorAnalysisAnnotationsOrBuilderList()

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

getEvaluatedDataItemViewId()

public abstract 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
Type	Description
String	The evaluatedDataItemViewId.

getEvaluatedDataItemViewIdBytes()

public abstract 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
Type	Description
ByteString	The bytes for evaluatedDataItemViewId.

getExplanations(int index)

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

Returns
Type	Description
EvaluatedAnnotationExplanation

getExplanationsCount()

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

getExplanationsList()

public abstract 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
Type	Description
List<EvaluatedAnnotationExplanation>

getExplanationsOrBuilder(int index)

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

Returns
Type	Description
EvaluatedAnnotationExplanationOrBuilder

getExplanationsOrBuilderList()

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

getGroundTruths(int index)

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

getGroundTruthsCount()

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

getGroundTruthsList()

public abstract 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
Type	Description
List<Value>

getGroundTruthsOrBuilder(int index)

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

Returns
Type	Description
ValueOrBuilder

getGroundTruthsOrBuilderList()

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

getPredictions(int index)

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

getPredictionsCount()

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

getPredictionsList()

public abstract 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
Type	Description
List<Value>

getPredictionsOrBuilder(int index)

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

Returns
Type	Description
ValueOrBuilder

getPredictionsOrBuilderList()

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

getType()

public abstract EvaluatedAnnotation.EvaluatedAnnotationType getType()

Output only. Type of the EvaluatedAnnotation.

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

Returns
Type	Description
EvaluatedAnnotation.EvaluatedAnnotationType	The type.

getTypeValue()

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

hasDataItemPayload()

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