Class: Google::Cloud::Dialogflow::V2::EntityTypesClient
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::V2::EntityTypesClient
- Defined in:
- lib/google/cloud/dialogflow/v2/entity_types_client.rb
Overview
Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on.
There are three types of entities:
System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the
EntityType
type.Developer - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a
pizza.sauce
entity for red or white pizza sauce, apizza.cheese
entity for the different types of cheese on a pizza, apizza.topping
entity for different toppings, and so on. A developer entity is represented by theEntityType
type.User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the SessionEntityType type.
For more information about entity types, 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
-
.entity_type_path(project, entity_type) ⇒ String
Returns a fully-qualified entity_type resource name string.
-
.project_agent_path(project) ⇒ String
Returns a fully-qualified project_agent resource name string.
Instance Method Summary collapse
-
#batch_create_entities(parent, entities, language_code: nil, options: nil) ⇒ Google::Gax::Operation
Creates multiple new entities in the specified entity type.
-
#batch_delete_entities(parent, entity_values, language_code: nil, options: nil) ⇒ Google::Gax::Operation
Deletes entities in the specified entity type.
-
#batch_delete_entity_types(parent, entity_type_names, options: nil) ⇒ Google::Gax::Operation
Deletes entity types in the specified agent.
-
#batch_update_entities(parent, entities, language_code: nil, update_mask: nil, options: nil) ⇒ Google::Gax::Operation
Updates or creates multiple entities in the specified entity type.
-
#batch_update_entity_types(parent, entity_type_batch_uri: nil, entity_type_batch_inline: nil, language_code: nil, update_mask: nil, options: nil) ⇒ Google::Gax::Operation
Updates/Creates multiple entity types in the specified agent.
-
#create_entity_type(parent, entity_type, language_code: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::EntityType
Creates an entity type in the specified agent.
-
#delete_entity_type(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes the specified entity type.
-
#get_entity_type(name, language_code: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::EntityType
Retrieves the specified entity type.
-
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ EntityTypesClient
constructor
A new instance of EntityTypesClient.
-
#list_entity_types(parent, language_code: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::EntityType>
Returns the list of all entity types in the specified agent.
-
#update_entity_type(entity_type, language_code: nil, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::EntityType
Updates the specified entity type.
Constructor Details
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ EntityTypesClient
Returns a new instance of EntityTypesClient.
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 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 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 167 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/entity_type_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( "entity_types_client_config.json" ) defaults = client_config_file.open do |f| Google::Gax.construct_settings( "google.cloud.dialogflow.v2.EntityTypes", 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 @entity_types_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::EntityTypes::Stub.method(:new) ) @list_entity_types = Google::Gax.create_api_call( @entity_types_stub.method(:list_entity_types), defaults["list_entity_types"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @get_entity_type = Google::Gax.create_api_call( @entity_types_stub.method(:get_entity_type), defaults["get_entity_type"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'name' => request.name} end ) @create_entity_type = Google::Gax.create_api_call( @entity_types_stub.method(:create_entity_type), defaults["create_entity_type"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @update_entity_type = Google::Gax.create_api_call( @entity_types_stub.method(:update_entity_type), defaults["update_entity_type"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'entity_type.name' => request.entity_type.name} end ) @delete_entity_type = Google::Gax.create_api_call( @entity_types_stub.method(:delete_entity_type), defaults["delete_entity_type"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'name' => request.name} end ) @batch_update_entity_types = Google::Gax.create_api_call( @entity_types_stub.method(:batch_update_entity_types), defaults["batch_update_entity_types"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @batch_delete_entity_types = Google::Gax.create_api_call( @entity_types_stub.method(:batch_delete_entity_types), defaults["batch_delete_entity_types"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @batch_create_entities = Google::Gax.create_api_call( @entity_types_stub.method(:batch_create_entities), defaults["batch_create_entities"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @batch_update_entities = Google::Gax.create_api_call( @entity_types_stub.method(:batch_update_entities), defaults["batch_update_entities"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) @batch_delete_entities = Google::Gax.create_api_call( @entity_types_stub.method(:batch_delete_entities), defaults["batch_delete_entities"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'parent' => request.parent} end ) end |
Class Method Details
.entity_type_path(project, entity_type) ⇒ String
Returns a fully-qualified entity_type resource name string.
122 123 124 125 126 127 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 122 def self.entity_type_path project, entity_type ENTITY_TYPE_PATH_TEMPLATE.render( :"project" => project, :"entity_type" => entity_type ) end |
.project_agent_path(project) ⇒ String
Returns a fully-qualified project_agent resource name string.
132 133 134 135 136 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 132 def self.project_agent_path project PROJECT_AGENT_PATH_TEMPLATE.render( :"project" => project ) end |
Instance Method Details
#batch_create_entities(parent, entities, language_code: nil, options: nil) ⇒ Google::Gax::Operation
Creates multiple new entities in the specified entity type.
Operation
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 788 def batch_create_entities \ parent, entities, language_code: nil, options: nil req = { parent: parent, entities: entities, language_code: language_code }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::BatchCreateEntitiesRequest) operation = Google::Gax::Operation.new( @batch_create_entities.call(req, ), @operations_client, Google::Protobuf::Empty, Google::Protobuf::Struct, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end |
#batch_delete_entities(parent, entity_values, language_code: nil, options: nil) ⇒ Google::Gax::Operation
Deletes entities in the specified entity type.
Operation
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 958 def batch_delete_entities \ parent, entity_values, language_code: nil, options: nil req = { parent: parent, entity_values: entity_values, language_code: language_code }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::BatchDeleteEntitiesRequest) operation = Google::Gax::Operation.new( @batch_delete_entities.call(req, ), @operations_client, Google::Protobuf::Empty, Google::Protobuf::Struct, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end |
#batch_delete_entity_types(parent, entity_type_names, options: nil) ⇒ Google::Gax::Operation
Deletes entity types in the specified agent.
Operation
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 709 def batch_delete_entity_types \ parent, entity_type_names, options: nil req = { parent: parent, entity_type_names: entity_type_names }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::BatchDeleteEntityTypesRequest) operation = Google::Gax::Operation.new( @batch_delete_entity_types.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_entities(parent, entities, language_code: nil, update_mask: nil, options: nil) ⇒ Google::Gax::Operation
Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.
Operation
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 875 def batch_update_entities \ parent, entities, language_code: nil, update_mask: nil, options: nil req = { parent: parent, entities: entities, language_code: language_code, update_mask: update_mask }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::BatchUpdateEntitiesRequest) operation = Google::Gax::Operation.new( @batch_update_entities.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_entity_types(parent, entity_type_batch_uri: nil, entity_type_batch_inline: nil, language_code: nil, update_mask: nil, options: nil) ⇒ Google::Gax::Operation
Updates/Creates multiple entity types in the specified agent.
Operation
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 632 def batch_update_entity_types \ parent, entity_type_batch_uri: nil, entity_type_batch_inline: nil, language_code: nil, update_mask: nil, options: nil req = { parent: parent, entity_type_batch_uri: entity_type_batch_uri, entity_type_batch_inline: entity_type_batch_inline, language_code: language_code, update_mask: update_mask }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::BatchUpdateEntityTypesRequest) operation = Google::Gax::Operation.new( @batch_update_entity_types.call(req, ), @operations_client, Google::Cloud::Dialogflow::V2::BatchUpdateEntityTypesResponse, Google::Protobuf::Struct, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end |
#create_entity_type(parent, entity_type, language_code: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::EntityType
Creates an entity type in the specified agent.
472 473 474 475 476 477 478 479 480 481 482 483 484 485 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 472 def create_entity_type \ parent, entity_type, language_code: nil, options: nil, &block req = { parent: parent, entity_type: entity_type, language_code: language_code }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::CreateEntityTypeRequest) @create_entity_type.call(req, , &block) end |
#delete_entity_type(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes the specified entity type.
555 556 557 558 559 560 561 562 563 564 565 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 555 def delete_entity_type \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DeleteEntityTypeRequest) @delete_entity_type.call(req, , &block) nil end |
#get_entity_type(name, language_code: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::EntityType
Retrieves the specified entity type.
425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 425 def get_entity_type \ name, language_code: nil, options: nil, &block req = { name: name, language_code: language_code }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::GetEntityTypeRequest) @get_entity_type.call(req, , &block) end |
#list_entity_types(parent, language_code: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::EntityType>
Returns the list of all entity types in the specified agent.
383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 383 def list_entity_types \ parent, language_code: nil, page_size: nil, options: nil, &block req = { parent: parent, language_code: language_code, page_size: page_size }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::ListEntityTypesRequest) @list_entity_types.call(req, , &block) end |
#update_entity_type(entity_type, language_code: nil, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::EntityType
Updates the specified entity type.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 521 def update_entity_type \ entity_type, language_code: nil, update_mask: nil, options: nil, &block req = { entity_type: entity_type, language_code: language_code, update_mask: update_mask }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::UpdateEntityTypeRequest) @update_entity_type.call(req, , &block) end |