Class ModelEvaluation (2.17.0)

public final class ModelEvaluation extends GeneratedMessageV3 implements ModelEvaluationOrBuilder

Evaluation results of a model.

Protobuf type google.cloud.automl.v1.ModelEvaluation

Static Fields

ANNOTATION_SPEC_ID_FIELD_NUMBER

public static final int ANNOTATION_SPEC_ID_FIELD_NUMBER
Field Value
TypeDescription
int

CLASSIFICATION_EVALUATION_METRICS_FIELD_NUMBER

public static final int CLASSIFICATION_EVALUATION_METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

EVALUATED_EXAMPLE_COUNT_FIELD_NUMBER

public static final int EVALUATED_EXAMPLE_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_OBJECT_DETECTION_EVALUATION_METRICS_FIELD_NUMBER

public static final int IMAGE_OBJECT_DETECTION_EVALUATION_METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_EXTRACTION_EVALUATION_METRICS_FIELD_NUMBER

public static final int TEXT_EXTRACTION_EVALUATION_METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_SENTIMENT_EVALUATION_METRICS_FIELD_NUMBER

public static final int TEXT_SENTIMENT_EVALUATION_METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSLATION_EVALUATION_METRICS_FIELD_NUMBER

public static final int TRANSLATION_EVALUATION_METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ModelEvaluation getDefaultInstance()
Returns
TypeDescription
ModelEvaluation

getDescriptor()

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

newBuilder()

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

newBuilder(ModelEvaluation prototype)

public static ModelEvaluation.Builder newBuilder(ModelEvaluation prototype)
Parameter
NameDescription
prototypeModelEvaluation
Returns
TypeDescription
ModelEvaluation.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAnnotationSpecId()

public String getAnnotationSpecId()

Output only. The ID of the annotation spec that the model evaluation applies to. The The ID is empty for the overall model evaluation. For Tables annotation specs in the dataset do not exist and this ID is always not set, but for CLASSIFICATION prediction_type-s the display_name field is used.

string annotation_spec_id = 2;

Returns
TypeDescription
String

The annotationSpecId.

getAnnotationSpecIdBytes()

public ByteString getAnnotationSpecIdBytes()

Output only. The ID of the annotation spec that the model evaluation applies to. The The ID is empty for the overall model evaluation. For Tables annotation specs in the dataset do not exist and this ID is always not set, but for CLASSIFICATION prediction_type-s the display_name field is used.

string annotation_spec_id = 2;

Returns
TypeDescription
ByteString

The bytes for annotationSpecId.

getClassificationEvaluationMetrics()

public ClassificationEvaluationMetrics getClassificationEvaluationMetrics()

Model evaluation metrics for image, text, video and tables classification. Tables problem is considered a classification when the target column is CATEGORY DataType.

.google.cloud.automl.v1.ClassificationEvaluationMetrics classification_evaluation_metrics = 8;

Returns
TypeDescription
ClassificationEvaluationMetrics

The classificationEvaluationMetrics.

getClassificationEvaluationMetricsOrBuilder()

public ClassificationEvaluationMetricsOrBuilder getClassificationEvaluationMetricsOrBuilder()

Model evaluation metrics for image, text, video and tables classification. Tables problem is considered a classification when the target column is CATEGORY DataType.

.google.cloud.automl.v1.ClassificationEvaluationMetrics classification_evaluation_metrics = 8;

Returns
TypeDescription
ClassificationEvaluationMetricsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this model evaluation was created.

.google.protobuf.Timestamp create_time = 5;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this model evaluation was created.

.google.protobuf.Timestamp create_time = 5;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ModelEvaluation getDefaultInstanceForType()
Returns
TypeDescription
ModelEvaluation

getDisplayName()

public String getDisplayName()

Output only. The value of display_name at the moment when the model was trained. Because this field returns a value at model training time, for different models trained from the same dataset, the values may differ, since display names could had been changed between the two model's trainings. For Tables CLASSIFICATION prediction_type-s distinct values of the target column at the moment of the model evaluation are populated here. The display_name is empty for the overall model evaluation.

string display_name = 15;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. The value of display_name at the moment when the model was trained. Because this field returns a value at model training time, for different models trained from the same dataset, the values may differ, since display names could had been changed between the two model's trainings. For Tables CLASSIFICATION prediction_type-s distinct values of the target column at the moment of the model evaluation are populated here. The display_name is empty for the overall model evaluation.

string display_name = 15;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEvaluatedExampleCount()

public int getEvaluatedExampleCount()

Output only. The number of examples used for model evaluation, i.e. for which ground truth from time of model creation is compared against the predicted annotations created by the model. For overall ModelEvaluation (i.e. with annotation_spec_id not set) this is the total number of all examples used for evaluation. Otherwise, this is the count of examples that according to the ground truth were annotated by the annotation_spec_id.

int32 evaluated_example_count = 6;

Returns
TypeDescription
int

The evaluatedExampleCount.

getImageObjectDetectionEvaluationMetrics()

public ImageObjectDetectionEvaluationMetrics getImageObjectDetectionEvaluationMetrics()

Model evaluation metrics for image object detection.

.google.cloud.automl.v1.ImageObjectDetectionEvaluationMetrics image_object_detection_evaluation_metrics = 12;

Returns
TypeDescription
ImageObjectDetectionEvaluationMetrics

The imageObjectDetectionEvaluationMetrics.

getImageObjectDetectionEvaluationMetricsOrBuilder()

public ImageObjectDetectionEvaluationMetricsOrBuilder getImageObjectDetectionEvaluationMetricsOrBuilder()

Model evaluation metrics for image object detection.

.google.cloud.automl.v1.ImageObjectDetectionEvaluationMetrics image_object_detection_evaluation_metrics = 12;

Returns
TypeDescription
ImageObjectDetectionEvaluationMetricsOrBuilder

getMetricsCase()

public ModelEvaluation.MetricsCase getMetricsCase()
Returns
TypeDescription
ModelEvaluation.MetricsCase

getName()

public String getName()

Output only. Resource name of the model evaluation. Format: projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the model evaluation. Format: projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTextExtractionEvaluationMetrics()

public TextExtractionEvaluationMetrics getTextExtractionEvaluationMetrics()

Evaluation metrics for text extraction models.

.google.cloud.automl.v1.TextExtractionEvaluationMetrics text_extraction_evaluation_metrics = 13;

Returns
TypeDescription
TextExtractionEvaluationMetrics

The textExtractionEvaluationMetrics.

getTextExtractionEvaluationMetricsOrBuilder()

public TextExtractionEvaluationMetricsOrBuilder getTextExtractionEvaluationMetricsOrBuilder()

Evaluation metrics for text extraction models.

.google.cloud.automl.v1.TextExtractionEvaluationMetrics text_extraction_evaluation_metrics = 13;

Returns
TypeDescription
TextExtractionEvaluationMetricsOrBuilder

getTextSentimentEvaluationMetrics()

public TextSentimentEvaluationMetrics getTextSentimentEvaluationMetrics()

Evaluation metrics for text sentiment models.

.google.cloud.automl.v1.TextSentimentEvaluationMetrics text_sentiment_evaluation_metrics = 11;

Returns
TypeDescription
TextSentimentEvaluationMetrics

The textSentimentEvaluationMetrics.

getTextSentimentEvaluationMetricsOrBuilder()

public TextSentimentEvaluationMetricsOrBuilder getTextSentimentEvaluationMetricsOrBuilder()

Evaluation metrics for text sentiment models.

.google.cloud.automl.v1.TextSentimentEvaluationMetrics text_sentiment_evaluation_metrics = 11;

Returns
TypeDescription
TextSentimentEvaluationMetricsOrBuilder

getTranslationEvaluationMetrics()

public TranslationEvaluationMetrics getTranslationEvaluationMetrics()

Model evaluation metrics for translation.

.google.cloud.automl.v1.TranslationEvaluationMetrics translation_evaluation_metrics = 9;

Returns
TypeDescription
TranslationEvaluationMetrics

The translationEvaluationMetrics.

getTranslationEvaluationMetricsOrBuilder()

public TranslationEvaluationMetricsOrBuilder getTranslationEvaluationMetricsOrBuilder()

Model evaluation metrics for translation.

.google.cloud.automl.v1.TranslationEvaluationMetrics translation_evaluation_metrics = 9;

Returns
TypeDescription
TranslationEvaluationMetricsOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasClassificationEvaluationMetrics()

public boolean hasClassificationEvaluationMetrics()

Model evaluation metrics for image, text, video and tables classification. Tables problem is considered a classification when the target column is CATEGORY DataType.

.google.cloud.automl.v1.ClassificationEvaluationMetrics classification_evaluation_metrics = 8;

Returns
TypeDescription
boolean

Whether the classificationEvaluationMetrics field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this model evaluation was created.

.google.protobuf.Timestamp create_time = 5;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasImageObjectDetectionEvaluationMetrics()

public boolean hasImageObjectDetectionEvaluationMetrics()

Model evaluation metrics for image object detection.

.google.cloud.automl.v1.ImageObjectDetectionEvaluationMetrics image_object_detection_evaluation_metrics = 12;

Returns
TypeDescription
boolean

Whether the imageObjectDetectionEvaluationMetrics field is set.

hasTextExtractionEvaluationMetrics()

public boolean hasTextExtractionEvaluationMetrics()

Evaluation metrics for text extraction models.

.google.cloud.automl.v1.TextExtractionEvaluationMetrics text_extraction_evaluation_metrics = 13;

Returns
TypeDescription
boolean

Whether the textExtractionEvaluationMetrics field is set.

hasTextSentimentEvaluationMetrics()

public boolean hasTextSentimentEvaluationMetrics()

Evaluation metrics for text sentiment models.

.google.cloud.automl.v1.TextSentimentEvaluationMetrics text_sentiment_evaluation_metrics = 11;

Returns
TypeDescription
boolean

Whether the textSentimentEvaluationMetrics field is set.

hasTranslationEvaluationMetrics()

public boolean hasTranslationEvaluationMetrics()

Model evaluation metrics for translation.

.google.cloud.automl.v1.TranslationEvaluationMetrics translation_evaluation_metrics = 9;

Returns
TypeDescription
boolean

Whether the translationEvaluationMetrics field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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