Class EntityTypesAsyncClient (2.11.0)

EntityTypesAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflow_v2.services.entity_types.transports.base.EntityTypesTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for managing EntityTypes.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`EntityTypesTransport`	The transport used by the client instance.

Methods

EntityTypesAsyncClient

EntityTypesAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflow_v2.services.entity_types.transports.base.EntityTypesTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the entity types client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .EntityTypesTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

batch_create_entities

batch_create_entities(request: Optional[Union[google.cloud.dialogflow_v2.types.entity_type.BatchCreateEntitiesRequest, dict]] = None, *, parent: Optional[str] = None, entities: Optional[Sequence[google.cloud.dialogflow_v2.types.entity_type.EntityType.Entity]] = None, language_code: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates multiple new entities in the specified entity type.

This method is a long-running operation <https://cloud.google.com/dialogflow/es/docs/how/long-running-operations>__. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>__
response: An Empty message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty>__

Note: You should always train an agent prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/es/docs/training>__.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.BatchCreateEntitiesRequest, dict]` The request object. The request message for EntityTypes.BatchCreateEntities.
`parent`	`str` Required. The name of the entity type to create entities in. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`entities`	`:class:Sequence[google.cloud.dialogflow_v2.types.EntityType.Entity]` Required. The entities to create. This corresponds to the `entities` field on the `request` instance; if `request` is provided, this should not be set.
`language_code`	`str` 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 https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity`__. This corresponds to the `language_code` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

batch_delete_entities

batch_delete_entities(request: Optional[Union[google.cloud.dialogflow_v2.types.entity_type.BatchDeleteEntitiesRequest, dict]] = None, *, parent: Optional[str] = None, entity_values: Optional[Sequence[str]] = None, language_code: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes entities in the specified entity type.

This method is a long-running operation <https://cloud.google.com/dialogflow/es/docs/how/long-running-operations>__. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>__
response: An Empty message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty>__

Note: You should always train an agent prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/es/docs/training>__.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.BatchDeleteEntitiesRequest, dict]` The request object. The request message for EntityTypes.BatchDeleteEntities.
`parent`	`str` Required. The name of the entity type to delete entries for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`entity_values`	`:class:Sequence[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/`. This corresponds to the `entity_values` field on the `request` instance; if `request` is provided, this should not be set.
`language_code`	`str` 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 https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity`__. This corresponds to the `language_code` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

batch_delete_entity_types

batch_delete_entity_types(request: Optional[Union[google.cloud.dialogflow_v2.types.entity_type.BatchDeleteEntityTypesRequest, dict]] = None, *, parent: Optional[str] = None, entity_type_names: Optional[Sequence[str]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes entity types in the specified agent.

This method is a long-running operation <https://cloud.google.com/dialogflow/es/docs/how/long-running-operations>__. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>__
response: An Empty message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty>__

Note: You should always train an agent prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/es/docs/training>__.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.BatchDeleteEntityTypesRequest, dict]` The request object. The request message for EntityTypes.BatchDeleteEntityTypes.
`parent`	`str` Required. The name of the agent to delete all entities types for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`entity_type_names`	`:class:Sequence[str]` Required. The names entity types to delete. All names must point to the same agent as `parent`. This corresponds to the `entity_type_names` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

batch_update_entities

batch_update_entities(request: Optional[Union[google.cloud.dialogflow_v2.types.entity_type.BatchUpdateEntitiesRequest, dict]] = None, *, parent: Optional[str] = None, entities: Optional[Sequence[google.cloud.dialogflow_v2.types.entity_type.EntityType.Entity]] = None, language_code: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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 <https://cloud.google.com/dialogflow/es/docs/how/long-running-operations>__. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>__
response: An Empty message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty>__

Note: You should always train an agent prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/es/docs/training>__.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.BatchUpdateEntitiesRequest, dict]` The request object. The request message for EntityTypes.BatchUpdateEntities.
`parent`	`str` Required. The name of the entity type to update or create entities in. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`entities`	`:class:Sequence[google.cloud.dialogflow_v2.types.EntityType.Entity]` Required. The entities to update or create. This corresponds to the `entities` field on the `request` instance; if `request` is provided, this should not be set.
`language_code`	`str` 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 https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity`__. This corresponds to the `language_code` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

batch_update_entity_types

batch_update_entity_types(request: Optional[Union[google.cloud.dialogflow_v2.types.entity_type.BatchUpdateEntityTypesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates/Creates multiple entity types in the specified agent.

This method is a long-running operation <https://cloud.google.com/dialogflow/es/docs/how/long-running-operations>__. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>__
response: xref_BatchUpdateEntityTypesResponse

Note: You should always train an agent prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/es/docs/training>__.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.BatchUpdateEntityTypesRequest, dict]` The request object. The request message for EntityTypes.BatchUpdateEntityTypes.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be BatchUpdateEntityTypesResponse The response message for EntityTypes.BatchUpdateEntityTypes.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_entity_type

create_entity_type(request: Optional[Union[google.cloud.dialogflow_v2.types.entity_type.CreateEntityTypeRequest, dict]] = None, *, parent: Optional[str] = None, entity_type: Optional[google.cloud.dialogflow_v2.types.entity_type.EntityType] = None, language_code: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an entity type in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/es/docs/training>__.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.CreateEntityTypeRequest, dict]` The request object. The request message for EntityTypes.CreateEntityType.
`parent`	`str` Required. The agent to create a entity type for. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`entity_type`	`EntityType` Required. The entity type to create. This corresponds to the `entity_type` field on the `request` instance; if `request` is provided, this should not be set.
`language_code`	`str` 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 https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity`__. This corresponds to the `language_code` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

google.cloud.dialogflow_v2.types.EntityType Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](\ https://cloud.google.com/dialogflow/docs/entities-overview).

delete_entity_type

delete_entity_type(request: Optional[Union[google.cloud.dialogflow_v2.types.entity_type.DeleteEntityTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified entity type.

Note: You should always train an agent prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/es/docs/training>__.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.DeleteEntityTypeRequest, dict]` The request object. The request message for EntityTypes.DeleteEntityType.
`name`	`str` Required. The name of the entity type to delete. Format: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

entity_type_path

entity_type_path(project: str, entity_type: str)

Returns a fully-qualified entity_type string.

from_service_account_file

from_service_account_file(filename: str, *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
`EntityTypesAsyncClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`EntityTypesAsyncClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *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
`EntityTypesAsyncClient`	The constructed client.

get_entity_type

get_entity_type(request: Optional[Union[google.cloud.dialogflow_v2.types.entity_type.GetEntityTypeRequest, dict]] = None, *, name: Optional[str] = None, language_code: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified entity type.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.GetEntityTypeRequest, dict]` The request object. The request message for EntityTypes.GetEntityType.
`name`	`str` Required. The name of the entity type. Format: `projects/`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`language_code`	`str` 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 https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity`__. This corresponds to the `language_code` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_entity_types

list_entity_types(request: Optional[Union[google.cloud.dialogflow_v2.types.entity_type.ListEntityTypesRequest, dict]] = None, *, parent: Optional[str] = None, language_code: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.ListEntityTypesRequest, dict]` The request object. The request message for EntityTypes.ListEntityTypes.
`parent`	`str` Required. The agent to list all entity types from. Format: `projects/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`language_code`	`str` 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 https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity`__. This corresponds to the `language_code` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.dialogflow_v2.services.entity_types.pagers.ListEntityTypesAsyncPager`	The response message for EntityTypes.ListEntityTypes. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_entity_type_path

parse_entity_type_path(path: str)

Parses a entity_type path into its component segments.

update_entity_type

update_entity_type(request: Optional[Union[google.cloud.dialogflow_v2.types.entity_type.UpdateEntityTypeRequest, dict]] = None, *, entity_type: Optional[google.cloud.dialogflow_v2.types.entity_type.EntityType] = None, language_code: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified entity type.

Note: You should always train an agent prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/es/docs/training>__.

Parameters
Name	Description
`request`	`Union[google.cloud.dialogflow_v2.types.UpdateEntityTypeRequest, dict]` The request object. The request message for EntityTypes.UpdateEntityType.
`entity_type`	`EntityType` Required. The entity type to update. This corresponds to the `entity_type` field on the `request` instance; if `request` is provided, this should not be set.
`language_code`	`str` 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 https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity`__. This corresponds to the `language_code` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description