SessionEntityTypesClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.session_entity_types.transports.base.SessionEntityTypesTransport] = None, 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 SessionEntityTypes.
Methods
SessionEntityTypesClient
SessionEntityTypesClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.session_entity_types.transports.base.SessionEntityTypesTransport] = None, 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>)
Instantiate the session 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,
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 |
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
create_session_entity_type
create_session_entity_type(request: Optional[google.cloud.dialogflowcx_v3beta1.types.session_entity_type.CreateSessionEntityTypeRequest] = None, *, parent: Optional[str] = None, session_entity_type: Optional[google.cloud.dialogflowcx_v3beta1.types.session_entity_type.SessionEntityType] = None, retry: google.api_core.retry.Retry = <_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.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request message for SessionEntityTypes.CreateSessionEntityType. |
parent |
Required. The session to create a session entity type for. Format: |
session_entity_type |
Required. The session entity type to create. This corresponds to the |
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 |
| Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3beta1.EntityType] at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the Dialogflow documentation __. |
delete_session_entity_type
delete_session_entity_type(request: Optional[google.cloud.dialogflowcx_v3beta1.types.session_entity_type.DeleteSessionEntityTypeRequest] = 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 session entity type.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request message for SessionEntityTypes.DeleteSessionEntityType. |
name |
Required. The name of the session entity type to delete. Format: |
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 | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
{@api.name} | 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 |
{@api.name} | The constructed client. |
get_session_entity_type
get_session_entity_type(request: Optional[google.cloud.dialogflowcx_v3beta1.types.session_entity_type.GetSessionEntityTypeRequest] = 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 session entity type.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request message for SessionEntityTypes.GetSessionEntityType. |
name |
Required. The name of the session entity type. Format: |
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 |
| Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3beta1.EntityType] at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the Dialogflow documentation __. |
list_session_entity_types
list_session_entity_types(request: Optional[google.cloud.dialogflowcx_v3beta1.types.session_entity_type.ListSessionEntityTypesRequest] = 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 session entity types in the specified session.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request message for SessionEntityTypes.ListSessionEntityTypes. |
parent |
Required. The session to list all session entity types from. Format: |
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 |
| The response message for SessionEntityTypes.ListSessionEntityTypes. Iterating over this object will yield results and resolve additional pages automatically. |
parse_session_entity_type_path
parse_session_entity_type_path(path: str)
Parse a session_entity_type path into its component segments.
session_entity_type_path
session_entity_type_path(
project: str, location: str, agent: str, session: str, entity_type: str
)
Return a fully-qualified session_entity_type string.
update_session_entity_type
update_session_entity_type(request: Optional[google.cloud.dialogflowcx_v3beta1.types.session_entity_type.UpdateSessionEntityTypeRequest] = None, *, session_entity_type: Optional[google.cloud.dialogflowcx_v3beta1.types.session_entity_type.SessionEntityType] = 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 session entity type.
Parameters | |
---|---|
Name | Description |
request |
The request object. The request message for SessionEntityTypes.UpdateSessionEntityType. |
session_entity_type |
Required. The session entity type to update. Format: |
update_mask |
The mask to control which fields get updated. This corresponds to the |
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 |
| Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3beta1.EntityType] at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the Dialogflow documentation __. |