Class EvaluatedAnnotation.Builder (3.45.0) 

public static final class EvaluatedAnnotation.Builder extends GeneratedMessageV3.Builder<EvaluatedAnnotation.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EvaluatedAnnotation.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllErrorAnalysisAnnotations(Iterable<? extends ErrorAnalysisAnnotation> values)

public EvaluatedAnnotation.Builder addAllErrorAnalysisAnnotations(Iterable<? extends ErrorAnalysisAnnotation> values)

Annotations of model error analysis results.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1.ErrorAnalysisAnnotation>
Returns
Type Description
EvaluatedAnnotation.Builder

addAllExplanations(Iterable<? extends EvaluatedAnnotationExplanation> values)

public EvaluatedAnnotation.Builder addAllExplanations(Iterable<? extends EvaluatedAnnotationExplanation> values)

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
values Iterable<? extends com.google.cloud.aiplatform.v1.EvaluatedAnnotationExplanation>
Returns
Type Description
EvaluatedAnnotation.Builder

addAllGroundTruths(Iterable<? extends Value> values)

public EvaluatedAnnotation.Builder addAllGroundTruths(Iterable<? extends Value> values)

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
values Iterable<? extends com.google.protobuf.Value>
Returns
Type Description
EvaluatedAnnotation.Builder

addAllPredictions(Iterable<? extends Value> values)

public EvaluatedAnnotation.Builder addAllPredictions(Iterable<? extends Value> values)

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
values Iterable<? extends com.google.protobuf.Value>
Returns
Type Description
EvaluatedAnnotation.Builder

addErrorAnalysisAnnotations(ErrorAnalysisAnnotation value)

public EvaluatedAnnotation.Builder addErrorAnalysisAnnotations(ErrorAnalysisAnnotation value)

Annotations of model error analysis results.

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

Parameter
Name Description
value ErrorAnalysisAnnotation
Returns
Type Description
EvaluatedAnnotation.Builder

addErrorAnalysisAnnotations(ErrorAnalysisAnnotation.Builder builderForValue)

public EvaluatedAnnotation.Builder addErrorAnalysisAnnotations(ErrorAnalysisAnnotation.Builder builderForValue)

Annotations of model error analysis results.

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

Parameter
Name Description
builderForValue ErrorAnalysisAnnotation.Builder
Returns
Type Description
EvaluatedAnnotation.Builder

addErrorAnalysisAnnotations(int index, ErrorAnalysisAnnotation value)

public EvaluatedAnnotation.Builder addErrorAnalysisAnnotations(int index, ErrorAnalysisAnnotation value)

Annotations of model error analysis results.

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

Parameters
Name Description
index int
value ErrorAnalysisAnnotation
Returns
Type Description
EvaluatedAnnotation.Builder

addErrorAnalysisAnnotations(int index, ErrorAnalysisAnnotation.Builder builderForValue)

public EvaluatedAnnotation.Builder addErrorAnalysisAnnotations(int index, ErrorAnalysisAnnotation.Builder builderForValue)

Annotations of model error analysis results.

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

Parameters
Name Description
index int
builderForValue ErrorAnalysisAnnotation.Builder
Returns
Type Description
EvaluatedAnnotation.Builder

addErrorAnalysisAnnotationsBuilder()

public ErrorAnalysisAnnotation.Builder addErrorAnalysisAnnotationsBuilder()

Annotations of model error analysis results.

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

Returns
Type Description
ErrorAnalysisAnnotation.Builder

addErrorAnalysisAnnotationsBuilder(int index)

public ErrorAnalysisAnnotation.Builder addErrorAnalysisAnnotationsBuilder(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.Builder

addExplanations(EvaluatedAnnotationExplanation value)

public EvaluatedAnnotation.Builder addExplanations(EvaluatedAnnotationExplanation value)

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
value EvaluatedAnnotationExplanation
Returns
Type Description
EvaluatedAnnotation.Builder

addExplanations(EvaluatedAnnotationExplanation.Builder builderForValue)

public EvaluatedAnnotation.Builder addExplanations(EvaluatedAnnotationExplanation.Builder builderForValue)

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
builderForValue EvaluatedAnnotationExplanation.Builder
Returns
Type Description
EvaluatedAnnotation.Builder

addExplanations(int index, EvaluatedAnnotationExplanation value)

public EvaluatedAnnotation.Builder addExplanations(int index, EvaluatedAnnotationExplanation value)

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;

Parameters
Name Description
index int
value EvaluatedAnnotationExplanation
Returns
Type Description
EvaluatedAnnotation.Builder

addExplanations(int index, EvaluatedAnnotationExplanation.Builder builderForValue)

public EvaluatedAnnotation.Builder addExplanations(int index, EvaluatedAnnotationExplanation.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue EvaluatedAnnotationExplanation.Builder
Returns
Type Description
EvaluatedAnnotation.Builder

addExplanationsBuilder()

public EvaluatedAnnotationExplanation.Builder addExplanationsBuilder()

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
EvaluatedAnnotationExplanation.Builder

addExplanationsBuilder(int index)

public EvaluatedAnnotationExplanation.Builder addExplanationsBuilder(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.Builder

addGroundTruths(Value value)

public EvaluatedAnnotation.Builder addGroundTruths(Value value)

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
value Value
Returns
Type Description
EvaluatedAnnotation.Builder

addGroundTruths(Value.Builder builderForValue)

public EvaluatedAnnotation.Builder addGroundTruths(Value.Builder builderForValue)

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
builderForValue Builder
Returns
Type Description
EvaluatedAnnotation.Builder

addGroundTruths(int index, Value value)

public EvaluatedAnnotation.Builder addGroundTruths(int index, Value value)

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

Parameters
Name Description
index int
value Value
Returns
Type Description
EvaluatedAnnotation.Builder

addGroundTruths(int index, Value.Builder builderForValue)

public EvaluatedAnnotation.Builder addGroundTruths(int index, Value.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
EvaluatedAnnotation.Builder

addGroundTruthsBuilder()

public Value.Builder addGroundTruthsBuilder()

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
Builder

addGroundTruthsBuilder(int index)

public Value.Builder addGroundTruthsBuilder(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
Builder

addPredictions(Value value)

public EvaluatedAnnotation.Builder addPredictions(Value value)

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
value Value
Returns
Type Description
EvaluatedAnnotation.Builder

addPredictions(Value.Builder builderForValue)

public EvaluatedAnnotation.Builder addPredictions(Value.Builder builderForValue)

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
builderForValue Builder
Returns
Type Description
EvaluatedAnnotation.Builder

addPredictions(int index, Value value)

public EvaluatedAnnotation.Builder addPredictions(int index, Value value)

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

Parameters
Name Description
index int
value Value
Returns
Type Description
EvaluatedAnnotation.Builder

addPredictions(int index, Value.Builder builderForValue)

public EvaluatedAnnotation.Builder addPredictions(int index, Value.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
EvaluatedAnnotation.Builder

addPredictionsBuilder()

public Value.Builder addPredictionsBuilder()

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
Builder

addPredictionsBuilder(int index)

public Value.Builder addPredictionsBuilder(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
Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EvaluatedAnnotation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
EvaluatedAnnotation.Builder
Overrides

build()

public EvaluatedAnnotation build()
Returns
Type Description
EvaluatedAnnotation

buildPartial()

public EvaluatedAnnotation buildPartial()
Returns
Type Description
EvaluatedAnnotation

clear()

public EvaluatedAnnotation.Builder clear()
Returns
Type Description
EvaluatedAnnotation.Builder
Overrides

clearDataItemPayload()

public EvaluatedAnnotation.Builder clearDataItemPayload()

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
EvaluatedAnnotation.Builder

clearErrorAnalysisAnnotations()

public EvaluatedAnnotation.Builder clearErrorAnalysisAnnotations()

Annotations of model error analysis results.

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

Returns
Type Description
EvaluatedAnnotation.Builder

clearEvaluatedDataItemViewId()

public EvaluatedAnnotation.Builder clearEvaluatedDataItemViewId()

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
EvaluatedAnnotation.Builder

This builder for chaining.

clearExplanations()

public EvaluatedAnnotation.Builder clearExplanations()

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
EvaluatedAnnotation.Builder

clearField(Descriptors.FieldDescriptor field)

public EvaluatedAnnotation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
EvaluatedAnnotation.Builder
Overrides

clearGroundTruths()

public EvaluatedAnnotation.Builder clearGroundTruths()

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
EvaluatedAnnotation.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public EvaluatedAnnotation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
EvaluatedAnnotation.Builder
Overrides

clearPredictions()

public EvaluatedAnnotation.Builder clearPredictions()

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
EvaluatedAnnotation.Builder

clearType()

public EvaluatedAnnotation.Builder clearType()

Output only. Type of the EvaluatedAnnotation.

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

Returns
Type Description
EvaluatedAnnotation.Builder

This builder for chaining.

clone()

public EvaluatedAnnotation.Builder clone()
Returns
Type Description
EvaluatedAnnotation.Builder
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
Type Description
Value

The dataItemPayload.

getDataItemPayloadBuilder()

public Value.Builder getDataItemPayloadBuilder()

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
Builder

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

getDefaultInstanceForType()

public EvaluatedAnnotation getDefaultInstanceForType()
Returns
Type Description
EvaluatedAnnotation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Name Description
index int
Returns
Type Description
ErrorAnalysisAnnotation

getErrorAnalysisAnnotationsBuilder(int index)

public ErrorAnalysisAnnotation.Builder getErrorAnalysisAnnotationsBuilder(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.Builder

getErrorAnalysisAnnotationsBuilderList()

public List<ErrorAnalysisAnnotation.Builder> getErrorAnalysisAnnotationsBuilderList()

Annotations of model error analysis results.

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

Returns
Type Description
List<Builder>

getErrorAnalysisAnnotationsCount()

public int getErrorAnalysisAnnotationsCount()

Annotations of model error analysis results.

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

Returns
Type Description
int

getErrorAnalysisAnnotationsList()

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

getExplanationsBuilder(int index)

public EvaluatedAnnotationExplanation.Builder getExplanationsBuilder(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.Builder

getExplanationsBuilderList()

public List<EvaluatedAnnotationExplanation.Builder> getExplanationsBuilderList()

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<Builder>

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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
Value

getGroundTruthsBuilder(int index)

public Value.Builder getGroundTruthsBuilder(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
Builder

getGroundTruthsBuilderList()

public List<Value.Builder> getGroundTruthsBuilderList()

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<Builder>

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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.protobuf.ValueOrBuilder>

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
Name Description
index int
Returns
Type Description
Value

getPredictionsBuilder(int index)

public Value.Builder getPredictionsBuilder(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
Builder

getPredictionsBuilderList()

public List<Value.Builder> getPredictionsBuilderList()

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<Builder>

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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.protobuf.ValueOrBuilder>

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
Type Description
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
Type Description
int

The enum numeric value on the wire for type.

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
Type Description
boolean

Whether the dataItemPayload field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDataItemPayload(Value value)

public EvaluatedAnnotation.Builder mergeDataItemPayload(Value value)

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

Parameter
Name Description
value Value
Returns
Type Description
EvaluatedAnnotation.Builder

mergeFrom(EvaluatedAnnotation other)

public EvaluatedAnnotation.Builder mergeFrom(EvaluatedAnnotation other)
Parameter
Name Description
other EvaluatedAnnotation
Returns
Type Description
EvaluatedAnnotation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EvaluatedAnnotation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluatedAnnotation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public EvaluatedAnnotation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
EvaluatedAnnotation.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EvaluatedAnnotation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
EvaluatedAnnotation.Builder
Overrides

removeErrorAnalysisAnnotations(int index)

public EvaluatedAnnotation.Builder removeErrorAnalysisAnnotations(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
EvaluatedAnnotation.Builder

removeExplanations(int index)

public EvaluatedAnnotation.Builder removeExplanations(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
EvaluatedAnnotation.Builder

removeGroundTruths(int index)

public EvaluatedAnnotation.Builder removeGroundTruths(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
EvaluatedAnnotation.Builder

removePredictions(int index)

public EvaluatedAnnotation.Builder removePredictions(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
EvaluatedAnnotation.Builder

setDataItemPayload(Value value)

public EvaluatedAnnotation.Builder setDataItemPayload(Value value)

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

Parameter
Name Description
value Value
Returns
Type Description
EvaluatedAnnotation.Builder

setDataItemPayload(Value.Builder builderForValue)

public EvaluatedAnnotation.Builder setDataItemPayload(Value.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
EvaluatedAnnotation.Builder

setErrorAnalysisAnnotations(int index, ErrorAnalysisAnnotation value)

public EvaluatedAnnotation.Builder setErrorAnalysisAnnotations(int index, ErrorAnalysisAnnotation value)

Annotations of model error analysis results.

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

Parameters
Name Description
index int
value ErrorAnalysisAnnotation
Returns
Type Description
EvaluatedAnnotation.Builder

setErrorAnalysisAnnotations(int index, ErrorAnalysisAnnotation.Builder builderForValue)

public EvaluatedAnnotation.Builder setErrorAnalysisAnnotations(int index, ErrorAnalysisAnnotation.Builder builderForValue)

Annotations of model error analysis results.

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

Parameters
Name Description
index int
builderForValue ErrorAnalysisAnnotation.Builder
Returns
Type Description
EvaluatedAnnotation.Builder

setEvaluatedDataItemViewId(String value)

public EvaluatedAnnotation.Builder setEvaluatedDataItemViewId(String value)

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

Parameter
Name Description
value String

The evaluatedDataItemViewId to set.
Returns
Type Description
EvaluatedAnnotation.Builder

This builder for chaining.

setEvaluatedDataItemViewIdBytes(ByteString value)

public EvaluatedAnnotation.Builder setEvaluatedDataItemViewIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for evaluatedDataItemViewId to set.
Returns
Type Description
EvaluatedAnnotation.Builder

This builder for chaining.

setExplanations(int index, EvaluatedAnnotationExplanation value)

public EvaluatedAnnotation.Builder setExplanations(int index, EvaluatedAnnotationExplanation value)

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;

Parameters
Name Description
index int
value EvaluatedAnnotationExplanation
Returns
Type Description
EvaluatedAnnotation.Builder

setExplanations(int index, EvaluatedAnnotationExplanation.Builder builderForValue)

public EvaluatedAnnotation.Builder setExplanations(int index, EvaluatedAnnotationExplanation.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue EvaluatedAnnotationExplanation.Builder
Returns
Type Description
EvaluatedAnnotation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public EvaluatedAnnotation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
EvaluatedAnnotation.Builder
Overrides

setGroundTruths(int index, Value value)

public EvaluatedAnnotation.Builder setGroundTruths(int index, Value value)

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

Parameters
Name Description
index int
value Value
Returns
Type Description
EvaluatedAnnotation.Builder

setGroundTruths(int index, Value.Builder builderForValue)

public EvaluatedAnnotation.Builder setGroundTruths(int index, Value.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
EvaluatedAnnotation.Builder

setPredictions(int index, Value value)

public EvaluatedAnnotation.Builder setPredictions(int index, Value value)

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

Parameters
Name Description
index int
value Value
Returns
Type Description
EvaluatedAnnotation.Builder

setPredictions(int index, Value.Builder builderForValue)

public EvaluatedAnnotation.Builder setPredictions(int index, Value.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
EvaluatedAnnotation.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public EvaluatedAnnotation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
EvaluatedAnnotation.Builder
Overrides

setType(EvaluatedAnnotation.EvaluatedAnnotationType value)

public EvaluatedAnnotation.Builder setType(EvaluatedAnnotation.EvaluatedAnnotationType value)

Output only. Type of the EvaluatedAnnotation.

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

Parameter
Name Description
value EvaluatedAnnotation.EvaluatedAnnotationType

The type to set.
Returns
Type Description
EvaluatedAnnotation.Builder

This builder for chaining.

setTypeValue(int value)

public EvaluatedAnnotation.Builder setTypeValue(int value)

Output only. Type of the EvaluatedAnnotation.

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

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.
Returns
Type Description
EvaluatedAnnotation.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final EvaluatedAnnotation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
EvaluatedAnnotation.Builder
Overrides