Class SessionsClient (1.2.0)

SessionsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3beta1.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 method to determine user intent and respond.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`SessionsTransport`	The transport used by the client instance.

Methods

SessionsClient

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

Instantiates 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`	`google.api_core.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.
`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.

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.

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.

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

Parameters
Name	Description
`request`	`google.cloud.dialogflowcx_v3beta1.types.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
`google.cloud.dialogflowcx_v3beta1.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.

flow_path

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

Returns a fully-qualified flow string.

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
`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.

Parameter
Name	Description
`info`	`dict` The service account private key info.

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.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`SessionsClient`	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`	`google.cloud.dialogflowcx_v3beta1.types.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
`google.cloud.dialogflowcx_v3beta1.types.FulfillIntentResponse`	Response of [FulfillIntent][]

intent_path

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

Returns 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`	`google.cloud.dialogflowcx_v3beta1.types.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
`google.cloud.dialogflowcx_v3beta1.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.

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_entity_type_path

parse_entity_type_path(path: str)

Parses a entity_type path into its component segments.

parse_flow_path

parse_flow_path(path: str)

Parses a flow path into its component segments.

parse_intent_path

parse_intent_path(path: str)

Parses a intent path into its component segments.

parse_page_path

parse_page_path(path: str)

Parses a page 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.

parse_session_path

parse_session_path(path: str)

Parses a session path into its component segments.

parse_transition_route_group_path

parse_transition_route_group_path(path: str)

Parses a transition_route_group path into its component segments.

parse_version_path

parse_version_path(path: str)

Parses a version path into its component segments.

parse_webhook_path

parse_webhook_path(path: str)

Parses a webhook path into its component segments.

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.

session_path

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

Returns a fully-qualified session string.

streaming_detect_intent

streaming_detect_intent(requests: Optional[Iterator[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).

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

Parameters
Name	Description
`requests`	`Iterator[google.cloud.dialogflowcx_v3beta1.types.StreamingDetectIntentRequest]` The request object iterator. 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

Iterable[google.cloud.dialogflowcx_v3beta1.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.

version_path

version_path(project: str, location: str, agent: str, flow: str, version: str)

Returns a fully-qualified version string.

webhook_path

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

Returns a fully-qualified webhook string.