google-cloud-ai_platform-v1 0.47.0 → 0.48.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1412 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AIPlatform
23
+ module V1
24
+ # Request message for EvaluationService.EvaluateInstances.
25
+ # @!attribute [rw] exact_match_input
26
+ # @return [::Google::Cloud::AIPlatform::V1::ExactMatchInput]
27
+ # Auto metric instances.
28
+ # Instances and metric spec for exact match metric.
29
+ # @!attribute [rw] bleu_input
30
+ # @return [::Google::Cloud::AIPlatform::V1::BleuInput]
31
+ # Instances and metric spec for bleu metric.
32
+ # @!attribute [rw] rouge_input
33
+ # @return [::Google::Cloud::AIPlatform::V1::RougeInput]
34
+ # Instances and metric spec for rouge metric.
35
+ # @!attribute [rw] fluency_input
36
+ # @return [::Google::Cloud::AIPlatform::V1::FluencyInput]
37
+ # LLM-based metric instance.
38
+ # General text generation metrics, applicable to other categories.
39
+ # Input for fluency metric.
40
+ # @!attribute [rw] coherence_input
41
+ # @return [::Google::Cloud::AIPlatform::V1::CoherenceInput]
42
+ # Input for coherence metric.
43
+ # @!attribute [rw] safety_input
44
+ # @return [::Google::Cloud::AIPlatform::V1::SafetyInput]
45
+ # Input for safety metric.
46
+ # @!attribute [rw] groundedness_input
47
+ # @return [::Google::Cloud::AIPlatform::V1::GroundednessInput]
48
+ # Input for groundedness metric.
49
+ # @!attribute [rw] fulfillment_input
50
+ # @return [::Google::Cloud::AIPlatform::V1::FulfillmentInput]
51
+ # Input for fulfillment metric.
52
+ # @!attribute [rw] summarization_quality_input
53
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationQualityInput]
54
+ # Input for summarization quality metric.
55
+ # @!attribute [rw] pairwise_summarization_quality_input
56
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualityInput]
57
+ # Input for pairwise summarization quality metric.
58
+ # @!attribute [rw] summarization_helpfulness_input
59
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessInput]
60
+ # Input for summarization helpfulness metric.
61
+ # @!attribute [rw] summarization_verbosity_input
62
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationVerbosityInput]
63
+ # Input for summarization verbosity metric.
64
+ # @!attribute [rw] question_answering_quality_input
65
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualityInput]
66
+ # Input for question answering quality metric.
67
+ # @!attribute [rw] pairwise_question_answering_quality_input
68
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualityInput]
69
+ # Input for pairwise question answering quality metric.
70
+ # @!attribute [rw] question_answering_relevance_input
71
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceInput]
72
+ # Input for question answering relevance metric.
73
+ # @!attribute [rw] question_answering_helpfulness_input
74
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessInput]
75
+ # Input for question answering helpfulness
76
+ # metric.
77
+ # @!attribute [rw] question_answering_correctness_input
78
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessInput]
79
+ # Input for question answering correctness
80
+ # metric.
81
+ # @!attribute [rw] pointwise_metric_input
82
+ # @return [::Google::Cloud::AIPlatform::V1::PointwiseMetricInput]
83
+ # Input for pointwise metric.
84
+ # @!attribute [rw] pairwise_metric_input
85
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseMetricInput]
86
+ # Input for pairwise metric.
87
+ # @!attribute [rw] tool_call_valid_input
88
+ # @return [::Google::Cloud::AIPlatform::V1::ToolCallValidInput]
89
+ # Tool call metric instances.
90
+ # Input for tool call valid metric.
91
+ # @!attribute [rw] tool_name_match_input
92
+ # @return [::Google::Cloud::AIPlatform::V1::ToolNameMatchInput]
93
+ # Input for tool name match metric.
94
+ # @!attribute [rw] tool_parameter_key_match_input
95
+ # @return [::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchInput]
96
+ # Input for tool parameter key match metric.
97
+ # @!attribute [rw] tool_parameter_kv_match_input
98
+ # @return [::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchInput]
99
+ # Input for tool parameter key value match metric.
100
+ # @!attribute [rw] location
101
+ # @return [::String]
102
+ # Required. The resource name of the Location to evaluate the instances.
103
+ # Format: `projects/{project}/locations/{location}`
104
+ class EvaluateInstancesRequest
105
+ include ::Google::Protobuf::MessageExts
106
+ extend ::Google::Protobuf::MessageExts::ClassMethods
107
+ end
108
+
109
+ # Response message for EvaluationService.EvaluateInstances.
110
+ # @!attribute [rw] exact_match_results
111
+ # @return [::Google::Cloud::AIPlatform::V1::ExactMatchResults]
112
+ # Auto metric evaluation results.
113
+ # Results for exact match metric.
114
+ # @!attribute [rw] bleu_results
115
+ # @return [::Google::Cloud::AIPlatform::V1::BleuResults]
116
+ # Results for bleu metric.
117
+ # @!attribute [rw] rouge_results
118
+ # @return [::Google::Cloud::AIPlatform::V1::RougeResults]
119
+ # Results for rouge metric.
120
+ # @!attribute [rw] fluency_result
121
+ # @return [::Google::Cloud::AIPlatform::V1::FluencyResult]
122
+ # LLM-based metric evaluation result.
123
+ # General text generation metrics, applicable to other categories.
124
+ # Result for fluency metric.
125
+ # @!attribute [rw] coherence_result
126
+ # @return [::Google::Cloud::AIPlatform::V1::CoherenceResult]
127
+ # Result for coherence metric.
128
+ # @!attribute [rw] safety_result
129
+ # @return [::Google::Cloud::AIPlatform::V1::SafetyResult]
130
+ # Result for safety metric.
131
+ # @!attribute [rw] groundedness_result
132
+ # @return [::Google::Cloud::AIPlatform::V1::GroundednessResult]
133
+ # Result for groundedness metric.
134
+ # @!attribute [rw] fulfillment_result
135
+ # @return [::Google::Cloud::AIPlatform::V1::FulfillmentResult]
136
+ # Result for fulfillment metric.
137
+ # @!attribute [rw] summarization_quality_result
138
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationQualityResult]
139
+ # Summarization only metrics.
140
+ # Result for summarization quality metric.
141
+ # @!attribute [rw] pairwise_summarization_quality_result
142
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualityResult]
143
+ # Result for pairwise summarization quality metric.
144
+ # @!attribute [rw] summarization_helpfulness_result
145
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessResult]
146
+ # Result for summarization helpfulness metric.
147
+ # @!attribute [rw] summarization_verbosity_result
148
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationVerbosityResult]
149
+ # Result for summarization verbosity metric.
150
+ # @!attribute [rw] question_answering_quality_result
151
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualityResult]
152
+ # Question answering only metrics.
153
+ # Result for question answering quality metric.
154
+ # @!attribute [rw] pairwise_question_answering_quality_result
155
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualityResult]
156
+ # Result for pairwise question answering quality metric.
157
+ # @!attribute [rw] question_answering_relevance_result
158
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceResult]
159
+ # Result for question answering relevance metric.
160
+ # @!attribute [rw] question_answering_helpfulness_result
161
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessResult]
162
+ # Result for question answering helpfulness metric.
163
+ # @!attribute [rw] question_answering_correctness_result
164
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessResult]
165
+ # Result for question answering correctness metric.
166
+ # @!attribute [rw] pointwise_metric_result
167
+ # @return [::Google::Cloud::AIPlatform::V1::PointwiseMetricResult]
168
+ # Generic metrics.
169
+ # Result for pointwise metric.
170
+ # @!attribute [rw] pairwise_metric_result
171
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseMetricResult]
172
+ # Result for pairwise metric.
173
+ # @!attribute [rw] tool_call_valid_results
174
+ # @return [::Google::Cloud::AIPlatform::V1::ToolCallValidResults]
175
+ # Tool call metrics.
176
+ # Results for tool call valid metric.
177
+ # @!attribute [rw] tool_name_match_results
178
+ # @return [::Google::Cloud::AIPlatform::V1::ToolNameMatchResults]
179
+ # Results for tool name match metric.
180
+ # @!attribute [rw] tool_parameter_key_match_results
181
+ # @return [::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchResults]
182
+ # Results for tool parameter key match metric.
183
+ # @!attribute [rw] tool_parameter_kv_match_results
184
+ # @return [::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchResults]
185
+ # Results for tool parameter key value match metric.
186
+ class EvaluateInstancesResponse
187
+ include ::Google::Protobuf::MessageExts
188
+ extend ::Google::Protobuf::MessageExts::ClassMethods
189
+ end
190
+
191
+ # Input for exact match metric.
192
+ # @!attribute [rw] metric_spec
193
+ # @return [::Google::Cloud::AIPlatform::V1::ExactMatchSpec]
194
+ # Required. Spec for exact match metric.
195
+ # @!attribute [rw] instances
196
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ExactMatchInstance>]
197
+ # Required. Repeated exact match instances.
198
+ class ExactMatchInput
199
+ include ::Google::Protobuf::MessageExts
200
+ extend ::Google::Protobuf::MessageExts::ClassMethods
201
+ end
202
+
203
+ # Spec for exact match instance.
204
+ # @!attribute [rw] prediction
205
+ # @return [::String]
206
+ # Required. Output of the evaluated model.
207
+ # @!attribute [rw] reference
208
+ # @return [::String]
209
+ # Required. Ground truth used to compare against the prediction.
210
+ class ExactMatchInstance
211
+ include ::Google::Protobuf::MessageExts
212
+ extend ::Google::Protobuf::MessageExts::ClassMethods
213
+ end
214
+
215
+ # Spec for exact match metric - returns 1 if prediction and reference exactly
216
+ # matches, otherwise 0.
217
+ class ExactMatchSpec
218
+ include ::Google::Protobuf::MessageExts
219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
220
+ end
221
+
222
+ # Results for exact match metric.
223
+ # @!attribute [r] exact_match_metric_values
224
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ExactMatchMetricValue>]
225
+ # Output only. Exact match metric values.
226
+ class ExactMatchResults
227
+ include ::Google::Protobuf::MessageExts
228
+ extend ::Google::Protobuf::MessageExts::ClassMethods
229
+ end
230
+
231
+ # Exact match metric value for an instance.
232
+ # @!attribute [r] score
233
+ # @return [::Float]
234
+ # Output only. Exact match score.
235
+ class ExactMatchMetricValue
236
+ include ::Google::Protobuf::MessageExts
237
+ extend ::Google::Protobuf::MessageExts::ClassMethods
238
+ end
239
+
240
+ # Input for bleu metric.
241
+ # @!attribute [rw] metric_spec
242
+ # @return [::Google::Cloud::AIPlatform::V1::BleuSpec]
243
+ # Required. Spec for bleu score metric.
244
+ # @!attribute [rw] instances
245
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::BleuInstance>]
246
+ # Required. Repeated bleu instances.
247
+ class BleuInput
248
+ include ::Google::Protobuf::MessageExts
249
+ extend ::Google::Protobuf::MessageExts::ClassMethods
250
+ end
251
+
252
+ # Spec for bleu instance.
253
+ # @!attribute [rw] prediction
254
+ # @return [::String]
255
+ # Required. Output of the evaluated model.
256
+ # @!attribute [rw] reference
257
+ # @return [::String]
258
+ # Required. Ground truth used to compare against the prediction.
259
+ class BleuInstance
260
+ include ::Google::Protobuf::MessageExts
261
+ extend ::Google::Protobuf::MessageExts::ClassMethods
262
+ end
263
+
264
+ # Spec for bleu score metric - calculates the precision of n-grams in the
265
+ # prediction as compared to reference - returns a score ranging between 0 to 1.
266
+ # @!attribute [rw] use_effective_order
267
+ # @return [::Boolean]
268
+ # Optional. Whether to use_effective_order to compute bleu score.
269
+ class BleuSpec
270
+ include ::Google::Protobuf::MessageExts
271
+ extend ::Google::Protobuf::MessageExts::ClassMethods
272
+ end
273
+
274
+ # Results for bleu metric.
275
+ # @!attribute [r] bleu_metric_values
276
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::BleuMetricValue>]
277
+ # Output only. Bleu metric values.
278
+ class BleuResults
279
+ include ::Google::Protobuf::MessageExts
280
+ extend ::Google::Protobuf::MessageExts::ClassMethods
281
+ end
282
+
283
+ # Bleu metric value for an instance.
284
+ # @!attribute [r] score
285
+ # @return [::Float]
286
+ # Output only. Bleu score.
287
+ class BleuMetricValue
288
+ include ::Google::Protobuf::MessageExts
289
+ extend ::Google::Protobuf::MessageExts::ClassMethods
290
+ end
291
+
292
+ # Input for rouge metric.
293
+ # @!attribute [rw] metric_spec
294
+ # @return [::Google::Cloud::AIPlatform::V1::RougeSpec]
295
+ # Required. Spec for rouge score metric.
296
+ # @!attribute [rw] instances
297
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::RougeInstance>]
298
+ # Required. Repeated rouge instances.
299
+ class RougeInput
300
+ include ::Google::Protobuf::MessageExts
301
+ extend ::Google::Protobuf::MessageExts::ClassMethods
302
+ end
303
+
304
+ # Spec for rouge instance.
305
+ # @!attribute [rw] prediction
306
+ # @return [::String]
307
+ # Required. Output of the evaluated model.
308
+ # @!attribute [rw] reference
309
+ # @return [::String]
310
+ # Required. Ground truth used to compare against the prediction.
311
+ class RougeInstance
312
+ include ::Google::Protobuf::MessageExts
313
+ extend ::Google::Protobuf::MessageExts::ClassMethods
314
+ end
315
+
316
+ # Spec for rouge score metric - calculates the recall of n-grams in prediction
317
+ # as compared to reference - returns a score ranging between 0 and 1.
318
+ # @!attribute [rw] rouge_type
319
+ # @return [::String]
320
+ # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
321
+ # @!attribute [rw] use_stemmer
322
+ # @return [::Boolean]
323
+ # Optional. Whether to use stemmer to compute rouge score.
324
+ # @!attribute [rw] split_summaries
325
+ # @return [::Boolean]
326
+ # Optional. Whether to split summaries while using rougeLsum.
327
+ class RougeSpec
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
331
+
332
+ # Results for rouge metric.
333
+ # @!attribute [r] rouge_metric_values
334
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::RougeMetricValue>]
335
+ # Output only. Rouge metric values.
336
+ class RougeResults
337
+ include ::Google::Protobuf::MessageExts
338
+ extend ::Google::Protobuf::MessageExts::ClassMethods
339
+ end
340
+
341
+ # Rouge metric value for an instance.
342
+ # @!attribute [r] score
343
+ # @return [::Float]
344
+ # Output only. Rouge score.
345
+ class RougeMetricValue
346
+ include ::Google::Protobuf::MessageExts
347
+ extend ::Google::Protobuf::MessageExts::ClassMethods
348
+ end
349
+
350
+ # Input for coherence metric.
351
+ # @!attribute [rw] metric_spec
352
+ # @return [::Google::Cloud::AIPlatform::V1::CoherenceSpec]
353
+ # Required. Spec for coherence score metric.
354
+ # @!attribute [rw] instance
355
+ # @return [::Google::Cloud::AIPlatform::V1::CoherenceInstance]
356
+ # Required. Coherence instance.
357
+ class CoherenceInput
358
+ include ::Google::Protobuf::MessageExts
359
+ extend ::Google::Protobuf::MessageExts::ClassMethods
360
+ end
361
+
362
+ # Spec for coherence instance.
363
+ # @!attribute [rw] prediction
364
+ # @return [::String]
365
+ # Required. Output of the evaluated model.
366
+ class CoherenceInstance
367
+ include ::Google::Protobuf::MessageExts
368
+ extend ::Google::Protobuf::MessageExts::ClassMethods
369
+ end
370
+
371
+ # Spec for coherence score metric.
372
+ # @!attribute [rw] version
373
+ # @return [::Integer]
374
+ # Optional. Which version to use for evaluation.
375
+ class CoherenceSpec
376
+ include ::Google::Protobuf::MessageExts
377
+ extend ::Google::Protobuf::MessageExts::ClassMethods
378
+ end
379
+
380
+ # Spec for coherence result.
381
+ # @!attribute [r] score
382
+ # @return [::Float]
383
+ # Output only. Coherence score.
384
+ # @!attribute [r] explanation
385
+ # @return [::String]
386
+ # Output only. Explanation for coherence score.
387
+ # @!attribute [r] confidence
388
+ # @return [::Float]
389
+ # Output only. Confidence for coherence score.
390
+ class CoherenceResult
391
+ include ::Google::Protobuf::MessageExts
392
+ extend ::Google::Protobuf::MessageExts::ClassMethods
393
+ end
394
+
395
+ # Input for fluency metric.
396
+ # @!attribute [rw] metric_spec
397
+ # @return [::Google::Cloud::AIPlatform::V1::FluencySpec]
398
+ # Required. Spec for fluency score metric.
399
+ # @!attribute [rw] instance
400
+ # @return [::Google::Cloud::AIPlatform::V1::FluencyInstance]
401
+ # Required. Fluency instance.
402
+ class FluencyInput
403
+ include ::Google::Protobuf::MessageExts
404
+ extend ::Google::Protobuf::MessageExts::ClassMethods
405
+ end
406
+
407
+ # Spec for fluency instance.
408
+ # @!attribute [rw] prediction
409
+ # @return [::String]
410
+ # Required. Output of the evaluated model.
411
+ class FluencyInstance
412
+ include ::Google::Protobuf::MessageExts
413
+ extend ::Google::Protobuf::MessageExts::ClassMethods
414
+ end
415
+
416
+ # Spec for fluency score metric.
417
+ # @!attribute [rw] version
418
+ # @return [::Integer]
419
+ # Optional. Which version to use for evaluation.
420
+ class FluencySpec
421
+ include ::Google::Protobuf::MessageExts
422
+ extend ::Google::Protobuf::MessageExts::ClassMethods
423
+ end
424
+
425
+ # Spec for fluency result.
426
+ # @!attribute [r] score
427
+ # @return [::Float]
428
+ # Output only. Fluency score.
429
+ # @!attribute [r] explanation
430
+ # @return [::String]
431
+ # Output only. Explanation for fluency score.
432
+ # @!attribute [r] confidence
433
+ # @return [::Float]
434
+ # Output only. Confidence for fluency score.
435
+ class FluencyResult
436
+ include ::Google::Protobuf::MessageExts
437
+ extend ::Google::Protobuf::MessageExts::ClassMethods
438
+ end
439
+
440
+ # Input for safety metric.
441
+ # @!attribute [rw] metric_spec
442
+ # @return [::Google::Cloud::AIPlatform::V1::SafetySpec]
443
+ # Required. Spec for safety metric.
444
+ # @!attribute [rw] instance
445
+ # @return [::Google::Cloud::AIPlatform::V1::SafetyInstance]
446
+ # Required. Safety instance.
447
+ class SafetyInput
448
+ include ::Google::Protobuf::MessageExts
449
+ extend ::Google::Protobuf::MessageExts::ClassMethods
450
+ end
451
+
452
+ # Spec for safety instance.
453
+ # @!attribute [rw] prediction
454
+ # @return [::String]
455
+ # Required. Output of the evaluated model.
456
+ class SafetyInstance
457
+ include ::Google::Protobuf::MessageExts
458
+ extend ::Google::Protobuf::MessageExts::ClassMethods
459
+ end
460
+
461
+ # Spec for safety metric.
462
+ # @!attribute [rw] version
463
+ # @return [::Integer]
464
+ # Optional. Which version to use for evaluation.
465
+ class SafetySpec
466
+ include ::Google::Protobuf::MessageExts
467
+ extend ::Google::Protobuf::MessageExts::ClassMethods
468
+ end
469
+
470
+ # Spec for safety result.
471
+ # @!attribute [r] score
472
+ # @return [::Float]
473
+ # Output only. Safety score.
474
+ # @!attribute [r] explanation
475
+ # @return [::String]
476
+ # Output only. Explanation for safety score.
477
+ # @!attribute [r] confidence
478
+ # @return [::Float]
479
+ # Output only. Confidence for safety score.
480
+ class SafetyResult
481
+ include ::Google::Protobuf::MessageExts
482
+ extend ::Google::Protobuf::MessageExts::ClassMethods
483
+ end
484
+
485
+ # Input for groundedness metric.
486
+ # @!attribute [rw] metric_spec
487
+ # @return [::Google::Cloud::AIPlatform::V1::GroundednessSpec]
488
+ # Required. Spec for groundedness metric.
489
+ # @!attribute [rw] instance
490
+ # @return [::Google::Cloud::AIPlatform::V1::GroundednessInstance]
491
+ # Required. Groundedness instance.
492
+ class GroundednessInput
493
+ include ::Google::Protobuf::MessageExts
494
+ extend ::Google::Protobuf::MessageExts::ClassMethods
495
+ end
496
+
497
+ # Spec for groundedness instance.
498
+ # @!attribute [rw] prediction
499
+ # @return [::String]
500
+ # Required. Output of the evaluated model.
501
+ # @!attribute [rw] context
502
+ # @return [::String]
503
+ # Required. Background information provided in context used to compare
504
+ # against the prediction.
505
+ class GroundednessInstance
506
+ include ::Google::Protobuf::MessageExts
507
+ extend ::Google::Protobuf::MessageExts::ClassMethods
508
+ end
509
+
510
+ # Spec for groundedness metric.
511
+ # @!attribute [rw] version
512
+ # @return [::Integer]
513
+ # Optional. Which version to use for evaluation.
514
+ class GroundednessSpec
515
+ include ::Google::Protobuf::MessageExts
516
+ extend ::Google::Protobuf::MessageExts::ClassMethods
517
+ end
518
+
519
+ # Spec for groundedness result.
520
+ # @!attribute [r] score
521
+ # @return [::Float]
522
+ # Output only. Groundedness score.
523
+ # @!attribute [r] explanation
524
+ # @return [::String]
525
+ # Output only. Explanation for groundedness score.
526
+ # @!attribute [r] confidence
527
+ # @return [::Float]
528
+ # Output only. Confidence for groundedness score.
529
+ class GroundednessResult
530
+ include ::Google::Protobuf::MessageExts
531
+ extend ::Google::Protobuf::MessageExts::ClassMethods
532
+ end
533
+
534
+ # Input for fulfillment metric.
535
+ # @!attribute [rw] metric_spec
536
+ # @return [::Google::Cloud::AIPlatform::V1::FulfillmentSpec]
537
+ # Required. Spec for fulfillment score metric.
538
+ # @!attribute [rw] instance
539
+ # @return [::Google::Cloud::AIPlatform::V1::FulfillmentInstance]
540
+ # Required. Fulfillment instance.
541
+ class FulfillmentInput
542
+ include ::Google::Protobuf::MessageExts
543
+ extend ::Google::Protobuf::MessageExts::ClassMethods
544
+ end
545
+
546
+ # Spec for fulfillment instance.
547
+ # @!attribute [rw] prediction
548
+ # @return [::String]
549
+ # Required. Output of the evaluated model.
550
+ # @!attribute [rw] instruction
551
+ # @return [::String]
552
+ # Required. Inference instruction prompt to compare prediction with.
553
+ class FulfillmentInstance
554
+ include ::Google::Protobuf::MessageExts
555
+ extend ::Google::Protobuf::MessageExts::ClassMethods
556
+ end
557
+
558
+ # Spec for fulfillment metric.
559
+ # @!attribute [rw] version
560
+ # @return [::Integer]
561
+ # Optional. Which version to use for evaluation.
562
+ class FulfillmentSpec
563
+ include ::Google::Protobuf::MessageExts
564
+ extend ::Google::Protobuf::MessageExts::ClassMethods
565
+ end
566
+
567
+ # Spec for fulfillment result.
568
+ # @!attribute [r] score
569
+ # @return [::Float]
570
+ # Output only. Fulfillment score.
571
+ # @!attribute [r] explanation
572
+ # @return [::String]
573
+ # Output only. Explanation for fulfillment score.
574
+ # @!attribute [r] confidence
575
+ # @return [::Float]
576
+ # Output only. Confidence for fulfillment score.
577
+ class FulfillmentResult
578
+ include ::Google::Protobuf::MessageExts
579
+ extend ::Google::Protobuf::MessageExts::ClassMethods
580
+ end
581
+
582
+ # Input for summarization quality metric.
583
+ # @!attribute [rw] metric_spec
584
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationQualitySpec]
585
+ # Required. Spec for summarization quality score metric.
586
+ # @!attribute [rw] instance
587
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationQualityInstance]
588
+ # Required. Summarization quality instance.
589
+ class SummarizationQualityInput
590
+ include ::Google::Protobuf::MessageExts
591
+ extend ::Google::Protobuf::MessageExts::ClassMethods
592
+ end
593
+
594
+ # Spec for summarization quality instance.
595
+ # @!attribute [rw] prediction
596
+ # @return [::String]
597
+ # Required. Output of the evaluated model.
598
+ # @!attribute [rw] reference
599
+ # @return [::String]
600
+ # Optional. Ground truth used to compare against the prediction.
601
+ # @!attribute [rw] context
602
+ # @return [::String]
603
+ # Required. Text to be summarized.
604
+ # @!attribute [rw] instruction
605
+ # @return [::String]
606
+ # Required. Summarization prompt for LLM.
607
+ class SummarizationQualityInstance
608
+ include ::Google::Protobuf::MessageExts
609
+ extend ::Google::Protobuf::MessageExts::ClassMethods
610
+ end
611
+
612
+ # Spec for summarization quality score metric.
613
+ # @!attribute [rw] use_reference
614
+ # @return [::Boolean]
615
+ # Optional. Whether to use instance.reference to compute summarization
616
+ # quality.
617
+ # @!attribute [rw] version
618
+ # @return [::Integer]
619
+ # Optional. Which version to use for evaluation.
620
+ class SummarizationQualitySpec
621
+ include ::Google::Protobuf::MessageExts
622
+ extend ::Google::Protobuf::MessageExts::ClassMethods
623
+ end
624
+
625
+ # Spec for summarization quality result.
626
+ # @!attribute [r] score
627
+ # @return [::Float]
628
+ # Output only. Summarization Quality score.
629
+ # @!attribute [r] explanation
630
+ # @return [::String]
631
+ # Output only. Explanation for summarization quality score.
632
+ # @!attribute [r] confidence
633
+ # @return [::Float]
634
+ # Output only. Confidence for summarization quality score.
635
+ class SummarizationQualityResult
636
+ include ::Google::Protobuf::MessageExts
637
+ extend ::Google::Protobuf::MessageExts::ClassMethods
638
+ end
639
+
640
+ # Input for pairwise summarization quality metric.
641
+ # @!attribute [rw] metric_spec
642
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualitySpec]
643
+ # Required. Spec for pairwise summarization quality score metric.
644
+ # @!attribute [rw] instance
645
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualityInstance]
646
+ # Required. Pairwise summarization quality instance.
647
+ class PairwiseSummarizationQualityInput
648
+ include ::Google::Protobuf::MessageExts
649
+ extend ::Google::Protobuf::MessageExts::ClassMethods
650
+ end
651
+
652
+ # Spec for pairwise summarization quality instance.
653
+ # @!attribute [rw] prediction
654
+ # @return [::String]
655
+ # Required. Output of the candidate model.
656
+ # @!attribute [rw] baseline_prediction
657
+ # @return [::String]
658
+ # Required. Output of the baseline model.
659
+ # @!attribute [rw] reference
660
+ # @return [::String]
661
+ # Optional. Ground truth used to compare against the prediction.
662
+ # @!attribute [rw] context
663
+ # @return [::String]
664
+ # Required. Text to be summarized.
665
+ # @!attribute [rw] instruction
666
+ # @return [::String]
667
+ # Required. Summarization prompt for LLM.
668
+ class PairwiseSummarizationQualityInstance
669
+ include ::Google::Protobuf::MessageExts
670
+ extend ::Google::Protobuf::MessageExts::ClassMethods
671
+ end
672
+
673
+ # Spec for pairwise summarization quality score metric.
674
+ # @!attribute [rw] use_reference
675
+ # @return [::Boolean]
676
+ # Optional. Whether to use instance.reference to compute pairwise
677
+ # summarization quality.
678
+ # @!attribute [rw] version
679
+ # @return [::Integer]
680
+ # Optional. Which version to use for evaluation.
681
+ class PairwiseSummarizationQualitySpec
682
+ include ::Google::Protobuf::MessageExts
683
+ extend ::Google::Protobuf::MessageExts::ClassMethods
684
+ end
685
+
686
+ # Spec for pairwise summarization quality result.
687
+ # @!attribute [r] pairwise_choice
688
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseChoice]
689
+ # Output only. Pairwise summarization prediction choice.
690
+ # @!attribute [r] explanation
691
+ # @return [::String]
692
+ # Output only. Explanation for summarization quality score.
693
+ # @!attribute [r] confidence
694
+ # @return [::Float]
695
+ # Output only. Confidence for summarization quality score.
696
+ class PairwiseSummarizationQualityResult
697
+ include ::Google::Protobuf::MessageExts
698
+ extend ::Google::Protobuf::MessageExts::ClassMethods
699
+ end
700
+
701
+ # Input for summarization helpfulness metric.
702
+ # @!attribute [rw] metric_spec
703
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessSpec]
704
+ # Required. Spec for summarization helpfulness score metric.
705
+ # @!attribute [rw] instance
706
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessInstance]
707
+ # Required. Summarization helpfulness instance.
708
+ class SummarizationHelpfulnessInput
709
+ include ::Google::Protobuf::MessageExts
710
+ extend ::Google::Protobuf::MessageExts::ClassMethods
711
+ end
712
+
713
+ # Spec for summarization helpfulness instance.
714
+ # @!attribute [rw] prediction
715
+ # @return [::String]
716
+ # Required. Output of the evaluated model.
717
+ # @!attribute [rw] reference
718
+ # @return [::String]
719
+ # Optional. Ground truth used to compare against the prediction.
720
+ # @!attribute [rw] context
721
+ # @return [::String]
722
+ # Required. Text to be summarized.
723
+ # @!attribute [rw] instruction
724
+ # @return [::String]
725
+ # Optional. Summarization prompt for LLM.
726
+ class SummarizationHelpfulnessInstance
727
+ include ::Google::Protobuf::MessageExts
728
+ extend ::Google::Protobuf::MessageExts::ClassMethods
729
+ end
730
+
731
+ # Spec for summarization helpfulness score metric.
732
+ # @!attribute [rw] use_reference
733
+ # @return [::Boolean]
734
+ # Optional. Whether to use instance.reference to compute summarization
735
+ # helpfulness.
736
+ # @!attribute [rw] version
737
+ # @return [::Integer]
738
+ # Optional. Which version to use for evaluation.
739
+ class SummarizationHelpfulnessSpec
740
+ include ::Google::Protobuf::MessageExts
741
+ extend ::Google::Protobuf::MessageExts::ClassMethods
742
+ end
743
+
744
+ # Spec for summarization helpfulness result.
745
+ # @!attribute [r] score
746
+ # @return [::Float]
747
+ # Output only. Summarization Helpfulness score.
748
+ # @!attribute [r] explanation
749
+ # @return [::String]
750
+ # Output only. Explanation for summarization helpfulness score.
751
+ # @!attribute [r] confidence
752
+ # @return [::Float]
753
+ # Output only. Confidence for summarization helpfulness score.
754
+ class SummarizationHelpfulnessResult
755
+ include ::Google::Protobuf::MessageExts
756
+ extend ::Google::Protobuf::MessageExts::ClassMethods
757
+ end
758
+
759
+ # Input for summarization verbosity metric.
760
+ # @!attribute [rw] metric_spec
761
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationVerbositySpec]
762
+ # Required. Spec for summarization verbosity score metric.
763
+ # @!attribute [rw] instance
764
+ # @return [::Google::Cloud::AIPlatform::V1::SummarizationVerbosityInstance]
765
+ # Required. Summarization verbosity instance.
766
+ class SummarizationVerbosityInput
767
+ include ::Google::Protobuf::MessageExts
768
+ extend ::Google::Protobuf::MessageExts::ClassMethods
769
+ end
770
+
771
+ # Spec for summarization verbosity instance.
772
+ # @!attribute [rw] prediction
773
+ # @return [::String]
774
+ # Required. Output of the evaluated model.
775
+ # @!attribute [rw] reference
776
+ # @return [::String]
777
+ # Optional. Ground truth used to compare against the prediction.
778
+ # @!attribute [rw] context
779
+ # @return [::String]
780
+ # Required. Text to be summarized.
781
+ # @!attribute [rw] instruction
782
+ # @return [::String]
783
+ # Optional. Summarization prompt for LLM.
784
+ class SummarizationVerbosityInstance
785
+ include ::Google::Protobuf::MessageExts
786
+ extend ::Google::Protobuf::MessageExts::ClassMethods
787
+ end
788
+
789
+ # Spec for summarization verbosity score metric.
790
+ # @!attribute [rw] use_reference
791
+ # @return [::Boolean]
792
+ # Optional. Whether to use instance.reference to compute summarization
793
+ # verbosity.
794
+ # @!attribute [rw] version
795
+ # @return [::Integer]
796
+ # Optional. Which version to use for evaluation.
797
+ class SummarizationVerbositySpec
798
+ include ::Google::Protobuf::MessageExts
799
+ extend ::Google::Protobuf::MessageExts::ClassMethods
800
+ end
801
+
802
+ # Spec for summarization verbosity result.
803
+ # @!attribute [r] score
804
+ # @return [::Float]
805
+ # Output only. Summarization Verbosity score.
806
+ # @!attribute [r] explanation
807
+ # @return [::String]
808
+ # Output only. Explanation for summarization verbosity score.
809
+ # @!attribute [r] confidence
810
+ # @return [::Float]
811
+ # Output only. Confidence for summarization verbosity score.
812
+ class SummarizationVerbosityResult
813
+ include ::Google::Protobuf::MessageExts
814
+ extend ::Google::Protobuf::MessageExts::ClassMethods
815
+ end
816
+
817
+ # Input for question answering quality metric.
818
+ # @!attribute [rw] metric_spec
819
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualitySpec]
820
+ # Required. Spec for question answering quality score metric.
821
+ # @!attribute [rw] instance
822
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualityInstance]
823
+ # Required. Question answering quality instance.
824
+ class QuestionAnsweringQualityInput
825
+ include ::Google::Protobuf::MessageExts
826
+ extend ::Google::Protobuf::MessageExts::ClassMethods
827
+ end
828
+
829
+ # Spec for question answering quality instance.
830
+ # @!attribute [rw] prediction
831
+ # @return [::String]
832
+ # Required. Output of the evaluated model.
833
+ # @!attribute [rw] reference
834
+ # @return [::String]
835
+ # Optional. Ground truth used to compare against the prediction.
836
+ # @!attribute [rw] context
837
+ # @return [::String]
838
+ # Required. Text to answer the question.
839
+ # @!attribute [rw] instruction
840
+ # @return [::String]
841
+ # Required. Question Answering prompt for LLM.
842
+ class QuestionAnsweringQualityInstance
843
+ include ::Google::Protobuf::MessageExts
844
+ extend ::Google::Protobuf::MessageExts::ClassMethods
845
+ end
846
+
847
+ # Spec for question answering quality score metric.
848
+ # @!attribute [rw] use_reference
849
+ # @return [::Boolean]
850
+ # Optional. Whether to use instance.reference to compute question answering
851
+ # quality.
852
+ # @!attribute [rw] version
853
+ # @return [::Integer]
854
+ # Optional. Which version to use for evaluation.
855
+ class QuestionAnsweringQualitySpec
856
+ include ::Google::Protobuf::MessageExts
857
+ extend ::Google::Protobuf::MessageExts::ClassMethods
858
+ end
859
+
860
+ # Spec for question answering quality result.
861
+ # @!attribute [r] score
862
+ # @return [::Float]
863
+ # Output only. Question Answering Quality score.
864
+ # @!attribute [r] explanation
865
+ # @return [::String]
866
+ # Output only. Explanation for question answering quality score.
867
+ # @!attribute [r] confidence
868
+ # @return [::Float]
869
+ # Output only. Confidence for question answering quality score.
870
+ class QuestionAnsweringQualityResult
871
+ include ::Google::Protobuf::MessageExts
872
+ extend ::Google::Protobuf::MessageExts::ClassMethods
873
+ end
874
+
875
+ # Input for pairwise question answering quality metric.
876
+ # @!attribute [rw] metric_spec
877
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualitySpec]
878
+ # Required. Spec for pairwise question answering quality score metric.
879
+ # @!attribute [rw] instance
880
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualityInstance]
881
+ # Required. Pairwise question answering quality instance.
882
+ class PairwiseQuestionAnsweringQualityInput
883
+ include ::Google::Protobuf::MessageExts
884
+ extend ::Google::Protobuf::MessageExts::ClassMethods
885
+ end
886
+
887
+ # Spec for pairwise question answering quality instance.
888
+ # @!attribute [rw] prediction
889
+ # @return [::String]
890
+ # Required. Output of the candidate model.
891
+ # @!attribute [rw] baseline_prediction
892
+ # @return [::String]
893
+ # Required. Output of the baseline model.
894
+ # @!attribute [rw] reference
895
+ # @return [::String]
896
+ # Optional. Ground truth used to compare against the prediction.
897
+ # @!attribute [rw] context
898
+ # @return [::String]
899
+ # Required. Text to answer the question.
900
+ # @!attribute [rw] instruction
901
+ # @return [::String]
902
+ # Required. Question Answering prompt for LLM.
903
+ class PairwiseQuestionAnsweringQualityInstance
904
+ include ::Google::Protobuf::MessageExts
905
+ extend ::Google::Protobuf::MessageExts::ClassMethods
906
+ end
907
+
908
+ # Spec for pairwise question answering quality score metric.
909
+ # @!attribute [rw] use_reference
910
+ # @return [::Boolean]
911
+ # Optional. Whether to use instance.reference to compute question answering
912
+ # quality.
913
+ # @!attribute [rw] version
914
+ # @return [::Integer]
915
+ # Optional. Which version to use for evaluation.
916
+ class PairwiseQuestionAnsweringQualitySpec
917
+ include ::Google::Protobuf::MessageExts
918
+ extend ::Google::Protobuf::MessageExts::ClassMethods
919
+ end
920
+
921
+ # Spec for pairwise question answering quality result.
922
+ # @!attribute [r] pairwise_choice
923
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseChoice]
924
+ # Output only. Pairwise question answering prediction choice.
925
+ # @!attribute [r] explanation
926
+ # @return [::String]
927
+ # Output only. Explanation for question answering quality score.
928
+ # @!attribute [r] confidence
929
+ # @return [::Float]
930
+ # Output only. Confidence for question answering quality score.
931
+ class PairwiseQuestionAnsweringQualityResult
932
+ include ::Google::Protobuf::MessageExts
933
+ extend ::Google::Protobuf::MessageExts::ClassMethods
934
+ end
935
+
936
+ # Input for question answering relevance metric.
937
+ # @!attribute [rw] metric_spec
938
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceSpec]
939
+ # Required. Spec for question answering relevance score metric.
940
+ # @!attribute [rw] instance
941
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceInstance]
942
+ # Required. Question answering relevance instance.
943
+ class QuestionAnsweringRelevanceInput
944
+ include ::Google::Protobuf::MessageExts
945
+ extend ::Google::Protobuf::MessageExts::ClassMethods
946
+ end
947
+
948
+ # Spec for question answering relevance instance.
949
+ # @!attribute [rw] prediction
950
+ # @return [::String]
951
+ # Required. Output of the evaluated model.
952
+ # @!attribute [rw] reference
953
+ # @return [::String]
954
+ # Optional. Ground truth used to compare against the prediction.
955
+ # @!attribute [rw] context
956
+ # @return [::String]
957
+ # Optional. Text provided as context to answer the question.
958
+ # @!attribute [rw] instruction
959
+ # @return [::String]
960
+ # Required. The question asked and other instruction in the inference prompt.
961
+ class QuestionAnsweringRelevanceInstance
962
+ include ::Google::Protobuf::MessageExts
963
+ extend ::Google::Protobuf::MessageExts::ClassMethods
964
+ end
965
+
966
+ # Spec for question answering relevance metric.
967
+ # @!attribute [rw] use_reference
968
+ # @return [::Boolean]
969
+ # Optional. Whether to use instance.reference to compute question answering
970
+ # relevance.
971
+ # @!attribute [rw] version
972
+ # @return [::Integer]
973
+ # Optional. Which version to use for evaluation.
974
+ class QuestionAnsweringRelevanceSpec
975
+ include ::Google::Protobuf::MessageExts
976
+ extend ::Google::Protobuf::MessageExts::ClassMethods
977
+ end
978
+
979
+ # Spec for question answering relevance result.
980
+ # @!attribute [r] score
981
+ # @return [::Float]
982
+ # Output only. Question Answering Relevance score.
983
+ # @!attribute [r] explanation
984
+ # @return [::String]
985
+ # Output only. Explanation for question answering relevance score.
986
+ # @!attribute [r] confidence
987
+ # @return [::Float]
988
+ # Output only. Confidence for question answering relevance score.
989
+ class QuestionAnsweringRelevanceResult
990
+ include ::Google::Protobuf::MessageExts
991
+ extend ::Google::Protobuf::MessageExts::ClassMethods
992
+ end
993
+
994
+ # Input for question answering helpfulness metric.
995
+ # @!attribute [rw] metric_spec
996
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessSpec]
997
+ # Required. Spec for question answering helpfulness score metric.
998
+ # @!attribute [rw] instance
999
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessInstance]
1000
+ # Required. Question answering helpfulness instance.
1001
+ class QuestionAnsweringHelpfulnessInput
1002
+ include ::Google::Protobuf::MessageExts
1003
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1004
+ end
1005
+
1006
+ # Spec for question answering helpfulness instance.
1007
+ # @!attribute [rw] prediction
1008
+ # @return [::String]
1009
+ # Required. Output of the evaluated model.
1010
+ # @!attribute [rw] reference
1011
+ # @return [::String]
1012
+ # Optional. Ground truth used to compare against the prediction.
1013
+ # @!attribute [rw] context
1014
+ # @return [::String]
1015
+ # Optional. Text provided as context to answer the question.
1016
+ # @!attribute [rw] instruction
1017
+ # @return [::String]
1018
+ # Required. The question asked and other instruction in the inference prompt.
1019
+ class QuestionAnsweringHelpfulnessInstance
1020
+ include ::Google::Protobuf::MessageExts
1021
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1022
+ end
1023
+
1024
+ # Spec for question answering helpfulness metric.
1025
+ # @!attribute [rw] use_reference
1026
+ # @return [::Boolean]
1027
+ # Optional. Whether to use instance.reference to compute question answering
1028
+ # helpfulness.
1029
+ # @!attribute [rw] version
1030
+ # @return [::Integer]
1031
+ # Optional. Which version to use for evaluation.
1032
+ class QuestionAnsweringHelpfulnessSpec
1033
+ include ::Google::Protobuf::MessageExts
1034
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1035
+ end
1036
+
1037
+ # Spec for question answering helpfulness result.
1038
+ # @!attribute [r] score
1039
+ # @return [::Float]
1040
+ # Output only. Question Answering Helpfulness score.
1041
+ # @!attribute [r] explanation
1042
+ # @return [::String]
1043
+ # Output only. Explanation for question answering helpfulness score.
1044
+ # @!attribute [r] confidence
1045
+ # @return [::Float]
1046
+ # Output only. Confidence for question answering helpfulness score.
1047
+ class QuestionAnsweringHelpfulnessResult
1048
+ include ::Google::Protobuf::MessageExts
1049
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1050
+ end
1051
+
1052
+ # Input for question answering correctness metric.
1053
+ # @!attribute [rw] metric_spec
1054
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessSpec]
1055
+ # Required. Spec for question answering correctness score metric.
1056
+ # @!attribute [rw] instance
1057
+ # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessInstance]
1058
+ # Required. Question answering correctness instance.
1059
+ class QuestionAnsweringCorrectnessInput
1060
+ include ::Google::Protobuf::MessageExts
1061
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1062
+ end
1063
+
1064
+ # Spec for question answering correctness instance.
1065
+ # @!attribute [rw] prediction
1066
+ # @return [::String]
1067
+ # Required. Output of the evaluated model.
1068
+ # @!attribute [rw] reference
1069
+ # @return [::String]
1070
+ # Optional. Ground truth used to compare against the prediction.
1071
+ # @!attribute [rw] context
1072
+ # @return [::String]
1073
+ # Optional. Text provided as context to answer the question.
1074
+ # @!attribute [rw] instruction
1075
+ # @return [::String]
1076
+ # Required. The question asked and other instruction in the inference prompt.
1077
+ class QuestionAnsweringCorrectnessInstance
1078
+ include ::Google::Protobuf::MessageExts
1079
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1080
+ end
1081
+
1082
+ # Spec for question answering correctness metric.
1083
+ # @!attribute [rw] use_reference
1084
+ # @return [::Boolean]
1085
+ # Optional. Whether to use instance.reference to compute question answering
1086
+ # correctness.
1087
+ # @!attribute [rw] version
1088
+ # @return [::Integer]
1089
+ # Optional. Which version to use for evaluation.
1090
+ class QuestionAnsweringCorrectnessSpec
1091
+ include ::Google::Protobuf::MessageExts
1092
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1093
+ end
1094
+
1095
+ # Spec for question answering correctness result.
1096
+ # @!attribute [r] score
1097
+ # @return [::Float]
1098
+ # Output only. Question Answering Correctness score.
1099
+ # @!attribute [r] explanation
1100
+ # @return [::String]
1101
+ # Output only. Explanation for question answering correctness score.
1102
+ # @!attribute [r] confidence
1103
+ # @return [::Float]
1104
+ # Output only. Confidence for question answering correctness score.
1105
+ class QuestionAnsweringCorrectnessResult
1106
+ include ::Google::Protobuf::MessageExts
1107
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1108
+ end
1109
+
1110
+ # Input for pointwise metric.
1111
+ # @!attribute [rw] metric_spec
1112
+ # @return [::Google::Cloud::AIPlatform::V1::PointwiseMetricSpec]
1113
+ # Required. Spec for pointwise metric.
1114
+ # @!attribute [rw] instance
1115
+ # @return [::Google::Cloud::AIPlatform::V1::PointwiseMetricInstance]
1116
+ # Required. Pointwise metric instance.
1117
+ class PointwiseMetricInput
1118
+ include ::Google::Protobuf::MessageExts
1119
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1120
+ end
1121
+
1122
+ # Pointwise metric instance. Usually one instance corresponds to one row in an
1123
+ # evaluation dataset.
1124
+ # @!attribute [rw] json_instance
1125
+ # @return [::String]
1126
+ # Instance specified as a json string. String key-value pairs are expected
1127
+ # in the json_instance to render
1128
+ # PointwiseMetricSpec.instance_prompt_template.
1129
+ class PointwiseMetricInstance
1130
+ include ::Google::Protobuf::MessageExts
1131
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1132
+ end
1133
+
1134
+ # Spec for pointwise metric.
1135
+ # @!attribute [rw] metric_prompt_template
1136
+ # @return [::String]
1137
+ # Required. Metric prompt template for pointwise metric.
1138
+ class PointwiseMetricSpec
1139
+ include ::Google::Protobuf::MessageExts
1140
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1141
+ end
1142
+
1143
+ # Spec for pointwise metric result.
1144
+ # @!attribute [r] score
1145
+ # @return [::Float]
1146
+ # Output only. Pointwise metric score.
1147
+ # @!attribute [r] explanation
1148
+ # @return [::String]
1149
+ # Output only. Explanation for pointwise metric score.
1150
+ class PointwiseMetricResult
1151
+ include ::Google::Protobuf::MessageExts
1152
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1153
+ end
1154
+
1155
+ # Input for pairwise metric.
1156
+ # @!attribute [rw] metric_spec
1157
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseMetricSpec]
1158
+ # Required. Spec for pairwise metric.
1159
+ # @!attribute [rw] instance
1160
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseMetricInstance]
1161
+ # Required. Pairwise metric instance.
1162
+ class PairwiseMetricInput
1163
+ include ::Google::Protobuf::MessageExts
1164
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1165
+ end
1166
+
1167
+ # Pairwise metric instance. Usually one instance corresponds to one row in an
1168
+ # evaluation dataset.
1169
+ # @!attribute [rw] json_instance
1170
+ # @return [::String]
1171
+ # Instance specified as a json string. String key-value pairs are expected
1172
+ # in the json_instance to render
1173
+ # PairwiseMetricSpec.instance_prompt_template.
1174
+ class PairwiseMetricInstance
1175
+ include ::Google::Protobuf::MessageExts
1176
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1177
+ end
1178
+
1179
+ # Spec for pairwise metric.
1180
+ # @!attribute [rw] metric_prompt_template
1181
+ # @return [::String]
1182
+ # Required. Metric prompt template for pairwise metric.
1183
+ class PairwiseMetricSpec
1184
+ include ::Google::Protobuf::MessageExts
1185
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1186
+ end
1187
+
1188
+ # Spec for pairwise metric result.
1189
+ # @!attribute [r] pairwise_choice
1190
+ # @return [::Google::Cloud::AIPlatform::V1::PairwiseChoice]
1191
+ # Output only. Pairwise metric choice.
1192
+ # @!attribute [r] explanation
1193
+ # @return [::String]
1194
+ # Output only. Explanation for pairwise metric score.
1195
+ class PairwiseMetricResult
1196
+ include ::Google::Protobuf::MessageExts
1197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1198
+ end
1199
+
1200
+ # Input for tool call valid metric.
1201
+ # @!attribute [rw] metric_spec
1202
+ # @return [::Google::Cloud::AIPlatform::V1::ToolCallValidSpec]
1203
+ # Required. Spec for tool call valid metric.
1204
+ # @!attribute [rw] instances
1205
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ToolCallValidInstance>]
1206
+ # Required. Repeated tool call valid instances.
1207
+ class ToolCallValidInput
1208
+ include ::Google::Protobuf::MessageExts
1209
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1210
+ end
1211
+
1212
+ # Spec for tool call valid metric.
1213
+ class ToolCallValidSpec
1214
+ include ::Google::Protobuf::MessageExts
1215
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1216
+ end
1217
+
1218
+ # Spec for tool call valid instance.
1219
+ # @!attribute [rw] prediction
1220
+ # @return [::String]
1221
+ # Required. Output of the evaluated model.
1222
+ # @!attribute [rw] reference
1223
+ # @return [::String]
1224
+ # Required. Ground truth used to compare against the prediction.
1225
+ class ToolCallValidInstance
1226
+ include ::Google::Protobuf::MessageExts
1227
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1228
+ end
1229
+
1230
+ # Results for tool call valid metric.
1231
+ # @!attribute [r] tool_call_valid_metric_values
1232
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ToolCallValidMetricValue>]
1233
+ # Output only. Tool call valid metric values.
1234
+ class ToolCallValidResults
1235
+ include ::Google::Protobuf::MessageExts
1236
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1237
+ end
1238
+
1239
+ # Tool call valid metric value for an instance.
1240
+ # @!attribute [r] score
1241
+ # @return [::Float]
1242
+ # Output only. Tool call valid score.
1243
+ class ToolCallValidMetricValue
1244
+ include ::Google::Protobuf::MessageExts
1245
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1246
+ end
1247
+
1248
+ # Input for tool name match metric.
1249
+ # @!attribute [rw] metric_spec
1250
+ # @return [::Google::Cloud::AIPlatform::V1::ToolNameMatchSpec]
1251
+ # Required. Spec for tool name match metric.
1252
+ # @!attribute [rw] instances
1253
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ToolNameMatchInstance>]
1254
+ # Required. Repeated tool name match instances.
1255
+ class ToolNameMatchInput
1256
+ include ::Google::Protobuf::MessageExts
1257
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1258
+ end
1259
+
1260
+ # Spec for tool name match metric.
1261
+ class ToolNameMatchSpec
1262
+ include ::Google::Protobuf::MessageExts
1263
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1264
+ end
1265
+
1266
+ # Spec for tool name match instance.
1267
+ # @!attribute [rw] prediction
1268
+ # @return [::String]
1269
+ # Required. Output of the evaluated model.
1270
+ # @!attribute [rw] reference
1271
+ # @return [::String]
1272
+ # Required. Ground truth used to compare against the prediction.
1273
+ class ToolNameMatchInstance
1274
+ include ::Google::Protobuf::MessageExts
1275
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1276
+ end
1277
+
1278
+ # Results for tool name match metric.
1279
+ # @!attribute [r] tool_name_match_metric_values
1280
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ToolNameMatchMetricValue>]
1281
+ # Output only. Tool name match metric values.
1282
+ class ToolNameMatchResults
1283
+ include ::Google::Protobuf::MessageExts
1284
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1285
+ end
1286
+
1287
+ # Tool name match metric value for an instance.
1288
+ # @!attribute [r] score
1289
+ # @return [::Float]
1290
+ # Output only. Tool name match score.
1291
+ class ToolNameMatchMetricValue
1292
+ include ::Google::Protobuf::MessageExts
1293
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1294
+ end
1295
+
1296
+ # Input for tool parameter key match metric.
1297
+ # @!attribute [rw] metric_spec
1298
+ # @return [::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchSpec]
1299
+ # Required. Spec for tool parameter key match metric.
1300
+ # @!attribute [rw] instances
1301
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchInstance>]
1302
+ # Required. Repeated tool parameter key match instances.
1303
+ class ToolParameterKeyMatchInput
1304
+ include ::Google::Protobuf::MessageExts
1305
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1306
+ end
1307
+
1308
+ # Spec for tool parameter key match metric.
1309
+ class ToolParameterKeyMatchSpec
1310
+ include ::Google::Protobuf::MessageExts
1311
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1312
+ end
1313
+
1314
+ # Spec for tool parameter key match instance.
1315
+ # @!attribute [rw] prediction
1316
+ # @return [::String]
1317
+ # Required. Output of the evaluated model.
1318
+ # @!attribute [rw] reference
1319
+ # @return [::String]
1320
+ # Required. Ground truth used to compare against the prediction.
1321
+ class ToolParameterKeyMatchInstance
1322
+ include ::Google::Protobuf::MessageExts
1323
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1324
+ end
1325
+
1326
+ # Results for tool parameter key match metric.
1327
+ # @!attribute [r] tool_parameter_key_match_metric_values
1328
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchMetricValue>]
1329
+ # Output only. Tool parameter key match metric values.
1330
+ class ToolParameterKeyMatchResults
1331
+ include ::Google::Protobuf::MessageExts
1332
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1333
+ end
1334
+
1335
+ # Tool parameter key match metric value for an instance.
1336
+ # @!attribute [r] score
1337
+ # @return [::Float]
1338
+ # Output only. Tool parameter key match score.
1339
+ class ToolParameterKeyMatchMetricValue
1340
+ include ::Google::Protobuf::MessageExts
1341
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1342
+ end
1343
+
1344
+ # Input for tool parameter key value match metric.
1345
+ # @!attribute [rw] metric_spec
1346
+ # @return [::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchSpec]
1347
+ # Required. Spec for tool parameter key value match metric.
1348
+ # @!attribute [rw] instances
1349
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchInstance>]
1350
+ # Required. Repeated tool parameter key value match instances.
1351
+ class ToolParameterKVMatchInput
1352
+ include ::Google::Protobuf::MessageExts
1353
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1354
+ end
1355
+
1356
+ # Spec for tool parameter key value match metric.
1357
+ # @!attribute [rw] use_strict_string_match
1358
+ # @return [::Boolean]
1359
+ # Optional. Whether to use STRCIT string match on parameter values.
1360
+ class ToolParameterKVMatchSpec
1361
+ include ::Google::Protobuf::MessageExts
1362
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1363
+ end
1364
+
1365
+ # Spec for tool parameter key value match instance.
1366
+ # @!attribute [rw] prediction
1367
+ # @return [::String]
1368
+ # Required. Output of the evaluated model.
1369
+ # @!attribute [rw] reference
1370
+ # @return [::String]
1371
+ # Required. Ground truth used to compare against the prediction.
1372
+ class ToolParameterKVMatchInstance
1373
+ include ::Google::Protobuf::MessageExts
1374
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1375
+ end
1376
+
1377
+ # Results for tool parameter key value match metric.
1378
+ # @!attribute [r] tool_parameter_kv_match_metric_values
1379
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchMetricValue>]
1380
+ # Output only. Tool parameter key value match metric values.
1381
+ class ToolParameterKVMatchResults
1382
+ include ::Google::Protobuf::MessageExts
1383
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1384
+ end
1385
+
1386
+ # Tool parameter key value match metric value for an instance.
1387
+ # @!attribute [r] score
1388
+ # @return [::Float]
1389
+ # Output only. Tool parameter key value match score.
1390
+ class ToolParameterKVMatchMetricValue
1391
+ include ::Google::Protobuf::MessageExts
1392
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1393
+ end
1394
+
1395
+ # Pairwise prediction autorater preference.
1396
+ module PairwiseChoice
1397
+ # Unspecified prediction choice.
1398
+ PAIRWISE_CHOICE_UNSPECIFIED = 0
1399
+
1400
+ # Baseline prediction wins
1401
+ BASELINE = 1
1402
+
1403
+ # Candidate prediction wins
1404
+ CANDIDATE = 2
1405
+
1406
+ # Winner cannot be determined
1407
+ TIE = 3
1408
+ end
1409
+ end
1410
+ end
1411
+ end
1412
+ end