Class: Google::Cloud::Dialogflow::V2::SessionsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dialogflow/v2/sessions_client.rb

Overview

A session represents an interaction with a user. You retrieve user input and pass it to the DetectIntent (or StreamingDetectIntent) method to determine user intent and respond.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"dialogflow.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "") ⇒ SessionsClient

Returns a new instance of SessionsClient

Parameters:

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

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

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

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.



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

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    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/session_services_pb"

  credentials ||= Google::Cloud::Dialogflow::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Dialogflow::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 = Gem.loaded_specs['google-cloud-dialogflow'].version.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 }
  client_config_file = Pathname.new(__dir__).join(
    "sessions_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.dialogflow.v2.Sessions",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      errors: Google::Gax::Grpc::API_ERRORS,
      kwargs: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  @sessions_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    &Google::Cloud::Dialogflow::V2::Sessions::Stub.method(:new)
  )

  @detect_intent = Google::Gax.create_api_call(
    @sessions_stub.method(:detect_intent),
    defaults["detect_intent"]
  )
  @streaming_detect_intent = Google::Gax.create_api_call(
    @sessions_stub.method(:streaming_detect_intent),
    defaults["streaming_detect_intent"]
  )
end

Instance Attribute Details

#sessions_stub ⇒ Google::Cloud::Dialogflow::V2::Sessions::Stub (readonly)

Returns:

  • (Google::Cloud::Dialogflow::V2::Sessions::Stub) 


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

class SessionsClient
  attr_reader :sessions_stub

  # The default address of the service.
  SERVICE_ADDRESS = "dialogflow.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  DEFAULT_TIMEOUT = 30

  # 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"
  ].freeze


  SESSION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/agent/sessions/{session}"
  )

  private_constant :SESSION_PATH_TEMPLATE

  # Returns a fully-qualified session resource name string.
  # @param project [String]
  # @param session [String]
  # @return [String]
  def self.session_path project, session
    SESSION_PATH_TEMPLATE.render(
      :"project" => project,
      :"session" => session
    )
  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.
  def initialize \
      credentials: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      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/session_services_pb"

    credentials ||= Google::Cloud::Dialogflow::Credentials.default

    if credentials.is_a?(String) || credentials.is_a?(Hash)
      updater_proc = Google::Cloud::Dialogflow::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 = Gem.loaded_specs['google-cloud-dialogflow'].version.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 }
    client_config_file = Pathname.new(__dir__).join(
      "sessions_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.cloud.dialogflow.v2.Sessions",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end

    # Allow overriding the service path/port in subclasses.
    service_path = self.class::SERVICE_ADDRESS
    port = self.class::DEFAULT_SERVICE_PORT
    @sessions_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      &Google::Cloud::Dialogflow::V2::Sessions::Stub.method(:new)
    )

    @detect_intent = Google::Gax.create_api_call(
      @sessions_stub.method(:detect_intent),
      defaults["detect_intent"]
    )
    @streaming_detect_intent = Google::Gax.create_api_call(
      @sessions_stub.method(:streaming_detect_intent),
      defaults["streaming_detect_intent"]
    )
  end

  # Service calls

  # 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.
  #
  # @param session [String]
  #   Required. The name of the session this query is sent to. Format:
  #   +projects/<Project ID>/agent/sessions/<Session ID>+. It's up to the API
  #   caller to choose an appropriate session ID. It can be a random number or
  #   some type of user identifier (preferably hashed). The length of the session
  #   ID must not exceed 36 bytes.
  # @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.
  #   A hash of the same form as `Google::Cloud::Dialogflow::V2::QueryInput`
  #   can also be provided.
  # @param query_params [Google::Cloud::Dialogflow::V2::QueryParameters | Hash]
  #   Optional. The parameters of this query.
  #   A hash of the same form as `Google::Cloud::Dialogflow::V2::QueryParameters`
  #   can also be provided.
  # @param input_audio [String]
  #   Optional. 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.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Cloud::Dialogflow::V2::DetectIntentResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/dialogflow/v2"
  #
  #   sessions_client = Google::Cloud::Dialogflow::V2::Sessions.new
  #   formatted_session = Google::Cloud::Dialogflow::V2::SessionsClient.session_path("[PROJECT]", "[SESSION]")
  #
  #   # TODO: Initialize +query_input+:
  #   query_input = {}
  #   response = sessions_client.detect_intent(formatted_session, query_input)

  def detect_intent \
      session,
      query_input,
      query_params: nil,
      input_audio: nil,
      options: nil
    req = {
      session: session,
      query_input: query_input,
      query_params: query_params,
      input_audio: input_audio
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DetectIntentRequest)
    @detect_intent.call(req, options)
  end

  # 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).
  #
  # @param reqs [Enumerable<Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest>]
  #   The input requests.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Enumerable<Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse>]
  #   An enumerable of Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse instances.
  #
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  #
  # @note
  #   EXPERIMENTAL:
  #     Streaming requests are still undergoing review.
  #     This method interface might change in the future.
  #
  # @example
  #   require "google/cloud/dialogflow/v2"
  #
  #   sessions_client = Google::Cloud::Dialogflow::V2::Sessions.new
  #
  #   # TODO: Initialize +session+:
  #   session = ''
  #
  #   # TODO: Initialize +query_input+:
  #   query_input = {}
  #   request = { session: session, query_input: query_input }
  #   requests = [request]
  #   sessions_client.streaming_detect_intent(requests).each do |element|
  #     # Process element.
  #   end

  def streaming_detect_intent reqs, options: nil
    request_protos = reqs.lazy.map do |req|
      Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest)
    end
    @streaming_detect_intent.call(request_protos, options)
  end
end

Class Method Details

.session_path(project, session) ⇒ String

Returns a fully-qualified session resource name string.

Parameters:

  • project (String)
  • session (String)

Returns:

  • (String) 


69
70
71
72
73
74
 
# File 'lib/google/cloud/dialogflow/v2/sessions_client.rb', line 69

def self.session_path project, session
  SESSION_PATH_TEMPLATE.render(
    :"project" => project,
    :"session" => session
  )
end

Instance Method Details

#detect_intent(session, query_input, query_params: nil, input_audio: nil, options: 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.

Examples:

require "google/cloud/dialogflow/v2"

sessions_client = Google::Cloud::Dialogflow::V2::Sessions.new
formatted_session = Google::Cloud::Dialogflow::V2::SessionsClient.session_path("[PROJECT]", "[SESSION]")

# TODO: Initialize +query_input+:
query_input = {}
response = sessions_client.detect_intent(formatted_session, query_input)

Parameters:

  • session (String) —

    Required. The name of the session this query is sent to. Format: +projects//agent/sessions/+. It's up to the API caller to choose an appropriate session ID. It can be a random number or some type of user identifier (preferably hashed). The length of the session ID must not exceed 36 bytes.

  • 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. A hash of the same form as Google::Cloud::Dialogflow::V2::QueryInput can also be provided.

  • query_params (Google::Cloud::Dialogflow::V2::QueryParameters | Hash) —

    Optional. The parameters of this query. A hash of the same form as Google::Cloud::Dialogflow::V2::QueryParameters can also be provided.

  • input_audio (String) —

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

  • options (Google::Gax::CallOptions) —

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/cloud/dialogflow/v2/sessions_client.rb', line 225

def detect_intent \
    session,
    query_input,
    query_params: nil,
    input_audio: nil,
    options: nil
  req = {
    session: session,
    query_input: query_input,
    query_params: query_params,
    input_audio: input_audio
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DetectIntentRequest)
  @detect_intent.call(req, options)
end

#streaming_detect_intent(reqs, options: nil) ⇒ Enumerable<Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse>

Note:

EXPERIMENTAL: Streaming requests are still undergoing review. This method interface might change in the future.

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

Examples:

require "google/cloud/dialogflow/v2"

sessions_client = Google::Cloud::Dialogflow::V2::Sessions.new

# TODO: Initialize +session+:
session = ''

# TODO: Initialize +query_input+:
query_input = {}
request = { session: session, query_input: query_input }
requests = [request]
sessions_client.streaming_detect_intent(requests).each do |element|
  # Process element.
end

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



276
277
278
279
280
281
 
# File 'lib/google/cloud/dialogflow/v2/sessions_client.rb', line 276

def streaming_detect_intent reqs, options: nil
  request_protos = reqs.lazy.map do |req|
    Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest)
  end
  @streaming_detect_intent.call(request_protos, options)
end