Class: Google::Cloud::Dialogflow::V2::Sessions::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/dialogflow/v2/sessions/client.rb

Overview

Client for the Sessions service.

A service used for session interactions.

For more information, see the API interactions guide.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#context_path, #session_entity_type_path, #session_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Sessions client object.

Examples

To create a new Sessions client with the default configuration:

client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new

To create a new Sessions client with a custom configuration:

client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Sessions client.

Yield Parameters:



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
 
# File 'lib/google/cloud/dialogflow/v2/sessions/client.rb', line 135

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/session_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
  # Use self-signed JWT if the scope and endpoint are unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.scope == Client.configure.scope &&
                           @config.endpoint == Client.configure.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 = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dialogflow::V2::Sessions::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Sessions Client class.

See Configuration for a description of the configuration fields.

Example

To modify the configuration for all Sessions clients:

::Google::Cloud::Dialogflow::V2::Sessions::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
 
# File 'lib/google/cloud/dialogflow/v2/sessions/client.rb', line 60

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.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.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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



110
111
112
113
 
# File 'lib/google/cloud/dialogflow/v2/sessions/client.rb', line 110

def configure
  yield @config if block_given?
  @config
end

#detect_intent(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::DetectIntentResponse #detect_intent(session: nil, query_params: nil, query_input: nil, output_audio_config: nil, output_audio_config_mask: nil, input_audio: nil) ⇒ ::Google::Cloud::Dialogflow::V2::DetectIntentResponse

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and 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.

Overloads:

  • #detect_intent(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::DetectIntentResponse

    Pass arguments to detect_intent via a request object, either of type DetectIntentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dialogflow::V2::DetectIntentRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #detect_intent(session: nil, query_params: nil, query_input: nil, output_audio_config: nil, output_audio_config_mask: nil, input_audio: nil) ⇒ ::Google::Cloud::Dialogflow::V2::DetectIntentResponse

    Pass arguments to detect_intent via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • session (::String) (defaults to: nil) —

      Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.

      For more information, see the API interactions guide.

      Note: Always use agent versions for production traffic. See Versions and environments.

    • query_params (::Google::Cloud::Dialogflow::V2::QueryParameters, ::Hash) (defaults to: nil) —

      The parameters of this query.

    • query_input (::Google::Cloud::Dialogflow::V2::QueryInput, ::Hash) (defaults to: nil) —

      Required. The input specification. It can be set to:

      1. an audio config which instructs the speech recognizer how to process the speech audio,

      2. a conversational query in the form of text, or

      3. an event that specifies which intent to trigger.

    • output_audio_config (::Google::Cloud::Dialogflow::V2::OutputAudioConfig, ::Hash) (defaults to: nil) —

      Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

    • output_audio_config_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level.

      If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

    • input_audio (::String) (defaults to: nil) —

      The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config. A single request can contain up to 1 minute of speech audio data.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



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
 
# File 'lib/google/cloud/dialogflow/v2/sessions/client.rb', line 252

def detect_intent request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::DetectIntentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.detect_intent.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"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
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "session" => request.session
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.detect_intent.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.detect_intent.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @sessions_stub.call_rpc :detect_intent, request, options: 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

#streaming_detect_intent(request, options = nil) {|response, operation| ... } ⇒ ::Enumerable<::Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse>

Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).

Note: Always use agent versions for production traffic. See Versions and environments.

Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



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
 
# File 'lib/google/cloud/dialogflow/v2/sessions/client.rb', line 311

def streaming_detect_intent request, options = nil
  unless request.is_a? ::Enumerable
    raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
    request = request.to_enum
  end

  request = request.lazy.map do |req|
    ::Gapic::Protobuf.coerce req, to: ::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest
  end

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.streaming_detect_intent.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"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
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.streaming_detect_intent.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.streaming_detect_intent.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @sessions_stub.call_rpc :streaming_detect_intent, request, options: 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