Class SessionsAsyncClient (0.1.1)

Version 0.1.1

• 1.37.0 (latest)
• 1.36.0
• 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

SessionsAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.sessions.transports.base.SessionsTransport] = '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>)

A session represents an interaction with a user. You retrieve user input and pass it to the DetectIntent method to determine user intent and respond.

Methods

SessionsAsyncClient

SessionsAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.sessions.transports.base.SessionsTransport] = '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>)

Instantiate the sessions 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, .SessionsTransport] 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.

Exceptions
Type	Description
google.auth.exceptions.MutualTlsChannelError	If mutual TLS transport creation failed for any reason.

detect_intent

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

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.

Parameters
Name	Description
request	.session.DetectIntentRequest The request object. The request to detect user's intent.
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.DetectIntentResponse	The message returned from the DetectIntent method.

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.

fulfill_intent

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

Fulfills a matched intent returned by xref_MatchIntent. Must be called after xref_MatchIntent, with input from xref_MatchIntentResponse. Otherwise, the behavior is undefined.

Parameters
Name	Description
request	.session.FulfillIntentRequest The request object. Request of [FulfillIntent][]
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.FulfillIntentResponse	Response of [FulfillIntent][]

get_transport_class

get_transport_class()

Return an appropriate transport class.

intent_path

intent_path(project: str, location: str, agent: str, intent: str)

Return a fully-qualified intent string.

match_intent

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

Returns preliminary intent match results, doesn't change the session status.

Parameters
Name	Description
request	.session.MatchIntentRequest The request object. Request of [MatchIntent][].
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.MatchIntentResponse	Response of [MatchIntent][].

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.

streaming_detect_intent

streaming_detect_intent(requests: Optional[AsyncIterator[google.cloud.dialogflowcx_v3beta1.types.session.StreamingDetectIntentRequest]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).

Parameters
Name	Description
requests	AsyncIterator[.session.StreamingDetectIntentRequest] The request object AsyncIterator. The top-level message sent by the client to the Sessions.StreamingDetectIntent method. Multiple request messages should be sent in order: 1. The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config. 2. If query_input was set to query_input.audio.config, all subsequent messages must contain query_input.audio.audio to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with query_input.text. However, note that: * Dialogflow will bill you for the audio duration so far. * Dialogflow discards all Speech recognition results in favor of the input text. * Dialogflow will use the language code from the first message. After you sent all input, you must half-close or abort the request stream.
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
AsyncIterable[.session.StreamingDetectIntentResponse]	The top-level message returned from the StreamingDetectIntent method. Multiple response messages can be returned in order: 1. If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true. 2. The last message contains detect_intent_response.