Class: Google::Cloud::Dialogflow::V2::EntityTypesClient

Inherits:
Object
  • Object
show all
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.

  • Custom - 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, a pizza.cheese entity for the different types of cheese on a pizza, a pizza.topping entity for different toppings, and so on. A custom entity is represented by the EntityType 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

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of EntityTypesClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    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>) (defaults to: ALL_SCOPES) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {}) —

    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) (defaults to: DEFAULT_TIMEOUT) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

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

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

    Override for the service hostname, or nil to leave as the default.

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

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil) —

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



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
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 171

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

  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 }
  if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
    headers[:"x-goog-user-project"] = credentials.quota_project_id
  end
  headers.merge!(metadata) unless metadata.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 = service_address || self.class::SERVICE_ADDRESS
  port = service_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.

Parameters:

  • project (String)
  • entity_type (String)

Returns:

  • (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.

Parameters:

  • project (String)

Returns:

  • (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 Protobuf::Empty>

Examples:

require "google/cloud/dialogflow"

entity_types_client = Google::Cloud::Dialogflow::EntityTypes.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::EntityTypesClient.entity_type_path("[PROJECT]", "[ENTITY_TYPE]")

# TODO: Initialize `entities`:
entities = []

# Register a callback during the method call.
operation = entity_types_client.batch_create_entities(formatted_parent, entities) 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 name of the entity type to create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

  • entities (Array<Google::Cloud::Dialogflow::V2::EntityType::Entity | Hash>) —

    Required. The entities to create. A hash of the same form as Google::Cloud::Dialogflow::V2::EntityType::Entity can also be provided.

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

    Optional. The language of entity synonyms defined in entities. 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.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 800

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, options),
    @operations_client,
    Google::Protobuf::Empty,
    Google::Protobuf::Struct,
    call_options: 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 Protobuf::Empty>

Examples:

require "google/cloud/dialogflow"

entity_types_client = Google::Cloud::Dialogflow::EntityTypes.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::EntityTypesClient.entity_type_path("[PROJECT]", "[ENTITY_TYPE]")

# TODO: Initialize `entity_values`:
entity_values = []

# Register a callback during the method call.
operation = entity_types_client.batch_delete_entities(formatted_parent, entity_values) 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 name of the entity type to delete entries for. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

  • entity_values (Array<String>) —

    Required. The reference values of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with projects/<Project ID>.

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

    Optional. The language of entity synonyms defined in entities. 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.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
 
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 972

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, options),
    @operations_client,
    Google::Protobuf::Empty,
    Google::Protobuf::Struct,
    call_options: 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 Protobuf::Empty>

Examples:

require "google/cloud/dialogflow"

entity_types_client = Google::Cloud::Dialogflow::EntityTypes.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::EntityTypesClient.project_agent_path("[PROJECT]")

# TODO: Initialize `entity_type_names`:
entity_type_names = []

# Register a callback during the method call.
operation = entity_types_client.batch_delete_entity_types(formatted_parent, entity_type_names) 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 name of the agent to delete all entities types for. Format: projects/<Project ID>/agent.

  • entity_type_names (Array<String>) —

    Required. The names entity types to delete. All names must point to the same agent as parent.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
 
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 721

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, options),
    @operations_client,
    Google::Protobuf::Empty,
    Google::Protobuf::Struct,
    call_options: 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 Protobuf::Empty>

Examples:

require "google/cloud/dialogflow"

entity_types_client = Google::Cloud::Dialogflow::EntityTypes.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::EntityTypesClient.entity_type_path("[PROJECT]", "[ENTITY_TYPE]")

# TODO: Initialize `entities`:
entities = []

# Register a callback during the method call.
operation = entity_types_client.batch_update_entities(formatted_parent, entities) 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 name of the entity type to update or create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.

  • entities (Array<Google::Cloud::Dialogflow::V2::EntityType::Entity | Hash>) —

    Required. The entities to update or create. A hash of the same form as Google::Cloud::Dialogflow::V2::EntityType::Entity can also be provided.

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

    Optional. The language of entity synonyms defined in entities. 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.

  • update_mask (Google::Protobuf::FieldMask | Hash) (defaults to: nil) —

    Optional. The mask to control which fields get updated. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
 
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 888

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, options),
    @operations_client,
    Google::Protobuf::Empty,
    Google::Protobuf::Struct,
    call_options: 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 BatchUpdateEntityTypesResponse>

Examples:

require "google/cloud/dialogflow"

entity_types_client = Google::Cloud::Dialogflow::EntityTypes.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::EntityTypesClient.project_agent_path("[PROJECT]")

# Register a callback during the method call.
operation = entity_types_client.batch_update_entity_types(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 name of the agent to update or create entity types in. Format: projects/<Project ID>/agent.

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

    The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with "gs://".

  • entity_type_batch_inline (Google::Cloud::Dialogflow::V2::EntityTypeBatch | Hash) (defaults to: nil) —

    The collection of entity types to update or create. A hash of the same form as Google::Cloud::Dialogflow::V2::EntityTypeBatch can also be provided.

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

    Optional. The language of entity synonyms defined in entity_types. 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.

  • update_mask (Google::Protobuf::FieldMask | Hash) (defaults to: nil) —

    Optional. The mask to control which fields get updated. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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
665
666
667
668
 
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 644

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, options),
    @operations_client,
    Google::Cloud::Dialogflow::V2::BatchUpdateEntityTypesResponse,
    Google::Protobuf::Struct,
    call_options: 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.

Examples:

require "google/cloud/dialogflow"

entity_types_client = Google::Cloud::Dialogflow::EntityTypes.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::EntityTypesClient.project_agent_path("[PROJECT]")

# TODO: Initialize `entity_type`:
entity_type = {}
response = entity_types_client.create_entity_type(formatted_parent, entity_type)

Parameters:

  • parent (String) —

    Required. The agent to create a entity type for. Format: projects/<Project ID>/agent.

  • entity_type (Google::Cloud::Dialogflow::V2::EntityType | Hash) —

    Required. The entity type to create. A hash of the same form as Google::Cloud::Dialogflow::V2::EntityType can also be provided.

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

    Optional. The language of entity synonyms defined in entity_type. 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.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 484

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, options, &block)
end

#delete_entity_type(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes the specified entity type.

Examples:

require "google/cloud/dialogflow"

entity_types_client = Google::Cloud::Dialogflow::EntityTypes.new(version: :v2)
formatted_name = Google::Cloud::Dialogflow::V2::EntityTypesClient.entity_type_path("[PROJECT]", "[ENTITY_TYPE]")
entity_types_client.delete_entity_type(formatted_name)

Parameters:

  • name (String) —

    Required. The name of the entity type to delete. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 567

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, options, &block)
  nil
end

#get_entity_type(name, language_code: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::EntityType

Retrieves the specified entity type.

Examples:

require "google/cloud/dialogflow"

entity_types_client = Google::Cloud::Dialogflow::EntityTypes.new(version: :v2)
formatted_name = Google::Cloud::Dialogflow::V2::EntityTypesClient.entity_type_path("[PROJECT]", "[ENTITY_TYPE]")
response = entity_types_client.get_entity_type(formatted_name)

Parameters:

  • name (String) —

    Required. The name of the entity type. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.

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

    Optional. The language to retrieve entity synonyms for. 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.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 437

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, options, &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.

Examples:

require "google/cloud/dialogflow"

entity_types_client = Google::Cloud::Dialogflow::EntityTypes.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::EntityTypesClient.project_agent_path("[PROJECT]")

# Iterate over all results.
entity_types_client.list_entity_types(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
entity_types_client.list_entity_types(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 agent to list all entity types from. Format: projects/<Project ID>/agent.

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

    Optional. The language to list entity synonyms for. 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.

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

    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) (defaults to: nil) —

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

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



395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 395

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, options, &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.

Examples:

require "google/cloud/dialogflow"

entity_types_client = Google::Cloud::Dialogflow::EntityTypes.new(version: :v2)

# TODO: Initialize `entity_type`:
entity_type = {}
response = entity_types_client.update_entity_type(entity_type)

Parameters:

  • entity_type (Google::Cloud::Dialogflow::V2::EntityType | Hash) —

    Required. The entity type to update. A hash of the same form as Google::Cloud::Dialogflow::V2::EntityType can also be provided.

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

    Optional. The language of entity synonyms defined in entity_type. 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.

  • update_mask (Google::Protobuf::FieldMask | Hash) (defaults to: nil) —

    Optional. The mask to control which fields get updated. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/google/cloud/dialogflow/v2/entity_types_client.rb', line 533

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, options, &block)
end