Class SessionEntityTypesAsyncClient (2.14.1)

SessionEntityTypesAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflow_v2.services.session_entity_types.transports.base.SessionEntityTypesTransport] = '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 SessionEntityTypes.

Inheritance

builtins.object > SessionEntityTypesAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
SessionEntityTypesTransportThe transport used by the client instance.

Methods

SessionEntityTypesAsyncClient

SessionEntityTypesAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflow_v2.services.session_entity_types.transports.base.SessionEntityTypesTransport] = '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 session 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, `.SessionEntityTypesTransport`]

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
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf 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_session_entity_type

create_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2.types.session_entity_type.CreateSessionEntityTypeRequest, dict]] = None, *, parent: Optional[str] = None, session_entity_type: Optional[google.cloud.dialogflow_v2.types.session_entity_type.SessionEntityType] = 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 a session entity type. If the specified session entity type already exists, overrides the session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

from google.cloud import dialogflow_v2

async def sample_create_session_entity_type():
    # Create a client
    client = dialogflow_v2.SessionEntityTypesAsyncClient()

    # Initialize request argument(s)
    session_entity_type = dialogflow_v2.SessionEntityType()
    session_entity_type.name = "name_value"
    session_entity_type.entity_override_mode = "ENTITY_OVERRIDE_MODE_SUPPLEMENT"
    session_entity_type.entities.value = "value_value"
    session_entity_type.entities.synonyms = ['synonyms_value_1', 'synonyms_value_2']

    request = dialogflow_v2.CreateSessionEntityTypeRequest(
        parent="parent_value",
        session_entity_type=session_entity_type,
    )

    # Make the request
    response = await client.create_session_entity_type(request=request)

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

The request object. The request message for SessionEntityTypes.CreateSessionEntityType.

parent `str`

Required. The session to create a session entity type for. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

session_entity_type SessionEntityType

Required. The session entity type to create. This corresponds to the session_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.dialogflow_v2.types.SessionEntityTypeA session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](\ https://cloud.google.com/dialogflow/docs/entities-session).

delete_session_entity_type

delete_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2.types.session_entity_type.DeleteSessionEntityTypeRequest, 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 session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

from google.cloud import dialogflow_v2

async def sample_delete_session_entity_type():
    # Create a client
    client = dialogflow_v2.SessionEntityTypesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2.DeleteSessionEntityTypeRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_session_entity_type(request=request)
Parameters
NameDescription
request Union[google.cloud.dialogflow_v2.types.DeleteSessionEntityTypeRequest, dict]

The request object. The request message for SessionEntityTypes.DeleteSessionEntityType.

name `str`

Required. The name of the entity type to delete. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. 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.

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
SessionEntityTypesAsyncClientThe 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
SessionEntityTypesAsyncClientThe 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
SessionEntityTypesAsyncClientThe constructed client.

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.

get_session_entity_type

get_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2.types.session_entity_type.GetSessionEntityTypeRequest, 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 session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

from google.cloud import dialogflow_v2

async def sample_get_session_entity_type():
    # Create a client
    client = dialogflow_v2.SessionEntityTypesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2.GetSessionEntityTypeRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_session_entity_type(request=request)

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

The request object. The request message for SessionEntityTypes.GetSessionEntityType.

name `str`

Required. The name of the session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. 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.dialogflow_v2.types.SessionEntityTypeA session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](\ https://cloud.google.com/dialogflow/docs/entities-session).

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_session_entity_types

list_session_entity_types(request: Optional[Union[google.cloud.dialogflow_v2.types.session_entity_type.ListSessionEntityTypesRequest, 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 session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

from google.cloud import dialogflow_v2

async def sample_list_session_entity_types():
    # Create a client
    client = dialogflow_v2.SessionEntityTypesAsyncClient()

    # Initialize request argument(s)
    request = dialogflow_v2.ListSessionEntityTypesRequest(
        parent="parent_value",
    )

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

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

The request object. The request message for SessionEntityTypes.ListSessionEntityTypes.

parent `str`

Required. The session to list all session entity types from. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. 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.dialogflow_v2.services.session_entity_types.pagers.ListSessionEntityTypesAsyncPagerThe response message for SessionEntityTypes.ListSessionEntityTypes. 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_session_entity_type_path

parse_session_entity_type_path(path: str)

Parses a session_entity_type path into its component segments.

session_entity_type_path

session_entity_type_path(project: str, session: str, entity_type: str)

Returns a fully-qualified session_entity_type string.

update_session_entity_type

update_session_entity_type(request: Optional[Union[google.cloud.dialogflow_v2.types.session_entity_type.UpdateSessionEntityTypeRequest, dict]] = None, *, session_entity_type: Optional[google.cloud.dialogflow_v2.types.session_entity_type.SessionEntityType] = 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 session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

from google.cloud import dialogflow_v2

async def sample_update_session_entity_type():
    # Create a client
    client = dialogflow_v2.SessionEntityTypesAsyncClient()

    # Initialize request argument(s)
    session_entity_type = dialogflow_v2.SessionEntityType()
    session_entity_type.name = "name_value"
    session_entity_type.entity_override_mode = "ENTITY_OVERRIDE_MODE_SUPPLEMENT"
    session_entity_type.entities.value = "value_value"
    session_entity_type.entities.synonyms = ['synonyms_value_1', 'synonyms_value_2']

    request = dialogflow_v2.UpdateSessionEntityTypeRequest(
        session_entity_type=session_entity_type,
    )

    # Make the request
    response = await client.update_session_entity_type(request=request)

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

The request object. The request message for SessionEntityTypes.UpdateSessionEntityType.

session_entity_type SessionEntityType

Required. The session entity type to update. This corresponds to the session_entity_type field on the request instance; if request is provided, this should not be set.

update_mask `google.protobuf.field_mask_pb2.FieldMask`

Optional. 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.dialogflow_v2.types.SessionEntityTypeA session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](\ https://cloud.google.com/dialogflow/docs/entities-session).