Class: Google::Cloud::Dialogflow::V2::ContextsClient

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

Overview

A context represents additional information included with user input or with an intent returned by the Dialogflow API. Contexts are helpful for differentiating user input which may be vague or have a different meaning depending on additional details from your application such as user setting and preferences, previous user input, where the user is in your application, geographic location, and so on.

You can include contexts as input parameters of a DetectIntent (or StreamingDetectIntent) request, or as output contexts included in the returned intent. Contexts expire when an intent is matched, after the number of DetectIntent requests specified by the lifespan_count parameter, or after 20 minutes if no intents are matched for a DetectIntent request.

For more information about contexts, see the Dialogflow documentation.

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
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
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",
  "https://www.googleapis.com/auth/dialogflow"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ ContextsClient

Returns a new instance of ContextsClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil)

    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>) (defaults to: ALL_SCOPES)

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

  • client_config (Hash) (defaults to: {})

    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) (defaults to: DEFAULT_TIMEOUT)

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

  • metadata (Hash) (defaults to: nil)

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • service_address (String) (defaults to: nil)

    Override for the service hostname, or nil to leave as the default.

  • service_port (Integer) (defaults to: nil)

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil)

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



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
283
284
285
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 158

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

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

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Dialogflow::V2::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 = Google::Cloud::Dialogflow::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 }
  if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
    headers[:"x-goog-user-project"] = credentials.quota_project_id
  end
  headers.merge!() unless .nil?
  client_config_file = Pathname.new(__dir__).join(
    "contexts_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.dialogflow.v2.Contexts",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

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

  @list_contexts = Google::Gax.create_api_call(
    @contexts_stub.method(:list_contexts),
    defaults["list_contexts"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_context = Google::Gax.create_api_call(
    @contexts_stub.method(:get_context),
    defaults["get_context"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_context = Google::Gax.create_api_call(
    @contexts_stub.method(:create_context),
    defaults["create_context"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_context = Google::Gax.create_api_call(
    @contexts_stub.method(:update_context),
    defaults["update_context"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'context.name' => request.context.name}
    end
  )
  @delete_context = Google::Gax.create_api_call(
    @contexts_stub.method(:delete_context),
    defaults["delete_context"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @delete_all_contexts = Google::Gax.create_api_call(
    @contexts_stub.method(:delete_all_contexts),
    defaults["delete_all_contexts"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
end

Class Method Details

.context_path(project, session, context) ⇒ String

Returns a fully-qualified context resource name string.

Parameters:

  • project (String)
  • session (String)
  • context (String)

Returns:

  • (String)


106
107
108
109
110
111
112
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 106

def self.context_path project, session, context
  CONTEXT_PATH_TEMPLATE.render(
    :"project" => project,
    :"session" => session,
    :"context" => context
  )
end

.session_path(project, session) ⇒ String

Returns a fully-qualified session resource name string.

Parameters:

  • project (String)
  • session (String)

Returns:

  • (String)


118
119
120
121
122
123
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 118

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

Instance Method Details

#create_context(parent, context, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Context

Creates a context.

If the specified context already exists, overrides the context.

Examples:

require "google/cloud/dialogflow"

contexts_client = Google::Cloud::Dialogflow::Contexts.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::ContextsClient.session_path("[PROJECT]", "[SESSION]")

# TODO: Initialize `context`:
context = {}
response = contexts_client.create_context(formatted_parent, context)

Parameters:

  • parent (String)

    Required. The session to create a context for. Format: projects/<Project ID>/agent/sessions/<Session ID>.

  • context (Google::Cloud::Dialogflow::V2::Context | Hash)

    Required. The context to create. A hash of the same form as Google::Cloud::Dialogflow::V2::Context can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil)

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

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



404
405
406
407
408
409
410
411
412
413
414
415
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 404

def create_context \
    parent,
    context,
    options: nil,
    &block
  req = {
    parent: parent,
    context: context
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::CreateContextRequest)
  @create_context.call(req, options, &block)
end

#delete_all_contexts(parent, options: nil) {|result, operation| ... } ⇒ Object

Deletes all active contexts in the specified session.

Examples:

require "google/cloud/dialogflow"

contexts_client = Google::Cloud::Dialogflow::Contexts.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::ContextsClient.session_path("[PROJECT]", "[SESSION]")
contexts_client.delete_all_contexts(formatted_parent)

Parameters:

  • parent (String)

    Required. The name of the session to delete all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID>.

  • options (Google::Gax::CallOptions) (defaults to: nil)

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

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • result

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



507
508
509
510
511
512
513
514
515
516
517
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 507

def delete_all_contexts \
    parent,
    options: nil,
    &block
  req = {
    parent: parent
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DeleteAllContextsRequest)
  @delete_all_contexts.call(req, options, &block)
  nil
end

#delete_context(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes the specified context.

Examples:

require "google/cloud/dialogflow"

contexts_client = Google::Cloud::Dialogflow::Contexts.new(version: :v2)
formatted_name = Google::Cloud::Dialogflow::V2::ContextsClient.context_path("[PROJECT]", "[SESSION]", "[CONTEXT]")
contexts_client.delete_context(formatted_name)

Parameters:

  • name (String)

    Required. The name of the context to delete. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>.

  • options (Google::Gax::CallOptions) (defaults to: nil)

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

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • result

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



476
477
478
479
480
481
482
483
484
485
486
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 476

def delete_context \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DeleteContextRequest)
  @delete_context.call(req, options, &block)
  nil
end

#get_context(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Context

Retrieves the specified context.

Examples:

require "google/cloud/dialogflow"

contexts_client = Google::Cloud::Dialogflow::Contexts.new(version: :v2)
formatted_name = Google::Cloud::Dialogflow::V2::ContextsClient.context_path("[PROJECT]", "[SESSION]", "[CONTEXT]")
response = contexts_client.get_context(formatted_name)

Parameters:

  • name (String)

    Required. The name of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>.

  • options (Google::Gax::CallOptions) (defaults to: nil)

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

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



364
365
366
367
368
369
370
371
372
373
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 364

def get_context \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::GetContextRequest)
  @get_context.call(req, options, &block)
end

#list_contexts(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::Context>

Returns the list of all contexts in the specified session.

Examples:

require "google/cloud/dialogflow"

contexts_client = Google::Cloud::Dialogflow::Contexts.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::ContextsClient.session_path("[PROJECT]", "[SESSION]")

# Iterate over all results.
contexts_client.list_contexts(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
contexts_client.list_contexts(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String)

    Required. The session to list all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID>.

  • page_size (Integer) (defaults to: nil)

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil)

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

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::Context>)

    An enumerable of Google::Cloud::Dialogflow::V2::Context instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



331
332
333
334
335
336
337
338
339
340
341
342
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 331

def list_contexts \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::ListContextsRequest)
  @list_contexts.call(req, options, &block)
end

#update_context(context, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Context

Updates the specified context.

Examples:

require "google/cloud/dialogflow"

contexts_client = Google::Cloud::Dialogflow::Contexts.new(version: :v2)

# TODO: Initialize `context`:
context = {}
response = contexts_client.update_context(context)

Parameters:

  • context (Google::Cloud::Dialogflow::V2::Context | Hash)

    Required. The context to update. A hash of the same form as Google::Cloud::Dialogflow::V2::Context can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) (defaults to: nil)

    Optional. The mask to control which fields get updated. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil)

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

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



444
445
446
447
448
449
450
451
452
453
454
455
# File 'lib/google/cloud/dialogflow/v2/contexts_client.rb', line 444

def update_context \
    context,
    update_mask: nil,
    options: nil,
    &block
  req = {
    context: context,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::UpdateContextRequest)
  @update_context.call(req, options, &block)
end