Class EntityTypesAsyncClient (0.8.2)

Version 0.8.2

• 1.36.0 (latest)
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.5
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.0
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.1

EntityTypesAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.entity_types.transports.base.EntityTypesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-dialogflow-cx/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = 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: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.entity_types.transports.base.EntityTypesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-dialogflow-cx/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = 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.

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[google.cloud.dialogflowcx_v3beta1.types.entity_type.CreateEntityTypeRequest] = None, *, parent: Optional[str] = None, entity_type: Optional[google.cloud.dialogflowcx_v3beta1.types.entity_type.EntityType] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an entity type in the specified agent.

Parameters
Name	Description
request	CreateEntityTypeRequest 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.
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.dialogflowcx_v3beta1.types.EntityType	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).

delete_entity_type

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

Deletes the specified entity type.

Note: You should always train a flow prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>__.

Parameters
Name	Description
request	DeleteEntityTypeRequest 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, location: str, agent: 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[google.cloud.dialogflowcx_v3beta1.types.entity_type.GetEntityTypeRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified entity type.

Parameters
Name	Description
request	GetEntityTypeRequest 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.
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.dialogflowcx_v3beta1.types.EntityType	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).

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_entity_types

list_entity_types(request: Optional[google.cloud.dialogflowcx_v3beta1.types.entity_type.ListEntityTypesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_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	ListEntityTypesRequest The request object. The request message for EntityTypes.ListEntityTypes.
parent	str Required. The agent to list all entity types for. Format: projects/. This corresponds to the parent 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.dialogflowcx_v3beta1.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[google.cloud.dialogflowcx_v3beta1.types.entity_type.UpdateEntityTypeRequest] = None, *, entity_type: Optional[google.cloud.dialogflowcx_v3beta1.types.entity_type.EntityType] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified entity type.

Note: You should always train a flow prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>__.

Parameters
Name	Description
request	UpdateEntityTypeRequest 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.
update_mask	google.protobuf.field_mask_pb2.FieldMask The mask to control which fields get updated. This corresponds to the update_mask 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.dialogflowcx_v3beta1.types.EntityType	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).