-
Notifications
You must be signed in to change notification settings - Fork 535
/
intents_client.rb
760 lines (714 loc) · 33 KB
/
intents_client.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# EDITING INSTRUCTIONS
# This file was generated from the file
# https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2/intent.proto,
# and updates to that file get reflected here through a refresh process.
# For the short term, the refresh process will only be runnable by Google
# engineers.
require "json"
require "pathname"
require "google/gax"
require "google/gax/operation"
require "google/longrunning/operations_client"
require "google/cloud/dialogflow/v2/intent_pb"
require "google/cloud/dialogflow/v2/credentials"
require "google/cloud/dialogflow/version"
module Google
module Cloud
module Dialogflow
module V2
# An intent represents a mapping between input from a user and an action to
# be taken by your application. When you pass user input to the
# {Google::Cloud::Dialogflow::V2::Sessions::DetectIntent DetectIntent} (or
# {Google::Cloud::Dialogflow::V2::Sessions::StreamingDetectIntent StreamingDetectIntent}) method, the
# Dialogflow API analyzes the input and searches
# for a matching intent. If no match is found, the Dialogflow API returns a
# fallback intent (`is_fallback` = true).
#
# You can provide additional information for the Dialogflow API to use to
# match user input to an intent by adding the following to your intent.
#
# * **Contexts** - provide additional context for intent analysis. For
# example, if an intent is related to an object in your application that
# plays music, you can provide a context to determine when to match the
# intent if the user input is "turn it off". You can include a context
# that matches the intent when there is previous user input of
# "play music", and not when there is previous user input of
# "turn on the light".
#
# * **Events** - allow for matching an intent by using an event name
# instead of user input. Your application can provide an event name and
# related parameters to the Dialogflow API to match an intent. For
# example, when your application starts, you can send a welcome event
# with a user name parameter to the Dialogflow API to match an intent with
# a personalized welcome message for the user.
#
# * **Training phrases** - provide examples of user input to train the
# Dialogflow API agent to better match intents.
#
# For more information about intents, see the
# [Dialogflow
# documentation](https://cloud.google.com/dialogflow/docs/intents-overview).
#
# @!attribute [r] intents_stub
# @return [Google::Cloud::Dialogflow::V2::Intents::Stub]
class IntentsClient
# @private
attr_reader :intents_stub
# The default address of the service.
SERVICE_ADDRESS = "dialogflow.googleapis.com".freeze
# The default port of the service.
DEFAULT_SERVICE_PORT = 443
# The default set of gRPC interceptors.
GRPC_INTERCEPTORS = []
DEFAULT_TIMEOUT = 30
PAGE_DESCRIPTORS = {
"list_intents" => Google::Gax::PageDescriptor.new(
"page_token",
"next_page_token",
"intents")
}.freeze
private_constant :PAGE_DESCRIPTORS
# The scopes needed to make gRPC calls to all of the methods defined in
# this service.
ALL_SCOPES = [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/dialogflow"
].freeze
# @private
class OperationsClient < Google::Longrunning::OperationsClient
self::SERVICE_ADDRESS = IntentsClient::SERVICE_ADDRESS
self::GRPC_INTERCEPTORS = IntentsClient::GRPC_INTERCEPTORS
end
AGENT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
"projects/{project}/agents/{agent}"
)
private_constant :AGENT_PATH_TEMPLATE
INTENT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
"projects/{project}/agent/intents/{intent}"
)
private_constant :INTENT_PATH_TEMPLATE
PROJECT_AGENT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
"projects/{project}/agent"
)
private_constant :PROJECT_AGENT_PATH_TEMPLATE
# Returns a fully-qualified agent resource name string.
# @param project [String]
# @param agent [String]
# @return [String]
def self.agent_path project, agent
AGENT_PATH_TEMPLATE.render(
:"project" => project,
:"agent" => agent
)
end
# Returns a fully-qualified intent resource name string.
# @param project [String]
# @param intent [String]
# @return [String]
def self.intent_path project, intent
INTENT_PATH_TEMPLATE.render(
:"project" => project,
:"intent" => intent
)
end
# Returns a fully-qualified project_agent resource name string.
# @param project [String]
# @return [String]
def self.project_agent_path project
PROJECT_AGENT_PATH_TEMPLATE.render(
:"project" => project
)
end
# @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
# Provides the means for authenticating requests made by the client. This parameter can
# be many types.
# A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
# authenticating requests made by this client.
# A `String` will be treated as the path to the keyfile to be used for the construction of
# credentials for this client.
# A `Hash` will be treated as the contents of a keyfile to be used for the construction of
# credentials for this client.
# A `GRPC::Core::Channel` will be used to make calls through.
# A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
# should already be composed with a `GRPC::Core::CallCredentials` object.
# A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
# metadata for requests, generally, to give OAuth credentials.
# @param scopes [Array<String>]
# The OAuth scopes for this service. This parameter is ignored if
# an updater_proc is supplied.
# @param client_config [Hash]
# A Hash for call options for each method. See
# Google::Gax#construct_settings for the structure of
# this data. Falls back to the default config if not specified
# or the specified config is missing data points.
# @param timeout [Numeric]
# The default timeout, in seconds, for calls made through this client.
# @param metadata [Hash]
# Default metadata to be sent with each request. This can be overridden on a per call basis.
# @param service_address [String]
# Override for the service hostname, or `nil` to leave as the default.
# @param service_port [Integer]
# Override for the service port, or `nil` to leave as the default.
# @param exception_transformer [Proc]
# An optional proc that intercepts any exceptions raised during an API call to inject
# custom error handling.
def initialize \
credentials: nil,
scopes: ALL_SCOPES,
client_config: {},
timeout: DEFAULT_TIMEOUT,
metadata: nil,
service_address: nil,
service_port: nil,
exception_transformer: nil,
lib_name: nil,
lib_version: ""
# These require statements are intentionally placed here to initialize
# the gRPC module only when it's required.
# See https://github.com/googleapis/toolkit/issues/446
require "google/gax/grpc"
require "google/cloud/dialogflow/v2/intent_services_pb"
credentials ||= Google::Cloud::Dialogflow::V2::Credentials.default
@operations_client = OperationsClient.new(
credentials: credentials,
scopes: scopes,
client_config: client_config,
timeout: timeout,
lib_name: lib_name,
service_address: service_address,
service_port: service_port,
lib_version: lib_version,
metadata: metadata,
)
if credentials.is_a?(String) || credentials.is_a?(Hash)
updater_proc = Google::Cloud::Dialogflow::V2::Credentials.new(credentials).updater_proc
end
if credentials.is_a?(GRPC::Core::Channel)
channel = credentials
end
if credentials.is_a?(GRPC::Core::ChannelCredentials)
chan_creds = credentials
end
if credentials.is_a?(Proc)
updater_proc = credentials
end
if credentials.is_a?(Google::Auth::Credentials)
updater_proc = credentials.updater_proc
end
package_version = Google::Cloud::Dialogflow::VERSION
google_api_client = "gl-ruby/#{RUBY_VERSION}"
google_api_client << " #{lib_name}/#{lib_version}" if lib_name
google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
google_api_client << " grpc/#{GRPC::VERSION}"
google_api_client.freeze
headers = { :"x-goog-api-client" => google_api_client }
headers.merge!(metadata) unless metadata.nil?
client_config_file = Pathname.new(__dir__).join(
"intents_client_config.json"
)
defaults = client_config_file.open do |f|
Google::Gax.construct_settings(
"google.cloud.dialogflow.v2.Intents",
JSON.parse(f.read),
client_config,
Google::Gax::Grpc::STATUS_CODE_NAMES,
timeout,
page_descriptors: PAGE_DESCRIPTORS,
errors: Google::Gax::Grpc::API_ERRORS,
metadata: headers
)
end
# Allow overriding the service path/port in subclasses.
service_path = service_address || self.class::SERVICE_ADDRESS
port = service_port || self.class::DEFAULT_SERVICE_PORT
interceptors = self.class::GRPC_INTERCEPTORS
@intents_stub = Google::Gax::Grpc.create_stub(
service_path,
port,
chan_creds: chan_creds,
channel: channel,
updater_proc: updater_proc,
scopes: scopes,
interceptors: interceptors,
&Google::Cloud::Dialogflow::V2::Intents::Stub.method(:new)
)
@list_intents = Google::Gax.create_api_call(
@intents_stub.method(:list_intents),
defaults["list_intents"],
exception_transformer: exception_transformer,
params_extractor: proc do |request|
{'parent' => request.parent}
end
)
@get_intent = Google::Gax.create_api_call(
@intents_stub.method(:get_intent),
defaults["get_intent"],
exception_transformer: exception_transformer,
params_extractor: proc do |request|
{'name' => request.name}
end
)
@create_intent = Google::Gax.create_api_call(
@intents_stub.method(:create_intent),
defaults["create_intent"],
exception_transformer: exception_transformer,
params_extractor: proc do |request|
{'parent' => request.parent}
end
)
@update_intent = Google::Gax.create_api_call(
@intents_stub.method(:update_intent),
defaults["update_intent"],
exception_transformer: exception_transformer,
params_extractor: proc do |request|
{'intent.name' => request.intent.name}
end
)
@delete_intent = Google::Gax.create_api_call(
@intents_stub.method(:delete_intent),
defaults["delete_intent"],
exception_transformer: exception_transformer,
params_extractor: proc do |request|
{'name' => request.name}
end
)
@batch_update_intents = Google::Gax.create_api_call(
@intents_stub.method(:batch_update_intents),
defaults["batch_update_intents"],
exception_transformer: exception_transformer,
params_extractor: proc do |request|
{'parent' => request.parent}
end
)
@batch_delete_intents = Google::Gax.create_api_call(
@intents_stub.method(:batch_delete_intents),
defaults["batch_delete_intents"],
exception_transformer: exception_transformer,
params_extractor: proc do |request|
{'parent' => request.parent}
end
)
end
# Service calls
# Returns the list of all intents in the specified agent.
#
# @param parent [String]
# Required. The agent to list all intents from.
# Format: `projects/<Project ID>/agent`.
# @param language_code [String]
# Optional. The language to list training phrases, parameters and rich
# messages for. If not specified, the agent's default language is used.
# [Many
# languages](https://cloud.google.com/dialogflow/docs/reference/language)
# are supported. Note: languages must be enabled in the agent before they can
# be used.
# @param intent_view [Google::Cloud::Dialogflow::V2::IntentView]
# Optional. The resource view to apply to the returned intent.
# @param page_size [Integer]
# The maximum number of resources contained in the underlying API
# response. If page streaming is performed per-resource, this
# parameter does not affect the return value. If page streaming is
# performed per-page, this determines the maximum number of
# resources in a page.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result [Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::Intent>]
# @yieldparam operation [GRPC::ActiveCall::Operation]
# @return [Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::Intent>]
# An enumerable of Google::Cloud::Dialogflow::V2::Intent instances.
# See Google::Gax::PagedEnumerable documentation for other
# operations such as per-page iteration or access to the response
# object.
# @raise [Google::Gax::GaxError] if the RPC is aborted.
# @example
# require "google/cloud/dialogflow"
#
# intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
# formatted_parent = Google::Cloud::Dialogflow::V2::IntentsClient.project_agent_path("[PROJECT]")
#
# # Iterate over all results.
# intents_client.list_intents(formatted_parent).each do |element|
# # Process element.
# end
#
# # Or iterate over results one page at a time.
# intents_client.list_intents(formatted_parent).each_page do |page|
# # Process each page at a time.
# page.each do |element|
# # Process element.
# end
# end
def list_intents \
parent,
language_code: nil,
intent_view: nil,
page_size: nil,
options: nil,
&block
req = {
parent: parent,
language_code: language_code,
intent_view: intent_view,
page_size: page_size
}.delete_if { |_, v| v.nil? }
req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::ListIntentsRequest)
@list_intents.call(req, options, &block)
end
# Retrieves the specified intent.
#
# @param name [String]
# Required. The name of the intent.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
# @param language_code [String]
# Optional. The language to retrieve training phrases, parameters and rich
# messages for. If not specified, the agent's default language is used.
# [Many
# languages](https://cloud.google.com/dialogflow/docs/reference/language)
# are supported. Note: languages must be enabled in the agent before they can
# be used.
# @param intent_view [Google::Cloud::Dialogflow::V2::IntentView]
# Optional. The resource view to apply to the returned intent.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result [Google::Cloud::Dialogflow::V2::Intent]
# @yieldparam operation [GRPC::ActiveCall::Operation]
# @return [Google::Cloud::Dialogflow::V2::Intent]
# @raise [Google::Gax::GaxError] if the RPC is aborted.
# @example
# require "google/cloud/dialogflow"
#
# intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
# formatted_name = Google::Cloud::Dialogflow::V2::IntentsClient.intent_path("[PROJECT]", "[INTENT]")
# response = intents_client.get_intent(formatted_name)
def get_intent \
name,
language_code: nil,
intent_view: nil,
options: nil,
&block
req = {
name: name,
language_code: language_code,
intent_view: intent_view
}.delete_if { |_, v| v.nil? }
req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::GetIntentRequest)
@get_intent.call(req, options, &block)
end
# Creates an intent in the specified agent.
#
# @param parent [String]
# Required. The agent to create a intent for.
# Format: `projects/<Project ID>/agent`.
# @param intent [Google::Cloud::Dialogflow::V2::Intent | Hash]
# Required. The intent to create.
# A hash of the same form as `Google::Cloud::Dialogflow::V2::Intent`
# can also be provided.
# @param language_code [String]
# Optional. The language of training phrases, parameters and rich messages
# defined in `intent`. If not specified, the agent's default language is
# used. [Many
# languages](https://cloud.google.com/dialogflow/docs/reference/language)
# are supported. Note: languages must be enabled in the agent before they can
# be used.
# @param intent_view [Google::Cloud::Dialogflow::V2::IntentView]
# Optional. The resource view to apply to the returned intent.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result [Google::Cloud::Dialogflow::V2::Intent]
# @yieldparam operation [GRPC::ActiveCall::Operation]
# @return [Google::Cloud::Dialogflow::V2::Intent]
# @raise [Google::Gax::GaxError] if the RPC is aborted.
# @example
# require "google/cloud/dialogflow"
#
# intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
# formatted_parent = Google::Cloud::Dialogflow::V2::IntentsClient.project_agent_path("[PROJECT]")
#
# # TODO: Initialize `intent`:
# intent = {}
# response = intents_client.create_intent(formatted_parent, intent)
def create_intent \
parent,
intent,
language_code: nil,
intent_view: nil,
options: nil,
&block
req = {
parent: parent,
intent: intent,
language_code: language_code,
intent_view: intent_view
}.delete_if { |_, v| v.nil? }
req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::CreateIntentRequest)
@create_intent.call(req, options, &block)
end
# Updates the specified intent.
#
# @param intent [Google::Cloud::Dialogflow::V2::Intent | Hash]
# Required. The intent to update.
# A hash of the same form as `Google::Cloud::Dialogflow::V2::Intent`
# can also be provided.
# @param language_code [String]
# Optional. The language of training phrases, parameters and rich messages
# defined in `intent`. If not specified, the agent's default language is
# used. [Many
# languages](https://cloud.google.com/dialogflow/docs/reference/language)
# are supported. Note: languages must be enabled in the agent before they can
# be used.
# @param update_mask [Google::Protobuf::FieldMask | Hash]
# Optional. The mask to control which fields get updated.
# A hash of the same form as `Google::Protobuf::FieldMask`
# can also be provided.
# @param intent_view [Google::Cloud::Dialogflow::V2::IntentView]
# Optional. The resource view to apply to the returned intent.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result [Google::Cloud::Dialogflow::V2::Intent]
# @yieldparam operation [GRPC::ActiveCall::Operation]
# @return [Google::Cloud::Dialogflow::V2::Intent]
# @raise [Google::Gax::GaxError] if the RPC is aborted.
# @example
# require "google/cloud/dialogflow"
#
# intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
#
# # TODO: Initialize `intent`:
# intent = {}
# response = intents_client.update_intent(intent)
def update_intent \
intent,
language_code: nil,
update_mask: nil,
intent_view: nil,
options: nil,
&block
req = {
intent: intent,
language_code: language_code,
update_mask: update_mask,
intent_view: intent_view
}.delete_if { |_, v| v.nil? }
req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::UpdateIntentRequest)
@update_intent.call(req, options, &block)
end
# Deletes the specified intent and its direct or indirect followup intents.
#
# @param name [String]
# Required. The name of the intent to delete. If this intent has direct or
# indirect followup intents, we also delete them.
# Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result []
# @yieldparam operation [GRPC::ActiveCall::Operation]
# @raise [Google::Gax::GaxError] if the RPC is aborted.
# @example
# require "google/cloud/dialogflow"
#
# intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
# formatted_name = Google::Cloud::Dialogflow::V2::IntentsClient.intent_path("[PROJECT]", "[INTENT]")
# intents_client.delete_intent(formatted_name)
def delete_intent \
name,
options: nil,
&block
req = {
name: name
}.delete_if { |_, v| v.nil? }
req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DeleteIntentRequest)
@delete_intent.call(req, options, &block)
nil
end
# Updates/Creates multiple intents in the specified agent.
#
# Operation <response: {Google::Cloud::Dialogflow::V2::BatchUpdateIntentsResponse BatchUpdateIntentsResponse}>
#
# @param parent [String]
# Required. The name of the agent to update or create intents in.
# Format: `projects/<Project ID>/agent`.
# @param intent_batch_uri [String]
# The URI to a Google Cloud Storage file containing intents to update or
# create. The file format can either be a serialized proto (of IntentBatch
# type) or JSON object. Note: The URI must start with "gs://".
# @param intent_batch_inline [Google::Cloud::Dialogflow::V2::IntentBatch | Hash]
# The collection of intents to update or create.
# A hash of the same form as `Google::Cloud::Dialogflow::V2::IntentBatch`
# can also be provided.
# @param language_code [String]
# Optional. The language of training phrases, parameters and rich messages
# defined in `intents`. If not specified, the agent's default language is
# used. [Many
# languages](https://cloud.google.com/dialogflow/docs/reference/language)
# are supported. Note: languages must be enabled in the agent before they can
# be used.
# @param update_mask [Google::Protobuf::FieldMask | Hash]
# Optional. The mask to control which fields get updated.
# A hash of the same form as `Google::Protobuf::FieldMask`
# can also be provided.
# @param intent_view [Google::Cloud::Dialogflow::V2::IntentView]
# Optional. The resource view to apply to the returned intent.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @return [Google::Gax::Operation]
# @raise [Google::Gax::GaxError] if the RPC is aborted.
# @example
# require "google/cloud/dialogflow"
#
# intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
# formatted_parent = Google::Cloud::Dialogflow::V2::IntentsClient.project_agent_path("[PROJECT]")
#
# # Register a callback during the method call.
# operation = intents_client.batch_update_intents(formatted_parent) do |op|
# raise op.results.message if op.error?
# op_results = op.results
# # Process the results.
#
# metadata = op.metadata
# # Process the metadata.
# end
#
# # Or use the return value to register a callback.
# operation.on_done do |op|
# raise op.results.message if op.error?
# op_results = op.results
# # Process the results.
#
# metadata = op.metadata
# # Process the metadata.
# end
#
# # Manually reload the operation.
# operation.reload!
#
# # Or block until the operation completes, triggering callbacks on
# # completion.
# operation.wait_until_done!
def batch_update_intents \
parent,
intent_batch_uri: nil,
intent_batch_inline: nil,
language_code: nil,
update_mask: nil,
intent_view: nil,
options: nil
req = {
parent: parent,
intent_batch_uri: intent_batch_uri,
intent_batch_inline: intent_batch_inline,
language_code: language_code,
update_mask: update_mask,
intent_view: intent_view
}.delete_if { |_, v| v.nil? }
req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::BatchUpdateIntentsRequest)
operation = Google::Gax::Operation.new(
@batch_update_intents.call(req, options),
@operations_client,
Google::Cloud::Dialogflow::V2::BatchUpdateIntentsResponse,
Google::Protobuf::Struct,
call_options: options
)
operation.on_done { |operation| yield(operation) } if block_given?
operation
end
# Deletes intents in the specified agent.
#
# Operation <response: {Google::Protobuf::Empty}>
#
# @param parent [String]
# Required. The name of the agent to delete all entities types for. Format:
# `projects/<Project ID>/agent`.
# @param intents [Array<Google::Cloud::Dialogflow::V2::Intent | Hash>]
# Required. The collection of intents to delete. Only intent `name` must be
# filled in.
# A hash of the same form as `Google::Cloud::Dialogflow::V2::Intent`
# can also be provided.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @return [Google::Gax::Operation]
# @raise [Google::Gax::GaxError] if the RPC is aborted.
# @example
# require "google/cloud/dialogflow"
#
# intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
# formatted_parent = Google::Cloud::Dialogflow::V2::IntentsClient.project_agent_path("[PROJECT]")
#
# # TODO: Initialize `intents`:
# intents = []
#
# # Register a callback during the method call.
# operation = intents_client.batch_delete_intents(formatted_parent, intents) do |op|
# raise op.results.message if op.error?
# op_results = op.results
# # Process the results.
#
# metadata = op.metadata
# # Process the metadata.
# end
#
# # Or use the return value to register a callback.
# operation.on_done do |op|
# raise op.results.message if op.error?
# op_results = op.results
# # Process the results.
#
# metadata = op.metadata
# # Process the metadata.
# end
#
# # Manually reload the operation.
# operation.reload!
#
# # Or block until the operation completes, triggering callbacks on
# # completion.
# operation.wait_until_done!
def batch_delete_intents \
parent,
intents,
options: nil
req = {
parent: parent,
intents: intents
}.delete_if { |_, v| v.nil? }
req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::BatchDeleteIntentsRequest)
operation = Google::Gax::Operation.new(
@batch_delete_intents.call(req, options),
@operations_client,
Google::Protobuf::Empty,
Google::Protobuf::Struct,
call_options: options
)
operation.on_done { |operation| yield(operation) } if block_given?
operation
end
end
end
end
end
end