As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Sessions

class google.cloud.dialogflowcx_v3.services.sessions.SessionsAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.sessions.transports.base.SessionsTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/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>)[source]

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.

Instantiates the sessions client.

Parameters
  • 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_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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async 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]] = ())google.cloud.dialogflowcx_v3.types.session.DetectIntentResponse[source]

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.

Parameters
Returns

The message returned from the DetectIntent method.

Return type

google.cloud.dialogflowcx_v3.types.DetectIntentResponse

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

Returns a fully-qualified entity_type string.

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

Returns a fully-qualified flow string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

SessionsAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • 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

The constructed client.

Return type

SessionsAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

SessionsAsyncClient

async 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]] = ())google.cloud.dialogflowcx_v3.types.session.FulfillIntentResponse[source]

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.

Parameters
Returns

Response of [FulfillIntent][]

Return type

google.cloud.dialogflowcx_v3.types.FulfillIntentResponse

get_transport_class()Type[google.cloud.dialogflowcx_v3.services.sessions.transports.base.SessionsTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

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

Returns a fully-qualified intent string.

async 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]] = ())google.cloud.dialogflowcx_v3.types.session.MatchIntentResponse[source]

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

Parameters
Returns

Response of [MatchIntent][].

Return type

google.cloud.dialogflowcx_v3.types.MatchIntentResponse

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

Returns a fully-qualified page string.

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_entity_type_path(path: str)Dict[str, str]

Parses a entity_type path into its component segments.

static parse_flow_path(path: str)Dict[str, str]

Parses a flow path into its component segments.

static parse_intent_path(path: str)Dict[str, str]

Parses a intent path into its component segments.

static parse_page_path(path: str)Dict[str, str]

Parses a page path into its component segments.

static parse_session_entity_type_path(path: str)Dict[str, str]

Parses a session_entity_type path into its component segments.

static parse_session_path(path: str)Dict[str, str]

Parses a session path into its component segments.

static parse_transition_route_group_path(path: str)Dict[str, str]

Parses a transition_route_group path into its component segments.

static parse_version_path(path: str)Dict[str, str]

Parses a version path into its component segments.

static parse_webhook_path(path: str)Dict[str, str]

Parses a webhook path into its component segments.

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

Returns a fully-qualified session_entity_type string.

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

Returns a fully-qualified session string.

streaming_detect_intent(requests: Optional[AsyncIterator[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]] = ())Awaitable[AsyncIterable[google.cloud.dialogflowcx_v3.types.session.StreamingDetectIntentResponse]][source]

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.

Parameters
  • requests (AsyncIterator[google.cloud.dialogflowcx_v3.types.StreamingDetectIntentRequest]) –

    The request object AsyncIterator. 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.

  • 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

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

Return type

AsyncIterable[google.cloud.dialogflowcx_v3.types.StreamingDetectIntentResponse]

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

Returns a fully-qualified transition_route_group string.

property transport: google.cloud.dialogflowcx_v3.services.sessions.transports.base.SessionsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

SessionsTransport

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

Returns a fully-qualified version string.

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

Returns a fully-qualified webhook string.

class google.cloud.dialogflowcx_v3.services.sessions.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>)[source]

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.

Instantiates the sessions client.

Parameters
  • 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

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]] = ())google.cloud.dialogflowcx_v3.types.session.DetectIntentResponse[source]

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.

Parameters
Returns

The message returned from the DetectIntent method.

Return type

google.cloud.dialogflowcx_v3.types.DetectIntentResponse

static entity_type_path(project: str, location: str, agent: str, entity_type: str)str[source]

Returns a fully-qualified entity_type string.

static flow_path(project: str, location: str, agent: str, flow: str)str[source]

Returns a fully-qualified flow string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

SessionsClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • 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

The constructed client.

Return type

SessionsClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • 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

The constructed client.

Return type

SessionsClient

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]] = ())google.cloud.dialogflowcx_v3.types.session.FulfillIntentResponse[source]

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.

Parameters
Returns

Response of [FulfillIntent][]

Return type

google.cloud.dialogflowcx_v3.types.FulfillIntentResponse

static intent_path(project: str, location: str, agent: str, intent: str)str[source]

Returns a fully-qualified intent string.

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]] = ())google.cloud.dialogflowcx_v3.types.session.MatchIntentResponse[source]

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

Parameters
Returns

Response of [MatchIntent][].

Return type

google.cloud.dialogflowcx_v3.types.MatchIntentResponse

static page_path(project: str, location: str, agent: str, flow: str, page: str)str[source]

Returns a fully-qualified page string.

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_entity_type_path(path: str)Dict[str, str][source]

Parses a entity_type path into its component segments.

static parse_flow_path(path: str)Dict[str, str][source]

Parses a flow path into its component segments.

static parse_intent_path(path: str)Dict[str, str][source]

Parses a intent path into its component segments.

static parse_page_path(path: str)Dict[str, str][source]

Parses a page path into its component segments.

static parse_session_entity_type_path(path: str)Dict[str, str][source]

Parses a session_entity_type path into its component segments.

static parse_session_path(path: str)Dict[str, str][source]

Parses a session path into its component segments.

static parse_transition_route_group_path(path: str)Dict[str, str][source]

Parses a transition_route_group path into its component segments.

static parse_version_path(path: str)Dict[str, str][source]

Parses a version path into its component segments.

static parse_webhook_path(path: str)Dict[str, str][source]

Parses a webhook path into its component segments.

static session_entity_type_path(project: str, location: str, agent: str, session: str, entity_type: str)str[source]

Returns a fully-qualified session_entity_type string.

static session_path(project: str, location: str, agent: str, session: str)str[source]

Returns a fully-qualified session string.

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]] = ())Iterable[google.cloud.dialogflowcx_v3.types.session.StreamingDetectIntentResponse][source]

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.

Parameters
  • 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.

  • 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

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

Return type

Iterable[google.cloud.dialogflowcx_v3.types.StreamingDetectIntentResponse]

static transition_route_group_path(project: str, location: str, agent: str, flow: str, transition_route_group: str)str[source]

Returns a fully-qualified transition_route_group string.

property transport: google.cloud.dialogflowcx_v3.services.sessions.transports.base.SessionsTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

SessionsTransport

static version_path(project: str, location: str, agent: str, flow: str, version: str)str[source]

Returns a fully-qualified version string.

static webhook_path(project: str, location: str, agent: str, webhook: str)str[source]

Returns a fully-qualified webhook string.