Class: Google::Cloud::Dialogflow::V2::IntentsClient

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

Overview

An intent represents a mapping between input from a user and an action to be taken by your application. When you pass user input to the DetectIntent (or StreamingDetectIntent) method, the Dialogflow API analyzes the input and searches for a matching intent. If no match is found, the Dialogflow API returns a fallback intent (is_fallback = true).

You can provide additional information for the Dialogflow API to use to match user input to an intent by adding the following to your intent.

  • Contexts - provide additional context for intent analysis. For example, if an intent is related to an object in your application that plays music, you can provide a context to determine when to match the intent if the user input is "turn it off". You can include a context that matches the intent when there is previous user input of "play music", and not when there is previous user input of "turn on the light".

  • Events - allow for matching an intent by using an event name instead of user input. Your application can provide an event name and related parameters to the Dialogflow API to match an intent. For example, when your application starts, you can send a welcome event with a user name parameter to the Dialogflow API to match an intent with a personalized welcome message for the user.

  • Training phrases - provide examples of user input to train the Dialogflow API agent to better match intents.

For more information about intents, 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: "") ⇒ IntentsClient

Returns a new instance of IntentsClient.

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.



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
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 192

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/intent_services_pb"

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

  @operations_client = OperationsClient.new(
    credentials: credentials,
    scopes: scopes,
    client_config: client_config,
    timeout: timeout,
    lib_name: lib_name,
    service_address: service_address,
    service_port: service_port,
    lib_version: lib_version,
    metadata: metadata,
  )

  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 }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "intents_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.dialogflow.v2.Intents",
      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
  @intents_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::Intents::Stub.method(:new)
  )

  @list_intents = Google::Gax.create_api_call(
    @intents_stub.method(:list_intents),
    defaults["list_intents"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_intent = Google::Gax.create_api_call(
    @intents_stub.method(:get_intent),
    defaults["get_intent"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_intent = Google::Gax.create_api_call(
    @intents_stub.method(:create_intent),
    defaults["create_intent"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_intent = Google::Gax.create_api_call(
    @intents_stub.method(:update_intent),
    defaults["update_intent"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'intent.name' => request.intent.name}
    end
  )
  @delete_intent = Google::Gax.create_api_call(
    @intents_stub.method(:delete_intent),
    defaults["delete_intent"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @batch_update_intents = Google::Gax.create_api_call(
    @intents_stub.method(:batch_update_intents),
    defaults["batch_update_intents"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @batch_delete_intents = Google::Gax.create_api_call(
    @intents_stub.method(:batch_delete_intents),
    defaults["batch_delete_intents"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
end

Class Method Details

.agent_path(project, agent) ⇒ String

Returns a fully-qualified agent resource name string.

Parameters:

  • project (String)
  • agent (String)

Returns:

  • (String) 


132
133
134
135
136
137
 
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 132

def self.agent_path project, agent
  AGENT_PATH_TEMPLATE.render(
    :"project" => project,
    :"agent" => agent
  )
end

.intent_path(project, intent) ⇒ String

Returns a fully-qualified intent resource name string.

Parameters:

  • project (String)
  • intent (String)

Returns:

  • (String) 


143
144
145
146
147
148
 
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 143

def self.intent_path project, intent
  INTENT_PATH_TEMPLATE.render(
    :"project" => project,
    :"intent" => intent
  )
end

.project_agent_path(project) ⇒ String

Returns a fully-qualified project_agent resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


153
154
155
156
157
 
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 153

def self.project_agent_path project
  PROJECT_AGENT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

Instance Method Details

#batch_delete_intents(parent, intents, options: nil) ⇒ Google::Gax::Operation

Deletes intents in the specified agent.

Operation Protobuf::Empty>

Examples:

require "google/cloud/dialogflow"

intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::IntentsClient.project_agent_path("[PROJECT]")

# TODO: Initialize `intents`:
intents = []

# Register a callback during the method call.
operation = intents_client.batch_delete_intents(formatted_parent, intents) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • parent (String) —

    Required. The name of the agent to delete all entities types for. Format: projects/<Project ID>/agent.

  • intents (Array<Google::Cloud::Dialogflow::V2::Intent | Hash>) —

    Required. The collection of intents to delete. Only intent name must be filled in. A hash of the same form as Google::Cloud::Dialogflow::V2::Intent can also be provided.

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

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

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 743

def batch_delete_intents \
    parent,
    intents,
    options: nil
  req = {
    parent: parent,
    intents: intents
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::BatchDeleteIntentsRequest)
  operation = Google::Gax::Operation.new(
    @batch_delete_intents.call(req, options),
    @operations_client,
    Google::Protobuf::Empty,
    Google::Protobuf::Struct,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#batch_update_intents(parent, language_code, intent_batch_uri: nil, intent_batch_inline: nil, update_mask: nil, intent_view: nil, options: nil) ⇒ Google::Gax::Operation

Updates/Creates multiple intents in the specified agent.

Operation BatchUpdateIntentsResponse>

Examples:

require "google/cloud/dialogflow"

intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::IntentsClient.project_agent_path("[PROJECT]")

# TODO: Initialize `language_code`:
language_code = ''

# Register a callback during the method call.
operation = intents_client.batch_update_intents(formatted_parent, language_code) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • parent (String) —

    Required. The name of the agent to update or create intents in. Format: projects/<Project ID>/agent.

  • language_code (String) —

    Optional. The language of training phrases, parameters and rich messages defined in intents. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

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

    The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".

  • intent_batch_inline (Google::Cloud::Dialogflow::V2::IntentBatch | Hash) (defaults to: nil) —

    The collection of intents to update or create. A hash of the same form as Google::Cloud::Dialogflow::V2::IntentBatch 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.

  • intent_view (Google::Cloud::Dialogflow::V2::IntentView) (defaults to: nil) —

    Optional. The resource view to apply to the returned intent.

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

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

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 662

def batch_update_intents \
    parent,
    language_code,
    intent_batch_uri: nil,
    intent_batch_inline: nil,
    update_mask: nil,
    intent_view: nil,
    options: nil
  req = {
    parent: parent,
    language_code: language_code,
    intent_batch_uri: intent_batch_uri,
    intent_batch_inline: intent_batch_inline,
    update_mask: update_mask,
    intent_view: intent_view
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::BatchUpdateIntentsRequest)
  operation = Google::Gax::Operation.new(
    @batch_update_intents.call(req, options),
    @operations_client,
    Google::Cloud::Dialogflow::V2::BatchUpdateIntentsResponse,
    Google::Protobuf::Struct,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#create_intent(parent, intent, language_code: nil, intent_view: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Intent

Creates an intent in the specified agent.

Examples:

require "google/cloud/dialogflow"

intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::IntentsClient.project_agent_path("[PROJECT]")

# TODO: Initialize `intent`:
intent = {}
response = intents_client.create_intent(formatted_parent, intent)

Parameters:

  • parent (String) —

    Required. The agent to create a intent for. Format: projects/<Project ID>/agent.

  • intent (Google::Cloud::Dialogflow::V2::Intent | Hash) —

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

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

    Optional. The language of training phrases, parameters and rich messages defined in intent. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • intent_view (Google::Cloud::Dialogflow::V2::IntentView) (defaults to: nil) —

    Optional. The resource view to apply to the returned intent.

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



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 488

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

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

Deletes the specified intent and its direct or indirect followup intents.

Examples:

require "google/cloud/dialogflow"

intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
formatted_name = Google::Cloud::Dialogflow::V2::IntentsClient.intent_path("[PROJECT]", "[INTENT]")
intents_client.delete_intent(formatted_name)

Parameters:

  • name (String) —

    Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: projects/<Project ID>/agent/intents/<Intent 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.



581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 581

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

#get_intent(name, language_code: nil, intent_view: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Intent

Retrieves the specified intent.

Examples:

require "google/cloud/dialogflow"

intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
formatted_name = Google::Cloud::Dialogflow::V2::IntentsClient.intent_path("[PROJECT]", "[INTENT]")
response = intents_client.get_intent(formatted_name)

Parameters:

  • name (String) —

    Required. The name of the intent. Format: projects/<Project ID>/agent/intents/<Intent ID>.

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

    Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • intent_view (Google::Cloud::Dialogflow::V2::IntentView) (defaults to: nil) —

    Optional. The resource view to apply to the returned intent.

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



437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 437

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

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

Returns the list of all intents in the specified agent.

Examples:

require "google/cloud/dialogflow"

intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::IntentsClient.project_agent_path("[PROJECT]")

# Iterate over all results.
intents_client.list_intents(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
intents_client.list_intents(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 agent to list all intents from. Format: projects/<Project ID>/agent.

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

    Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

  • intent_view (Google::Cloud::Dialogflow::V2::IntentView) (defaults to: nil) —

    Optional. The resource view to apply to the returned intent.

  • 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::Intent>) —

    An enumerable of Google::Cloud::Dialogflow::V2::Intent 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.



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 391

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

#update_intent(intent, language_code, update_mask: nil, intent_view: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Intent

Updates the specified intent.

Examples:

require "google/cloud/dialogflow"

intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)

# TODO: Initialize `intent`:
intent = {}

# TODO: Initialize `language_code`:
language_code = ''
response = intents_client.update_intent(intent, language_code)

Parameters:

  • intent (Google::Cloud::Dialogflow::V2::Intent | Hash) —

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

  • language_code (String) —

    Optional. The language of training phrases, parameters and rich messages defined in intent. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

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

  • intent_view (Google::Cloud::Dialogflow::V2::IntentView) (defaults to: nil) —

    Optional. The resource view to apply to the returned intent.

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



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 544

def update_intent \
    intent,
    language_code,
    update_mask: nil,
    intent_view: nil,
    options: nil,
    &block
  req = {
    intent: intent,
    language_code: language_code,
    update_mask: update_mask,
    intent_view: intent_view
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::UpdateIntentRequest)
  @update_intent.call(req, options, &block)
end