Class: Google::Cloud::Dialogflow::V2::Agents::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/dialogflow/v2/agents/client.rb

Overview

Client for the Agents service.

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][google.cloud.dialogflow.v2.EntityTypes], 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.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#agent_path, #project_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Agents client object.

Examples

To create a new Agents client with the default configuration:

client = Google::Cloud::Dialogflow::V2::Agents::Client.new

To create a new Agents client with a custom configuration:

client = Google::Cloud::Dialogflow::V2::Agents::Client.new do |config|
  config.timeout = 10_000
end

Yields:

  • (config) —

    Configure the Agents client.

Yield Parameters:



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

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/agent_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
  credentials ||= Credentials.default scope: @config.scope
  if credentials.is_a?(String) || credentials.is_a?(Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil

  @operations_client = Operations.new do |config|
    config.credentials = credentials
  end

  @agents_stub = Gapic::ServiceStub.new(
    Google::Cloud::Dialogflow::V2::Agents::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Agents Client class.

See Configuration for a description of the configuration fields.

Example

To modify the configuration for all Agents clients:

Google::Cloud::Dialogflow::V2::Agents::Client.configure do |config|
  config.timeout = 10_000
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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.rpcs.get_agent.timeout = 60.0
    default_config.rpcs.get_agent.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.set_agent.timeout = 60.0
    default_config.rpcs.set_agent.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.delete_agent.timeout = 60.0
    default_config.rpcs.delete_agent.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.search_agents.timeout = 60.0
    default_config.rpcs.search_agents.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.train_agent.timeout = 60.0
    default_config.rpcs.train_agent.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.export_agent.timeout = 60.0
    default_config.rpcs.export_agent.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config.rpcs.import_agent.timeout = 60.0

    default_config.rpcs.restore_agent.timeout = 60.0
    default_config.rpcs.restore_agent.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the Agents 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



182
183
184
185
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 182

def configure
  yield @config if block_given?
  @config
end

#delete_agent(request, options = nil) ⇒ Google::Protobuf::Empty #delete_agent(parent: nil) ⇒ Google::Protobuf::Empty

Deletes the specified agent.

Overloads:

  • #delete_agent(request, options = nil) ⇒ Google::Protobuf::Empty

    Parameters:

  • #delete_agent(parent: nil) ⇒ Google::Protobuf::Empty

    Parameters:

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

      Required. The project that the agent to delete is associated with. Format: projects/<Project ID>.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 387

def delete_agent request, options = nil
  raise ArgumentError, "request must be provided" if request.nil?

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::DeleteAgentRequest

  # 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.delete_agent.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 = {
    "parent" => request.parent
  }
  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.delete_agent.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_agent.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @agents_stub.call_rpc :delete_agent, 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

#export_agent(request, options = nil) ⇒ Gapic::Operation #export_agent(parent: nil, agent_uri: nil) ⇒ Gapic::Operation

Exports the specified agent to a ZIP file.

Operation ExportAgentResponse>

Overloads:

  • #export_agent(request, options = nil) ⇒ Gapic::Operation

    Parameters:

  • #export_agent(parent: nil, agent_uri: nil) ⇒ Gapic::Operation

    Parameters:

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

      Required. The project that the agent to export is associated with. Format: projects/<Project ID>.

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

      Required. The Google Cloud Storage URI to export the agent to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized agent is returned inline.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (Gapic::Operation)
  • operation (GRPC::ActiveCall::Operation)

Returns:

  • (Gapic::Operation)

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 599

def export_agent request, options = nil
  raise ArgumentError, "request must be provided" if request.nil?

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::ExportAgentRequest

  # 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.export_agent.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 = {
    "parent" => request.parent
  }
  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.export_agent.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.export_agent.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @agents_stub.call_rpc :export_agent, request, options: options do |response, operation|
    response = Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue GRPC::BadStatus => e
  raise Google::Cloud::Error.from_error(e)
end

#get_agent(request, options = nil) ⇒ Google::Cloud::Dialogflow::V2::Agent #get_agent(parent: nil) ⇒ Google::Cloud::Dialogflow::V2::Agent

Retrieves the specified agent.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



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

def get_agent request, options = nil
  raise ArgumentError, "request must be provided" if request.nil?

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::GetAgentRequest

  # 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.get_agent.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 = {
    "parent" => request.parent
  }
  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.get_agent.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_agent.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @agents_stub.call_rpc :get_agent, 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

#get_validation_result(request, options = nil) ⇒ Google::Cloud::Dialogflow::V2::ValidationResult #get_validation_result(parent: nil, language_code: nil) ⇒ Google::Cloud::Dialogflow::V2::ValidationResult

Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.

Overloads:

  • #get_validation_result(request, options = nil) ⇒ Google::Cloud::Dialogflow::V2::ValidationResult

    Parameters:

    • request (Google::Cloud::Dialogflow::V2::GetValidationResultRequest | Hash) —

      Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.

    • options (Gapic::CallOptions, Hash) (defaults to: nil) —

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

  • #get_validation_result(parent: nil, language_code: nil) ⇒ Google::Cloud::Dialogflow::V2::ValidationResult

    Parameters:

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

      Required. The project that the agent is associated with. Format: projects/<Project ID>.

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

      Optional. The language for which you want a validation result. 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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 822

def get_validation_result request, options = nil
  raise ArgumentError, "request must be provided" if request.nil?

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::GetValidationResultRequest

  # 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.get_validation_result.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 = {
    "parent" => request.parent
  }
  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.get_validation_result.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_validation_result.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @agents_stub.call_rpc :get_validation_result, 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

#import_agent(request, options = nil) ⇒ Gapic::Operation #import_agent(parent: nil, agent_uri: nil, agent_content: nil) ⇒ Gapic::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 google.protobuf.Empty>

Overloads:

  • #import_agent(request, options = nil) ⇒ Gapic::Operation

    Parameters:

    • request (Google::Cloud::Dialogflow::V2::ImportAgentRequest | Hash) —

      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 google.protobuf.Empty>

    • options (Gapic::CallOptions, Hash) (defaults to: nil) —

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

  • #import_agent(parent: nil, agent_uri: nil, agent_content: nil) ⇒ Gapic::Operation

    Parameters:

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

      Required. The project that the agent to import is associated with. Format: projects/<Project ID>.

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

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

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

      Zip compressed raw byte content for agent.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (Gapic::Operation)
  • operation (GRPC::ActiveCall::Operation)

Returns:

  • (Gapic::Operation)

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 677

def import_agent request, options = nil
  raise ArgumentError, "request must be provided" if request.nil?

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::ImportAgentRequest

  # 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.import_agent.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 = {
    "parent" => request.parent
  }
  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.import_agent.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.import_agent.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @agents_stub.call_rpc :import_agent, request, options: options do |response, operation|
    response = Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue GRPC::BadStatus => e
  raise Google::Cloud::Error.from_error(e)
end

#restore_agent(request, options = nil) ⇒ Gapic::Operation #restore_agent(parent: nil, agent_uri: nil, agent_content: nil) ⇒ Gapic::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 google.protobuf.Empty>

Overloads:

  • #restore_agent(request, options = nil) ⇒ Gapic::Operation

    Parameters:

    • request (Google::Cloud::Dialogflow::V2::RestoreAgentRequest | Hash) —

      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 google.protobuf.Empty>

    • options (Gapic::CallOptions, Hash) (defaults to: nil) —

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

  • #restore_agent(parent: nil, agent_uri: nil, agent_content: nil) ⇒ Gapic::Operation

    Parameters:

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

      Required. The project that the agent to restore is associated with. Format: projects/<Project ID>.

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

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

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

      Zip compressed raw byte content for agent.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (Gapic::Operation)
  • operation (GRPC::ActiveCall::Operation)

Returns:

  • (Gapic::Operation)

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 753

def restore_agent request, options = nil
  raise ArgumentError, "request must be provided" if request.nil?

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::RestoreAgentRequest

  # 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.restore_agent.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 = {
    "parent" => request.parent
  }
  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.restore_agent.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.restore_agent.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @agents_stub.call_rpc :restore_agent, request, options: options do |response, operation|
    response = Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue GRPC::BadStatus => e
  raise Google::Cloud::Error.from_error(e)
end

#search_agents(request, options = nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::Dialogflow::V2::Agent> #search_agents(parent: nil, page_size: nil, page_token: nil) ⇒ Gapic::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.

Overloads:

  • #search_agents(request, options = nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::Dialogflow::V2::Agent>

    Parameters:

    • request (Google::Cloud::Dialogflow::V2::SearchAgentsRequest | Hash) —

      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.

    • options (Gapic::CallOptions, Hash) (defaults to: nil) —

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

  • #search_agents(parent: nil, page_size: nil, page_token: nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::Dialogflow::V2::Agent>

    Parameters:

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

      Required. The project to list agents from. Format: projects/<Project ID or '-'>.

    • page_size (Integer) (defaults to: nil) —

      Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

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

      The next_page_token value returned from a previous list request.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 464

def search_agents request, options = nil
  raise ArgumentError, "request must be provided" if request.nil?

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::SearchAgentsRequest

  # 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.search_agents.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 = {
    "parent" => request.parent
  }
  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.search_agents.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_agents.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @agents_stub.call_rpc :search_agents, request, options: options do |response, operation|
    response = Gapic::PagedEnumerable.new @agents_stub, :search_agents, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue GRPC::BadStatus => e
  raise Google::Cloud::Error.from_error(e)
end

#set_agent(request, options = nil) ⇒ Google::Cloud::Dialogflow::V2::Agent #set_agent(agent: nil, update_mask: nil) ⇒ Google::Cloud::Dialogflow::V2::Agent

Creates/updates the specified agent.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 327

def set_agent request, options = nil
  raise ArgumentError, "request must be provided" if request.nil?

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::SetAgentRequest

  # 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.set_agent.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 = {
    "agent.parent" => request.agent.parent
  }
  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.set_agent.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_agent.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @agents_stub.call_rpc :set_agent, 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

#train_agent(request, options = nil) ⇒ Gapic::Operation #train_agent(parent: nil) ⇒ Gapic::Operation

Trains the specified agent.

Operation google.protobuf.Empty>

Overloads:

  • #train_agent(request, options = nil) ⇒ Gapic::Operation

    Parameters:

  • #train_agent(parent: nil) ⇒ Gapic::Operation

    Parameters:

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

      Required. The project that the agent to train is associated with. Format: projects/<Project ID>.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (Gapic::Operation)
  • operation (GRPC::ActiveCall::Operation)

Returns:

  • (Gapic::Operation)

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 529

def train_agent request, options = nil
  raise ArgumentError, "request must be provided" if request.nil?

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::TrainAgentRequest

  # 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.train_agent.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 = {
    "parent" => request.parent
  }
  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.train_agent.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.train_agent.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @agents_stub.call_rpc :train_agent, request, options: options do |response, operation|
    response = Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue GRPC::BadStatus => e
  raise Google::Cloud::Error.from_error(e)
end