Class: Google::Cloud::Dialogflow::CX::V3::Sessions::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::CX::V3::Sessions::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb
Overview
REST client for the Sessions service.
A session represents an interaction with a user. You retrieve user input and pass it to the DetectIntent method to determine user intent and respond.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client
readonly
Get the associated client for mix-in of the Locations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the Sessions Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the Sessions Client instance.
-
#detect_intent(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse
Processes a natural language query and returns structured, actionable data as a result.
-
#fulfill_intent(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::CX::V3::FulfillIntentResponse
Fulfills a matched intent returned by MatchIntent.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new Sessions REST client object.
-
#logger ⇒ Logger
The logger used for request/response debug logging.
-
#match_intent(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::CX::V3::MatchIntentResponse
Returns preliminary intent match results, doesn't change the session status.
-
#server_streaming_detect_intent(request, options = nil) ⇒ ::Enumerable<::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse>
Processes a natural language query and returns structured, actionable data as a result through server-side streaming.
-
#submit_answer_feedback(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback
Updates the feedback received from the user for a single turn of the bot response.
-
#universe_domain ⇒ String
The effective universe domain.
Methods included from Paths
#data_store_path, #entity_type_path, #intent_path, #page_path, #session_entity_type_path, #session_path, #version_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new Sessions REST client object.
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 |
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb', line 143 def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @sessions_stub = ::Google::Cloud::Dialogflow::CX::V3::Sessions::Rest::ServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials, logger: @config.logger ) @sessions_stub.logger(stub: true)&.info do |entry| entry.set_system_name entry.set_service entry. = "Created client for #{entry.service}" entry.set_credentials_fields credentials entry.set "customEndpoint", @config.endpoint if @config.endpoint entry.set "defaultTimeout", @config.timeout if @config.timeout entry.set "quotaProject", @quota_project_id if @quota_project_id end @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @sessions_stub.endpoint config.universe_domain = @sessions_stub.universe_domain config.bindings_override = @config.bindings_override config.logger = @sessions_stub.logger if config.respond_to? :logger= end end |
Instance Attribute Details
#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)
Get the associated client for mix-in of the Locations.
199 200 201 |
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb', line 199 def location_client @location_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the Sessions Client class.
See Configuration for a description of the configuration fields.
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 |
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb', line 69 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dialogflow", "CX", "V3"] 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.timeout = 60.0 default_config.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.detect_intent.timeout = 220.0 default_config.rpcs.detect_intent.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.server_streaming_detect_intent.timeout = 220.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the Sessions 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.
113 114 115 116 |
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb', line 113 def configure yield @config if block_given? @config end |
#detect_intent(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse #detect_intent(session: nil, query_params: nil, query_input: nil, output_audio_config: nil) ⇒ ::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.
Note: Always use agent versions for production traffic. See Versions and environments.
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 |
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb', line 284 def detect_intent request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest # 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.detect_intent..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::CX::V3::VERSION, transports_version_send: [:rest] [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.detect_intent.timeout, metadata: , retry_policy: @config.rpcs.detect_intent.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @sessions_stub.detect_intent request, do |result, operation| yield result, operation if block_given? end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#fulfill_intent(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::CX::V3::FulfillIntentResponse #fulfill_intent(match_intent_request: nil, match: nil, output_audio_config: nil) ⇒ ::Google::Cloud::Dialogflow::CX::V3::FulfillIntentResponse
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
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 |
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb', line 579 def fulfill_intent request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::FulfillIntentRequest # 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.fulfill_intent..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::CX::V3::VERSION, transports_version_send: [:rest] [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.fulfill_intent.timeout, metadata: , retry_policy: @config.rpcs.fulfill_intent.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @sessions_stub.fulfill_intent request, do |result, operation| yield result, operation if block_given? end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#logger ⇒ Logger
The logger used for request/response debug logging.
206 207 208 |
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb', line 206 def logger @sessions_stub.logger end |
#match_intent(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::CX::V3::MatchIntentResponse #match_intent(session: nil, query_params: nil, query_input: nil, persist_parameter_changes: nil) ⇒ ::Google::Cloud::Dialogflow::CX::V3::MatchIntentResponse
Returns preliminary intent match results, doesn't change the session status.
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 |
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb', line 490 def match_intent request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::MatchIntentRequest # 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.match_intent..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::CX::V3::VERSION, transports_version_send: [:rest] [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.match_intent.timeout, metadata: , retry_policy: @config.rpcs.match_intent.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @sessions_stub.match_intent request, do |result, operation| yield result, operation if block_given? end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#server_streaming_detect_intent(request, options = nil) ⇒ ::Enumerable<::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse> #server_streaming_detect_intent(session: nil, query_params: nil, query_input: nil, output_audio_config: nil) ⇒ ::Enumerable<::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse>
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.
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 |
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb', line 387 def server_streaming_detect_intent request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::DetectIntentRequest # 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.server_streaming_detect_intent..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::CX::V3::VERSION, transports_version_send: [:rest] [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.server_streaming_detect_intent.timeout, metadata: , retry_policy: @config.rpcs.server_streaming_detect_intent.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy ::Gapic::Rest::ServerStream.new( ::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse, ::Gapic::Rest::ThreadedEnumerator.new do |in_q, out_q| @sessions_stub.server_streaming_detect_intent request, do |chunk| in_q.deq out_q.enq chunk end end ) rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#submit_answer_feedback(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback #submit_answer_feedback(session: nil, response_id: nil, answer_feedback: nil, update_mask: nil) ⇒ ::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback
Updates the feedback received from the user for a single turn of the bot response.
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 |
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb', line 666 def submit_answer_feedback request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::SubmitAnswerFeedbackRequest # 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.submit_answer_feedback..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::CX::V3::VERSION, transports_version_send: [:rest] [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.submit_answer_feedback.timeout, metadata: , retry_policy: @config.rpcs.submit_answer_feedback.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @sessions_stub.submit_answer_feedback request, do |result, operation| yield result, operation if block_given? end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
123 124 125 |
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb', line 123 def universe_domain @sessions_stub.universe_domain end |