google-cloud-dialogflow-v2 0.11.4 → 0.14.0

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -162,7 +162,7 @@ module Google
162
162
  # @param options [::Gapic::CallOptions, ::Hash]
163
163
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
164
164
  #
165
- # @overload list_knowledge_bases(parent: nil, page_size: nil, page_token: nil)
165
+ # @overload list_knowledge_bases(parent: nil, page_size: nil, page_token: nil, filter: nil)
166
166
  # Pass arguments to `list_knowledge_bases` via keyword arguments. Note that at
167
167
  # least one keyword argument is required. To specify no parameters, or to keep all
168
168
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -175,6 +175,33 @@ module Google
175
175
  # default 10 and at most 100.
176
176
  # @param page_token [::String]
177
177
  # The next_page_token value returned from a previous list request.
178
+ # @param filter [::String]
179
+ # The filter expression used to filter knowledge bases returned by the list
180
+ # method. The expression has the following syntax:
181
+ #
182
+ # <field> <operator> <value> [AND <field> <operator> <value>] ...
183
+ #
184
+ # The following fields and operators are supported:
185
+ #
186
+ # * display_name with has(:) operator
187
+ # * language_code with equals(=) operator
188
+ #
189
+ # Examples:
190
+ #
191
+ # * 'language_code=en-us' matches knowledge bases with en-us language code.
192
+ # * 'display_name:articles' matches knowledge bases whose display name
193
+ # contains "articles".
194
+ # * 'display_name:"Best Articles"' matches knowledge bases whose display
195
+ # name contains "Best Articles".
196
+ # * 'language_code=en-gb AND display_name=articles' matches all knowledge
197
+ # bases whose display name contains "articles" and whose language code is
198
+ # "en-gb".
199
+ #
200
+ # Note: An empty filter string (i.e. "") is a no-op and will result in no
201
+ # filtering.
202
+ #
203
+ # For more information about filtering, see
204
+ # [API Filtering](https://aip.dev/160).
178
205
  #
179
206
  # @yield [response, operation] Access the result along with the RPC operation
180
207
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::KnowledgeBase>]
@@ -184,6 +211,27 @@ module Google
184
211
  #
185
212
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
186
213
  #
214
+ # @example Basic example
215
+ # require "google/cloud/dialogflow/v2"
216
+ #
217
+ # # Create a client object. The client can be reused for multiple calls.
218
+ # client = Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
219
+ #
220
+ # # Create a request. To set request fields, pass in keyword arguments.
221
+ # request = Google::Cloud::Dialogflow::V2::ListKnowledgeBasesRequest.new
222
+ #
223
+ # # Call the list_knowledge_bases method.
224
+ # result = client.list_knowledge_bases request
225
+ #
226
+ # # The returned object is of type Gapic::PagedEnumerable. You can
227
+ # # iterate over all elements by calling #each, and the enumerable
228
+ # # will lazily make API calls to fetch subsequent pages. Other
229
+ # # methods are also available for managing paging directly.
230
+ # result.each do |response|
231
+ # # Each element is of type ::Google::Cloud::Dialogflow::V2::KnowledgeBase.
232
+ # p response
233
+ # end
234
+ #
187
235
  def list_knowledge_bases request, options = nil
188
236
  raise ::ArgumentError, "request must be provided" if request.nil?
189
237
 
@@ -201,9 +249,11 @@ module Google
201
249
  gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
202
250
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
203
251
 
204
- header_params = {
205
- "parent" => request.parent
206
- }
252
+ header_params = {}
253
+ if request.parent
254
+ header_params["parent"] = request.parent
255
+ end
256
+
207
257
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
208
258
  metadata[:"x-goog-request-params"] ||= request_params_header
209
259
 
@@ -255,6 +305,21 @@ module Google
255
305
  #
256
306
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
257
307
  #
308
+ # @example Basic example
309
+ # require "google/cloud/dialogflow/v2"
310
+ #
311
+ # # Create a client object. The client can be reused for multiple calls.
312
+ # client = Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
313
+ #
314
+ # # Create a request. To set request fields, pass in keyword arguments.
315
+ # request = Google::Cloud::Dialogflow::V2::GetKnowledgeBaseRequest.new
316
+ #
317
+ # # Call the get_knowledge_base method.
318
+ # result = client.get_knowledge_base request
319
+ #
320
+ # # The returned object is of type Google::Cloud::Dialogflow::V2::KnowledgeBase.
321
+ # p result
322
+ #
258
323
  def get_knowledge_base request, options = nil
259
324
  raise ::ArgumentError, "request must be provided" if request.nil?
260
325
 
@@ -272,9 +337,11 @@ module Google
272
337
  gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
273
338
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
274
339
 
275
- header_params = {
276
- "name" => request.name
277
- }
340
+ header_params = {}
341
+ if request.name
342
+ header_params["name"] = request.name
343
+ end
344
+
278
345
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
279
346
  metadata[:"x-goog-request-params"] ||= request_params_header
280
347
 
@@ -326,6 +393,21 @@ module Google
326
393
  #
327
394
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
328
395
  #
396
+ # @example Basic example
397
+ # require "google/cloud/dialogflow/v2"
398
+ #
399
+ # # Create a client object. The client can be reused for multiple calls.
400
+ # client = Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
401
+ #
402
+ # # Create a request. To set request fields, pass in keyword arguments.
403
+ # request = Google::Cloud::Dialogflow::V2::CreateKnowledgeBaseRequest.new
404
+ #
405
+ # # Call the create_knowledge_base method.
406
+ # result = client.create_knowledge_base request
407
+ #
408
+ # # The returned object is of type Google::Cloud::Dialogflow::V2::KnowledgeBase.
409
+ # p result
410
+ #
329
411
  def create_knowledge_base request, options = nil
330
412
  raise ::ArgumentError, "request must be provided" if request.nil?
331
413
 
@@ -343,9 +425,11 @@ module Google
343
425
  gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
344
426
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
345
427
 
346
- header_params = {
347
- "parent" => request.parent
348
- }
428
+ header_params = {}
429
+ if request.parent
430
+ header_params["parent"] = request.parent
431
+ end
432
+
349
433
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
350
434
  metadata[:"x-goog-request-params"] ||= request_params_header
351
435
 
@@ -399,6 +483,21 @@ module Google
399
483
  #
400
484
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
401
485
  #
486
+ # @example Basic example
487
+ # require "google/cloud/dialogflow/v2"
488
+ #
489
+ # # Create a client object. The client can be reused for multiple calls.
490
+ # client = Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
491
+ #
492
+ # # Create a request. To set request fields, pass in keyword arguments.
493
+ # request = Google::Cloud::Dialogflow::V2::DeleteKnowledgeBaseRequest.new
494
+ #
495
+ # # Call the delete_knowledge_base method.
496
+ # result = client.delete_knowledge_base request
497
+ #
498
+ # # The returned object is of type Google::Protobuf::Empty.
499
+ # p result
500
+ #
402
501
  def delete_knowledge_base request, options = nil
403
502
  raise ::ArgumentError, "request must be provided" if request.nil?
404
503
 
@@ -416,9 +515,11 @@ module Google
416
515
  gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
417
516
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
418
517
 
419
- header_params = {
420
- "name" => request.name
421
- }
518
+ header_params = {}
519
+ if request.name
520
+ header_params["name"] = request.name
521
+ end
522
+
422
523
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
423
524
  metadata[:"x-goog-request-params"] ||= request_params_header
424
525
 
@@ -471,6 +572,21 @@ module Google
471
572
  #
472
573
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
473
574
  #
575
+ # @example Basic example
576
+ # require "google/cloud/dialogflow/v2"
577
+ #
578
+ # # Create a client object. The client can be reused for multiple calls.
579
+ # client = Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
580
+ #
581
+ # # Create a request. To set request fields, pass in keyword arguments.
582
+ # request = Google::Cloud::Dialogflow::V2::UpdateKnowledgeBaseRequest.new
583
+ #
584
+ # # Call the update_knowledge_base method.
585
+ # result = client.update_knowledge_base request
586
+ #
587
+ # # The returned object is of type Google::Cloud::Dialogflow::V2::KnowledgeBase.
588
+ # p result
589
+ #
474
590
  def update_knowledge_base request, options = nil
475
591
  raise ::ArgumentError, "request must be provided" if request.nil?
476
592
 
@@ -488,9 +604,11 @@ module Google
488
604
  gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
489
605
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
490
606
 
491
- header_params = {
492
- "knowledge_base.name" => request.knowledge_base.name
493
- }
607
+ header_params = {}
608
+ if request.knowledge_base&.name
609
+ header_params["knowledge_base.name"] = request.knowledge_base.name
610
+ end
611
+
494
612
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
495
613
  metadata[:"x-goog-request-params"] ||= request_params_header
496
614
 
@@ -6,6 +6,7 @@ require 'google/api/client_pb'
6
6
  require 'google/api/field_behavior_pb'
7
7
  require 'google/api/resource_pb'
8
8
  require 'google/cloud/dialogflow/v2/audio_config_pb'
9
+ require 'google/cloud/dialogflow/v2/gcs_pb'
9
10
  require 'google/cloud/dialogflow/v2/session_pb'
10
11
  require 'google/protobuf/any_pb'
11
12
  require 'google/protobuf/duration_pb'
@@ -21,6 +22,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
21
22
  optional :name, :string, 1
22
23
  optional :role, :enum, 2, "google.cloud.dialogflow.v2.Participant.Role"
23
24
  optional :sip_recording_media_label, :string, 6
25
+ map :documents_metadata_filters, :string, :string, 8
24
26
  end
25
27
  add_enum "google.cloud.dialogflow.v2.Participant.Role" do
26
28
  value :ROLE_UNSPECIFIED, 0
@@ -35,7 +37,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
35
37
  optional :participant, :string, 4
36
38
  optional :participant_role, :enum, 5, "google.cloud.dialogflow.v2.Participant.Role"
37
39
  optional :create_time, :message, 6, "google.protobuf.Timestamp"
40
+ optional :send_time, :message, 9, "google.protobuf.Timestamp"
38
41
  optional :message_annotation, :message, 7, "google.cloud.dialogflow.v2.MessageAnnotation"
42
+ optional :sentiment_analysis, :message, 8, "google.cloud.dialogflow.v2.SentimentAnalysisResult"
39
43
  end
40
44
  add_message "google.cloud.dialogflow.v2.CreateParticipantRequest" do
41
45
  optional :parent, :string, 1
@@ -61,6 +65,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
61
65
  optional :participant, :string, 1
62
66
  optional :reply_audio_config, :message, 5, "google.cloud.dialogflow.v2.OutputAudioConfig"
63
67
  optional :query_params, :message, 9, "google.cloud.dialogflow.v2.QueryParameters"
68
+ optional :assist_query_params, :message, 14, "google.cloud.dialogflow.v2.AssistQueryParameters"
64
69
  optional :request_id, :string, 11
65
70
  oneof :input do
66
71
  optional :text_input, :message, 6, "google.cloud.dialogflow.v2.TextInput"
@@ -83,6 +88,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
83
88
  optional :parent, :string, 1
84
89
  optional :latest_message, :string, 2
85
90
  optional :context_size, :int32, 3
91
+ optional :assist_query_params, :message, 4, "google.cloud.dialogflow.v2.AssistQueryParameters"
86
92
  end
87
93
  add_message "google.cloud.dialogflow.v2.SuggestArticlesResponse" do
88
94
  repeated :article_answers, :message, 1, "google.cloud.dialogflow.v2.ArticleAnswer"
@@ -93,12 +99,24 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
93
99
  optional :parent, :string, 1
94
100
  optional :latest_message, :string, 2
95
101
  optional :context_size, :int32, 3
102
+ optional :assist_query_params, :message, 4, "google.cloud.dialogflow.v2.AssistQueryParameters"
96
103
  end
97
104
  add_message "google.cloud.dialogflow.v2.SuggestFaqAnswersResponse" do
98
105
  repeated :faq_answers, :message, 1, "google.cloud.dialogflow.v2.FaqAnswer"
99
106
  optional :latest_message, :string, 2
100
107
  optional :context_size, :int32, 3
101
108
  end
109
+ add_message "google.cloud.dialogflow.v2.SuggestSmartRepliesRequest" do
110
+ optional :parent, :string, 1
111
+ optional :current_text_input, :message, 4, "google.cloud.dialogflow.v2.TextInput"
112
+ optional :latest_message, :string, 2
113
+ optional :context_size, :int32, 3
114
+ end
115
+ add_message "google.cloud.dialogflow.v2.SuggestSmartRepliesResponse" do
116
+ repeated :smart_reply_answers, :message, 1, "google.cloud.dialogflow.v2.SmartReplyAnswer"
117
+ optional :latest_message, :string, 2
118
+ optional :context_size, :int32, 3
119
+ end
102
120
  add_message "google.cloud.dialogflow.v2.OutputAudio" do
103
121
  optional :config, :message, 1, "google.cloud.dialogflow.v2.OutputAudioConfig"
104
122
  optional :audio, :bytes, 2
@@ -129,11 +147,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
129
147
  map :metadata, :string, :string, 5
130
148
  optional :answer_record, :string, 6
131
149
  end
150
+ add_message "google.cloud.dialogflow.v2.SmartReplyAnswer" do
151
+ optional :reply, :string, 1
152
+ optional :confidence, :float, 2
153
+ optional :answer_record, :string, 3
154
+ end
132
155
  add_message "google.cloud.dialogflow.v2.SuggestionResult" do
133
156
  oneof :suggestion_response do
134
157
  optional :error, :message, 1, "google.rpc.Status"
135
158
  optional :suggest_articles_response, :message, 2, "google.cloud.dialogflow.v2.SuggestArticlesResponse"
136
159
  optional :suggest_faq_answers_response, :message, 3, "google.cloud.dialogflow.v2.SuggestFaqAnswersResponse"
160
+ optional :suggest_smart_replies_response, :message, 4, "google.cloud.dialogflow.v2.SuggestSmartRepliesResponse"
137
161
  end
138
162
  end
139
163
  add_message "google.cloud.dialogflow.v2.AnnotatedMessagePart" do
@@ -145,6 +169,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
145
169
  repeated :parts, :message, 1, "google.cloud.dialogflow.v2.AnnotatedMessagePart"
146
170
  optional :contain_entities, :bool, 2
147
171
  end
172
+ add_message "google.cloud.dialogflow.v2.AssistQueryParameters" do
173
+ map :documents_metadata_filters, :string, :string, 1
174
+ end
148
175
  end
149
176
  end
150
177
 
@@ -167,14 +194,18 @@ module Google
167
194
  SuggestArticlesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SuggestArticlesResponse").msgclass
168
195
  SuggestFaqAnswersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SuggestFaqAnswersRequest").msgclass
169
196
  SuggestFaqAnswersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SuggestFaqAnswersResponse").msgclass
197
+ SuggestSmartRepliesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SuggestSmartRepliesRequest").msgclass
198
+ SuggestSmartRepliesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SuggestSmartRepliesResponse").msgclass
170
199
  OutputAudio = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.OutputAudio").msgclass
171
200
  AutomatedAgentReply = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AutomatedAgentReply").msgclass
172
201
  AutomatedAgentReply::AutomatedAgentReplyType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AutomatedAgentReply.AutomatedAgentReplyType").enummodule
173
202
  ArticleAnswer = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.ArticleAnswer").msgclass
174
203
  FaqAnswer = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.FaqAnswer").msgclass
204
+ SmartReplyAnswer = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SmartReplyAnswer").msgclass
175
205
  SuggestionResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SuggestionResult").msgclass
176
206
  AnnotatedMessagePart = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AnnotatedMessagePart").msgclass
177
207
  MessageAnnotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.MessageAnnotation").msgclass
208
+ AssistQueryParameters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AssistQueryParameters").msgclass
178
209
  end
179
210
  end
180
211
  end
@@ -54,6 +54,9 @@ module Google
54
54
  # Gets suggested faq answers for a participant based on specific historical
55
55
  # messages.
56
56
  rpc :SuggestFaqAnswers, ::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersRequest, ::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse
57
+ # Gets smart replies for a participant based on specific historical
58
+ # messages.
59
+ rpc :SuggestSmartReplies, ::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesRequest, ::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesResponse
57
60
  end
58
61
 
59
62
  Stub = Service.rpc_stub_class