Class SessionsClient (0.8.0)

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

A session represents an interaction with a user. You retrieve user input and pass it to the [DetectIntent][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent] method to determine user intent and respond.

Inheritance

builtins.object > SessionsClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
SessionsTransport	The transport used by the client instance.

Methods

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter

Name	Description
billing_account

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter

Name	Description
folder

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters

Name	Description
project
location

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter

Name	Description
organization

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter

Name	Description
project

detect_intent

detect_intent(request: Optional[google.cloud.dialogflowcx_v3.types.session.DetectIntentRequest] = None, *, retry: google.api_core.retry.Retry = <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.

Note: Always use agent versions for production traffic. See Versions and environments <https://cloud.google.com/dialogflow/cx/docs/concept/version>;__.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.DetectIntentRequest` The request object. The request to detect user's intent.

Returns

Type	Description
google.cloud.dialogflowcx_v3.types.DetectIntentResponse	The message returned from the DetectIntent method.

entity_type_path

entity_type_path(project: str, location: str, agent: str, entity_type: str)

Returns a fully-qualified entity_type string.

Parameters

Name	Description
project
location
agent
entity_type

flow_path

flow_path(project: str, location: str, agent: str, flow: str)

Returns a fully-qualified flow string.

Parameters

Name	Description
project
location
agent
flow

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters

Name	Description
filename	`str` The path to the service account private key json file.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
SessionsClient	The 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.

Parameters

Name	Description
info	`dict` The service account private key info.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
SessionsClient	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.

Parameters

Name	Description
filename	`str` The path to the service account private key json file.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
SessionsClient	The constructed client.

fulfill_intent

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

Fulfills a matched intent returned by [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent]. Must be called after [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent], with input from [MatchIntentResponse][google.cloud.dialogflow.cx.v3.MatchIntentResponse]. Otherwise, the behavior is undefined.

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.FulfillIntentRequest` The request object. Request of [FulfillIntent][]

Returns

Type	Description
google.cloud.dialogflowcx_v3.types.FulfillIntentResponse	Response of [FulfillIntent][]

intent_path

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

Returns a fully-qualified intent string.

Parameters

Name	Description
project
location
agent
intent

match_intent

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

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

Parameter

Name	Description
request	`google.cloud.dialogflowcx_v3.types.MatchIntentRequest` The request object. Request of [MatchIntent][].

Returns

Type	Description
google.cloud.dialogflowcx_v3.types.MatchIntentResponse	Response of [MatchIntent][].

page_path

page_path(project: str, location: str, agent: str, flow: str, page: str)

Returns a fully-qualified page string.

Parameters

Name	Description
project
location
agent
flow
page

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter

Name	Description
path

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter

Name	Description
path

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter

Name	Description
path

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter

Name	Description
path

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter

Name	Description
path

parse_entity_type_path

parse_entity_type_path(path: str)

Parses a entity_type path into its component segments.

Parameter

Name	Description
path

parse_flow_path

parse_flow_path(path: str)

Parses a flow path into its component segments.

Parameter

Name	Description
path

parse_intent_path

parse_intent_path(path: str)

Parses a intent path into its component segments.

Parameter

Name	Description
path

parse_page_path

parse_page_path(path: str)

Parses a page path into its component segments.

Parameter

Name	Description
path

parse_session_entity_type_path

parse_session_entity_type_path(path: str)

Parses a session_entity_type path into its component segments.

Parameter

Name	Description
path

parse_session_path

parse_session_path(path: str)

Parses a session path into its component segments.

Parameter

Name	Description
path

parse_transition_route_group_path

parse_transition_route_group_path(path: str)

Parses a transition_route_group path into its component segments.

Parameter

Name	Description
path

parse_webhook_path

parse_webhook_path(path: str)

Parses a webhook path into its component segments.

Parameter

Name	Description
path

session_entity_type_path

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

Returns a fully-qualified session_entity_type string.

Parameters

Name	Description
project
location
agent
session
entity_type

session_path

session_path(project: str, location: str, agent: str, session: str)

Returns a fully-qualified session string.

Parameters

Name	Description
project
location
agent
session

streaming_detect_intent

streaming_detect_intent(requests: Optional[Iterator[google.cloud.dialogflowcx_v3.types.session.StreamingDetectIntentRequest]] = None, *, retry: google.api_core.retry.Retry = <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).

Note: Always use agent versions for production traffic. See Versions and environments <https://cloud.google.com/dialogflow/cx/docs/concept/version>;__.

Parameter

Name Description

requests

Iterator[google.cloud.dialogflowcx_v3.types.StreamingDetectIntentRequest]

The request object iterator. The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent] method. Multiple request messages should be sent in order: 1. The first message must contain [session][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.session], [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] plus optionally [query_params][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_params]. If the client wants to receive an audio response, it should also contain [output_audio_config][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.output_audio_config]. 2. If [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] was set to [query_input.audio.config][google.cloud.dialogflow.cx.v3.AudioInput.config], all subsequent messages must contain [query_input.audio.audio][google.cloud.dialogflow.cx.v3.AudioInput.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][google.cloud.dialogflow.cx.v3.QueryInput.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.

Returns

Type

Description

Iterable[google.cloud.dialogflowcx_v3.types.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. If enable_partial_response is true, the following N messages (currently 1 <= n=""><= 4)="" contain="" detect_intent_response.="" the="" first="" (n-1)="" detect_intent_responses="" will="" have="" response_type="" set="" to="" partial.="" the="" last="" detect_intent_response="" has="" response_type="" set="" to="" final.="" if="" response_type="" is="" false,="" response="" stream="" only="" contains="" the="" final="">

transition_route_group_path

transition_route_group_path(project: str, location: str, agent: str, flow: str, transition_route_group: str)

Returns a fully-qualified transition_route_group string.

Parameters

Name	Description
project
location
agent
flow
transition_route_group

webhook_path

webhook_path(project: str, location: str, agent: str, webhook: str)

Returns a fully-qualified webhook string.

Parameters

Name	Description
project
location
agent
webhook