/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/automl/v1beta1/model_evaluation.proto
package com.google.cloud.automl.v1beta1;
public interface ModelEvaluationOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.automl.v1beta1.ModelEvaluation)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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.v1beta1.ClassificationEvaluationMetrics classification_evaluation_metrics = 8;
*
*
* @return Whether the classificationEvaluationMetrics field is set.
*/
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.v1beta1.ClassificationEvaluationMetrics classification_evaluation_metrics = 8;
*
*
* @return The classificationEvaluationMetrics.
*/
com.google.cloud.automl.v1beta1.ClassificationProto.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.v1beta1.ClassificationEvaluationMetrics classification_evaluation_metrics = 8;
*
*/
com.google.cloud.automl.v1beta1.ClassificationProto.ClassificationEvaluationMetricsOrBuilder
getClassificationEvaluationMetricsOrBuilder();
/**
*
*
*
* Model evaluation metrics for Tables regression.
* Tables problem is considered a regression when the target column
* has FLOAT64 DataType.
*
*
*
* .google.cloud.automl.v1beta1.RegressionEvaluationMetrics regression_evaluation_metrics = 24;
*
*
* @return Whether the regressionEvaluationMetrics field is set.
*/
boolean hasRegressionEvaluationMetrics();
/**
*
*
*
* Model evaluation metrics for Tables regression.
* Tables problem is considered a regression when the target column
* has FLOAT64 DataType.
*
*
*
* .google.cloud.automl.v1beta1.RegressionEvaluationMetrics regression_evaluation_metrics = 24;
*
*
* @return The regressionEvaluationMetrics.
*/
com.google.cloud.automl.v1beta1.RegressionProto.RegressionEvaluationMetrics
getRegressionEvaluationMetrics();
/**
*
*
*
* Model evaluation metrics for Tables regression.
* Tables problem is considered a regression when the target column
* has FLOAT64 DataType.
*
*
*
* .google.cloud.automl.v1beta1.RegressionEvaluationMetrics regression_evaluation_metrics = 24;
*
*/
com.google.cloud.automl.v1beta1.RegressionProto.RegressionEvaluationMetricsOrBuilder
getRegressionEvaluationMetricsOrBuilder();
/**
*
*
*
* Model evaluation metrics for translation.
*
*
*
* .google.cloud.automl.v1beta1.TranslationEvaluationMetrics translation_evaluation_metrics = 9;
*
*
* @return Whether the translationEvaluationMetrics field is set.
*/
boolean hasTranslationEvaluationMetrics();
/**
*
*
*
* Model evaluation metrics for translation.
*
*
*
* .google.cloud.automl.v1beta1.TranslationEvaluationMetrics translation_evaluation_metrics = 9;
*
*
* @return The translationEvaluationMetrics.
*/
com.google.cloud.automl.v1beta1.TranslationEvaluationMetrics getTranslationEvaluationMetrics();
/**
*
*
*
* Model evaluation metrics for translation.
*
*
*
* .google.cloud.automl.v1beta1.TranslationEvaluationMetrics translation_evaluation_metrics = 9;
*
*/
com.google.cloud.automl.v1beta1.TranslationEvaluationMetricsOrBuilder
getTranslationEvaluationMetricsOrBuilder();
/**
*
*
*
* Model evaluation metrics for image object detection.
*
*
*
* .google.cloud.automl.v1beta1.ImageObjectDetectionEvaluationMetrics image_object_detection_evaluation_metrics = 12;
*
*
* @return Whether the imageObjectDetectionEvaluationMetrics field is set.
*/
boolean hasImageObjectDetectionEvaluationMetrics();
/**
*
*
*
* Model evaluation metrics for image object detection.
*
*
*
* .google.cloud.automl.v1beta1.ImageObjectDetectionEvaluationMetrics image_object_detection_evaluation_metrics = 12;
*
*
* @return The imageObjectDetectionEvaluationMetrics.
*/
com.google.cloud.automl.v1beta1.ImageObjectDetectionEvaluationMetrics
getImageObjectDetectionEvaluationMetrics();
/**
*
*
*
* Model evaluation metrics for image object detection.
*
*
*
* .google.cloud.automl.v1beta1.ImageObjectDetectionEvaluationMetrics image_object_detection_evaluation_metrics = 12;
*
*/
com.google.cloud.automl.v1beta1.ImageObjectDetectionEvaluationMetricsOrBuilder
getImageObjectDetectionEvaluationMetricsOrBuilder();
/**
*
*
*
* Model evaluation metrics for video object tracking.
*
*
*
* .google.cloud.automl.v1beta1.VideoObjectTrackingEvaluationMetrics video_object_tracking_evaluation_metrics = 14;
*
*
* @return Whether the videoObjectTrackingEvaluationMetrics field is set.
*/
boolean hasVideoObjectTrackingEvaluationMetrics();
/**
*
*
*
* Model evaluation metrics for video object tracking.
*
*
*
* .google.cloud.automl.v1beta1.VideoObjectTrackingEvaluationMetrics video_object_tracking_evaluation_metrics = 14;
*
*
* @return The videoObjectTrackingEvaluationMetrics.
*/
com.google.cloud.automl.v1beta1.VideoObjectTrackingEvaluationMetrics
getVideoObjectTrackingEvaluationMetrics();
/**
*
*
*
* Model evaluation metrics for video object tracking.
*
*
*
* .google.cloud.automl.v1beta1.VideoObjectTrackingEvaluationMetrics video_object_tracking_evaluation_metrics = 14;
*
*/
com.google.cloud.automl.v1beta1.VideoObjectTrackingEvaluationMetricsOrBuilder
getVideoObjectTrackingEvaluationMetricsOrBuilder();
/**
*
*
*
* Evaluation metrics for text sentiment models.
*
*
*
* .google.cloud.automl.v1beta1.TextSentimentEvaluationMetrics text_sentiment_evaluation_metrics = 11;
*
*
* @return Whether the textSentimentEvaluationMetrics field is set.
*/
boolean hasTextSentimentEvaluationMetrics();
/**
*
*
*
* Evaluation metrics for text sentiment models.
*
*
*
* .google.cloud.automl.v1beta1.TextSentimentEvaluationMetrics text_sentiment_evaluation_metrics = 11;
*
*
* @return The textSentimentEvaluationMetrics.
*/
com.google.cloud.automl.v1beta1.TextSentimentProto.TextSentimentEvaluationMetrics
getTextSentimentEvaluationMetrics();
/**
*
*
*
* Evaluation metrics for text sentiment models.
*
*
*
* .google.cloud.automl.v1beta1.TextSentimentEvaluationMetrics text_sentiment_evaluation_metrics = 11;
*
*/
com.google.cloud.automl.v1beta1.TextSentimentProto.TextSentimentEvaluationMetricsOrBuilder
getTextSentimentEvaluationMetricsOrBuilder();
/**
*
*
*
* Evaluation metrics for text extraction models.
*
*
*
* .google.cloud.automl.v1beta1.TextExtractionEvaluationMetrics text_extraction_evaluation_metrics = 13;
*
*
* @return Whether the textExtractionEvaluationMetrics field is set.
*/
boolean hasTextExtractionEvaluationMetrics();
/**
*
*
*
* Evaluation metrics for text extraction models.
*
*
*
* .google.cloud.automl.v1beta1.TextExtractionEvaluationMetrics text_extraction_evaluation_metrics = 13;
*
*
* @return The textExtractionEvaluationMetrics.
*/
com.google.cloud.automl.v1beta1.TextExtractionEvaluationMetrics
getTextExtractionEvaluationMetrics();
/**
*
*
*
* Evaluation metrics for text extraction models.
*
*
*
* .google.cloud.automl.v1beta1.TextExtractionEvaluationMetrics text_extraction_evaluation_metrics = 13;
*
*/
com.google.cloud.automl.v1beta1.TextExtractionEvaluationMetricsOrBuilder
getTextExtractionEvaluationMetricsOrBuilder();
/**
*
*
*
* 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;
*
* @return The name.
*/
java.lang.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;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* 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][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type]
* the
* [display_name][google.cloud.automl.v1beta1.ModelEvaluation.display_name]
* field is used.
*
*
* string annotation_spec_id = 2;
*
* @return The annotationSpecId.
*/
java.lang.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][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type]
* the
* [display_name][google.cloud.automl.v1beta1.ModelEvaluation.display_name]
* field is used.
*
*
* string annotation_spec_id = 2;
*
* @return The bytes for annotationSpecId.
*/
com.google.protobuf.ByteString getAnnotationSpecIdBytes();
/**
*
*
*
* Output only. The value of
* [display_name][google.cloud.automl.v1beta1.AnnotationSpec.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][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type]
* 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;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Output only. The value of
* [display_name][google.cloud.automl.v1beta1.AnnotationSpec.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][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type]
* 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;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Output only. Timestamp when this model evaluation was created.
*
*
* .google.protobuf.Timestamp create_time = 5;
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Timestamp when this model evaluation was created.
*
*
* .google.protobuf.Timestamp create_time = 5;
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Timestamp when this model evaluation was created.
*
*
* .google.protobuf.Timestamp create_time = 5;
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* 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][google.cloud.automl.v1beta1.ModelEvaluation.annotation_spec_id].
*
*
* int32 evaluated_example_count = 6;
*
* @return The evaluatedExampleCount.
*/
int getEvaluatedExampleCount();
public com.google.cloud.automl.v1beta1.ModelEvaluation.MetricsCase getMetricsCase();
}