1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/automl/v1/model_evaluation.proto 18 19 package com.google.cloud.automl.v1; 20 21 public interface ModelEvaluationOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.automl.v1.ModelEvaluation) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Model evaluation metrics for image, text, video and tables 31 * classification. 32 * Tables problem is considered a classification when the target column 33 * is CATEGORY DataType. 34 * </pre> 35 * 36 * <code> 37 * .google.cloud.automl.v1.ClassificationEvaluationMetrics classification_evaluation_metrics = 8; 38 * </code> 39 * 40 * @return Whether the classificationEvaluationMetrics field is set. 41 */ hasClassificationEvaluationMetrics()42 boolean hasClassificationEvaluationMetrics(); 43 /** 44 * 45 * 46 * <pre> 47 * Model evaluation metrics for image, text, video and tables 48 * classification. 49 * Tables problem is considered a classification when the target column 50 * is CATEGORY DataType. 51 * </pre> 52 * 53 * <code> 54 * .google.cloud.automl.v1.ClassificationEvaluationMetrics classification_evaluation_metrics = 8; 55 * </code> 56 * 57 * @return The classificationEvaluationMetrics. 58 */ getClassificationEvaluationMetrics()59 com.google.cloud.automl.v1.ClassificationEvaluationMetrics getClassificationEvaluationMetrics(); 60 /** 61 * 62 * 63 * <pre> 64 * Model evaluation metrics for image, text, video and tables 65 * classification. 66 * Tables problem is considered a classification when the target column 67 * is CATEGORY DataType. 68 * </pre> 69 * 70 * <code> 71 * .google.cloud.automl.v1.ClassificationEvaluationMetrics classification_evaluation_metrics = 8; 72 * </code> 73 */ 74 com.google.cloud.automl.v1.ClassificationEvaluationMetricsOrBuilder getClassificationEvaluationMetricsOrBuilder()75 getClassificationEvaluationMetricsOrBuilder(); 76 77 /** 78 * 79 * 80 * <pre> 81 * Model evaluation metrics for translation. 82 * </pre> 83 * 84 * <code>.google.cloud.automl.v1.TranslationEvaluationMetrics translation_evaluation_metrics = 9; 85 * </code> 86 * 87 * @return Whether the translationEvaluationMetrics field is set. 88 */ hasTranslationEvaluationMetrics()89 boolean hasTranslationEvaluationMetrics(); 90 /** 91 * 92 * 93 * <pre> 94 * Model evaluation metrics for translation. 95 * </pre> 96 * 97 * <code>.google.cloud.automl.v1.TranslationEvaluationMetrics translation_evaluation_metrics = 9; 98 * </code> 99 * 100 * @return The translationEvaluationMetrics. 101 */ getTranslationEvaluationMetrics()102 com.google.cloud.automl.v1.TranslationEvaluationMetrics getTranslationEvaluationMetrics(); 103 /** 104 * 105 * 106 * <pre> 107 * Model evaluation metrics for translation. 108 * </pre> 109 * 110 * <code>.google.cloud.automl.v1.TranslationEvaluationMetrics translation_evaluation_metrics = 9; 111 * </code> 112 */ 113 com.google.cloud.automl.v1.TranslationEvaluationMetricsOrBuilder getTranslationEvaluationMetricsOrBuilder()114 getTranslationEvaluationMetricsOrBuilder(); 115 116 /** 117 * 118 * 119 * <pre> 120 * Model evaluation metrics for image object detection. 121 * </pre> 122 * 123 * <code> 124 * .google.cloud.automl.v1.ImageObjectDetectionEvaluationMetrics image_object_detection_evaluation_metrics = 12; 125 * </code> 126 * 127 * @return Whether the imageObjectDetectionEvaluationMetrics field is set. 128 */ hasImageObjectDetectionEvaluationMetrics()129 boolean hasImageObjectDetectionEvaluationMetrics(); 130 /** 131 * 132 * 133 * <pre> 134 * Model evaluation metrics for image object detection. 135 * </pre> 136 * 137 * <code> 138 * .google.cloud.automl.v1.ImageObjectDetectionEvaluationMetrics image_object_detection_evaluation_metrics = 12; 139 * </code> 140 * 141 * @return The imageObjectDetectionEvaluationMetrics. 142 */ 143 com.google.cloud.automl.v1.ImageObjectDetectionEvaluationMetrics getImageObjectDetectionEvaluationMetrics()144 getImageObjectDetectionEvaluationMetrics(); 145 /** 146 * 147 * 148 * <pre> 149 * Model evaluation metrics for image object detection. 150 * </pre> 151 * 152 * <code> 153 * .google.cloud.automl.v1.ImageObjectDetectionEvaluationMetrics image_object_detection_evaluation_metrics = 12; 154 * </code> 155 */ 156 com.google.cloud.automl.v1.ImageObjectDetectionEvaluationMetricsOrBuilder getImageObjectDetectionEvaluationMetricsOrBuilder()157 getImageObjectDetectionEvaluationMetricsOrBuilder(); 158 159 /** 160 * 161 * 162 * <pre> 163 * Evaluation metrics for text sentiment models. 164 * </pre> 165 * 166 * <code> 167 * .google.cloud.automl.v1.TextSentimentEvaluationMetrics text_sentiment_evaluation_metrics = 11; 168 * </code> 169 * 170 * @return Whether the textSentimentEvaluationMetrics field is set. 171 */ hasTextSentimentEvaluationMetrics()172 boolean hasTextSentimentEvaluationMetrics(); 173 /** 174 * 175 * 176 * <pre> 177 * Evaluation metrics for text sentiment models. 178 * </pre> 179 * 180 * <code> 181 * .google.cloud.automl.v1.TextSentimentEvaluationMetrics text_sentiment_evaluation_metrics = 11; 182 * </code> 183 * 184 * @return The textSentimentEvaluationMetrics. 185 */ getTextSentimentEvaluationMetrics()186 com.google.cloud.automl.v1.TextSentimentEvaluationMetrics getTextSentimentEvaluationMetrics(); 187 /** 188 * 189 * 190 * <pre> 191 * Evaluation metrics for text sentiment models. 192 * </pre> 193 * 194 * <code> 195 * .google.cloud.automl.v1.TextSentimentEvaluationMetrics text_sentiment_evaluation_metrics = 11; 196 * </code> 197 */ 198 com.google.cloud.automl.v1.TextSentimentEvaluationMetricsOrBuilder getTextSentimentEvaluationMetricsOrBuilder()199 getTextSentimentEvaluationMetricsOrBuilder(); 200 201 /** 202 * 203 * 204 * <pre> 205 * Evaluation metrics for text extraction models. 206 * </pre> 207 * 208 * <code> 209 * .google.cloud.automl.v1.TextExtractionEvaluationMetrics text_extraction_evaluation_metrics = 13; 210 * </code> 211 * 212 * @return Whether the textExtractionEvaluationMetrics field is set. 213 */ hasTextExtractionEvaluationMetrics()214 boolean hasTextExtractionEvaluationMetrics(); 215 /** 216 * 217 * 218 * <pre> 219 * Evaluation metrics for text extraction models. 220 * </pre> 221 * 222 * <code> 223 * .google.cloud.automl.v1.TextExtractionEvaluationMetrics text_extraction_evaluation_metrics = 13; 224 * </code> 225 * 226 * @return The textExtractionEvaluationMetrics. 227 */ getTextExtractionEvaluationMetrics()228 com.google.cloud.automl.v1.TextExtractionEvaluationMetrics getTextExtractionEvaluationMetrics(); 229 /** 230 * 231 * 232 * <pre> 233 * Evaluation metrics for text extraction models. 234 * </pre> 235 * 236 * <code> 237 * .google.cloud.automl.v1.TextExtractionEvaluationMetrics text_extraction_evaluation_metrics = 13; 238 * </code> 239 */ 240 com.google.cloud.automl.v1.TextExtractionEvaluationMetricsOrBuilder getTextExtractionEvaluationMetricsOrBuilder()241 getTextExtractionEvaluationMetricsOrBuilder(); 242 243 /** 244 * 245 * 246 * <pre> 247 * Output only. Resource name of the model evaluation. 248 * Format: 249 * `projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}` 250 * </pre> 251 * 252 * <code>string name = 1;</code> 253 * 254 * @return The name. 255 */ getName()256 java.lang.String getName(); 257 /** 258 * 259 * 260 * <pre> 261 * Output only. Resource name of the model evaluation. 262 * Format: 263 * `projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}` 264 * </pre> 265 * 266 * <code>string name = 1;</code> 267 * 268 * @return The bytes for name. 269 */ getNameBytes()270 com.google.protobuf.ByteString getNameBytes(); 271 272 /** 273 * 274 * 275 * <pre> 276 * Output only. The ID of the annotation spec that the model evaluation applies to. The 277 * The ID is empty for the overall model evaluation. 278 * For Tables annotation specs in the dataset do not exist and this ID is 279 * always not set, but for CLASSIFICATION 280 * [prediction_type-s][google.cloud.automl.v1.TablesModelMetadata.prediction_type] 281 * the 282 * [display_name][google.cloud.automl.v1.ModelEvaluation.display_name] 283 * field is used. 284 * </pre> 285 * 286 * <code>string annotation_spec_id = 2;</code> 287 * 288 * @return The annotationSpecId. 289 */ getAnnotationSpecId()290 java.lang.String getAnnotationSpecId(); 291 /** 292 * 293 * 294 * <pre> 295 * Output only. The ID of the annotation spec that the model evaluation applies to. The 296 * The ID is empty for the overall model evaluation. 297 * For Tables annotation specs in the dataset do not exist and this ID is 298 * always not set, but for CLASSIFICATION 299 * [prediction_type-s][google.cloud.automl.v1.TablesModelMetadata.prediction_type] 300 * the 301 * [display_name][google.cloud.automl.v1.ModelEvaluation.display_name] 302 * field is used. 303 * </pre> 304 * 305 * <code>string annotation_spec_id = 2;</code> 306 * 307 * @return The bytes for annotationSpecId. 308 */ getAnnotationSpecIdBytes()309 com.google.protobuf.ByteString getAnnotationSpecIdBytes(); 310 311 /** 312 * 313 * 314 * <pre> 315 * Output only. The value of 316 * [display_name][google.cloud.automl.v1.AnnotationSpec.display_name] 317 * at the moment when the model was trained. Because this field returns a 318 * value at model training time, for different models trained from the same 319 * dataset, the values may differ, since display names could had been changed 320 * between the two model's trainings. For Tables CLASSIFICATION 321 * [prediction_type-s][google.cloud.automl.v1.TablesModelMetadata.prediction_type] 322 * distinct values of the target column at the moment of the model evaluation 323 * are populated here. 324 * The display_name is empty for the overall model evaluation. 325 * </pre> 326 * 327 * <code>string display_name = 15;</code> 328 * 329 * @return The displayName. 330 */ getDisplayName()331 java.lang.String getDisplayName(); 332 /** 333 * 334 * 335 * <pre> 336 * Output only. The value of 337 * [display_name][google.cloud.automl.v1.AnnotationSpec.display_name] 338 * at the moment when the model was trained. Because this field returns a 339 * value at model training time, for different models trained from the same 340 * dataset, the values may differ, since display names could had been changed 341 * between the two model's trainings. For Tables CLASSIFICATION 342 * [prediction_type-s][google.cloud.automl.v1.TablesModelMetadata.prediction_type] 343 * distinct values of the target column at the moment of the model evaluation 344 * are populated here. 345 * The display_name is empty for the overall model evaluation. 346 * </pre> 347 * 348 * <code>string display_name = 15;</code> 349 * 350 * @return The bytes for displayName. 351 */ getDisplayNameBytes()352 com.google.protobuf.ByteString getDisplayNameBytes(); 353 354 /** 355 * 356 * 357 * <pre> 358 * Output only. Timestamp when this model evaluation was created. 359 * </pre> 360 * 361 * <code>.google.protobuf.Timestamp create_time = 5;</code> 362 * 363 * @return Whether the createTime field is set. 364 */ hasCreateTime()365 boolean hasCreateTime(); 366 /** 367 * 368 * 369 * <pre> 370 * Output only. Timestamp when this model evaluation was created. 371 * </pre> 372 * 373 * <code>.google.protobuf.Timestamp create_time = 5;</code> 374 * 375 * @return The createTime. 376 */ getCreateTime()377 com.google.protobuf.Timestamp getCreateTime(); 378 /** 379 * 380 * 381 * <pre> 382 * Output only. Timestamp when this model evaluation was created. 383 * </pre> 384 * 385 * <code>.google.protobuf.Timestamp create_time = 5;</code> 386 */ getCreateTimeOrBuilder()387 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 388 389 /** 390 * 391 * 392 * <pre> 393 * Output only. The number of examples used for model evaluation, i.e. for 394 * which ground truth from time of model creation is compared against the 395 * predicted annotations created by the model. 396 * For overall ModelEvaluation (i.e. with annotation_spec_id not set) this is 397 * the total number of all examples used for evaluation. 398 * Otherwise, this is the count of examples that according to the ground 399 * truth were annotated by the 400 * [annotation_spec_id][google.cloud.automl.v1.ModelEvaluation.annotation_spec_id]. 401 * </pre> 402 * 403 * <code>int32 evaluated_example_count = 6;</code> 404 * 405 * @return The evaluatedExampleCount. 406 */ getEvaluatedExampleCount()407 int getEvaluatedExampleCount(); 408 getMetricsCase()409 public com.google.cloud.automl.v1.ModelEvaluation.MetricsCase getMetricsCase(); 410 } 411