google-cloud-dialogflow-v2 0.14.0 → 0.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dialogflow/v2/answer_record_pb.rb +0 -1
  4. data/lib/google/cloud/dialogflow/v2/audio_config_pb.rb +0 -2
  5. data/lib/google/cloud/dialogflow/v2/conversation_dataset_pb.rb +92 -0
  6. data/lib/google/cloud/dialogflow/v2/conversation_dataset_services_pb.rb +81 -0
  7. data/lib/google/cloud/dialogflow/v2/conversation_datasets/client.rb +849 -0
  8. data/lib/google/cloud/dialogflow/v2/conversation_datasets/credentials.rb +52 -0
  9. data/lib/google/cloud/dialogflow/v2/conversation_datasets/operations.rb +767 -0
  10. data/lib/google/cloud/dialogflow/v2/conversation_datasets/paths.rb +69 -0
  11. data/lib/google/cloud/dialogflow/v2/conversation_datasets.rb +53 -0
  12. data/lib/google/cloud/dialogflow/v2/conversation_event_pb.rb +0 -1
  13. data/lib/google/cloud/dialogflow/v2/conversation_model_pb.rb +205 -0
  14. data/lib/google/cloud/dialogflow/v2/conversation_model_services_pb.rb +98 -0
  15. data/lib/google/cloud/dialogflow/v2/conversation_models/client.rb +1257 -0
  16. data/lib/google/cloud/dialogflow/v2/conversation_models/credentials.rb +52 -0
  17. data/lib/google/cloud/dialogflow/v2/conversation_models/operations.rb +767 -0
  18. data/lib/google/cloud/dialogflow/v2/conversation_models/paths.rb +179 -0
  19. data/lib/google/cloud/dialogflow/v2/conversation_models.rb +50 -0
  20. data/lib/google/cloud/dialogflow/v2/conversation_pb.rb +0 -3
  21. data/lib/google/cloud/dialogflow/v2/conversation_profile_pb.rb +26 -1
  22. data/lib/google/cloud/dialogflow/v2/conversation_profile_services_pb.rb +27 -0
  23. data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +250 -0
  24. data/lib/google/cloud/dialogflow/v2/conversation_profiles/operations.rb +767 -0
  25. data/lib/google/cloud/dialogflow/v2/conversation_profiles/paths.rb +31 -9
  26. data/lib/google/cloud/dialogflow/v2/conversation_profiles.rb +1 -0
  27. data/lib/google/cloud/dialogflow/v2/document_pb.rb +18 -0
  28. data/lib/google/cloud/dialogflow/v2/gcs_pb.rb +0 -1
  29. data/lib/google/cloud/dialogflow/v2/human_agent_assistant_event_pb.rb +0 -1
  30. data/lib/google/cloud/dialogflow/v2/intent_pb.rb +0 -2
  31. data/lib/google/cloud/dialogflow/v2/participant_pb.rb +0 -3
  32. data/lib/google/cloud/dialogflow/v2/session_pb.rb +0 -1
  33. data/lib/google/cloud/dialogflow/v2/validation_result_pb.rb +0 -1
  34. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  35. data/lib/google/cloud/dialogflow/v2/webhook_pb.rb +0 -1
  36. data/lib/google/cloud/dialogflow/v2.rb +5 -1
  37. data/proto_docs/google/cloud/dialogflow/v2/conversation_dataset.rb +211 -0
  38. data/proto_docs/google/cloud/dialogflow/v2/conversation_model.rb +522 -0
  39. data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +87 -2
  40. data/proto_docs/google/cloud/dialogflow/v2/document.rb +39 -0
  41. metadata +19 -2
@@ -0,0 +1,522 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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
+ # Represents a conversation model.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # ConversationModel resource name. Format:
28
+ # `projects/<Project ID>/conversationModels/<Conversation Model ID>`
29
+ # @!attribute [rw] display_name
30
+ # @return [::String]
31
+ # Required. The display name of the model. At most 64 bytes long.
32
+ # @!attribute [r] create_time
33
+ # @return [::Google::Protobuf::Timestamp]
34
+ # Output only. Creation time of this model.
35
+ # @!attribute [rw] datasets
36
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::InputDataset>]
37
+ # Required. Datasets used to create model.
38
+ # @!attribute [r] state
39
+ # @return [::Google::Cloud::Dialogflow::V2::ConversationModel::State]
40
+ # Output only. State of the model. A model can only serve prediction requests
41
+ # after it gets deployed.
42
+ # @!attribute [rw] language_code
43
+ # @return [::String]
44
+ # Language code for the conversation model. If not specified, the language
45
+ # is en-US. Language at ConversationModel should be set for all non en-us
46
+ # languages.
47
+ # This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
48
+ # language tag. Example: "en-US".
49
+ # @!attribute [rw] article_suggestion_model_metadata
50
+ # @return [::Google::Cloud::Dialogflow::V2::ArticleSuggestionModelMetadata]
51
+ # Metadata for article suggestion models.
52
+ # @!attribute [rw] smart_reply_model_metadata
53
+ # @return [::Google::Cloud::Dialogflow::V2::SmartReplyModelMetadata]
54
+ # Metadata for smart reply models.
55
+ class ConversationModel
56
+ include ::Google::Protobuf::MessageExts
57
+ extend ::Google::Protobuf::MessageExts::ClassMethods
58
+
59
+ # State of the model.
60
+ module State
61
+ # Should not be used, an un-set enum has this value by default.
62
+ STATE_UNSPECIFIED = 0
63
+
64
+ # Model being created.
65
+ CREATING = 1
66
+
67
+ # Model is not deployed but ready to deploy.
68
+ UNDEPLOYED = 2
69
+
70
+ # Model is deploying.
71
+ DEPLOYING = 3
72
+
73
+ # Model is deployed and ready to use.
74
+ DEPLOYED = 4
75
+
76
+ # Model is undeploying.
77
+ UNDEPLOYING = 5
78
+
79
+ # Model is deleting.
80
+ DELETING = 6
81
+
82
+ # Model is in error state. Not ready to deploy and use.
83
+ FAILED = 7
84
+
85
+ # Model is being created but the training has not started,
86
+ # The model may remain in this state until there is enough capacity to
87
+ # start training.
88
+ PENDING = 8
89
+ end
90
+
91
+ # Model type.
92
+ module ModelType
93
+ # ModelType unspecified.
94
+ MODEL_TYPE_UNSPECIFIED = 0
95
+
96
+ # ModelType smart reply dual encoder model.
97
+ SMART_REPLY_DUAL_ENCODER_MODEL = 2
98
+
99
+ # ModelType smart reply bert model.
100
+ SMART_REPLY_BERT_MODEL = 6
101
+ end
102
+ end
103
+
104
+ # Represents evaluation result of a conversation model.
105
+ # @!attribute [rw] name
106
+ # @return [::String]
107
+ # The resource name of the evaluation. Format:
108
+ # `projects/<Project ID>/conversationModels/<Conversation Model
109
+ # ID>/evaluations/<Evaluation ID>`
110
+ # @!attribute [rw] display_name
111
+ # @return [::String]
112
+ # Optional. The display name of the model evaluation. At most 64 bytes long.
113
+ # @!attribute [rw] evaluation_config
114
+ # @return [::Google::Cloud::Dialogflow::V2::EvaluationConfig]
115
+ # Optional. The configuration of the evaluation task.
116
+ # @!attribute [r] create_time
117
+ # @return [::Google::Protobuf::Timestamp]
118
+ # Output only. Creation time of this model.
119
+ # @!attribute [r] smart_reply_metrics
120
+ # @return [::Google::Cloud::Dialogflow::V2::SmartReplyMetrics]
121
+ # Output only. Only available when model is for smart reply.
122
+ class ConversationModelEvaluation
123
+ include ::Google::Protobuf::MessageExts
124
+ extend ::Google::Protobuf::MessageExts::ClassMethods
125
+ end
126
+
127
+ # The configuration for model evaluation.
128
+ # @!attribute [rw] datasets
129
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::InputDataset>]
130
+ # Required. Datasets used for evaluation.
131
+ # @!attribute [rw] smart_reply_config
132
+ # @return [::Google::Cloud::Dialogflow::V2::EvaluationConfig::SmartReplyConfig]
133
+ # Configuration for smart reply model evalution.
134
+ # @!attribute [rw] smart_compose_config
135
+ # @return [::Google::Cloud::Dialogflow::V2::EvaluationConfig::SmartComposeConfig]
136
+ # Configuration for smart compose model evalution.
137
+ class EvaluationConfig
138
+ include ::Google::Protobuf::MessageExts
139
+ extend ::Google::Protobuf::MessageExts::ClassMethods
140
+
141
+ # Smart reply specific configuration for evaluation job.
142
+ # @!attribute [rw] allowlist_document
143
+ # @return [::String]
144
+ # The allowlist document resource name.
145
+ # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
146
+ # ID>/documents/<Document ID>`. Only used for smart reply model.
147
+ # @!attribute [rw] max_result_count
148
+ # @return [::Integer]
149
+ # Required. The model to be evaluated can return multiple results with confidence
150
+ # score on each query. These results will be sorted by the descending order
151
+ # of the scores and we only keep the first max_result_count results as the
152
+ # final results to evaluate.
153
+ class SmartReplyConfig
154
+ include ::Google::Protobuf::MessageExts
155
+ extend ::Google::Protobuf::MessageExts::ClassMethods
156
+ end
157
+
158
+ # Smart compose specific configuration for evaluation job.
159
+ # @!attribute [rw] allowlist_document
160
+ # @return [::String]
161
+ # The allowlist document resource name.
162
+ # Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
163
+ # ID>/documents/<Document ID>`. Only used for smart compose model.
164
+ # @!attribute [rw] max_result_count
165
+ # @return [::Integer]
166
+ # Required. The model to be evaluated can return multiple results with confidence
167
+ # score on each query. These results will be sorted by the descending order
168
+ # of the scores and we only keep the first max_result_count results as the
169
+ # final results to evaluate.
170
+ class SmartComposeConfig
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+ end
175
+
176
+ # InputDataset used to create model or do evaluation.
177
+ # NextID:5
178
+ # @!attribute [rw] dataset
179
+ # @return [::String]
180
+ # Required. ConversationDataset resource name. Format:
181
+ # `projects/<Project ID>/locations/<Location
182
+ # ID>/conversationDatasets/<Conversation Dataset ID>`
183
+ class InputDataset
184
+ include ::Google::Protobuf::MessageExts
185
+ extend ::Google::Protobuf::MessageExts::ClassMethods
186
+ end
187
+
188
+ # Metadata for article suggestion models.
189
+ # @!attribute [rw] training_model_type
190
+ # @return [::Google::Cloud::Dialogflow::V2::ConversationModel::ModelType]
191
+ # Optional. Type of the article suggestion model. If not provided, model_type is used.
192
+ class ArticleSuggestionModelMetadata
193
+ include ::Google::Protobuf::MessageExts
194
+ extend ::Google::Protobuf::MessageExts::ClassMethods
195
+ end
196
+
197
+ # Metadata for smart reply models.
198
+ # @!attribute [rw] training_model_type
199
+ # @return [::Google::Cloud::Dialogflow::V2::ConversationModel::ModelType]
200
+ # Optional. Type of the smart reply model. If not provided, model_type is used.
201
+ class SmartReplyModelMetadata
202
+ include ::Google::Protobuf::MessageExts
203
+ extend ::Google::Protobuf::MessageExts::ClassMethods
204
+ end
205
+
206
+ # The evaluation metrics for smart reply model.
207
+ # @!attribute [rw] allowlist_coverage
208
+ # @return [::Float]
209
+ # Percentage of target participant messages in the evaluation dataset for
210
+ # which similar messages have appeared at least once in the allowlist. Should
211
+ # be [0, 1].
212
+ # @!attribute [rw] top_n_metrics
213
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::SmartReplyMetrics::TopNMetrics>]
214
+ # Metrics of top n smart replies, sorted by [TopNMetric.n][].
215
+ # @!attribute [rw] conversation_count
216
+ # @return [::Integer]
217
+ # Total number of conversations used to generate this metric.
218
+ class SmartReplyMetrics
219
+ include ::Google::Protobuf::MessageExts
220
+ extend ::Google::Protobuf::MessageExts::ClassMethods
221
+
222
+ # Evaluation metrics when retrieving `n` smart replies with the model.
223
+ # @!attribute [rw] n
224
+ # @return [::Integer]
225
+ # Number of retrieved smart replies. For example, when `n` is 3, this
226
+ # evaluation contains metrics for when Dialogflow retrieves 3 smart replies
227
+ # with the model.
228
+ # @!attribute [rw] recall
229
+ # @return [::Float]
230
+ # Defined as `number of queries whose top n smart replies have at least one
231
+ # similar (token match similarity above the defined threshold) reply as the
232
+ # real reply` divided by `number of queries with at least one smart reply`.
233
+ # Value ranges from 0.0 to 1.0 inclusive.
234
+ class TopNMetrics
235
+ include ::Google::Protobuf::MessageExts
236
+ extend ::Google::Protobuf::MessageExts::ClassMethods
237
+ end
238
+ end
239
+
240
+ # The request message for
241
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#create_conversation_model ConversationModels.CreateConversationModel}
242
+ # @!attribute [rw] parent
243
+ # @return [::String]
244
+ # The project to create conversation model for. Format:
245
+ # `projects/<Project ID>`
246
+ # @!attribute [rw] conversation_model
247
+ # @return [::Google::Cloud::Dialogflow::V2::ConversationModel]
248
+ # Required. The conversation model to create.
249
+ class CreateConversationModelRequest
250
+ include ::Google::Protobuf::MessageExts
251
+ extend ::Google::Protobuf::MessageExts::ClassMethods
252
+ end
253
+
254
+ # The request message for
255
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#get_conversation_model ConversationModels.GetConversationModel}
256
+ # @!attribute [rw] name
257
+ # @return [::String]
258
+ # Required. The conversation model to retrieve. Format:
259
+ # `projects/<Project ID>/conversationModels/<Conversation Model ID>`
260
+ class GetConversationModelRequest
261
+ include ::Google::Protobuf::MessageExts
262
+ extend ::Google::Protobuf::MessageExts::ClassMethods
263
+ end
264
+
265
+ # The request message for
266
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#list_conversation_models ConversationModels.ListConversationModels}
267
+ # @!attribute [rw] parent
268
+ # @return [::String]
269
+ # Required. The project to list all conversation models for.
270
+ # Format: `projects/<Project ID>`
271
+ # @!attribute [rw] page_size
272
+ # @return [::Integer]
273
+ # Optional. Maximum number of conversation models to return in a single
274
+ # page. By default 100 and at most 1000.
275
+ # @!attribute [rw] page_token
276
+ # @return [::String]
277
+ # Optional. The next_page_token value returned from a previous list request.
278
+ class ListConversationModelsRequest
279
+ include ::Google::Protobuf::MessageExts
280
+ extend ::Google::Protobuf::MessageExts::ClassMethods
281
+ end
282
+
283
+ # The response message for
284
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#list_conversation_models ConversationModels.ListConversationModels}
285
+ # @!attribute [rw] conversation_models
286
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::ConversationModel>]
287
+ # The list of models to return.
288
+ # @!attribute [rw] next_page_token
289
+ # @return [::String]
290
+ # Token to retrieve the next page of results, or empty if there are no more
291
+ # results in the list.
292
+ class ListConversationModelsResponse
293
+ include ::Google::Protobuf::MessageExts
294
+ extend ::Google::Protobuf::MessageExts::ClassMethods
295
+ end
296
+
297
+ # The request message for
298
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#delete_conversation_model ConversationModels.DeleteConversationModel}
299
+ # @!attribute [rw] name
300
+ # @return [::String]
301
+ # Required. The conversation model to delete. Format:
302
+ # `projects/<Project ID>/conversationModels/<Conversation Model ID>`
303
+ class DeleteConversationModelRequest
304
+ include ::Google::Protobuf::MessageExts
305
+ extend ::Google::Protobuf::MessageExts::ClassMethods
306
+ end
307
+
308
+ # The request message for
309
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#deploy_conversation_model ConversationModels.DeployConversationModel}
310
+ # @!attribute [rw] name
311
+ # @return [::String]
312
+ # Required. The conversation model to deploy. Format:
313
+ # `projects/<Project ID>/conversationModels/<Conversation Model ID>`
314
+ class DeployConversationModelRequest
315
+ include ::Google::Protobuf::MessageExts
316
+ extend ::Google::Protobuf::MessageExts::ClassMethods
317
+ end
318
+
319
+ # The request message for
320
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#undeploy_conversation_model ConversationModels.UndeployConversationModel}
321
+ # @!attribute [rw] name
322
+ # @return [::String]
323
+ # Required. The conversation model to undeploy. Format:
324
+ # `projects/<Project ID>/conversationModels/<Conversation Model ID>`
325
+ class UndeployConversationModelRequest
326
+ include ::Google::Protobuf::MessageExts
327
+ extend ::Google::Protobuf::MessageExts::ClassMethods
328
+ end
329
+
330
+ # The request message for
331
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#get_conversation_model_evaluation ConversationModels.GetConversationModelEvaluation}
332
+ # @!attribute [rw] name
333
+ # @return [::String]
334
+ # Required. The conversation model evaluation resource name. Format:
335
+ # `projects/<Project ID>/conversationModels/<Conversation Model
336
+ # ID>/evaluations/<Evaluation ID>`
337
+ class GetConversationModelEvaluationRequest
338
+ include ::Google::Protobuf::MessageExts
339
+ extend ::Google::Protobuf::MessageExts::ClassMethods
340
+ end
341
+
342
+ # The request message for
343
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#list_conversation_model_evaluations ConversationModels.ListConversationModelEvaluations}
344
+ # @!attribute [rw] parent
345
+ # @return [::String]
346
+ # Required. The conversation model resource name. Format:
347
+ # `projects/<Project ID>/conversationModels/<Conversation Model ID>`
348
+ # @!attribute [rw] page_size
349
+ # @return [::Integer]
350
+ # Optional. Maximum number of evaluations to return in a
351
+ # single page. By default 100 and at most 1000.
352
+ # @!attribute [rw] page_token
353
+ # @return [::String]
354
+ # Optional. The next_page_token value returned from a previous list request.
355
+ class ListConversationModelEvaluationsRequest
356
+ include ::Google::Protobuf::MessageExts
357
+ extend ::Google::Protobuf::MessageExts::ClassMethods
358
+ end
359
+
360
+ # The response message for
361
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#list_conversation_model_evaluations ConversationModels.ListConversationModelEvaluations}
362
+ # @!attribute [rw] conversation_model_evaluations
363
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation>]
364
+ # The list of evaluations to return.
365
+ # @!attribute [rw] next_page_token
366
+ # @return [::String]
367
+ # Token to retrieve the next page of results, or empty if there are no more
368
+ # results in the list.
369
+ class ListConversationModelEvaluationsResponse
370
+ include ::Google::Protobuf::MessageExts
371
+ extend ::Google::Protobuf::MessageExts::ClassMethods
372
+ end
373
+
374
+ # The request message for
375
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#create_conversation_model_evaluation ConversationModels.CreateConversationModelEvaluation}
376
+ # @!attribute [rw] parent
377
+ # @return [::String]
378
+ # Required. The conversation model resource name. Format:
379
+ # `projects/<Project ID>/locations/<Location
380
+ # ID>/conversationModels/<Conversation Model ID>`
381
+ # @!attribute [rw] conversation_model_evaluation
382
+ # @return [::Google::Cloud::Dialogflow::V2::ConversationModelEvaluation]
383
+ # Required. The conversation model evaluation to be created.
384
+ class CreateConversationModelEvaluationRequest
385
+ include ::Google::Protobuf::MessageExts
386
+ extend ::Google::Protobuf::MessageExts::ClassMethods
387
+ end
388
+
389
+ # Metadata for a {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#create_conversation_model ConversationModels.CreateConversationModel} operation.
390
+ # @!attribute [rw] conversation_model
391
+ # @return [::String]
392
+ # The resource name of the conversation model. Format:
393
+ # `projects/<Project ID>/conversationModels/<Conversation Model Id>`
394
+ # @!attribute [rw] state
395
+ # @return [::Google::Cloud::Dialogflow::V2::CreateConversationModelOperationMetadata::State]
396
+ # State of CreateConversationModel operation.
397
+ # @!attribute [rw] create_time
398
+ # @return [::Google::Protobuf::Timestamp]
399
+ # Timestamp when the request to create conversation model is submitted. The
400
+ # time is measured on server side.
401
+ class CreateConversationModelOperationMetadata
402
+ include ::Google::Protobuf::MessageExts
403
+ extend ::Google::Protobuf::MessageExts::ClassMethods
404
+
405
+ # State of CreateConversationModel operation.
406
+ module State
407
+ # Invalid.
408
+ STATE_UNSPECIFIED = 0
409
+
410
+ # Request is submitted, but training has not started yet.
411
+ # The model may remain in this state until there is enough capacity to
412
+ # start training.
413
+ PENDING = 1
414
+
415
+ # The training has succeeded.
416
+ SUCCEEDED = 2
417
+
418
+ # The training has succeeded.
419
+ FAILED = 3
420
+
421
+ # The training has been cancelled.
422
+ CANCELLED = 4
423
+
424
+ # The training is in cancelling state.
425
+ CANCELLING = 5
426
+
427
+ # Custom model is training.
428
+ TRAINING = 6
429
+ end
430
+ end
431
+
432
+ # Metadata for a {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#deploy_conversation_model ConversationModels.DeployConversationModel} operation.
433
+ # @!attribute [rw] conversation_model
434
+ # @return [::String]
435
+ # The resource name of the conversation model. Format:
436
+ # `projects/<Project ID>/conversationModels/<Conversation Model Id>`
437
+ # @!attribute [rw] create_time
438
+ # @return [::Google::Protobuf::Timestamp]
439
+ # Timestamp when request to deploy conversation model was submitted. The time
440
+ # is measured on server side.
441
+ class DeployConversationModelOperationMetadata
442
+ include ::Google::Protobuf::MessageExts
443
+ extend ::Google::Protobuf::MessageExts::ClassMethods
444
+ end
445
+
446
+ # Metadata for a {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#undeploy_conversation_model ConversationModels.UndeployConversationModel} operation.
447
+ # @!attribute [rw] conversation_model
448
+ # @return [::String]
449
+ # The resource name of the conversation model. Format:
450
+ # `projects/<Project ID>/conversationModels/<Conversation Model Id>`
451
+ # @!attribute [rw] create_time
452
+ # @return [::Google::Protobuf::Timestamp]
453
+ # Timestamp when the request to undeploy conversation model was submitted.
454
+ # The time is measured on server side.
455
+ class UndeployConversationModelOperationMetadata
456
+ include ::Google::Protobuf::MessageExts
457
+ extend ::Google::Protobuf::MessageExts::ClassMethods
458
+ end
459
+
460
+ # Metadata for a {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#delete_conversation_model ConversationModels.DeleteConversationModel} operation.
461
+ # @!attribute [rw] conversation_model
462
+ # @return [::String]
463
+ # The resource name of the conversation model. Format:
464
+ # `projects/<Project ID>/conversationModels/<Conversation Model Id>`
465
+ # @!attribute [rw] create_time
466
+ # @return [::Google::Protobuf::Timestamp]
467
+ # Timestamp when delete conversation model request was created. The time is
468
+ # measured on server side.
469
+ class DeleteConversationModelOperationMetadata
470
+ include ::Google::Protobuf::MessageExts
471
+ extend ::Google::Protobuf::MessageExts::ClassMethods
472
+ end
473
+
474
+ # Metadata for a
475
+ # {::Google::Cloud::Dialogflow::V2::ConversationModels::Client#create_conversation_model_evaluation ConversationModels.CreateConversationModelEvaluation}
476
+ # operation.
477
+ # @!attribute [rw] conversation_model_evaluation
478
+ # @return [::String]
479
+ # The resource name of the conversation model. Format:
480
+ # `projects/<Project ID>/locations/<Location
481
+ # ID>/conversationModels/<Conversation Model Id>/evaluations/<Evaluation Id>`
482
+ # @!attribute [rw] conversation_model
483
+ # @return [::String]
484
+ # The resource name of the conversation model. Format:
485
+ # `projects/<Project ID>/locations/<Location
486
+ # ID>/conversationModels/<Conversation Model Id>`
487
+ # @!attribute [rw] state
488
+ # @return [::Google::Cloud::Dialogflow::V2::CreateConversationModelEvaluationOperationMetadata::State]
489
+ # State of CreateConversationModel operation.
490
+ # @!attribute [rw] create_time
491
+ # @return [::Google::Protobuf::Timestamp]
492
+ # Timestamp when the request to create conversation model was submitted. The
493
+ # time is measured on server side.
494
+ class CreateConversationModelEvaluationOperationMetadata
495
+ include ::Google::Protobuf::MessageExts
496
+ extend ::Google::Protobuf::MessageExts::ClassMethods
497
+
498
+ # State of CreateConversationModel operation.
499
+ module State
500
+ # Operation status not specified.
501
+ STATE_UNSPECIFIED = 0
502
+
503
+ # The operation is being prepared.
504
+ INITIALIZING = 1
505
+
506
+ # The operation is running.
507
+ RUNNING = 2
508
+
509
+ # The operation is cancelled.
510
+ CANCELLED = 3
511
+
512
+ # The operation has succeeded.
513
+ SUCCEEDED = 4
514
+
515
+ # The operation has failed.
516
+ FAILED = 5
517
+ end
518
+ end
519
+ end
520
+ end
521
+ end
522
+ end
@@ -486,11 +486,15 @@ module Google
486
486
  # {::Google::Cloud::Dialogflow::V2::ConversationEvent::Type::CONVERSATION_STARTED CONVERSATION_STARTED} as
487
487
  # serialized {::Google::Cloud::Dialogflow::V2::ConversationEvent ConversationEvent} protos.
488
488
  #
489
- # Notification works for phone calls, if this topic either is in the same
490
- # project as the conversation or you grant `service-<Conversation Project
489
+ # For telephony integration to receive notification, make sure either this
490
+ # topic is in the same project as the conversation or you grant
491
+ # `service-<Conversation Project
491
492
  # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow Service
492
493
  # Agent` role in the topic project.
493
494
  #
495
+ # For chat integration to receive notification, make sure API caller has been
496
+ # granted the `Dialogflow Service Agent` role for the topic.
497
+ #
494
498
  # Format: `projects/<Project ID>/locations/<Location ID>/topics/<Topic ID>`.
495
499
  # @!attribute [rw] message_format
496
500
  # @return [::Google::Cloud::Dialogflow::V2::NotificationConfig::MessageFormat]
@@ -549,6 +553,87 @@ module Google
549
553
  SMART_REPLY = 3
550
554
  end
551
555
  end
556
+
557
+ # The request message for
558
+ # [ConversationProfiles.SetSuggestionFeature][].
559
+ # @!attribute [rw] conversation_profile
560
+ # @return [::String]
561
+ # Required. The Conversation Profile to add or update the suggestion feature
562
+ # config. Format: `projects/<Project ID>/locations/<Location
563
+ # ID>/conversationProfiles/<Conversation Profile ID>`.
564
+ # @!attribute [rw] participant_role
565
+ # @return [::Google::Cloud::Dialogflow::V2::Participant::Role]
566
+ # Required. The participant role to add or update the suggestion feature
567
+ # config. Only HUMAN_AGENT or END_USER can be used.
568
+ # @!attribute [rw] suggestion_feature_config
569
+ # @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionFeatureConfig]
570
+ # Required. The suggestion feature config to add or update.
571
+ class SetSuggestionFeatureConfigRequest
572
+ include ::Google::Protobuf::MessageExts
573
+ extend ::Google::Protobuf::MessageExts::ClassMethods
574
+ end
575
+
576
+ # The request message for [ConversationProfiles.ClearFeature][].
577
+ # @!attribute [rw] conversation_profile
578
+ # @return [::String]
579
+ # Required. The Conversation Profile to add or update the suggestion feature
580
+ # config. Format: `projects/<Project ID>/locations/<Location
581
+ # ID>/conversationProfiles/<Conversation Profile ID>`.
582
+ # @!attribute [rw] participant_role
583
+ # @return [::Google::Cloud::Dialogflow::V2::Participant::Role]
584
+ # Required. The participant role to remove the suggestion feature
585
+ # config. Only HUMAN_AGENT or END_USER can be used.
586
+ # @!attribute [rw] suggestion_feature_type
587
+ # @return [::Google::Cloud::Dialogflow::V2::SuggestionFeature::Type]
588
+ # Required. The type of the suggestion feature to remove.
589
+ class ClearSuggestionFeatureConfigRequest
590
+ include ::Google::Protobuf::MessageExts
591
+ extend ::Google::Protobuf::MessageExts::ClassMethods
592
+ end
593
+
594
+ # Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][]
595
+ # operation.
596
+ # @!attribute [rw] conversation_profile
597
+ # @return [::String]
598
+ # The resource name of the conversation profile. Format:
599
+ # `projects/<Project ID>/locations/<Location
600
+ # ID>/conversationProfiles/<Conversation Profile ID>`
601
+ # @!attribute [rw] participant_role
602
+ # @return [::Google::Cloud::Dialogflow::V2::Participant::Role]
603
+ # Required. The participant role to add or update the suggestion feature
604
+ # config. Only HUMAN_AGENT or END_USER can be used.
605
+ # @!attribute [rw] suggestion_feature_type
606
+ # @return [::Google::Cloud::Dialogflow::V2::SuggestionFeature::Type]
607
+ # Required. The type of the suggestion feature to add or update.
608
+ # @!attribute [rw] create_time
609
+ # @return [::Google::Protobuf::Timestamp]
610
+ # Timestamp whe the request was created. The time is measured on server side.
611
+ class SetSuggestionFeatureConfigOperationMetadata
612
+ include ::Google::Protobuf::MessageExts
613
+ extend ::Google::Protobuf::MessageExts::ClassMethods
614
+ end
615
+
616
+ # Metadata for a [ConversationProfile.ClearSuggestionFeatureConfig][]
617
+ # operation.
618
+ # @!attribute [rw] conversation_profile
619
+ # @return [::String]
620
+ # The resource name of the conversation profile. Format:
621
+ # `projects/<Project ID>/locations/<Location
622
+ # ID>/conversationProfiles/<Conversation Profile ID>`
623
+ # @!attribute [rw] participant_role
624
+ # @return [::Google::Cloud::Dialogflow::V2::Participant::Role]
625
+ # Required. The participant role to remove the suggestion feature
626
+ # config. Only HUMAN_AGENT or END_USER can be used.
627
+ # @!attribute [rw] suggestion_feature_type
628
+ # @return [::Google::Cloud::Dialogflow::V2::SuggestionFeature::Type]
629
+ # Required. The type of the suggestion feature to remove.
630
+ # @!attribute [rw] create_time
631
+ # @return [::Google::Protobuf::Timestamp]
632
+ # Timestamp whe the request was created. The time is measured on server side.
633
+ class ClearSuggestionFeatureConfigOperationMetadata
634
+ include ::Google::Protobuf::MessageExts
635
+ extend ::Google::Protobuf::MessageExts::ClassMethods
636
+ end
552
637
  end
553
638
  end
554
639
  end