google-cloud-dialogflow-v2 1.12.1 → 1.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/dialogflow/v2/agent_coaching_instruction_pb.rb +47 -0
  3. data/lib/google/cloud/dialogflow/v2/answer_record_pb.rb +3 -1
  4. data/lib/google/cloud/dialogflow/v2/answer_records/paths.rb +19 -0
  5. data/lib/google/cloud/dialogflow/v2/audio_config_pb.rb +3 -1
  6. data/lib/google/cloud/dialogflow/v2/conversation_event_pb.rb +3 -1
  7. data/lib/google/cloud/dialogflow/v2/conversation_model_pb.rb +1 -1
  8. data/lib/google/cloud/dialogflow/v2/conversation_pb.rb +1 -1
  9. data/lib/google/cloud/dialogflow/v2/conversation_profile_pb.rb +3 -1
  10. data/lib/google/cloud/dialogflow/v2/conversations/client.rb +10 -1
  11. data/lib/google/cloud/dialogflow/v2/conversations/paths.rb +19 -0
  12. data/lib/google/cloud/dialogflow/v2/conversations/rest/client.rb +10 -1
  13. data/lib/google/cloud/dialogflow/v2/document_pb.rb +1 -1
  14. data/lib/google/cloud/dialogflow/v2/generator_evaluation_pb.rb +82 -0
  15. data/lib/google/cloud/dialogflow/v2/generator_evaluation_services_pb.rb +51 -0
  16. data/lib/google/cloud/dialogflow/v2/generator_evaluations/client.rb +815 -0
  17. data/lib/google/cloud/dialogflow/v2/generator_evaluations/credentials.rb +52 -0
  18. data/lib/google/cloud/dialogflow/v2/generator_evaluations/operations.rb +841 -0
  19. data/lib/google/cloud/dialogflow/v2/generator_evaluations/paths.rb +92 -0
  20. data/lib/google/cloud/dialogflow/v2/generator_evaluations/rest/client.rb +752 -0
  21. data/lib/google/cloud/dialogflow/v2/generator_evaluations/rest/operations.rb +945 -0
  22. data/lib/google/cloud/dialogflow/v2/generator_evaluations/rest/service_stub.rb +326 -0
  23. data/lib/google/cloud/dialogflow/v2/generator_evaluations/rest.rb +54 -0
  24. data/lib/google/cloud/dialogflow/v2/generator_evaluations.rb +56 -0
  25. data/lib/google/cloud/dialogflow/v2/generator_pb.rb +18 -1
  26. data/lib/google/cloud/dialogflow/v2/generators/paths.rb +19 -0
  27. data/lib/google/cloud/dialogflow/v2/operations_pb.rb +45 -0
  28. data/lib/google/cloud/dialogflow/v2/participant_pb.rb +3 -1
  29. data/lib/google/cloud/dialogflow/v2/rest.rb +3 -0
  30. data/lib/google/cloud/dialogflow/v2/sip_trunk_pb.rb +62 -0
  31. data/lib/google/cloud/dialogflow/v2/sip_trunk_services_pb.rb +53 -0
  32. data/lib/google/cloud/dialogflow/v2/sip_trunks/client.rb +885 -0
  33. data/lib/google/cloud/dialogflow/v2/sip_trunks/credentials.rb +52 -0
  34. data/lib/google/cloud/dialogflow/v2/sip_trunks/paths.rb +69 -0
  35. data/lib/google/cloud/dialogflow/v2/sip_trunks/rest/client.rb +815 -0
  36. data/lib/google/cloud/dialogflow/v2/sip_trunks/rest/service_stub.rb +388 -0
  37. data/lib/google/cloud/dialogflow/v2/sip_trunks/rest.rb +53 -0
  38. data/lib/google/cloud/dialogflow/v2/sip_trunks.rb +55 -0
  39. data/lib/google/cloud/dialogflow/v2/tool_call_pb.rb +52 -0
  40. data/lib/google/cloud/dialogflow/v2/tool_pb.rb +80 -0
  41. data/lib/google/cloud/dialogflow/v2/tool_services_pb.rb +55 -0
  42. data/lib/google/cloud/dialogflow/v2/tools/client.rb +897 -0
  43. data/lib/google/cloud/dialogflow/v2/tools/credentials.rb +52 -0
  44. data/lib/google/cloud/dialogflow/v2/tools/paths.rb +109 -0
  45. data/lib/google/cloud/dialogflow/v2/tools/rest/client.rb +827 -0
  46. data/lib/google/cloud/dialogflow/v2/tools/rest/service_stub.rb +388 -0
  47. data/lib/google/cloud/dialogflow/v2/tools/rest.rb +55 -0
  48. data/lib/google/cloud/dialogflow/v2/tools.rb +57 -0
  49. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  50. data/lib/google/cloud/dialogflow/v2/webhook_pb.rb +2 -1
  51. data/lib/google/cloud/dialogflow/v2.rb +3 -0
  52. data/proto_docs/google/cloud/dialogflow/v2/agent_coaching_instruction.rb +109 -0
  53. data/proto_docs/google/cloud/dialogflow/v2/answer_record.rb +8 -3
  54. data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +40 -0
  55. data/proto_docs/google/cloud/dialogflow/v2/conversation.rb +19 -2
  56. data/proto_docs/google/cloud/dialogflow/v2/conversation_event.rb +2 -0
  57. data/proto_docs/google/cloud/dialogflow/v2/conversation_model.rb +12 -0
  58. data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +38 -6
  59. data/proto_docs/google/cloud/dialogflow/v2/document.rb +3 -0
  60. data/proto_docs/google/cloud/dialogflow/v2/generator.rb +220 -4
  61. data/proto_docs/google/cloud/dialogflow/v2/generator_evaluation.rb +539 -0
  62. data/proto_docs/google/cloud/dialogflow/v2/operations.rb +39 -0
  63. data/proto_docs/google/cloud/dialogflow/v2/participant.rb +70 -7
  64. data/proto_docs/google/cloud/dialogflow/v2/sip_trunk.rb +211 -0
  65. data/proto_docs/google/cloud/dialogflow/v2/tool.rb +552 -0
  66. data/proto_docs/google/cloud/dialogflow/v2/tool_call.rb +115 -0
  67. metadata +39 -1
@@ -0,0 +1,539 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 Dialogflow
23
+ module V2
24
+ # Request of CreateGeneratorEvaluation.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The generator resource name. Format:
28
+ # `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
29
+ # @!attribute [rw] generator_evaluation
30
+ # @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluation]
31
+ # Required. The generator evaluation to be created.
32
+ class CreateGeneratorEvaluationRequest
33
+ include ::Google::Protobuf::MessageExts
34
+ extend ::Google::Protobuf::MessageExts::ClassMethods
35
+ end
36
+
37
+ # Request of GetGeneratorEvaluation.
38
+ # @!attribute [rw] name
39
+ # @return [::String]
40
+ # Required. The generator evaluation resource name. Format:
41
+ # `projects/<Project ID>/locations/<Location ID>/generators/<Generator
42
+ # ID>/evaluations/<Evaluation ID>`
43
+ class GetGeneratorEvaluationRequest
44
+ include ::Google::Protobuf::MessageExts
45
+ extend ::Google::Protobuf::MessageExts::ClassMethods
46
+ end
47
+
48
+ # Request of ListGeneratorEvaluations.
49
+ # @!attribute [rw] parent
50
+ # @return [::String]
51
+ # Required. The generator resource name. Format:
52
+ # `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
53
+ # Wildcard value `-` is supported on generator_id to list evaluations across
54
+ # all generators under same project.
55
+ # @!attribute [rw] page_size
56
+ # @return [::Integer]
57
+ # Optional. Maximum number of evaluations to return in a
58
+ # single page. By default 100 and at most 1000.
59
+ # @!attribute [rw] page_token
60
+ # @return [::String]
61
+ # Optional. The next_page_token value returned from a previous list request.
62
+ class ListGeneratorEvaluationsRequest
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+ end
66
+
67
+ # Response of ListGeneratorEvaluations.
68
+ # @!attribute [rw] generator_evaluations
69
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::GeneratorEvaluation>]
70
+ # The list of evaluations to return.
71
+ # @!attribute [rw] next_page_token
72
+ # @return [::String]
73
+ # Token to retrieve the next page of results, or empty if there are no more
74
+ # results in the list.
75
+ class ListGeneratorEvaluationsResponse
76
+ include ::Google::Protobuf::MessageExts
77
+ extend ::Google::Protobuf::MessageExts::ClassMethods
78
+ end
79
+
80
+ # Request of DeleteGeneratorEvaluation.
81
+ # @!attribute [rw] name
82
+ # @return [::String]
83
+ # Required. The generator evaluation resource name. Format:
84
+ # `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/
85
+ # evaluations/<Evaluation ID>`
86
+ class DeleteGeneratorEvaluationRequest
87
+ include ::Google::Protobuf::MessageExts
88
+ extend ::Google::Protobuf::MessageExts::ClassMethods
89
+ end
90
+
91
+ # Represents evaluation result of a generator.
92
+ # @!attribute [r] name
93
+ # @return [::String]
94
+ # Output only. Identifier. The resource name of the evaluation. Format:
95
+ # `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/
96
+ # evaluations/<Evaluation ID>`
97
+ # @!attribute [rw] display_name
98
+ # @return [::String]
99
+ # Optional. The display name of the generator evaluation. At most 64 bytes
100
+ # long.
101
+ # @!attribute [rw] generator_evaluation_config
102
+ # @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig]
103
+ # Required. The configuration of the evaluation task.
104
+ # @!attribute [r] create_time
105
+ # @return [::Google::Protobuf::Timestamp]
106
+ # Output only. Creation time of this generator evaluation.
107
+ # @!attribute [r] complete_time
108
+ # @return [::Google::Protobuf::Timestamp]
109
+ # Output only. Completion time of this generator evaluation.
110
+ # @!attribute [rw] initial_generator
111
+ # @return [::Google::Cloud::Dialogflow::V2::Generator]
112
+ # Required. The initial generator that was used when creating this
113
+ # evaluation. This is a copy of the generator read from storage when creating
114
+ # the evaluation.
115
+ # @!attribute [r] summarization_metrics
116
+ # @return [::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics]
117
+ # Output only. Only available when the summarization generator is provided.
118
+ # @!attribute [r] evaluation_status
119
+ # @return [::Google::Cloud::Dialogflow::V2::EvaluationStatus]
120
+ # Output only. The result status of the evaluation pipeline. Provides the
121
+ # status information including if the evaluation is still in progress,
122
+ # completed or failed with certain error and user actionable message.
123
+ # @!attribute [r] satisfies_pzs
124
+ # @return [::Boolean]
125
+ # Output only. A read only boolean field reflecting Zone Separation
126
+ # status of the model. The field is an aggregated
127
+ # value of ZS status of its underlying dependencies. See more details in
128
+ # go/zicy-resource-placement#resource-status
129
+ # @!attribute [r] satisfies_pzi
130
+ # @return [::Boolean]
131
+ # Output only. A read only boolean field reflecting Zone Isolation status
132
+ # of the model. The field is an aggregated value of
133
+ # ZI status of its underlying dependencies. See more details in
134
+ # go/zicy-resource-placement#resource-status
135
+ class GeneratorEvaluation
136
+ include ::Google::Protobuf::MessageExts
137
+ extend ::Google::Protobuf::MessageExts::ClassMethods
138
+ end
139
+
140
+ # Evaluation metrics for summarization generator.
141
+ # @!attribute [r] summarization_evaluation_results
142
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::SummarizationEvaluationResult>]
143
+ # Output only. A list of evaluation results per conversation(&summary),
144
+ # metric and section.
145
+ # @!attribute [r] summarization_evaluation_merged_results_uri
146
+ # @return [::String]
147
+ # Output only. User bucket uri for merged evaluation score and aggregation
148
+ # score csv.
149
+ # @!attribute [r] overall_metrics
150
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::OverallScoresByMetric>]
151
+ # Output only. A list of aggregated(average) scores per metric section.
152
+ # @!attribute [r] overall_section_tokens
153
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::SectionToken>]
154
+ # Output only. Overall token per section. This is an aggregated(sum) result
155
+ # of input token of summary acorss all conversations that are selected for
156
+ # summarization evaluation.
157
+ # @!attribute [r] conversation_details
158
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::ConversationDetail>]
159
+ # Output only. List of conversation details.
160
+ class SummarizationEvaluationMetrics
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+
164
+ # Decomposition details for accuracy.
165
+ # @!attribute [r] point
166
+ # @return [::String]
167
+ # Output only. The breakdown point of the summary.
168
+ # @!attribute [r] accuracy_reasoning
169
+ # @return [::String]
170
+ # Output only. The accuracy reasoning of the breakdown point.
171
+ # @!attribute [r] is_accurate
172
+ # @return [::Boolean]
173
+ # Output only. Whether the breakdown point is accurate or not.
174
+ class AccuracyDecomposition
175
+ include ::Google::Protobuf::MessageExts
176
+ extend ::Google::Protobuf::MessageExts::ClassMethods
177
+ end
178
+
179
+ # Decomposition details for adherence.
180
+ # @deprecated This message is deprecated and may be removed in the next major version update.
181
+ # @!attribute [r] point
182
+ # @return [::String]
183
+ # Output only. The breakdown point of the given instructions.
184
+ # @!attribute [r] adherence_reasoning
185
+ # @return [::String]
186
+ # Output only. The adherence reasoning of the breakdown point.
187
+ # @!attribute [r] is_adherent
188
+ # @return [::Boolean]
189
+ # Output only. Whether the breakdown point is adherent or not.
190
+ class AdherenceDecomposition
191
+ include ::Google::Protobuf::MessageExts
192
+ extend ::Google::Protobuf::MessageExts::ClassMethods
193
+ end
194
+
195
+ # Rubric result of the adherence evaluation. A rubric is ued to determine
196
+ # if the summary adheres to all aspects of the given instructions.
197
+ # @!attribute [r] question
198
+ # @return [::String]
199
+ # Output only. The question generated from instruction that used to
200
+ # evaluate summary.
201
+ # @!attribute [r] reasoning
202
+ # @return [::String]
203
+ # Output only. The reasoning of the rubric question is addressed or not.
204
+ # @!attribute [r] is_addressed
205
+ # @return [::Boolean]
206
+ # Output only. A boolean that indicates whether the rubric question is
207
+ # addressed or not.
208
+ class AdherenceRubric
209
+ include ::Google::Protobuf::MessageExts
210
+ extend ::Google::Protobuf::MessageExts::ClassMethods
211
+ end
212
+
213
+ # Rubric details of the completeness evaluation result.
214
+ # @!attribute [r] question
215
+ # @return [::String]
216
+ # Output only. The question generated from instruction that used to
217
+ # evaluate summary.
218
+ # @!attribute [r] is_addressed
219
+ # @return [::Boolean]
220
+ # Output only. A boolean that indicates whether the rubric question is
221
+ # addressed or not.
222
+ class CompletenessRubric
223
+ include ::Google::Protobuf::MessageExts
224
+ extend ::Google::Protobuf::MessageExts::ClassMethods
225
+ end
226
+
227
+ # Decomposition details
228
+ # @deprecated This message is deprecated and may be removed in the next major version update.
229
+ # @!attribute [rw] accuracy_decomposition
230
+ # @return [::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::AccuracyDecomposition]
231
+ # only available for accuracy metric.
232
+ #
233
+ # Note: The following fields are mutually exclusive: `accuracy_decomposition`, `adherence_decomposition`. If a field in that set is populated, all other fields in the set will automatically be cleared.
234
+ # @!attribute [rw] adherence_decomposition
235
+ # @return [::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::AdherenceDecomposition]
236
+ # only available for adherence metric.
237
+ #
238
+ # Note: The following fields are mutually exclusive: `adherence_decomposition`, `accuracy_decomposition`. If a field in that set is populated, all other fields in the set will automatically be cleared.
239
+ class Decomposition
240
+ include ::Google::Protobuf::MessageExts
241
+ extend ::Google::Protobuf::MessageExts::ClassMethods
242
+ end
243
+
244
+ # Evaluation result that contains one of accuracy, adherence or completeness
245
+ # evaluation result.
246
+ # @!attribute [rw] accuracy_decomposition
247
+ # @return [::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::AccuracyDecomposition]
248
+ # Only available for accuracy metric.
249
+ #
250
+ # Note: The following fields are mutually exclusive: `accuracy_decomposition`, `adherence_rubric`, `completeness_rubric`. If a field in that set is populated, all other fields in the set will automatically be cleared.
251
+ # @!attribute [rw] adherence_rubric
252
+ # @return [::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::AdherenceRubric]
253
+ # Only available for adherence metric.
254
+ #
255
+ # Note: The following fields are mutually exclusive: `adherence_rubric`, `accuracy_decomposition`, `completeness_rubric`. If a field in that set is populated, all other fields in the set will automatically be cleared.
256
+ # @!attribute [rw] completeness_rubric
257
+ # @return [::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::CompletenessRubric]
258
+ # Only available for completeness metric.
259
+ #
260
+ # Note: The following fields are mutually exclusive: `completeness_rubric`, `accuracy_decomposition`, `adherence_rubric`. If a field in that set is populated, all other fields in the set will automatically be cleared.
261
+ class EvaluationResult
262
+ include ::Google::Protobuf::MessageExts
263
+ extend ::Google::Protobuf::MessageExts::ClassMethods
264
+ end
265
+
266
+ # Evaluation result per conversation(&summary), metric and section.
267
+ # @!attribute [r] session_id
268
+ # @deprecated This field is deprecated and may be removed in the next major version update.
269
+ # @return [::String]
270
+ # Output only. conversation session id
271
+ # @!attribute [r] metric
272
+ # @return [::String]
273
+ # Output only. metric name, e.g. accuracy, completeness, adherence, etc.
274
+ # @!attribute [r] section
275
+ # @return [::String]
276
+ # Output only. section/task name, e.g. action, situation, etc
277
+ # @!attribute [r] score
278
+ # @return [::Float]
279
+ # Output only. score calculated from decompositions
280
+ # @!attribute [r] section_summary
281
+ # @return [::String]
282
+ # Output only. Summary of this section
283
+ # @!attribute [r] decompositions
284
+ # @deprecated This field is deprecated and may be removed in the next major version update.
285
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::Decomposition>]
286
+ # Output only. List of decompostion details
287
+ # @!attribute [r] evaluation_results
288
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::EvaluationResult>]
289
+ # Output only. List of evaluation results.
290
+ class SummarizationEvaluationResult
291
+ include ::Google::Protobuf::MessageExts
292
+ extend ::Google::Protobuf::MessageExts::ClassMethods
293
+ end
294
+
295
+ # Overall performance per metric. This is the aggregated score for each
296
+ # metric across all conversations that are selected for summarization
297
+ # evaluation.
298
+ # @!attribute [r] metric
299
+ # @return [::String]
300
+ # Output only. Metric name. e.g. accuracy, adherence, completeness.
301
+ class OverallScoresByMetric
302
+ include ::Google::Protobuf::MessageExts
303
+ extend ::Google::Protobuf::MessageExts::ClassMethods
304
+ end
305
+
306
+ # A pair of section name and input token count of the input summary section.
307
+ # @!attribute [r] section
308
+ # @return [::String]
309
+ # Output only. The name of the summary instruction.
310
+ # @!attribute [r] token_count
311
+ # @return [::Integer]
312
+ # Output only. Token count.
313
+ class SectionToken
314
+ include ::Google::Protobuf::MessageExts
315
+ extend ::Google::Protobuf::MessageExts::ClassMethods
316
+ end
317
+
318
+ # Aggregated evaluation result on conversation level. This conatins
319
+ # evaluation results of all the metrics and sections.
320
+ # @!attribute [r] message_entries
321
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::MessageEntry>]
322
+ # Output only. Conversation transcript that used for summarization
323
+ # evaluation as a reference.
324
+ # @!attribute [r] summary_sections
325
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarySuggestion::SummarySection>]
326
+ # Output only. Summary sections that used for summarization evaluation as a
327
+ # reference.
328
+ # @!attribute [r] metric_details
329
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::ConversationDetail::MetricDetail>]
330
+ # Output only. List of metric details.
331
+ # @!attribute [r] section_tokens
332
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::SectionToken>]
333
+ # Output only. Conversation level token count per section. This is an
334
+ # aggregated(sum) result of input token of summary acorss all metrics for a
335
+ # single conversation.
336
+ class ConversationDetail
337
+ include ::Google::Protobuf::MessageExts
338
+ extend ::Google::Protobuf::MessageExts::ClassMethods
339
+
340
+ # Aggregated result on metric level. This conatins the evaluation results
341
+ # of all the sections.
342
+ # @!attribute [r] metric
343
+ # @return [::String]
344
+ # Output only. Metrics name. e.g. accuracy, adherence, completeness.
345
+ # @!attribute [r] score
346
+ # @return [::Float]
347
+ # Output only. Aggregated(average) score on this metric across all
348
+ # sections.
349
+ # @!attribute [r] section_details
350
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::ConversationDetail::MetricDetail::SectionDetail>]
351
+ # Output only. List of section details.
352
+ class MetricDetail
353
+ include ::Google::Protobuf::MessageExts
354
+ extend ::Google::Protobuf::MessageExts::ClassMethods
355
+
356
+ # Section level result.
357
+ # @!attribute [r] section
358
+ # @return [::String]
359
+ # Output only. The name of the summary instruction.
360
+ # @!attribute [r] score
361
+ # @return [::Float]
362
+ # Output only. Aggregated(average) score on this section across all
363
+ # evaluation results. Either decompositions or rubrics.
364
+ # @!attribute [r] section_summary
365
+ # @return [::String]
366
+ # Output only. Summary for this section
367
+ # @!attribute [r] evaluation_results
368
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SummarizationEvaluationMetrics::EvaluationResult>]
369
+ # Output only. List of evaluation result. The list only contains one
370
+ # kind of the evaluation result.
371
+ class SectionDetail
372
+ include ::Google::Protobuf::MessageExts
373
+ extend ::Google::Protobuf::MessageExts::ClassMethods
374
+ end
375
+ end
376
+ end
377
+ end
378
+
379
+ # Generator evaluation input config.
380
+ # @!attribute [rw] input_data_config
381
+ # @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataConfig]
382
+ # Required. The config/source of input data.
383
+ # @!attribute [rw] output_gcs_bucket_path
384
+ # @return [::String]
385
+ # Required. The output Cloud Storage bucket path to store eval files, e.g.
386
+ # per_summary_accuracy_score report. This path is provided by customer and
387
+ # files stored in it are visible to customer, no internal data should be
388
+ # stored in this path.
389
+ # @!attribute [rw] summarization_config
390
+ # @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::SummarizationConfig]
391
+ # Evaluation configs for summarization generator.
392
+ class GeneratorEvaluationConfig
393
+ include ::Google::Protobuf::MessageExts
394
+ extend ::Google::Protobuf::MessageExts::ClassMethods
395
+
396
+ # The distinctive configs for Agent Assist conversations as the conversation
397
+ # source.
398
+ # @!attribute [rw] start_time
399
+ # @return [::Google::Protobuf::Timestamp]
400
+ # Required. The start of the time range for conversations to be evaluated.
401
+ # Only conversations created at or after this timestamp will be sampled.
402
+ # @!attribute [rw] end_time
403
+ # @return [::Google::Protobuf::Timestamp]
404
+ # Required. The end of the time range for conversations to be evaluated.
405
+ # Only conversations ended at or before this timestamp will be sampled.
406
+ class AgentAssistInputDataConfig
407
+ include ::Google::Protobuf::MessageExts
408
+ extend ::Google::Protobuf::MessageExts::ClassMethods
409
+ end
410
+
411
+ # The distinctive configs for dataset as the conversation source.
412
+ # @!attribute [rw] dataset
413
+ # @return [::String]
414
+ # Required. The identifier of the dataset to be evaluated.
415
+ # Format:
416
+ # `projects/<ProjectId>/locations/<LocationID>/datasets/<DatasetID>`.
417
+ class DatasetInputDataConfig
418
+ include ::Google::Protobuf::MessageExts
419
+ extend ::Google::Protobuf::MessageExts::ClassMethods
420
+ end
421
+
422
+ # Input data config details
423
+ # @!attribute [rw] input_data_source_type
424
+ # @deprecated This field is deprecated and may be removed in the next major version update.
425
+ # @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataSourceType]
426
+ # Required. The source type of input data.
427
+ # @!attribute [rw] start_time
428
+ # @deprecated This field is deprecated and may be removed in the next major version update.
429
+ # @return [::Google::Protobuf::Timestamp]
430
+ # Optional. The start timestamp to fetch conversation data.
431
+ # @!attribute [rw] end_time
432
+ # @deprecated This field is deprecated and may be removed in the next major version update.
433
+ # @return [::Google::Protobuf::Timestamp]
434
+ # Optional. The end timestamp to fetch conversation data.
435
+ # @!attribute [rw] sample_size
436
+ # @return [::Integer]
437
+ # Optional. Desired number of conversation-summary pairs to be evaluated.
438
+ # @!attribute [rw] is_summary_generation_allowed
439
+ # @deprecated This field is deprecated and may be removed in the next major version update.
440
+ # @return [::Boolean]
441
+ # Optional. Whether the summary generation is allowed when the pre-existing
442
+ # qualified summaries are insufficient to cover the sample size.
443
+ # @!attribute [rw] summary_generation_option
444
+ # @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataConfig::SummaryGenerationOption]
445
+ # Optional. Option to control whether summaries are generated during
446
+ # evaluation.
447
+ # @!attribute [rw] agent_assist_input_data_config
448
+ # @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::AgentAssistInputDataConfig]
449
+ # The distinctive configs for Agent Assist conversations as the
450
+ # conversation source.
451
+ #
452
+ # Note: The following fields are mutually exclusive: `agent_assist_input_data_config`, `dataset_input_data_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
453
+ # @!attribute [rw] dataset_input_data_config
454
+ # @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::DatasetInputDataConfig]
455
+ # The distinctive configs for dataset as the conversation source.
456
+ #
457
+ # Note: The following fields are mutually exclusive: `dataset_input_data_config`, `agent_assist_input_data_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
458
+ class InputDataConfig
459
+ include ::Google::Protobuf::MessageExts
460
+ extend ::Google::Protobuf::MessageExts::ClassMethods
461
+
462
+ # Summary generation options.
463
+ module SummaryGenerationOption
464
+ # Default option will not be used
465
+ SUMMARY_GENERATION_OPTION_UNSPECIFIED = 0
466
+
467
+ # Always Generate summary for all conversations.
468
+ ALWAYS_GENERATE = 1
469
+
470
+ # Gnerate only missing summaries.
471
+ GENERATE_IF_MISSING = 2
472
+
473
+ # Do not generate new summaries. Only use existing summaries found.
474
+ DO_NOT_GENERATE = 3
475
+ end
476
+ end
477
+
478
+ # Evaluation configs for summarization generator.
479
+ # @!attribute [rw] enable_accuracy_evaluation
480
+ # @deprecated This field is deprecated and may be removed in the next major version update.
481
+ # @return [::Boolean]
482
+ # Optional. Enable accuracy evaluation.
483
+ # @!attribute [rw] accuracy_evaluation_version
484
+ # @deprecated This field is deprecated and may be removed in the next major version update.
485
+ # @return [::String]
486
+ # Optional. Version for summarization accuracy. This will determine the
487
+ # prompt and model used at backend.
488
+ # @!attribute [rw] enable_completeness_evaluation
489
+ # @deprecated This field is deprecated and may be removed in the next major version update.
490
+ # @return [::Boolean]
491
+ # Optional. Enable completeness evaluation.
492
+ # @!attribute [rw] completeness_evaluation_version
493
+ # @deprecated This field is deprecated and may be removed in the next major version update.
494
+ # @return [::String]
495
+ # Optional. Version for summarization completeness. This will determine the
496
+ # prompt and model used at backend.
497
+ # @!attribute [rw] evaluator_version
498
+ # @return [::String]
499
+ # Optional. Version for summarization evaluation.
500
+ class SummarizationConfig
501
+ include ::Google::Protobuf::MessageExts
502
+ extend ::Google::Protobuf::MessageExts::ClassMethods
503
+ end
504
+
505
+ # Enumeration of input data source type.
506
+ module InputDataSourceType
507
+ # Unspecified InputDataSourceType. Should not be used.
508
+ INPUT_DATA_SOURCE_TYPE_UNSPECIFIED = 0
509
+
510
+ # Fetch data from Agent Assist storage. If this source type is chosen,
511
+ # input_data_config.start_time and input_data_config.end_timestamp must be
512
+ # provided.
513
+ AGENT_ASSIST_CONVERSATIONS = 1
514
+
515
+ # Fetch data from Insights storage. If this source type is chosen,
516
+ # input_data_config.start_time and input_data_config.end_timestamp must be
517
+ # provided.
518
+ INSIGHTS_CONVERSATIONS = 2
519
+ end
520
+ end
521
+
522
+ # A common evalaution pipeline status.
523
+ # @!attribute [r] done
524
+ # @return [::Boolean]
525
+ # Output only. If the value is `false`, it means the evaluation is still in
526
+ # progress. If `true`, the operation is completed, and either `error` or
527
+ # `response` is available.
528
+ # @!attribute [r] pipeline_status
529
+ # @return [::Google::Rpc::Status]
530
+ # Output only. The error result of the evaluation in case of failure in
531
+ # evaluation pipeline.
532
+ class EvaluationStatus
533
+ include ::Google::Protobuf::MessageExts
534
+ extend ::Google::Protobuf::MessageExts::ClassMethods
535
+ end
536
+ end
537
+ end
538
+ end
539
+ end
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 Dialogflow
23
+ module V2
24
+ # Metadata for a
25
+ # {::Google::Cloud::Dialogflow::V2::GeneratorEvaluations::Client#create_generator_evaluation GeneratorEvaluations.CreateGeneratorEvaluation}
26
+ # operation.
27
+ # @!attribute [r] generator_evaluation
28
+ # @return [::String]
29
+ # Output only. The resource name of the generator evaluation. Format:
30
+ # `projects/<Project ID>/locations/<Location
31
+ # ID>/generators/<Generator ID>/evaluations/<Evaluation ID>`
32
+ class GeneratorEvaluationOperationMetadata
33
+ include ::Google::Protobuf::MessageExts
34
+ extend ::Google::Protobuf::MessageExts::ClassMethods
35
+ end
36
+ end
37
+ end
38
+ end
39
+ end
@@ -90,6 +90,18 @@ module Google
90
90
  # value: "agent"
91
91
  # }
92
92
  # ```
93
+ # @!attribute [rw] agent_desktop_source
94
+ # @return [::Google::Cloud::Dialogflow::V2::Participant::AgentDesktopSource]
95
+ # Optional. For tracking the utilization of prebuilt Agent Assist integration
96
+ # modules. This field is only inscope for Integration type that include UI
97
+ # Modules, Backend Modules, and Agent Desktop connector, it is out of scope
98
+ # for CCaaS and Direct Integration.
99
+ # For each human agent, prebuilt UI Modules needs to trigger the
100
+ # UpdateParticipant API to update this field. Both
101
+ # {::Google::Cloud::Dialogflow::V2::CreateParticipantRequest#participant CreateParticipantRequest}
102
+ # and
103
+ # {::Google::Cloud::Dialogflow::V2::UpdateParticipantRequest#participant UpdateParticipantRequest}
104
+ # will be supported.
93
105
  class Participant
94
106
  include ::Google::Protobuf::MessageExts
95
107
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -118,6 +130,29 @@ module Google
118
130
  # Dialogflow services.
119
131
  END_USER = 3
120
132
  end
133
+
134
+ # Enumeration of the Agent Desktop Source when using prebuilt Agent
135
+ # Assist integration modules.
136
+ module AgentDesktopSource
137
+ # Agent Desktop Source is not specified.
138
+ AGENT_DESKTOP_SOURCE_UNSPECIFIED = 0
139
+
140
+ # Agent Desktop Source is Live Person.
141
+ LIVE_PERSON = 1
142
+
143
+ # Agent Desktop Source is Genesys Cloud.
144
+ GENESYS_CLOUD = 2
145
+
146
+ # Agent Desktop Source is Twilio.
147
+ TWILIO = 3
148
+
149
+ # Agent Desktop Source is Salesforce.
150
+ SALESFORCE = 4
151
+
152
+ # UI Modules are in use but the desktop is either not currently released or
153
+ # setting this field to the applicable desktop.
154
+ OTHER = 8
155
+ end
121
156
  end
122
157
 
123
158
  # Represents a message posted into a conversation.
@@ -1074,18 +1109,46 @@ module Google
1074
1109
  extend ::Google::Protobuf::MessageExts::ClassMethods
1075
1110
  end
1076
1111
 
1077
- # Represents the selection of a suggestion.
1112
+ # Represents the action to take for a tool call that requires confirmation.
1078
1113
  # @!attribute [rw] answer_record
1079
1114
  # @return [::String]
1080
- # Required. The ID of a suggestion selected by the human agent.
1081
- # The suggestion(s) were generated in a previous call to
1082
- # request Dialogflow assist.
1083
- # The format is:
1084
- # `projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record
1085
- # ID>` where <Answer Record ID> is an alphanumeric string.
1115
+ # Required. Format: `projects/<Project ID>/locations/<Location
1116
+ # ID>/answerRecords/<Answer Record ID>`
1117
+ # The answer record associated with the tool call.
1118
+ # @!attribute [rw] parameters
1119
+ # @return [::Google::Protobuf::Struct]
1120
+ # Optional. Parameters to be used for the tool call. If not provided, the
1121
+ # tool will be called without any parameters.
1122
+ # @!attribute [rw] action
1123
+ # @return [::Google::Cloud::Dialogflow::V2::SuggestionInput::Action]
1124
+ # Optional. The type of action to take with the tool.
1125
+ # @!attribute [rw] send_time
1126
+ # @return [::Google::Protobuf::Timestamp]
1127
+ # Optional. Time when the current suggest input is sent. For tool calls, this
1128
+ # timestamp (along with the answer record) will be included in the
1129
+ # corresponding tool call result so that it can be identified.
1086
1130
  class SuggestionInput
1087
1131
  include ::Google::Protobuf::MessageExts
1088
1132
  extend ::Google::Protobuf::MessageExts::ClassMethods
1133
+
1134
+ # Indicate what type of action to take with the tool call.
1135
+ module Action
1136
+ # Action not specified.
1137
+ ACTION_UNSPECIFIED = 0
1138
+
1139
+ # Indicates the user chooses to not make the tool call. It
1140
+ # is only applicable to tool calls that are waiting for user
1141
+ # confirmation.
1142
+ CANCEL = 1
1143
+
1144
+ # Makes the tool call with provided parameters. This action is intended
1145
+ # for tool calls that only read but not write data.
1146
+ REVISE = 2
1147
+
1148
+ # Makes the tool call with provided parameters. This action is intended
1149
+ # for tool calls that may write data.
1150
+ CONFIRM = 3
1151
+ end
1089
1152
  end
1090
1153
 
1091
1154
  # Represents the parameters of human assist query.