// Copyright 2018 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
//
//     http://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.

syntax = "proto3";

package google.cloud.automl.v1beta1;

import "google/api/annotations.proto";
import "google/cloud/automl/v1beta1/classification.proto";
import "google/cloud/automl/v1beta1/translation.proto";
import "google/protobuf/timestamp.proto";

option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
option java_multiple_files = true;
option java_package = "com.google.cloud.automl.v1beta1";


// Evaluation results of a model.
message ModelEvaluation {
  // Output only. Problem type specific evaluation metrics.
  oneof metrics {
    // Evaluation metrics for models on classification problems models.
    ClassificationEvaluationMetrics classification_evaluation_metrics = 8;

    // Evaluation metrics for models on translation models.
    TranslationEvaluationMetrics translation_evaluation_metrics = 9;
  }

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

  // Output only.
  // The ID of the annotation spec that the model evaluation applies to. The
  // ID is empty for overall model evaluation.
  // NOTE: Currently there is no way to obtain the display_name of the
  // annotation spec from its ID. To see the display_names, review the model
  // evaluations in the UI.
  string annotation_spec_id = 2;

  // Output only.
  // Timestamp when this model evaluation was created.
  google.protobuf.Timestamp create_time = 5;

  // Output only. The number of examples used for model evaluation.
  int32 evaluated_example_count = 6;
}
