Class: Google::Cloud::Ces::V1beta::EvaluationRun

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/ces/v1beta/evaluation.rb

Overview

An evaluation run represents an all the evaluation results from an evaluation execution.

Defined Under Namespace

Modules: EvaluationRunState, EvaluationType Classes: EvaluationRunSummariesEntry, EvaluationRunSummary, Progress

Instance Attribute Summary collapse

Instance Attribute Details

#app_version::String (readonly)

Returns Output only. The app version to evaluate. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}.

Returns:

  • (::String)

    Output only. The app version to evaluate. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#app_version_display_name::String (readonly)

Returns Output only. The display name of the app_version that the evaluation ran against.

Returns:

  • (::String)

    Output only. The display name of the app_version that the evaluation ran against.



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#changelog::String (readonly)

Returns Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.

Returns:

  • (::String)

    Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#changelog_create_time::Google::Protobuf::Timestamp (readonly)

Returns Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.

Returns:

  • (::Google::Protobuf::Timestamp)

    Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#config::Google::Cloud::Ces::V1beta::EvaluationConfig (readonly)

Returns Output only. The configuration used in the run.

Returns:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#create_time::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when the evaluation run was created.

Returns:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#display_name::String

Returns Optional. User-defined display name of the evaluation run. default: " run - ".

Returns:

  • (::String)

    Optional. User-defined display name of the evaluation run. default: " run - ".



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#error::Google::Rpc::Status (readonly)

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Output only. Deprecated: Use error_info instead. Errors encountered during execution.

Returns:

  • (::Google::Rpc::Status)

    Output only. Deprecated: Use error_info instead. Errors encountered during execution.



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#error_info::Google::Cloud::Ces::V1beta::EvaluationErrorInfo (readonly)

Returns Output only. Error information for the evaluation run.

Returns:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#evaluation_dataset::String (readonly)

Returns Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with evaluations. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}.

Returns:

  • (::String)

    Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with evaluations. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#evaluation_results::Array<::String> (readonly)

Returns Output only. The evaluation results that are part of this run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}.

Returns:

  • (::Array<::String>)

    Output only. The evaluation results that are part of this run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#evaluation_run_summaries::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary} (readonly)

Returns Output only. Map of evaluation name to EvaluationRunSummary.

Returns:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#evaluation_type::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationType (readonly)

Returns Output only. The type of the evaluations in this run.

Returns:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#evaluations::Array<::String> (readonly)

Returns Output only. The evaluations that are part of this run. The list may contain evaluations of either type. This field is mutually exclusive with evaluation_dataset. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}.

Returns:

  • (::Array<::String>)

    Output only. The evaluations that are part of this run. The list may contain evaluations of either type. This field is mutually exclusive with evaluation_dataset. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#golden_run_method::Google::Cloud::Ces::V1beta::GoldenRunMethod (readonly)

Returns Output only. The method used to run the evaluation.

Returns:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#initiated_by::String (readonly)

Returns Output only. The user who initiated the evaluation run.

Returns:

  • (::String)

    Output only. The user who initiated the evaluation run.



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#latency_report::Google::Cloud::Ces::V1beta::LatencyReport (readonly)

Returns Output only. Latency report for the evaluation run.

Returns:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#name::String

Returns Identifier. The unique identifier of the evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}.

Returns:

  • (::String)

    Identifier. The unique identifier of the evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#optimization_config::Google::Cloud::Ces::V1beta::OptimizationConfig

Returns Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run.

Returns:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#persona_run_configs::Array<::Google::Cloud::Ces::V1beta::PersonaRunConfig> (readonly)

Returns Output only. The configuration to use for the run per persona.

Returns:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#progress::Google::Cloud::Ces::V1beta::EvaluationRun::Progress (readonly)

Returns Output only. The progress of the evaluation run.

Returns:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#run_count::Integer (readonly)

Returns Output only. The number of times the evaluations inside the run were run.

Returns:

  • (::Integer)

    Output only. The number of times the evaluations inside the run were run.



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#scheduled_evaluation_run::String (readonly)

Returns Output only. The scheduled evaluation run resource name that created this evaluation run. This field is only set if the evaluation run was created by a scheduled evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}.

Returns:

  • (::String)

    Output only. The scheduled evaluation run resource name that created this evaluation run. This field is only set if the evaluation run was created by a scheduled evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end

#state::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunState (readonly)

Returns Output only. The state of the evaluation run.

Returns:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 1101

class EvaluationRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The progress of the evaluation run.
  # @!attribute [r] total_count
  #   @return [::Integer]
  #     Output only. Total number of evaluation results in this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     FAIL. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is FAIL).
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that failed to execute.
  #     (EvaluationResult.execution_state is ERROR).
  # @!attribute [r] completed_count
  #   @return [::Integer]
  #     Output only. Number of evaluation results that finished successfully.
  #     (EvaluationResult.execution_state is COMPLETED).
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of completed evaluation results with an outcome of
  #     PASS. (EvaluationResult.execution_state is COMPLETED and
  #     EvaluationResult.evaluation_status is PASS).
  class Progress
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains the summary of passed and failed result counts for a specific
  # evaluation in an evaluation run.
  # @!attribute [r] passed_count
  #   @return [::Integer]
  #     Output only. Number of passed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] failed_count
  #   @return [::Integer]
  #     Output only. Number of failed results for the associated Evaluation in
  #     this run.
  # @!attribute [r] error_count
  #   @return [::Integer]
  #     Output only. Number of error results for the associated Evaluation in
  #     this run.
  class EvaluationRunSummary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary]
  class EvaluationRunSummariesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of the evaluations in this run.
  # Additional values may be added in the future.
  module EvaluationType
    # Evaluation type is not specified.
    EVALUATION_TYPE_UNSPECIFIED = 0

    # Golden evaluation.
    GOLDEN = 1

    # Scenario evaluation.
    SCENARIO = 2

    # Indicates the run includes a mix of golden and scenario evaluations.
    MIXED = 3
  end

  # The state of the evaluation run.
  module EvaluationRunState
    # Evaluation run state is not specified.
    EVALUATION_RUN_STATE_UNSPECIFIED = 0

    # Evaluation run is running.
    RUNNING = 1

    # Evaluation run has completed.
    COMPLETED = 2

    # The evaluation run has an error.
    ERROR = 3
  end
end