Class EntityTypesClient (1.12.0)

EntityTypesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.entity_types.transports.base.EntityTypesTransport]] = None, 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.

Inheritance

builtins.object > EntityTypesClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
EntityTypesTransportThe transport used by the client instance.

Methods

EntityTypesClient

EntityTypesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.entity_types.transports.base.EntityTypesTransport]] = None, 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
NameDescription
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 google.api_core.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.

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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

.. warning:: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

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.dialogflowcx_v3.types.entity_type.CreateEntityTypeRequest, dict]] = None, *, parent: Optional[str] = None, entity_type: Optional[google.cloud.dialogflowcx_v3.types.entity_type.EntityType] = 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 a flow prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>__.

from google.cloud import dialogflowcx_v3

def sample_create_entity_type():
    # Create a client
    client = dialogflowcx_v3.EntityTypesClient()

    # Initialize request argument(s)
    entity_type = dialogflowcx_v3.EntityType()
    entity_type.display_name = "display_name_value"
    entity_type.kind = "KIND_REGEXP"

    request = dialogflowcx_v3.CreateEntityTypeRequest(
        parent="parent_value",
        entity_type=entity_type,
    )

    # Make the request
    response = client.create_entity_type(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3.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/<Project ID>/locations/<Location ID>/agents/<Agent ID>. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

entity_type google.cloud.dialogflowcx_v3.types.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
TypeDescription
google.cloud.dialogflowcx_v3.types.EntityTypeEntities 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[Union[google.cloud.dialogflowcx_v3.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 a flow prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>__.

from google.cloud import dialogflowcx_v3

def sample_delete_entity_type():
    # Create a client
    client = dialogflowcx_v3.EntityTypesClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.DeleteEntityTypeRequest(
        name="name_value",
    )

    # Make the request
    client.delete_entity_type(request=request)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3.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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>. 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
EntityTypesClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
EntityTypesClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
EntityTypesClientThe constructed client.

get_entity_type

get_entity_type(request: Optional[Union[google.cloud.dialogflowcx_v3.types.entity_type.GetEntityTypeRequest, 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]] = ())

Retrieves the specified entity type.

from google.cloud import dialogflowcx_v3

def sample_get_entity_type():
    # Create a client
    client = dialogflowcx_v3.EntityTypesClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.GetEntityTypeRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_entity_type(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3.types.GetEntityTypeRequest, dict]

The request object. The request message for EntityTypes.GetEntityType.

name str

Required. The name of the entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>. 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
TypeDescription
google.cloud.dialogflowcx_v3.types.EntityTypeEntities 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_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
NameDescription
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

list_entity_types

list_entity_types(request: Optional[Union[google.cloud.dialogflowcx_v3.types.entity_type.ListEntityTypesRequest, dict]] = None, *, parent: 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.

from google.cloud import dialogflowcx_v3

def sample_list_entity_types():
    # Create a client
    client = dialogflowcx_v3.EntityTypesClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.ListEntityTypesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_entity_types(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3.types.ListEntityTypesRequest, dict]

The request object. The request message for EntityTypes.ListEntityTypes.

parent str

Required. The agent to list all entity types for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. 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
TypeDescription
google.cloud.dialogflowcx_v3.services.entity_types.pagers.ListEntityTypesPagerThe 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.dialogflowcx_v3.types.entity_type.UpdateEntityTypeRequest, dict]] = None, *, entity_type: Optional[google.cloud.dialogflowcx_v3.types.entity_type.EntityType] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 a flow prior to sending it queries. See the training documentation <https://cloud.google.com/dialogflow/cx/docs/concept/training>__.

from google.cloud import dialogflowcx_v3

def sample_update_entity_type():
    # Create a client
    client = dialogflowcx_v3.EntityTypesClient()

    # Initialize request argument(s)
    entity_type = dialogflowcx_v3.EntityType()
    entity_type.display_name = "display_name_value"
    entity_type.kind = "KIND_REGEXP"

    request = dialogflowcx_v3.UpdateEntityTypeRequest(
        entity_type=entity_type,
    )

    # Make the request
    response = client.update_entity_type(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.dialogflowcx_v3.types.UpdateEntityTypeRequest, dict]

The request object. The request message for EntityTypes.UpdateEntityType.

entity_type google.cloud.dialogflowcx_v3.types.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
TypeDescription
google.cloud.dialogflowcx_v3.types.EntityTypeEntities 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).