Class: Google::Cloud::Dialogflow::V2::IntentsClient
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::V2::IntentsClient
- 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" ].freeze
Class Method Summary collapse
-
.agent_path(project, agent) ⇒ String
Returns a fully-qualified agent resource name string.
-
.intent_path(project, intent) ⇒ String
Returns a fully-qualified intent resource name string.
-
.project_agent_path(project) ⇒ String
Returns a fully-qualified project_agent resource name string.
Instance Method Summary collapse
-
#batch_delete_intents(parent, intents, options: nil) ⇒ Google::Gax::Operation
Deletes intents in the specified agent.
-
#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.
-
#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.
-
#delete_intent(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes the specified intent.
-
#get_intent(name, language_code: nil, intent_view: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Intent
Retrieves the specified intent.
-
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ IntentsClient
constructor
A new instance of IntentsClient.
-
#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.
-
#update_intent(intent, language_code, update_mask: nil, intent_view: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::Intent
Updates the specified intent.
Constructor Details
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ IntentsClient
Returns a new instance of IntentsClient
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 184 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/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, 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!() unless .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 = self.class::SERVICE_ADDRESS 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 ) @get_intent = Google::Gax.create_api_call( @intents_stub.method(:get_intent), defaults["get_intent"], exception_transformer: exception_transformer ) @create_intent = Google::Gax.create_api_call( @intents_stub.method(:create_intent), defaults["create_intent"], exception_transformer: exception_transformer ) @update_intent = Google::Gax.create_api_call( @intents_stub.method(:update_intent), defaults["update_intent"], exception_transformer: exception_transformer ) @delete_intent = Google::Gax.create_api_call( @intents_stub.method(:delete_intent), defaults["delete_intent"], exception_transformer: exception_transformer ) @batch_update_intents = Google::Gax.create_api_call( @intents_stub.method(:batch_update_intents), defaults["batch_update_intents"], exception_transformer: exception_transformer ) @batch_delete_intents = Google::Gax.create_api_call( @intents_stub.method(:batch_delete_intents), defaults["batch_delete_intents"], exception_transformer: exception_transformer ) end |
Class Method Details
.agent_path(project, agent) ⇒ String
Returns a fully-qualified agent resource name string.
148 149 150 151 152 153 |
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 148 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.
137 138 139 140 141 142 |
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 137 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.
127 128 129 130 131 |
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 127 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
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 |
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 704 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, ), @operations_client, Google::Protobuf::Empty, Google::Protobuf::Struct, call_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
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 |
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 623 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, ), @operations_client, Google::Cloud::Dialogflow::V2::BatchUpdateIntentsResponse, Google::Protobuf::Struct, call_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.
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 |
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 451 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, , &block) end |
#delete_intent(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes the specified intent.
543 544 545 546 547 548 549 550 551 552 553 |
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 543 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, , &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.
401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 401 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, , &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.
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 |
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 356 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, , &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.
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 |
# File 'lib/google/cloud/dialogflow/v2/intents_client.rb', line 507 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, , &block) end |