Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::EntityTypes::Rest::Client (v0.24.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::EntityTypes::Rest::Client.

REST client for the EntityTypes service.

Service for managing EntityTypes.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the EntityTypes Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all EntityTypes clients
::Google::Cloud::Dialogflow::V2::EntityTypes::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#batch_create_entities

def batch_create_entities(request, options = nil) -> ::Gapic::Operation
def batch_create_entities(parent: nil, entities: nil, language_code: nil) -> ::Gapic::Operation

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

Overloads 
def batch_create_entities(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_create_entities via a request object, either of type BatchCreateEntitiesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::BatchCreateEntitiesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def batch_create_entities(parent: nil, entities: nil, language_code: nil) -> ::Gapic::Operation
Pass arguments to batch_create_entities via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
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.
  • language_code (::String) — Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#batch_delete_entities

def batch_delete_entities(request, options = nil) -> ::Gapic::Operation
def batch_delete_entities(parent: nil, entity_values: nil, language_code: nil) -> ::Gapic::Operation

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

Overloads 
def batch_delete_entities(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_delete_entities via a request object, either of type BatchDeleteEntitiesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::BatchDeleteEntitiesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def batch_delete_entities(parent: nil, entity_values: nil, language_code: nil) -> ::Gapic::Operation
Pass arguments to batch_delete_entities via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
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) — Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#batch_delete_entity_types

def batch_delete_entity_types(request, options = nil) -> ::Gapic::Operation
def batch_delete_entity_types(parent: nil, entity_type_names: nil) -> ::Gapic::Operation

Deletes entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

Overloads 
def batch_delete_entity_types(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_delete_entity_types via a request object, either of type BatchDeleteEntityTypesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::BatchDeleteEntityTypesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def batch_delete_entity_types(parent: nil, entity_type_names: nil) -> ::Gapic::Operation
Pass arguments to batch_delete_entity_types via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#batch_update_entities

def batch_update_entities(request, options = nil) -> ::Gapic::Operation
def batch_update_entities(parent: nil, entities: nil, language_code: nil, update_mask: nil) -> ::Gapic::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.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

Overloads 
def batch_update_entities(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_update_entities via a request object, either of type BatchUpdateEntitiesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::BatchUpdateEntitiesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def batch_update_entities(parent: nil, entities: nil, language_code: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to batch_update_entities via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
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.
  • language_code (::String) — Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The mask to control which fields get updated.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#batch_update_entity_types

def batch_update_entity_types(request, options = nil) -> ::Gapic::Operation
def batch_update_entity_types(parent: nil, entity_type_batch_uri: nil, entity_type_batch_inline: nil, language_code: nil, update_mask: nil) -> ::Gapic::Operation

Updates/Creates multiple entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

Overloads 
def batch_update_entity_types(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_update_entity_types via a request object, either of type BatchUpdateEntityTypesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::BatchUpdateEntityTypesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def batch_update_entity_types(parent: nil, entity_type_batch_uri: nil, entity_type_batch_inline: nil, language_code: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to batch_update_entity_types via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
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) — 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) — The collection of entity types to update or create.
  • language_code (::String) — Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The mask to control which fields get updated.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#configure

def configure() { |config| ... } -> Client::Configuration

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

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_entity_type

def create_entity_type(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::EntityType
def create_entity_type(parent: nil, entity_type: nil, language_code: nil) -> ::Google::Cloud::Dialogflow::V2::EntityType

Creates an entity type in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Overloads 
def create_entity_type(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::EntityType
Pass arguments to create_entity_type via a request object, either of type CreateEntityTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::CreateEntityTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_entity_type(parent: nil, entity_type: nil, language_code: nil) -> ::Google::Cloud::Dialogflow::V2::EntityType
Pass arguments to create_entity_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
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.
  • language_code (::String) — Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_entity_type

def delete_entity_type(request, options = nil) -> ::Google::Protobuf::Empty
def delete_entity_type(name: nil) -> ::Google::Protobuf::Empty

Deletes the specified entity type.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Overloads 
def delete_entity_type(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_entity_type via a request object, either of type DeleteEntityTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::DeleteEntityTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_entity_type(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_entity_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the entity type to delete. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_entity_type

def get_entity_type(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::EntityType
def get_entity_type(name: nil, language_code: nil) -> ::Google::Cloud::Dialogflow::V2::EntityType

Retrieves the specified entity type.

Overloads 
def get_entity_type(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::EntityType
Pass arguments to get_entity_type via a request object, either of type GetEntityTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::GetEntityTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_entity_type(name: nil, language_code: nil) -> ::Google::Cloud::Dialogflow::V2::EntityType
Pass arguments to get_entity_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the entity type. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.
  • language_code (::String) — Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#initialize

def initialize() { |config| ... } -> Client

Create a new EntityTypes REST client object.

Yields
  • (config) — Configure the EntityTypes client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::V2::EntityTypes::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::V2::EntityTypes::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_entity_types

def list_entity_types(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::EntityType>
def list_entity_types(parent: nil, language_code: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::EntityType>

Returns the list of all entity types in the specified agent.

Overloads 
def list_entity_types(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::EntityType>
Pass arguments to list_entity_types via a request object, either of type ListEntityTypesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::ListEntityTypesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_entity_types(parent: nil, language_code: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::EntityType>
Pass arguments to list_entity_types via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The agent to list all entity types from. Format: projects/<Project ID>/agent.
  • language_code (::String) — Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
  • page_size (::Integer) — Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
  • page_token (::String) — Optional. The next_page_token value returned from a previous list request.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#operations_client

def operations_client() -> ::Google::Cloud::Dialogflow::V2::EntityTypes::Rest::Operations

Get the associated client for long-running operations.

Returns

#update_entity_type

def update_entity_type(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::EntityType
def update_entity_type(entity_type: nil, language_code: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::V2::EntityType

Updates the specified entity type.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Overloads 
def update_entity_type(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::EntityType
Pass arguments to update_entity_type via a request object, either of type UpdateEntityTypeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::UpdateEntityTypeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_entity_type(entity_type: nil, language_code: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::V2::EntityType
Pass arguments to update_entity_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.