google-cloud-dialogflow-v2 0.11.4 → 0.14.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 (46) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -1
  3. data/AUTHENTICATION.md +7 -25
  4. data/lib/google/cloud/dialogflow/v2/agents/client.rb +215 -27
  5. data/lib/google/cloud/dialogflow/v2/agents/operations.rb +115 -12
  6. data/lib/google/cloud/dialogflow/v2/answer_records/client.rb +46 -6
  7. data/lib/google/cloud/dialogflow/v2/audio_config_pb.rb +1 -1
  8. data/lib/google/cloud/dialogflow/v2/contexts/client.rb +126 -18
  9. data/lib/google/cloud/dialogflow/v2/conversation_event_pb.rb +1 -1
  10. data/lib/google/cloud/dialogflow/v2/conversation_pb.rb +2 -0
  11. data/lib/google/cloud/dialogflow/v2/conversation_profile_pb.rb +9 -0
  12. data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +106 -15
  13. data/lib/google/cloud/dialogflow/v2/conversation_profiles/paths.rb +19 -0
  14. data/lib/google/cloud/dialogflow/v2/conversations/client.rb +112 -15
  15. data/lib/google/cloud/dialogflow/v2/document_pb.rb +33 -0
  16. data/lib/google/cloud/dialogflow/v2/document_services_pb.rb +21 -0
  17. data/lib/google/cloud/dialogflow/v2/documents/client.rb +426 -20
  18. data/lib/google/cloud/dialogflow/v2/documents/operations.rb +115 -12
  19. data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +242 -30
  20. data/lib/google/cloud/dialogflow/v2/entity_types/operations.rb +115 -12
  21. data/lib/google/cloud/dialogflow/v2/environments/client.rb +132 -18
  22. data/lib/google/cloud/dialogflow/v2/fulfillments/client.rb +40 -6
  23. data/lib/google/cloud/dialogflow/v2/gcs_pb.rb +9 -1
  24. data/lib/google/cloud/dialogflow/v2/human_agent_assistant_event_pb.rb +1 -1
  25. data/lib/google/cloud/dialogflow/v2/intents/client.rb +161 -21
  26. data/lib/google/cloud/dialogflow/v2/intents/operations.rb +115 -12
  27. data/lib/google/cloud/dialogflow/v2/knowledge_base_pb.rb +1 -0
  28. data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +134 -16
  29. data/lib/google/cloud/dialogflow/v2/participant_pb.rb +31 -0
  30. data/lib/google/cloud/dialogflow/v2/participant_services_pb.rb +3 -0
  31. data/lib/google/cloud/dialogflow/v2/participants/client.rb +268 -28
  32. data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +106 -15
  33. data/lib/google/cloud/dialogflow/v2/session_pb.rb +1 -0
  34. data/lib/google/cloud/dialogflow/v2/sessions/client.rb +44 -3
  35. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  36. data/lib/google/cloud/dialogflow/v2/versions/client.rb +106 -15
  37. data/lib/google/cloud/dialogflow/v2/webhook_pb.rb +1 -1
  38. data/lib/google/cloud/dialogflow/v2.rb +1 -1
  39. data/proto_docs/google/api/resource.rb +10 -71
  40. data/proto_docs/google/cloud/dialogflow/v2/audio_config.rb +4 -1
  41. data/proto_docs/google/cloud/dialogflow/v2/conversation_profile.rb +41 -8
  42. data/proto_docs/google/cloud/dialogflow/v2/document.rb +118 -0
  43. data/proto_docs/google/cloud/dialogflow/v2/gcs.rb +50 -0
  44. data/proto_docs/google/cloud/dialogflow/v2/knowledge_base.rb +28 -0
  45. data/proto_docs/google/cloud/dialogflow/v2/participant.rb +157 -6
  46. metadata +4 -3
@@ -244,6 +244,21 @@ module Google
244
244
  #
245
245
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
246
246
  #
247
+ # @example Basic example
248
+ # require "google/cloud/dialogflow/v2"
249
+ #
250
+ # # Create a client object. The client can be reused for multiple calls.
251
+ # client = Google::Cloud::Dialogflow::V2::Sessions::Client.new
252
+ #
253
+ # # Create a request. To set request fields, pass in keyword arguments.
254
+ # request = Google::Cloud::Dialogflow::V2::DetectIntentRequest.new
255
+ #
256
+ # # Call the detect_intent method.
257
+ # result = client.detect_intent request
258
+ #
259
+ # # The returned object is of type Google::Cloud::Dialogflow::V2::DetectIntentResponse.
260
+ # p result
261
+ #
247
262
  def detect_intent request, options = nil
248
263
  raise ::ArgumentError, "request must be provided" if request.nil?
249
264
 
@@ -261,9 +276,11 @@ module Google
261
276
  gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
262
277
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
263
278
 
264
- header_params = {
265
- "session" => request.session
266
- }
279
+ header_params = {}
280
+ if request.session
281
+ header_params["session"] = request.session
282
+ end
283
+
267
284
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
268
285
  metadata[:"x-goog-request-params"] ||= request_params_header
269
286
 
@@ -312,6 +329,30 @@ module Google
312
329
  #
313
330
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
314
331
  #
332
+ # @example Basic example
333
+ # require "google/cloud/dialogflow/v2"
334
+ #
335
+ # # Create a client object. The client can be reused for multiple calls.
336
+ # client = Google::Cloud::Dialogflow::V2::Sessions::Client.new
337
+ #
338
+ # # Create an input stream
339
+ # input = Gapic::StreamInput.new
340
+ #
341
+ # # Call the streaming_detect_intent method to start streaming.
342
+ # output = client.streaming_detect_intent input
343
+ #
344
+ # # Send requests on the stream. For each request, pass in keyword
345
+ # # arguments to set fields. Be sure to close the stream when done.
346
+ # input << Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest.new
347
+ # input << Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest.new
348
+ # input.close
349
+ #
350
+ # # Handle streamed responses. These may be interleaved with inputs.
351
+ # # Each response is of type ::Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse.
352
+ # output.each do |response|
353
+ # p response
354
+ # end
355
+ #
315
356
  def streaming_detect_intent request, options = nil
316
357
  unless request.is_a? ::Enumerable
317
358
  raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Dialogflow
23
23
  module V2
24
- VERSION = "0.11.4"
24
+ VERSION = "0.14.0"
25
25
  end
26
26
  end
27
27
  end
@@ -187,6 +187,27 @@ module Google
187
187
  #
188
188
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
189
189
  #
190
+ # @example Basic example
191
+ # require "google/cloud/dialogflow/v2"
192
+ #
193
+ # # Create a client object. The client can be reused for multiple calls.
194
+ # client = Google::Cloud::Dialogflow::V2::Versions::Client.new
195
+ #
196
+ # # Create a request. To set request fields, pass in keyword arguments.
197
+ # request = Google::Cloud::Dialogflow::V2::ListVersionsRequest.new
198
+ #
199
+ # # Call the list_versions method.
200
+ # result = client.list_versions request
201
+ #
202
+ # # The returned object is of type Gapic::PagedEnumerable. You can
203
+ # # iterate over all elements by calling #each, and the enumerable
204
+ # # will lazily make API calls to fetch subsequent pages. Other
205
+ # # methods are also available for managing paging directly.
206
+ # result.each do |response|
207
+ # # Each element is of type ::Google::Cloud::Dialogflow::V2::Version.
208
+ # p response
209
+ # end
210
+ #
190
211
  def list_versions request, options = nil
191
212
  raise ::ArgumentError, "request must be provided" if request.nil?
192
213
 
@@ -204,9 +225,11 @@ module Google
204
225
  gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
205
226
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
206
227
 
207
- header_params = {
208
- "parent" => request.parent
209
- }
228
+ header_params = {}
229
+ if request.parent
230
+ header_params["parent"] = request.parent
231
+ end
232
+
210
233
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
211
234
  metadata[:"x-goog-request-params"] ||= request_params_header
212
235
 
@@ -261,6 +284,21 @@ module Google
261
284
  #
262
285
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
263
286
  #
287
+ # @example Basic example
288
+ # require "google/cloud/dialogflow/v2"
289
+ #
290
+ # # Create a client object. The client can be reused for multiple calls.
291
+ # client = Google::Cloud::Dialogflow::V2::Versions::Client.new
292
+ #
293
+ # # Create a request. To set request fields, pass in keyword arguments.
294
+ # request = Google::Cloud::Dialogflow::V2::GetVersionRequest.new
295
+ #
296
+ # # Call the get_version method.
297
+ # result = client.get_version request
298
+ #
299
+ # # The returned object is of type Google::Cloud::Dialogflow::V2::Version.
300
+ # p result
301
+ #
264
302
  def get_version request, options = nil
265
303
  raise ::ArgumentError, "request must be provided" if request.nil?
266
304
 
@@ -278,9 +316,11 @@ module Google
278
316
  gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
279
317
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
280
318
 
281
- header_params = {
282
- "name" => request.name
283
- }
319
+ header_params = {}
320
+ if request.name
321
+ header_params["name"] = request.name
322
+ end
323
+
284
324
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
285
325
  metadata[:"x-goog-request-params"] ||= request_params_header
286
326
 
@@ -337,6 +377,21 @@ module Google
337
377
  #
338
378
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
339
379
  #
380
+ # @example Basic example
381
+ # require "google/cloud/dialogflow/v2"
382
+ #
383
+ # # Create a client object. The client can be reused for multiple calls.
384
+ # client = Google::Cloud::Dialogflow::V2::Versions::Client.new
385
+ #
386
+ # # Create a request. To set request fields, pass in keyword arguments.
387
+ # request = Google::Cloud::Dialogflow::V2::CreateVersionRequest.new
388
+ #
389
+ # # Call the create_version method.
390
+ # result = client.create_version request
391
+ #
392
+ # # The returned object is of type Google::Cloud::Dialogflow::V2::Version.
393
+ # p result
394
+ #
340
395
  def create_version request, options = nil
341
396
  raise ::ArgumentError, "request must be provided" if request.nil?
342
397
 
@@ -354,9 +409,11 @@ module Google
354
409
  gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
355
410
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
356
411
 
357
- header_params = {
358
- "parent" => request.parent
359
- }
412
+ header_params = {}
413
+ if request.parent
414
+ header_params["parent"] = request.parent
415
+ end
416
+
360
417
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
361
418
  metadata[:"x-goog-request-params"] ||= request_params_header
362
419
 
@@ -416,6 +473,21 @@ module Google
416
473
  #
417
474
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
418
475
  #
476
+ # @example Basic example
477
+ # require "google/cloud/dialogflow/v2"
478
+ #
479
+ # # Create a client object. The client can be reused for multiple calls.
480
+ # client = Google::Cloud::Dialogflow::V2::Versions::Client.new
481
+ #
482
+ # # Create a request. To set request fields, pass in keyword arguments.
483
+ # request = Google::Cloud::Dialogflow::V2::UpdateVersionRequest.new
484
+ #
485
+ # # Call the update_version method.
486
+ # result = client.update_version request
487
+ #
488
+ # # The returned object is of type Google::Cloud::Dialogflow::V2::Version.
489
+ # p result
490
+ #
419
491
  def update_version request, options = nil
420
492
  raise ::ArgumentError, "request must be provided" if request.nil?
421
493
 
@@ -433,9 +505,11 @@ module Google
433
505
  gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
434
506
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
435
507
 
436
- header_params = {
437
- "version.name" => request.version.name
438
- }
508
+ header_params = {}
509
+ if request.version&.name
510
+ header_params["version.name"] = request.version.name
511
+ end
512
+
439
513
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
440
514
  metadata[:"x-goog-request-params"] ||= request_params_header
441
515
 
@@ -489,6 +563,21 @@ module Google
489
563
  #
490
564
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
491
565
  #
566
+ # @example Basic example
567
+ # require "google/cloud/dialogflow/v2"
568
+ #
569
+ # # Create a client object. The client can be reused for multiple calls.
570
+ # client = Google::Cloud::Dialogflow::V2::Versions::Client.new
571
+ #
572
+ # # Create a request. To set request fields, pass in keyword arguments.
573
+ # request = Google::Cloud::Dialogflow::V2::DeleteVersionRequest.new
574
+ #
575
+ # # Call the delete_version method.
576
+ # result = client.delete_version request
577
+ #
578
+ # # The returned object is of type Google::Protobuf::Empty.
579
+ # p result
580
+ #
492
581
  def delete_version request, options = nil
493
582
  raise ::ArgumentError, "request must be provided" if request.nil?
494
583
 
@@ -506,9 +595,11 @@ module Google
506
595
  gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
507
596
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
508
597
 
509
- header_params = {
510
- "name" => request.name
511
- }
598
+ header_params = {}
599
+ if request.name
600
+ header_params["name"] = request.name
601
+ end
602
+
512
603
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
513
604
  metadata[:"x-goog-request-params"] ||= request_params_header
514
605
 
@@ -1,12 +1,12 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/dialogflow/v2/webhook.proto
3
3
 
4
+ require 'google/api/annotations_pb'
4
5
  require 'google/cloud/dialogflow/v2/context_pb'
5
6
  require 'google/cloud/dialogflow/v2/intent_pb'
6
7
  require 'google/cloud/dialogflow/v2/session_pb'
7
8
  require 'google/cloud/dialogflow/v2/session_entity_type_pb'
8
9
  require 'google/protobuf/struct_pb'
9
- require 'google/api/annotations_pb'
10
10
  require 'google/protobuf'
11
11
 
12
12
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -24,8 +24,8 @@ require "google/cloud/dialogflow/v2/session_entity_types"
24
24
  require "google/cloud/dialogflow/v2/sessions"
25
25
  require "google/cloud/dialogflow/v2/participants"
26
26
  require "google/cloud/dialogflow/v2/answer_records"
27
- require "google/cloud/dialogflow/v2/conversations"
28
27
  require "google/cloud/dialogflow/v2/conversation_profiles"
28
+ require "google/cloud/dialogflow/v2/conversations"
29
29
  require "google/cloud/dialogflow/v2/documents"
30
30
  require "google/cloud/dialogflow/v2/fulfillments"
31
31
  require "google/cloud/dialogflow/v2/environments"
@@ -33,11 +33,7 @@ module Google
33
33
  # // For Kubernetes resources, the format is {api group}/{kind}.
34
34
  # option (google.api.resource) = {
35
35
  # type: "pubsub.googleapis.com/Topic"
36
- # name_descriptor: {
37
- # pattern: "projects/{project}/topics/{topic}"
38
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
- # parent_name_extractor: "projects/{project}"
40
- # }
36
+ # pattern: "projects/{project}/topics/{topic}"
41
37
  # };
42
38
  # }
43
39
  #
@@ -45,10 +41,7 @@ module Google
45
41
  #
46
42
  # resources:
47
43
  # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/{project}/topics/{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/{project}"
44
+ # pattern: "projects/{project}/topics/{topic}"
52
45
  #
53
46
  # Sometimes, resources have multiple patterns, typically because they can
54
47
  # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
58
51
  # message LogEntry {
59
52
  # option (google.api.resource) = {
60
53
  # type: "logging.googleapis.com/LogEntry"
61
- # name_descriptor: {
62
- # pattern: "projects/{project}/logs/{log}"
63
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
- # parent_name_extractor: "projects/{project}"
65
- # }
66
- # name_descriptor: {
67
- # pattern: "folders/{folder}/logs/{log}"
68
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
69
- # parent_name_extractor: "folders/{folder}"
70
- # }
71
- # name_descriptor: {
72
- # pattern: "organizations/{organization}/logs/{log}"
73
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
74
- # parent_name_extractor: "organizations/{organization}"
75
- # }
76
- # name_descriptor: {
77
- # pattern: "billingAccounts/{billing_account}/logs/{log}"
78
- # parent_type: "billing.googleapis.com/BillingAccount"
79
- # parent_name_extractor: "billingAccounts/{billing_account}"
80
- # }
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
81
58
  # };
82
59
  # }
83
60
  #
@@ -85,48 +62,10 @@ module Google
85
62
  #
86
63
  # resources:
87
64
  # - type: 'logging.googleapis.com/LogEntry'
88
- # name_descriptor:
89
- # - pattern: "projects/{project}/logs/{log}"
90
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
- # parent_name_extractor: "projects/{project}"
92
- # - pattern: "folders/{folder}/logs/{log}"
93
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
94
- # parent_name_extractor: "folders/{folder}"
95
- # - pattern: "organizations/{organization}/logs/{log}"
96
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
97
- # parent_name_extractor: "organizations/{organization}"
98
- # - pattern: "billingAccounts/{billing_account}/logs/{log}"
99
- # parent_type: "billing.googleapis.com/BillingAccount"
100
- # parent_name_extractor: "billingAccounts/{billing_account}"
101
- #
102
- # For flexible resources, the resource name doesn't contain parent names, but
103
- # the resource itself has parents for policy evaluation.
104
- #
105
- # Example:
106
- #
107
- # message Shelf {
108
- # option (google.api.resource) = {
109
- # type: "library.googleapis.com/Shelf"
110
- # name_descriptor: {
111
- # pattern: "shelves/{shelf}"
112
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
113
- # }
114
- # name_descriptor: {
115
- # pattern: "shelves/{shelf}"
116
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
117
- # }
118
- # };
119
- # }
120
- #
121
- # The ResourceDescriptor Yaml config will look like:
122
- #
123
- # resources:
124
- # - type: 'library.googleapis.com/Shelf'
125
- # name_descriptor:
126
- # - pattern: "shelves/{shelf}"
127
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
128
- # - pattern: "shelves/{shelf}"
129
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
130
69
  # @!attribute [rw] type
131
70
  # @return [::String]
132
71
  # The resource type. It must be in the format of
@@ -241,10 +241,13 @@ module Google
241
241
  # Configures speech transcription for {::Google::Cloud::Dialogflow::V2::ConversationProfile ConversationProfile}.
242
242
  # @!attribute [rw] speech_model_variant
243
243
  # @return [::Google::Cloud::Dialogflow::V2::SpeechModelVariant]
244
- # Optional. The speech model used in speech to text.
244
+ # The speech model used in speech to text.
245
245
  # `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as
246
246
  # `USE_ENHANCED`. It can be overridden in {::Google::Cloud::Dialogflow::V2::AnalyzeContentRequest AnalyzeContentRequest} and
247
247
  # [StreamingAnalyzeContentRequest][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest] request.
248
+ # If enhanced model variant is specified and an enhanced
249
+ # version of the specified model for the language does not exist, then it
250
+ # would emit an error.
248
251
  class SpeechToTextConfig
249
252
  include ::Google::Protobuf::MessageExts
250
253
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -63,9 +63,21 @@ module Google
63
63
  # Settings for speech transcription.
64
64
  # @!attribute [rw] language_code
65
65
  # @return [::String]
66
- # Language which represents the conversationProfile.
67
- # If unspecified, the default language code en-us applies. Users need to
68
- # create a ConversationProfile for each language they want to support.
66
+ # Language code for the conversation profile. If not specified, the language
67
+ # is en-US. Language at ConversationProfile should be set for all non en-US
68
+ # languages.
69
+ # This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
70
+ # language tag. Example: "en-US".
71
+ # @!attribute [rw] time_zone
72
+ # @return [::String]
73
+ # The time zone of this conversational profile from the
74
+ # [time zone database](https://www.iana.org/time-zones), e.g.,
75
+ # America/New_York, Europe/Paris. Defaults to America/New_York.
76
+ # @!attribute [rw] security_settings
77
+ # @return [::String]
78
+ # Name of the CX SecuritySettings reference for the agent.
79
+ # Format: `projects/<Project ID>/locations/<Location
80
+ # ID>/securitySettings/<Security Settings ID>`.
69
81
  class ConversationProfile
70
82
  include ::Google::Protobuf::MessageExts
71
83
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -162,11 +174,16 @@ module Google
162
174
  # Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API
163
175
  # Service Agent` role in this project.
164
176
  #
165
- # Format: `projects/<Project ID>/locations/<Location
177
+ # - For ES agents, use format: `projects/<Project ID>/locations/<Location
166
178
  # ID>/agent/environments/<Environment ID or '-'>`. If environment is not
167
179
  # specified, the default `draft` environment is used. Refer to
168
180
  # [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest)
169
181
  # for more details.
182
+ #
183
+ # - For CX agents, use format `projects/<Project ID>/locations/<Location
184
+ # ID>/agents/<Agent ID>/environments/<Environment ID
185
+ # or '-'>`. If environment is not specified, the default `draft` environment
186
+ # is used.
170
187
  class AutomatedAgentConfig
171
188
  include ::Google::Protobuf::MessageExts
172
189
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -226,6 +243,9 @@ module Google
226
243
  # @!attribute [rw] conversation_model_config
227
244
  # @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationModelConfig]
228
245
  # Configs of custom conversation model.
246
+ # @!attribute [rw] conversation_process_config
247
+ # @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::ConversationProcessConfig]
248
+ # Configs for processing conversation.
229
249
  class SuggestionFeatureConfig
230
250
  include ::Google::Protobuf::MessageExts
231
251
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -289,7 +309,7 @@ module Google
289
309
  # If this field is not set, it defaults to 0.0, which means that all
290
310
  # suggestions are returned.
291
311
  #
292
- # Supported features: ARTICLE_SUGGESTION.
312
+ # Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE.
293
313
  # @!attribute [rw] context_filter_settings
294
314
  # @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::ContextFilterSettings]
295
315
  # Determines how recent conversation context is filtered when generating
@@ -370,6 +390,16 @@ module Google
370
390
  extend ::Google::Protobuf::MessageExts::ClassMethods
371
391
  end
372
392
 
393
+ # Config to process conversation.
394
+ # @!attribute [rw] recent_sentences_count
395
+ # @return [::Integer]
396
+ # Number of recent non-small-talk sentences to use as context for article
397
+ # and FAQ suggestion
398
+ class ConversationProcessConfig
399
+ include ::Google::Protobuf::MessageExts
400
+ extend ::Google::Protobuf::MessageExts::ClassMethods
401
+ end
402
+
373
403
  # Configuration for analyses to run on each conversation message.
374
404
  # @!attribute [rw] enable_entity_extraction
375
405
  # @return [::Boolean]
@@ -471,13 +501,13 @@ module Google
471
501
 
472
502
  # Format of cloud pub/sub message.
473
503
  module MessageFormat
474
- # If it is unspeified, PROTO will be used.
504
+ # If it is unspecified, PROTO will be used.
475
505
  MESSAGE_FORMAT_UNSPECIFIED = 0
476
506
 
477
- # Pubsub message will be serialized proto.
507
+ # Pub/Sub message will be serialized proto.
478
508
  PROTO = 1
479
509
 
480
- # Pubsub message will be json.
510
+ # Pub/Sub message will be json.
481
511
  JSON = 2
482
512
  end
483
513
  end
@@ -514,6 +544,9 @@ module Google
514
544
 
515
545
  # Run FAQ model.
516
546
  FAQ = 2
547
+
548
+ # Run smart reply model.
549
+ SMART_REPLY = 3
517
550
  end
518
551
  end
519
552
  end
@@ -163,6 +163,29 @@ module Google
163
163
  # @!attribute [rw] page_token
164
164
  # @return [::String]
165
165
  # The next_page_token value returned from a previous list request.
166
+ # @!attribute [rw] filter
167
+ # @return [::String]
168
+ # The filter expression used to filter documents returned by the list method.
169
+ # The expression has the following syntax:
170
+ #
171
+ # <field> <operator> <value> [AND <field> <operator> <value>] ...
172
+ #
173
+ # The following fields and operators are supported:
174
+ #
175
+ # * knowledge_types with has(:) operator
176
+ # * display_name with has(:) operator
177
+ # * state with equals(=) operator
178
+ #
179
+ # Examples:
180
+ #
181
+ # * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
182
+ # * "display_name:customer" matches documents whose display name contains
183
+ # "customer".
184
+ # * "state=ACTIVE" matches documents with ACTIVE state.
185
+ # * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.
186
+ #
187
+ # For more information about filtering, see
188
+ # [API Filtering](https://aip.dev/160).
166
189
  class ListDocumentsRequest
167
190
  include ::Google::Protobuf::MessageExts
168
191
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -195,6 +218,68 @@ module Google
195
218
  extend ::Google::Protobuf::MessageExts::ClassMethods
196
219
  end
197
220
 
221
+ # Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#import_documents Documents.ImportDocuments}.
222
+ # @!attribute [rw] parent
223
+ # @return [::String]
224
+ # Required. The knowledge base to import documents into.
225
+ # Format: `projects/<Project ID>/locations/<Location
226
+ # ID>/knowledgeBases/<Knowledge Base ID>`.
227
+ # @!attribute [rw] gcs_source
228
+ # @return [::Google::Cloud::Dialogflow::V2::GcsSources]
229
+ # The Google Cloud Storage location for the documents.
230
+ # The path can include a wildcard.
231
+ #
232
+ # These URIs may have the forms
233
+ # `gs://<bucket-name>/<object-name>`.
234
+ # `gs://<bucket-name>/<object-path>/*.<extension>`.
235
+ # @!attribute [rw] document_template
236
+ # @return [::Google::Cloud::Dialogflow::V2::ImportDocumentTemplate]
237
+ # Required. Document template used for importing all the documents.
238
+ # @!attribute [rw] import_gcs_custom_metadata
239
+ # @return [::Boolean]
240
+ # Whether to import custom metadata from Google Cloud Storage.
241
+ # Only valid when the document source is Google Cloud Storage URI.
242
+ class ImportDocumentsRequest
243
+ include ::Google::Protobuf::MessageExts
244
+ extend ::Google::Protobuf::MessageExts::ClassMethods
245
+ end
246
+
247
+ # The template used for importing documents.
248
+ # @!attribute [rw] mime_type
249
+ # @return [::String]
250
+ # Required. The MIME type of the document.
251
+ # @!attribute [rw] knowledge_types
252
+ # @return [::Array<::Google::Cloud::Dialogflow::V2::Document::KnowledgeType>]
253
+ # Required. The knowledge type of document content.
254
+ # @!attribute [rw] metadata
255
+ # @return [::Google::Protobuf::Map{::String => ::String}]
256
+ # Metadata for the document. The metadata supports arbitrary
257
+ # key-value pairs. Suggested use cases include storing a document's title,
258
+ # an external URL distinct from the document's content_uri, etc.
259
+ # The max size of a `key` or a `value` of the metadata is 1024 bytes.
260
+ class ImportDocumentTemplate
261
+ include ::Google::Protobuf::MessageExts
262
+ extend ::Google::Protobuf::MessageExts::ClassMethods
263
+
264
+ # @!attribute [rw] key
265
+ # @return [::String]
266
+ # @!attribute [rw] value
267
+ # @return [::String]
268
+ class MetadataEntry
269
+ include ::Google::Protobuf::MessageExts
270
+ extend ::Google::Protobuf::MessageExts::ClassMethods
271
+ end
272
+ end
273
+
274
+ # Response message for {::Google::Cloud::Dialogflow::V2::Documents::Client#import_documents Documents.ImportDocuments}.
275
+ # @!attribute [rw] warnings
276
+ # @return [::Array<::Google::Rpc::Status>]
277
+ # Includes details about skipped documents or any other warnings.
278
+ class ImportDocumentsResponse
279
+ include ::Google::Protobuf::MessageExts
280
+ extend ::Google::Protobuf::MessageExts::ClassMethods
281
+ end
282
+
198
283
  # Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#delete_document Documents.DeleteDocument}.
199
284
  # @!attribute [rw] name
200
285
  # @return [::String]
@@ -233,15 +318,48 @@ module Google
233
318
  #
234
319
  # For documents stored in Google Cloud Storage, these URIs must have
235
320
  # the form `gs://<bucket-name>/<object-name>`.
321
+ # @!attribute [rw] import_gcs_custom_metadata
322
+ # @return [::Boolean]
323
+ # Optional. Whether to import custom metadata from Google Cloud Storage.
324
+ # Only valid when the document source is Google Cloud Storage URI.
325
+ # @!attribute [rw] smart_messaging_partial_update
326
+ # @return [::Boolean]
327
+ # Optional. When enabled, the reload request is to apply partial update to the smart
328
+ # messaging allowlist.
236
329
  class ReloadDocumentRequest
237
330
  include ::Google::Protobuf::MessageExts
238
331
  extend ::Google::Protobuf::MessageExts::ClassMethods
239
332
  end
240
333
 
334
+ # Request message for {::Google::Cloud::Dialogflow::V2::Documents::Client#export_document Documents.ExportDocument}.
335
+ # @!attribute [rw] name
336
+ # @return [::String]
337
+ # Required. The name of the document to export.
338
+ # Format: `projects/<Project ID>/locations/<Location
339
+ # ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
340
+ # @!attribute [rw] gcs_destination
341
+ # @return [::Google::Cloud::Dialogflow::V2::GcsDestination]
342
+ # Cloud Storage file path to export the document.
343
+ # @!attribute [rw] export_full_content
344
+ # @return [::Boolean]
345
+ # When enabled, export the full content of the document including empirical
346
+ # probability.
347
+ # @!attribute [rw] smart_messaging_partial_update
348
+ # @return [::Boolean]
349
+ # When enabled, export the smart messaging allowlist document for partial
350
+ # update.
351
+ class ExportDocumentRequest
352
+ include ::Google::Protobuf::MessageExts
353
+ extend ::Google::Protobuf::MessageExts::ClassMethods
354
+ end
355
+
241
356
  # Metadata in google::longrunning::Operation for Knowledge operations.
242
357
  # @!attribute [r] state
243
358
  # @return [::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata::State]
244
359
  # Output only. The current state of this operation.
360
+ # @!attribute [rw] knowledge_base
361
+ # @return [::String]
362
+ # The name of the knowledge base interacted with during the operation.
245
363
  class KnowledgeOperationMetadata
246
364
  include ::Google::Protobuf::MessageExts
247
365
  extend ::Google::Protobuf::MessageExts::ClassMethods