Class EntityTypesClient (1.0.0)

Version 1.0.0

• 2.34.0 (latest)
• 2.33.0
• 2.32.0
• 2.30.2
• 2.29.0
• 2.28.3
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.1
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.1
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.1
• 2.7.1
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.2
• 2.0.0
• 1.1.3
• 1.0.0
• 0.8.0
• 0.7.2

EntityTypesClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

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 <https://cloud.google.com/dialogflow/docs/entities-overview>__.

Methods

EntityTypesClient

EntityTypesClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters
Name	Description
channel	grpc.Channel DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.
credentials	google.auth.credentials.Credentials The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.
client_config	dict DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.
client_info	google.api_core.gapic_v1.client_info.ClientInfo The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
client_options	Union[dict, google.api_core.client_options.ClientOptions] Client options used to set user options on the client. API Endpoint should be set through client_options.

batch_create_entities

batch_create_entities(parent, entities, language_code=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates multiple new entities in the specified entity type.

Operation <response: google.protobuf.Empty>

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.EntityTypesClient()

parent = client.entity_type_path('[PROJECT]', '[ENTITY_TYPE]')

TODO: Initialize entities:

entities = []

response = client.batch_create_entities(parent, entities)

def callback(operation_future): ... # Handle result. ... result = operation_future.result()

response.add_done_callback(callback)

Handle metadata.

metadata = response.metadata()

Parameters
Name	Description
parent	str Required. The name of the entity type to create entities in. Format: projects/.
entities	list[Union[dict, Entity]] Required. The entities to create. If a dict is provided, it must be of the same form as the protobuf message Entity
language_code	str Optional. The language of entity synonyms defined in entities. If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language__ are supported. Note: languages must be enabled in the agent before they can be used.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

batch_delete_entities

batch_delete_entities(parent, entity_values, language_code=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes entities in the specified entity type.

Operation <response: google.protobuf.Empty>

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.EntityTypesClient()

parent = client.entity_type_path('[PROJECT]', '[ENTITY_TYPE]')

TODO: Initialize entity_values:

entity_values = []

response = client.batch_delete_entities(parent, entity_values)

def callback(operation_future): ... # Handle result. ... result = operation_future.result()

response.add_done_callback(callback)

Handle metadata.

metadata = response.metadata()

Parameters
Name	Description
parent	str Required. The name of the entity type to delete entries for. Format: projects/.
entity_values	list[str] 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/.
language_code	str Optional. The language of entity synonyms defined in entities. If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language__ are supported. Note: languages must be enabled in the agent before they can be used.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

batch_delete_entity_types

batch_delete_entity_types(parent, entity_type_names, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes entity types in the specified agent.

Operation <response: google.protobuf.Empty>

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.EntityTypesClient()

parent = client.project_agent_path('[PROJECT]')

TODO: Initialize entity_type_names:

entity_type_names = []

response = client.batch_delete_entity_types(parent, entity_type_names)

def callback(operation_future): ... # Handle result. ... result = operation_future.result()

response.add_done_callback(callback)

Handle metadata.

metadata = response.metadata()

Parameters
Name	Description
parent	str Required. The name of the agent to delete all entities types for. Format: projects/.
entity_type_names	list[str] Required. The names entity types to delete. All names must point to the same agent as parent.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

batch_update_entities

batch_update_entities(parent, entities, language_code=None, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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 <response: google.protobuf.Empty>

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.EntityTypesClient()

parent = client.entity_type_path('[PROJECT]', '[ENTITY_TYPE]')

TODO: Initialize entities:

entities = []

response = client.batch_update_entities(parent, entities)

def callback(operation_future): ... # Handle result. ... result = operation_future.result()

response.add_done_callback(callback)

Handle metadata.

metadata = response.metadata()

Parameters
Name	Description
parent	str Required. The name of the entity type to update or create entities in. Format: projects/.
entities	list[Union[dict, Entity]] Required. The entities to update or create. If a dict is provided, it must be of the same form as the protobuf message Entity
language_code	str Optional. The language of entity synonyms defined in entities. If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language__ are supported. Note: languages must be enabled in the agent before they can be used.
update_mask	Union[dict, FieldMask] Optional. The mask to control which fields get updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

batch_update_entity_types

batch_update_entity_types(parent, entity_type_batch_uri=None, entity_type_batch_inline=None, language_code=None, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates/Creates multiple entity types in the specified agent.

Operation <response: BatchUpdateEntityTypesResponse>

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.EntityTypesClient()

parent = client.project_agent_path('[PROJECT]')

response = client.batch_update_entity_types(parent)

def callback(operation_future): ... # Handle result. ... result = operation_future.result()

response.add_done_callback(callback)

Handle metadata.

metadata = response.metadata()

Parameters
Name	Description
parent	str Required. The name of the agent to update or create entity types in. Format: projects/.
entity_type_batch_uri	str 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	Union[dict, EntityTypeBatch] The collection of entity types to update or create. If a dict is provided, it must be of the same form as the protobuf message EntityTypeBatch
language_code	str Optional. The language of entity synonyms defined in entity_types. If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language__ are supported. Note: languages must be enabled in the agent before they can be used.
update_mask	Union[dict, FieldMask] Optional. The mask to control which fields get updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

create_entity_type

create_entity_type(parent, entity_type, language_code=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates an entity type in the specified agent.

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.EntityTypesClient()

parent = client.project_agent_path('[PROJECT]')

TODO: Initialize entity_type:

entity_type = {}

response = client.create_entity_type(parent, entity_type)

Parameters
Name	Description
parent	str Required. The agent to create a entity type for. Format: projects/.
entity_type	Union[dict, EntityType] Required. The entity type to create. If a dict is provided, it must be of the same form as the protobuf message EntityType
language_code	str Optional. The language of entity synonyms defined in entity_type. If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language__ are supported. Note: languages must be enabled in the agent before they can be used.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

delete_entity_type

delete_entity_type(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes the specified entity type.

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.EntityTypesClient()

name = client.entity_type_path('[PROJECT]', '[ENTITY_TYPE]')

client.delete_entity_type(name)

Parameters
Name	Description
name	str Required. The name of the entity type to delete. Format: projects/.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

entity_type_path

entity_type_path(project, entity_type)

Return a fully-qualified entity_type string.

from_service_account_file

from_service_account_file(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
dialogflow_v2beta1.EntityTypesClient	The constructed client.

from_service_account_json

from_service_account_json(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
dialogflow_v2beta1.EntityTypesClient	The constructed client.

get_entity_type

get_entity_type(name, language_code=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Retrieves the specified entity type.

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.EntityTypesClient()

name = client.entity_type_path('[PROJECT]', '[ENTITY_TYPE]')

response = client.get_entity_type(name)

Parameters
Name	Description
name	str Required. The name of the entity type. Format: projects/.
language_code	str Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language__ are supported. Note: languages must be enabled in the agent before they can be used.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

list_entity_types

list_entity_types(parent, language_code=None, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.EntityTypesClient()

parent = client.project_agent_path('[PROJECT]')

Iterate over all results

for element in client.list_entity_types(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_entity_types(parent).pages: ... for element in page: ... # process element ... pass

Parameters
Name	Description
parent	str Required. The agent to list all entity types from. Format: projects/.
language_code	str Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language__ are supported. Note: languages must be enabled in the agent before they can be used.
page_size	int 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.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

project_agent_path

project_agent_path(project)

Return a fully-qualified project_agent string.

update_entity_type

update_entity_type(entity_type, language_code=None, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates the specified entity type.

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.EntityTypesClient()

TODO: Initialize entity_type:

entity_type = {}

response = client.update_entity_type(entity_type)

Parameters
Name	Description
entity_type	Union[dict, EntityType] Required. The entity type to update. If a dict is provided, it must be of the same form as the protobuf message EntityType
language_code	str Optional. The language of entity synonyms defined in entity_type. If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language__ are supported. Note: languages must be enabled in the agent before they can be used.
update_mask	Union[dict, FieldMask] Optional. The mask to control which fields get updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions
Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.