Class: Google::Cloud::Dialogflow::V2::AgentsClient

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

Overview

Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.

After you create an agent, you can add Intents, Contexts, Entity Types, Webhooks, and so on to manage the flow of a conversation and match user input to predefined intents and actions.

You can create an agent using both Dialogflow Standard Edition and Dialogflow Enterprise Edition. For details, see Dialogflow Editions.

You can save your agent for backup or versioning by exporting the agent by using the ExportAgent method. You can import a saved agent by using the ImportAgent method.

Dialogflow provides several prebuilt agents for common conversation scenarios such as determining a date and time, converting currency, and so on.

For more information about agents, 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"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of AgentsClient

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.

  • metadata (Hash) —

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

  • exception_transformer (Proc) —

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



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

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: 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/agent_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,
    lib_version: lib_version,
  )

  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 = 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 }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "agents_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.dialogflow.v2.Agents",
      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 = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @agents_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::Agents::Stub.method(:new)
  )

  @get_agent = Google::Gax.create_api_call(
    @agents_stub.method(:get_agent),
    defaults["get_agent"],
    exception_transformer: exception_transformer
  )
  @search_agents = Google::Gax.create_api_call(
    @agents_stub.method(:search_agents),
    defaults["search_agents"],
    exception_transformer: exception_transformer
  )
  @train_agent = Google::Gax.create_api_call(
    @agents_stub.method(:train_agent),
    defaults["train_agent"],
    exception_transformer: exception_transformer
  )
  @export_agent = Google::Gax.create_api_call(
    @agents_stub.method(:export_agent),
    defaults["export_agent"],
    exception_transformer: exception_transformer
  )
  @import_agent = Google::Gax.create_api_call(
    @agents_stub.method(:import_agent),
    defaults["import_agent"],
    exception_transformer: exception_transformer
  )
  @restore_agent = Google::Gax.create_api_call(
    @agents_stub.method(:restore_agent),
    defaults["restore_agent"],
    exception_transformer: exception_transformer
  )
end

Class Method Details

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


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

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

Instance Method Details

#export_agent(parent, agent_uri: nil, options: nil) ⇒ Google::Gax::Operation

Exports the specified agent to a ZIP file.

Operation ExportAgentResponse, metadata: Protobuf::Struct>

Examples:

require "google/cloud/dialogflow"

agents_client = Google::Cloud::Dialogflow::Agents.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::AgentsClient.project_path("[PROJECT]")

# Register a callback during the method call.
operation = agents_client.export_agent(formatted_parent) 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 project that the agent to export is associated with. Format: +projects/+.

  • agent_uri (String) —

    Optional. The Google Cloud Storage URI to export the agent to. Note: The URI must start with "gs://". If left unspecified, the serialized agent is returned inline.

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

    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.



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 467

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

#get_agent(parent, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Agent

Retrieves the specified agent.

Examples:

require "google/cloud/dialogflow"

agents_client = Google::Cloud::Dialogflow::Agents.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::AgentsClient.project_path("[PROJECT]")
response = agents_client.get_agent(formatted_parent)

Parameters:

  • parent (String) —

    Required. The project that the agent to fetch is associated with. Format: +projects/+.

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

    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.



281
282
283
284
285
286
287
288
289
290
 
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 281

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

#import_agent(parent, agent_uri: nil, agent_content: nil, options: nil) ⇒ Google::Gax::Operation

Imports the specified agent from a ZIP file.

Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest.

Operation Protobuf::Empty, metadata: Protobuf::Struct>

Examples:

require "google/cloud/dialogflow"

agents_client = Google::Cloud::Dialogflow::Agents.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::AgentsClient.project_path("[PROJECT]")

# Register a callback during the method call.
operation = agents_client.import_agent(formatted_parent) 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 project that the agent to import is associated with. Format: +projects/+.

  • agent_uri (String) —

    The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://".

  • agent_content (String) —

    The agent to import.

    Example for how to import an agent via the command line:

    curl \ 'https://dialogflow.googleapis.com/v2/projects//agent:import\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat | base64 -w 0)' }"

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

    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.



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 555

def import_agent \
    parent,
    agent_uri: nil,
    agent_content: nil,
    options: nil
  req = {
    parent: parent,
    agent_uri: agent_uri,
    agent_content: agent_content
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::ImportAgentRequest)
  operation = Google::Gax::Operation.new(
    @import_agent.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

#restore_agent(parent, agent_uri: nil, agent_content: nil, options: nil) ⇒ Google::Gax::Operation

Restores the specified agent from a ZIP file.

Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted.

Operation Protobuf::Empty, metadata: Protobuf::Struct>

Examples:

require "google/cloud/dialogflow"

agents_client = Google::Cloud::Dialogflow::Agents.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::AgentsClient.project_path("[PROJECT]")

# Register a callback during the method call.
operation = agents_client.restore_agent(formatted_parent) 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 project that the agent to restore is associated with. Format: +projects/+.

  • agent_uri (String) —

    The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://".

  • agent_content (String) —

    The agent to restore.

    Example for how to restore an agent via the command line:

    curl \ 'https://dialogflow.googleapis.com/v2/projects//agent:restore\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat | base64 -w 0)' }" \

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

    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.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 644

def restore_agent \
    parent,
    agent_uri: nil,
    agent_content: nil,
    options: nil
  req = {
    parent: parent,
    agent_uri: agent_uri,
    agent_content: agent_content
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::RestoreAgentRequest)
  operation = Google::Gax::Operation.new(
    @restore_agent.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

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

Returns the list of agents.

Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Examples:

require "google/cloud/dialogflow"

agents_client = Google::Cloud::Dialogflow::Agents.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::AgentsClient.project_path("[PROJECT]")

# Iterate over all results.
agents_client.search_agents(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
agents_client.search_agents(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 project to list agents from. Format: +projects/+.

  • page_size (Integer) —

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

    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::Agent>) —

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



340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 340

def search_agents \
    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::SearchAgentsRequest)
  @search_agents.call(req, options, &block)
end

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

Trains the specified agent.

Operation Protobuf::Empty, metadata: Protobuf::Struct>

Examples:

require "google/cloud/dialogflow"

agents_client = Google::Cloud::Dialogflow::Agents.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::AgentsClient.project_path("[PROJECT]")

# Register a callback during the method call.
operation = agents_client.train_agent(formatted_parent) 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 project that the agent to train is associated with. Format: +projects/+.

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

    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.



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 399

def train_agent \
    parent,
    options: nil
  req = {
    parent: parent
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::TrainAgentRequest)
  operation = Google::Gax::Operation.new(
    @train_agent.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