Class: Google::Cloud::Dialogflow::V2::AgentsClient
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::V2::AgentsClient
- 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", "https://www.googleapis.com/auth/dialogflow" ].freeze
Class Method Summary collapse
-
.project_path(project) ⇒ String
Returns a fully-qualified project resource name string.
Instance Method Summary collapse
-
#export_agent(parent, agent_uri: nil, options: nil) ⇒ Google::Gax::Operation
Exports the specified agent to a ZIP file.
-
#get_agent(parent, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Agent
Retrieves the specified agent.
-
#import_agent(parent, agent_uri: nil, agent_content: nil, options: nil) ⇒ Google::Gax::Operation
Imports the specified agent from a ZIP file.
-
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ AgentsClient
constructor
A new instance of AgentsClient.
-
#restore_agent(parent, agent_uri: nil, agent_content: nil, options: nil) ⇒ Google::Gax::Operation
Restores the specified agent from a ZIP file.
-
#search_agents(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::Agent>
Returns the list of agents.
-
#train_agent(parent, options: nil) ⇒ Google::Gax::Operation
Trains the specified agent.
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.
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 150 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 = 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!() unless .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, params_extractor: proc do |request| {'parent' => request.parent} end ) @search_agents = Google::Gax.create_api_call( @agents_stub.method(:search_agents), defaults["search_agents"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @train_agent = Google::Gax.create_api_call( @agents_stub.method(:train_agent), defaults["train_agent"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @export_agent = Google::Gax.create_api_call( @agents_stub.method(:export_agent), defaults["export_agent"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @import_agent = Google::Gax.create_api_call( @agents_stub.method(:import_agent), defaults["import_agent"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @restore_agent = Google::Gax.create_api_call( @agents_stub.method(:restore_agent), defaults["restore_agent"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) end |
Class Method Details
.project_path(project) ⇒ String
Returns a fully-qualified project resource name string.
115 116 117 118 119 |
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 115 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 <response: ExportAgentResponse>
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 491 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, ), @operations_client, Google::Cloud::Dialogflow::V2::ExportAgentResponse, Google::Protobuf::Struct, call_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.
305 306 307 308 309 310 311 312 313 314 |
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 305 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, , &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 <response: Protobuf::Empty>
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 |
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 578 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, ), @operations_client, Google::Protobuf::Empty, Google::Protobuf::Struct, call_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 <response: Protobuf::Empty>
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 |
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 666 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, ), @operations_client, Google::Protobuf::Empty, Google::Protobuf::Struct, call_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.
364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 364 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, , &block) end |
#train_agent(parent, options: nil) ⇒ Google::Gax::Operation
Trains the specified agent.
Operation <response: Protobuf::Empty>
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 |
# File 'lib/google/cloud/dialogflow/v2/agents_client.rb', line 422 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, ), @operations_client, Google::Protobuf::Empty, Google::Protobuf::Struct, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end |