Class: Google::Cloud::Dialogflow::V2::Intents::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::V2::Intents::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/dialogflow/v2/intents/client.rb
Overview
Client for the Intents service.
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
DetectIntent (or
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.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the Intents Client class.
Instance Method Summary collapse
-
#batch_delete_intents(request, options = nil) {|response, operation| ... } ⇒ Gapic::Operation
Deletes intents in the specified agent.
-
#batch_update_intents(request, options = nil) {|response, operation| ... } ⇒ Gapic::Operation
Updates/Creates multiple intents in the specified agent.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the Intents Client instance.
-
#create_intent(request, options = nil) {|response, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Intent
Creates an intent in the specified agent.
-
#delete_intent(request, options = nil) {|response, operation| ... } ⇒ Google::Protobuf::Empty
Deletes the specified intent and its direct or indirect followup intents.
-
#get_intent(request, options = nil) {|response, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Intent
Retrieves the specified intent.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new Intents client object.
-
#list_intents(request, options = nil) {|response, operation| ... } ⇒ Gapic::PagedEnumerable<Google::Cloud::Dialogflow::V2::Intent>
Returns the list of all intents in the specified agent.
-
#update_intent(request, options = nil) {|response, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Intent
Updates the specified intent.
Methods included from Paths
#agent_path, #context_path, #intent_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new Intents client object.
Examples
To create a new Intents client with the default configuration:
client = Google::Cloud::Dialogflow::V2::Intents::Client.new
To create a new Intents client with a custom configuration:
client = Google::Cloud::Dialogflow::V2::Intents::Client.new do |config|
config.timeout = 10_000
end
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 |
# File 'lib/google/cloud/dialogflow/v2/intents/client.rb', line 191 def initialize # 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 "gapic/grpc" require "google/cloud/dialogflow/v2/intent_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials credentials ||= Credentials.default scope: @config.scope if credentials.is_a?(String) || credentials.is_a?(Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil @operations_client = Operations.new do |config| config.credentials = credentials end @intents_stub = Gapic::ServiceStub.new( Google::Cloud::Dialogflow::V2::Intents::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the Intents Client class.
See Configuration for a description of the configuration fields.
Example
To modify the configuration for all Intents clients:
Google::Cloud::Dialogflow::V2::Intents::Client.configure do |config|
config.timeout = 10_000
end
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 |
# File 'lib/google/cloud/dialogflow/v2/intents/client.rb', line 96 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dialogflow", "V2"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const&.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.list_intents.timeout = 60.0 default_config.rpcs.list_intents.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } default_config.rpcs.get_intent.timeout = 60.0 default_config.rpcs.get_intent.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } default_config.rpcs.create_intent.timeout = 60.0 default_config.rpcs.update_intent.timeout = 60.0 default_config.rpcs.delete_intent.timeout = 60.0 default_config.rpcs.delete_intent.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } default_config.rpcs.batch_update_intents.timeout = 60.0 default_config.rpcs.batch_delete_intents.timeout = 60.0 default_config.rpcs.batch_delete_intents.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#batch_delete_intents(request, options = nil) ⇒ Gapic::Operation #batch_delete_intents(parent: nil, intents: nil) ⇒ Gapic::Operation
Deletes intents in the specified agent.
Operation
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 |
# File 'lib/google/cloud/dialogflow/v2/intents/client.rb', line 685 def batch_delete_intents request, = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::BatchDeleteIntentsRequest # Converts hash and nil to an options object = Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.batch_delete_intents..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.batch_delete_intents.timeout, metadata: , retry_policy: @config.rpcs.batch_delete_intents.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @intents_stub.call_rpc :batch_delete_intents, request, options: do |response, operation| response = Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue GRPC::BadStatus => e raise Google::Cloud::Error.from_error(e) end |
#batch_update_intents(request, options = nil) ⇒ Gapic::Operation #batch_update_intents(parent: nil, intent_batch_uri: nil, intent_batch_inline: nil, language_code: nil, update_mask: nil, intent_view: nil) ⇒ Gapic::Operation
Updates/Creates multiple intents in the specified agent.
Operation
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 |
# File 'lib/google/cloud/dialogflow/v2/intents/client.rb', line 617 def batch_update_intents request, = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::BatchUpdateIntentsRequest # Converts hash and nil to an options object = Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.batch_update_intents..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.batch_update_intents.timeout, metadata: , retry_policy: @config.rpcs.batch_update_intents.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @intents_stub.call_rpc :batch_update_intents, request, options: do |response, operation| response = Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue GRPC::BadStatus => e raise Google::Cloud::Error.from_error(e) end |
#configure {|config| ... } ⇒ Client::Configuration
Configure the Intents Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
166 167 168 169 |
# File 'lib/google/cloud/dialogflow/v2/intents/client.rb', line 166 def configure yield @config if block_given? @config end |
#create_intent(request, options = nil) ⇒ Google::Cloud::Dialogflow::V2::Intent #create_intent(parent: nil, intent: nil, language_code: nil, intent_view: nil) ⇒ Google::Cloud::Dialogflow::V2::Intent
Creates an intent in the specified agent.
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 |
# File 'lib/google/cloud/dialogflow/v2/intents/client.rb', line 405 def create_intent request, = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::CreateIntentRequest # Converts hash and nil to an options object = Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_intent..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_intent.timeout, metadata: , retry_policy: @config.rpcs.create_intent.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @intents_stub.call_rpc :create_intent, request, options: do |response, operation| yield response, operation if block_given? return response end rescue GRPC::BadStatus => e raise Google::Cloud::Error.from_error(e) end |
#delete_intent(request, options = nil) ⇒ Google::Protobuf::Empty #delete_intent(name: nil) ⇒ Google::Protobuf::Empty
Deletes the specified intent and its direct or indirect followup intents.
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 |
# File 'lib/google/cloud/dialogflow/v2/intents/client.rb', line 536 def delete_intent request, = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::DeleteIntentRequest # Converts hash and nil to an options object = Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_intent..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_intent.timeout, metadata: , retry_policy: @config.rpcs.delete_intent.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @intents_stub.call_rpc :delete_intent, request, options: do |response, operation| yield response, operation if block_given? return response end rescue GRPC::BadStatus => e raise Google::Cloud::Error.from_error(e) end |
#get_intent(request, options = nil) ⇒ Google::Cloud::Dialogflow::V2::Intent #get_intent(name: nil, language_code: nil, intent_view: nil) ⇒ Google::Cloud::Dialogflow::V2::Intent
Retrieves the specified intent.
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 |
# File 'lib/google/cloud/dialogflow/v2/intents/client.rb', line 334 def get_intent request, = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::GetIntentRequest # Converts hash and nil to an options object = Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_intent..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_intent.timeout, metadata: , retry_policy: @config.rpcs.get_intent.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @intents_stub.call_rpc :get_intent, request, options: do |response, operation| yield response, operation if block_given? return response end rescue GRPC::BadStatus => e raise Google::Cloud::Error.from_error(e) end |
#list_intents(request, options = nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::Dialogflow::V2::Intent> #list_intents(parent: nil, language_code: nil, intent_view: nil, page_size: nil, page_token: nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::Dialogflow::V2::Intent>
Returns the list of all intents in the specified agent.
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 |
# File 'lib/google/cloud/dialogflow/v2/intents/client.rb', line 264 def list_intents request, = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::ListIntentsRequest # Converts hash and nil to an options object = Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_intents..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_intents.timeout, metadata: , retry_policy: @config.rpcs.list_intents.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @intents_stub.call_rpc :list_intents, request, options: do |response, operation| response = Gapic::PagedEnumerable.new @intents_stub, :list_intents, request, response, operation, yield response, operation if block_given? return response end rescue GRPC::BadStatus => e raise Google::Cloud::Error.from_error(e) end |
#update_intent(request, options = nil) ⇒ Google::Cloud::Dialogflow::V2::Intent #update_intent(intent: nil, language_code: nil, update_mask: nil, intent_view: nil) ⇒ Google::Cloud::Dialogflow::V2::Intent
Updates the specified intent.
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 |
# File 'lib/google/cloud/dialogflow/v2/intents/client.rb', line 475 def update_intent request, = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::UpdateIntentRequest # Converts hash and nil to an options object = Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_intent..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "intent.name" => request.intent.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_intent.timeout, metadata: , retry_policy: @config.rpcs.update_intent.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @intents_stub.call_rpc :update_intent, request, options: do |response, operation| yield response, operation if block_given? return response end rescue GRPC::BadStatus => e raise Google::Cloud::Error.from_error(e) end |