Class SessionEntityTypesClient (0.1.1)

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, .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 environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the `api_endpoint` property takes precedence if provided. (2) The `client_cert_source` property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.
`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
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`	`.gcdc_session_entity_type.CreateSessionEntityTypeRequest` The request object. The request message for SessionEntityTypes.CreateSessionEntityType.
`parent`	`str` Required. The session to create a session entity type for. Format: `projects/` or `projects/`. If `Environment ID` is not specified, we assume default 'draft' environment. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`session_entity_type`	`.gcdc_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

Type Description

.gcdc_session_entity_type.SessionEntityType 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`	`.session_entity_type.DeleteSessionEntityTypeRequest` The request object. The request message for SessionEntityTypes.DeleteSessionEntityType.
`name`	`str` Required. The name of the session entity type to delete. Format: `projects/` or `projects/`. If `Environment ID` is not specified, we assume default 'draft' environment. 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
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`	`.session_entity_type.GetSessionEntityTypeRequest` The request object. The request message for SessionEntityTypes.GetSessionEntityType.
`name`	`str` Required. The name of the session entity type. Format: `projects/` or `projects/`. If `Environment ID` is not specified, we assume default 'draft' environment. 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

.session_entity_type.SessionEntityType 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`	`.session_entity_type.ListSessionEntityTypesRequest` The request object. The request message for SessionEntityTypes.ListSessionEntityTypes.
`parent`	`str` Required. The session to list all session entity types from. Format: `projects/` or `projects/`. If `Environment ID` is not specified, we assume default 'draft' environment. 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
`.pagers.ListSessionEntityTypesPager`	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`	`.gcdc_session_entity_type.UpdateSessionEntityTypeRequest` The request object. The request message for SessionEntityTypes.UpdateSessionEntityType.
`session_entity_type`	`.gcdc_session_entity_type.SessionEntityType` Required. The session entity type to update. Format: `projects/` or `projects/`. If `Environment ID` is not specified, we assume default 'draft' environment. This corresponds to the `session_entity_type` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`.field_mask.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