class Google::Cloud::Dialogflow::V2::Sessions::Client

Client for the Sessions service.

A service used for session interactions.

For more information, see the [API interactions guide](cloud.google.com/dialogflow/docs/api-overview).

Attributes

sessions_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the Sessions Client class.

See {::Google::Cloud::Dialogflow::V2::Sessions::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all Sessions clients
::Google::Cloud::Dialogflow::V2::Sessions::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dialogflow/v2/sessions/client.rb, line 59
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
new() { |config| ... } click to toggle source

Create a new Sessions client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Sessions client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/dialogflow/v2/sessions/client.rb, line 124
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 endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @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

Public Instance Methods

configure() { |config| ... } click to toggle source

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 {Client.configure}.

See {::Google::Cloud::Dialogflow::V2::Sessions::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dialogflow/v2/sessions/client.rb, line 103
def configure
  yield @config if block_given?
  @config
end
detect_intent(request, options = nil) { |response, operation| ... } click to toggle source

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](cloud.google.com/dialogflow/es/docs/agents-versions).

@overload detect_intent(request, options = nil)

Pass arguments to `detect_intent` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::DetectIntentRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload detect_intent(session: nil, query_params: nil, query_input: nil, output_audio_config: nil, output_audio_config_mask: nil, input_audio: nil)

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

@param session [::String]
  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](https://cloud.google.com/dialogflow/docs/api-overview).

  Note: Always use agent versions for production traffic.
  See [Versions and
  environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
@param query_params [::Google::Cloud::Dialogflow::V2::QueryParameters, ::Hash]
  The parameters of this query.
@param query_input [::Google::Cloud::Dialogflow::V2::QueryInput, ::Hash]
  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.
@param output_audio_config [::Google::Cloud::Dialogflow::V2::OutputAudioConfig, ::Hash]
  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.
@param output_audio_config_mask [::Google::Protobuf::FieldMask, ::Hash]
  Mask for {::Google::Cloud::Dialogflow::V2::DetectIntentRequest#output_audio_config output_audio_config} indicating which settings in this
  request-level config should override speech synthesizer settings defined at
  agent-level.

  If unspecified or empty, {::Google::Cloud::Dialogflow::V2::DetectIntentRequest#output_audio_config output_audio_config} replaces the agent-level
  config in its entirety.
@param input_audio [::String]
  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.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::V2::DetectIntentResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dialogflow::V2::DetectIntentResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/v2/sessions/client.rb, line 240
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 timeout:      @config.timeout,
                         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| ... } click to toggle source

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](cloud.google.com/dialogflow/es/docs/agents-versions).

@param request [::Gapic::StreamInput, ::Enumerable<::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest, ::Hash>]

An enumerable of {::Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest} instances.

@param options [::Gapic::CallOptions, ::Hash]

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

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Enumerable<::Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Enumerable<::Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/v2/sessions/client.rb, line 301
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 timeout:      @config.timeout,
                         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