Class SessionsClient (2.0.0) 

SessionsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflowcx_v3beta1.services.sessions.transports.base.SessionsTransport, typing.Callable[[...], google.cloud.dialogflowcx_v3beta1.services.sessions.transports.base.SessionsTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

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

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

SessionsClient

SessionsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflowcx_v3beta1.services.sessions.transports.base.SessionsTransport, typing.Callable[[...], google.cloud.dialogflowcx_v3beta1.services.sessions.transports.base.SessionsTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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 Optional[Union[str,SessionsTransport,Callable[..., SessionsTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the SessionsTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS 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. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

cancel_operation

cancel_operation(     request: typing.Optional[         google.longrunning.operations_pb2.CancelOperationRequest     ] = None,     *,     retry: typing.Optional[         typing.Union[             google.api_core.retry.retry_unary.Retry,             google.api_core.gapic_v1.method._MethodDefault,         ]     ] = _MethodDefault._DEFAULT_VALUE,     timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,     metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

data_store_path

data_store_path(project: str, location: str, data_store: str) -> str

Returns a fully-qualified data_store string.

detect_intent

detect_intent(     request: typing.Optional[         typing.Union[             google.cloud.dialogflowcx_v3beta1.types.session.DetectIntentRequest, dict         ]     ] = None,     *,     retry: typing.Optional[         typing.Union[             google.api_core.retry.retry_unary.Retry,             google.api_core.gapic_v1.method._MethodDefault,         ]     ] = _MethodDefault._DEFAULT_VALUE,     timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,     metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.dialogflowcx_v3beta1.types.session.DetectIntentResponse

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

# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service #   client as shown in: #   https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import dialogflowcx_v3beta1  def sample_detect_intent():     # Create a client     client = dialogflowcx_v3beta1.SessionsClient()      # Initialize request argument(s)     query_input = dialogflowcx_v3beta1.QueryInput()     query_input.text.text = "text_value"     query_input.language_code = "language_code_value"      request = dialogflowcx_v3beta1.DetectIntentRequest(         session="session_value",         query_input=query_input,     )      # Make the request     response = client.detect_intent(request=request)      # Handle the response     print(response)
Parameters
Name Description
request Union[google.cloud.dialogflowcx_v3beta1.types.DetectIntentRequest, dict]

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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
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) -> str

Returns a fully-qualified entity_type string.

example_path

example_path(     project: str, location: str, agent: str, playbook: str, example: str ) -> str

Returns a fully-qualified example string.

flow_path

flow_path(project: str, location: str, agent: str, flow: str) -> 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: typing.Optional[         typing.Union[             google.cloud.dialogflowcx_v3beta1.types.session.FulfillIntentRequest, dict         ]     ] = None,     *,     retry: typing.Optional[         typing.Union[             google.api_core.retry.retry_unary.Retry,             google.api_core.gapic_v1.method._MethodDefault,         ]     ] = _MethodDefault._DEFAULT_VALUE,     timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,     metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.dialogflowcx_v3beta1.types.session.FulfillIntentResponse

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

# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service #   client as shown in: #   https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import dialogflowcx_v3beta1  def sample_fulfill_intent():     # Create a client     client = dialogflowcx_v3beta1.SessionsClient()      # Initialize request argument(s)     request = dialogflowcx_v3beta1.FulfillIntentRequest(     )      # Make the request     response = client.fulfill_intent(request=request)      # Handle the response     print(response)
Parameters
Name Description
request Union[google.cloud.dialogflowcx_v3beta1.types.FulfillIntentRequest, dict]

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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.dialogflowcx_v3beta1.types.FulfillIntentResponse Response of [FulfillIntent][]

generator_path

generator_path(project: str, location: str, agent: str, generator: str) -> str

Returns a fully-qualified generator string.

get_location

get_location(     request: typing.Optional[         google.cloud.location.locations_pb2.GetLocationRequest     ] = None,     *,     retry: typing.Optional[         typing.Union[             google.api_core.retry.retry_unary.Retry,             google.api_core.gapic_v1.method._MethodDefault,         ]     ] = _MethodDefault._DEFAULT_VALUE,     timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,     metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name Description
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.location_pb2.Location Location object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(     client_options: typing.Optional[         google.api_core.client_options.ClientOptions     ] = None, )

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(     request: typing.Optional[         google.longrunning.operations_pb2.GetOperationRequest     ] = None,     *,     retry: typing.Optional[         typing.Union[             google.api_core.retry.retry_unary.Retry,             google.api_core.gapic_v1.method._MethodDefault,         ]     ] = _MethodDefault._DEFAULT_VALUE,     timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,     metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.Operation An Operation object.

intent_path

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

Returns a fully-qualified intent string.

list_locations

list_locations(     request: typing.Optional[         google.cloud.location.locations_pb2.ListLocationsRequest     ] = None,     *,     retry: typing.Optional[         typing.Union[             google.api_core.retry.retry_unary.Retry,             google.api_core.gapic_v1.method._MethodDefault,         ]     ] = _MethodDefault._DEFAULT_VALUE,     timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,     metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name Description
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_operations

list_operations(     request: typing.Optional[         google.longrunning.operations_pb2.ListOperationsRequest     ] = None,     *,     retry: typing.Optional[         typing.Union[             google.api_core.retry.retry_unary.Retry,             google.api_core.gapic_v1.method._MethodDefault,         ]     ] = _MethodDefault._DEFAULT_VALUE,     timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,     metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

match_intent

match_intent(     request: typing.Optional[         typing.Union[             google.cloud.dialogflowcx_v3beta1.types.session.MatchIntentRequest, dict         ]     ] = None,     *,     retry: typing.Optional[         typing.Union[             google.api_core.retry.retry_unary.Retry,             google.api_core.gapic_v1.method._MethodDefault,         ]     ] = _MethodDefault._DEFAULT_VALUE,     timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,     metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.dialogflowcx_v3beta1.types.session.MatchIntentResponse

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

# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service #   client as shown in: #   https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import dialogflowcx_v3beta1  def sample_match_intent():     # Create a client     client = dialogflowcx_v3beta1.SessionsClient()      # Initialize request argument(s)     query_input = dialogflowcx_v3beta1.QueryInput()     query_input.text.text = "text_value"     query_input.language_code = "language_code_value"      request = dialogflowcx_v3beta1.MatchIntentRequest(         session="session_value",         query_input=query_input,     )      # Make the request     response = client.match_intent(request=request)      # Handle the response     print(response)
Parameters
Name Description
request Union[google.cloud.dialogflowcx_v3beta1.types.MatchIntentRequest, dict]

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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
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) -> str

Returns a fully-qualified page string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_data_store_path

parse_data_store_path(path: str) -> typing.Dict[str, str]

Parses a data_store path into its component segments.

parse_entity_type_path

parse_entity_type_path(path: str) -> typing.Dict[str, str]

Parses a entity_type path into its component segments.

parse_example_path

parse_example_path(path: str) -> typing.Dict[str, str]

Parses a example path into its component segments.

parse_flow_path

parse_flow_path(path: str) -> typing.Dict[str, str]

Parses a flow path into its component segments.

parse_generator_path

parse_generator_path(path: str) -> typing.Dict[str, str]

Parses a generator path into its component segments.

parse_intent_path

parse_intent_path(path: str) -> typing.Dict[str, str]

Parses a intent path into its component segments.

parse_page_path

parse_page_path(path: str) -> typing.Dict[str, str]

Parses a page path into its component segments.

parse_playbook_path

parse_playbook_path(path: str) -> typing.Dict[str, str]

Parses a playbook path into its component segments.

parse_session_entity_type_path

parse_session_entity_type_path(path: str) -> typing.Dict[str, str]

Parses a session_entity_type path into its component segments.

parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

parse_tool_path

parse_tool_path(path: str) -> typing.Dict[str, str]

Parses a tool path into its component segments.

parse_transition_route_group_path

parse_transition_route_group_path(path: str) -> typing.Dict[str, str]

Parses a transition_route_group path into its component segments.

parse_version_path

parse_version_path(path: str) -> typing.Dict[str, str]

Parses a version path into its component segments.

parse_webhook_path

parse_webhook_path(path: str) -> typing.Dict[str, str]

Parses a webhook path into its component segments.

playbook_path

playbook_path(project: str, location: str, agent: str, playbook: str) -> str

Returns a fully-qualified playbook string.

server_streaming_detect_intent

server_streaming_detect_intent(     request: typing.Optional[         typing.Union[             google.cloud.dialogflowcx_v3beta1.types.session.DetectIntentRequest, dict         ]     ] = None,     *,     retry: typing.Optional[         typing.Union[             google.api_core.retry.retry_unary.Retry,             google.api_core.gapic_v1.method._MethodDefault,         ]     ] = _MethodDefault._DEFAULT_VALUE,     timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,     metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> typing.Iterable[     google.cloud.dialogflowcx_v3beta1.types.session.DetectIntentResponse ]

Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses <https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response>__ earlier in a single request.

# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service #   client as shown in: #   https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import dialogflowcx_v3beta1  def sample_server_streaming_detect_intent():     # Create a client     client = dialogflowcx_v3beta1.SessionsClient()      # Initialize request argument(s)     query_input = dialogflowcx_v3beta1.QueryInput()     query_input.text.text = "text_value"     query_input.language_code = "language_code_value"      request = dialogflowcx_v3beta1.DetectIntentRequest(         session="session_value",         query_input=query_input,     )      # Make the request     stream = client.server_streaming_detect_intent(request=request)      # Handle the response     for response in stream:         print(response)
Parameters
Name Description
request Union[google.cloud.dialogflowcx_v3beta1.types.DetectIntentRequest, dict]

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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
Iterable[google.cloud.dialogflowcx_v3beta1.types.DetectIntentResponse] The message returned from the DetectIntent method.

session_entity_type_path

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

Returns a fully-qualified session_entity_type string.

session_path

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

Returns a fully-qualified session string.

streaming_detect_intent

streaming_detect_intent(     requests: typing.Optional[         typing.Iterator[             google.cloud.dialogflowcx_v3beta1.types.session.StreamingDetectIntentRequest         ]     ] = None,     *,     retry: typing.Optional[         typing.Union[             google.api_core.retry.retry_unary.Retry,             google.api_core.gapic_v1.method._MethodDefault,         ]     ] = _MethodDefault._DEFAULT_VALUE,     timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,     metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> typing.Iterable[     google.cloud.dialogflowcx_v3beta1.types.session.StreamingDetectIntentResponse ]

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

# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service #   client as shown in: #   https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import dialogflowcx_v3beta1  def sample_streaming_detect_intent():     # Create a client     client = dialogflowcx_v3beta1.SessionsClient()      # Initialize request argument(s)     query_input = dialogflowcx_v3beta1.QueryInput()     query_input.text.text = "text_value"     query_input.language_code = "language_code_value"      request = dialogflowcx_v3beta1.StreamingDetectIntentRequest(         query_input=query_input,     )      # This method expects an iterator which contains     # 'dialogflowcx_v3beta1.StreamingDetectIntentRequest' objects     # Here we create a generator that yields a single `request` for     # demonstrative purposes.     requests = [request]      def request_generator():         for request in requests:             yield request      # Make the request     stream = client.streaming_detect_intent(requests=request_generator())      # Handle the response     for response in stream:         print(response)
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
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: - If the StreamingDetectIntentRequest.query_input.audio field was set, the first M 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. - If the StreamingDetectIntentRequest.enable_partial_response field was true, the detect_intent_response field is populated for each of the following N responses, where 0 <= n=""><= 5.="" these="" responses="" set="" the="">DetectIntentResponse.response_type field to PARTIAL. For the last response message, the detect_intent_response is fully populated, and DetectIntentResponse.response_type is set to FINAL.

submit_answer_feedback

submit_answer_feedback(     request: typing.Optional[         typing.Union[             google.cloud.dialogflowcx_v3beta1.types.session.SubmitAnswerFeedbackRequest,             dict,         ]     ] = None,     *,     retry: typing.Optional[         typing.Union[             google.api_core.retry.retry_unary.Retry,             google.api_core.gapic_v1.method._MethodDefault,         ]     ] = _MethodDefault._DEFAULT_VALUE,     timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,     metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.dialogflowcx_v3beta1.types.session.AnswerFeedback

Updates the feedback received from the user for a single turn of the bot response.

# This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service #   client as shown in: #   https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import dialogflowcx_v3beta1  def sample_submit_answer_feedback():     # Create a client     client = dialogflowcx_v3beta1.SessionsClient()      # Initialize request argument(s)     request = dialogflowcx_v3beta1.SubmitAnswerFeedbackRequest(         session="session_value",         response_id="response_id_value",     )      # Make the request     response = client.submit_answer_feedback(request=request)      # Handle the response     print(response)
Parameters
Name Description
request Union[google.cloud.dialogflowcx_v3beta1.types.SubmitAnswerFeedbackRequest, dict]

The request object. The request to set the feedback for a bot answer.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.dialogflowcx_v3beta1.types.AnswerFeedback Stores information about feedback provided by users about a response.

tool_path

tool_path(project: str, location: str, agent: str, tool: str) -> str

Returns a fully-qualified tool string.

transition_route_group_path

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.

version_path

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

Returns a fully-qualified version string.

webhook_path

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

Returns a fully-qualified webhook string.