SessionsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflow_v2beta1.services.sessions.transports.base.SessionsTransport] = 'grpc_asyncio', 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 service used for session interactions.
For more information, see the API interactions
guide <https://cloud.google.com/dialogflow/docs/api-overview>__.
Inheritance
builtins.object > SessionsAsyncClientProperties
transport
Returns the transport used by the client instance.
| Type | Description |
| SessionsTransport | The transport used by the client instance. |
Methods
SessionsAsyncClient
SessionsAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflow_v2beta1.services.sessions.transports.base.SessionsTransport] = 'grpc_asyncio', 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.
| 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 |
| 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.
context_path
context_path(project: str, session: str, context: str)Returns a fully-qualified context string.
detect_intent
detect_intent(request: Optional[Union[google.cloud.dialogflow_v2beta1.types.session.DetectIntentRequest, dict]] = None, *, session: Optional[str] = None, query_input: Optional[google.cloud.dialogflow_v2beta1.types.session.QueryInput] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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 contexts and session entity types to be updated, which in turn might affect results of future queries.
If you might use Agent
Assist <https://cloud.google.com/dialogflow/docs/#aa>__ or
other CCAI products now or in the future, consider using
xref_AnalyzeContent
instead of DetectIntent. AnalyzeContent has additional
functionality for Agent Assist and other CCAI products.
Note: Always use agent versions for production traffic. See
Versions and
environments <https://cloud.google.com/dialogflow/es/docs/agents-versions>__.
from google.cloud import dialogflow_v2beta1
async def sample_detect_intent():
# Create a client
client = dialogflow_v2beta1.SessionsAsyncClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.DetectIntentRequest(
session="session_value",
)
# Make the request
response = await client.detect_intent(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.dialogflow_v2beta1.types.DetectIntentRequest, dict]
The request object. The request to detect user's intent. |
| session |
`str`
Required. The name of the session this query is sent to. Supported formats: - `projects//agent/sessions/, - |
| query_input |
QueryInput
Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger. This corresponds to the |
| 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. |
| Type | Description |
| google.cloud.dialogflow_v2beta1.types.DetectIntentResponse | The message returned from the DetectIntent method. |
document_path
document_path(project: str, knowledge_base: str, document: str)Returns a fully-qualified document string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| SessionsAsyncClient | 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.
| Name | Description |
| info |
dict
The service account private key info. |
| Type | Description |
| SessionsAsyncClient | 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.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| SessionsAsyncClient | The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)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 variabel 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.
| Name | Description |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
| Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()Returns an appropriate transport class.
intent_path
intent_path(project: str, intent: str)Returns a fully-qualified intent 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_context_path
parse_context_path(path: str)Parses a context path into its component segments.
parse_document_path
parse_document_path(path: str)Parses a document path into its component segments.
parse_intent_path
parse_intent_path(path: str)Parses a intent 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.
session_entity_type_path
session_entity_type_path(project: str, session: str, entity_type: str)Returns a fully-qualified session_entity_type string.
session_path
session_path(project: str, session: str)Returns a fully-qualified session string.
streaming_detect_intent
streaming_detect_intent(requests: Optional[AsyncIterator[google.cloud.dialogflow_v2beta1.types.session.StreamingDetectIntentRequest]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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).
If you might use Agent
Assist <https://cloud.google.com/dialogflow/docs/#aa>__ or
other CCAI products now or in the future, consider using
xref_StreamingAnalyzeContent
instead of StreamingDetectIntent.
StreamingAnalyzeContent has additional functionality for
Agent Assist and other CCAI products.
Note: Always use agent versions for production traffic. See
Versions and
environments <https://cloud.google.com/dialogflow/es/docs/agents-versions>__.
from google.cloud import dialogflow_v2beta1
async def sample_streaming_detect_intent():
# Create a client
client = dialogflow_v2beta1.SessionsAsyncClient()
# Initialize request argument(s)
request = dialogflow_v2beta1.StreamingDetectIntentRequest(
session="session_value",
)
# This method expects an iterator which contains
# 'dialogflow_v2beta1.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 = await client.streaming_detect_intent(requests=request_generator())
# Handle the response
async for response in stream:
print(response)
| Name | Description |
| requests |
AsyncIterator[`google.cloud.dialogflow_v2beta1.types.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. The message must not contain input_audio. 2. If query_input was set to query_input.audio_config, all subsequent messages must contain input_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. |
| Type | Description |
| AsyncIterable[google.cloud.dialogflow_v2beta1.types.StreamingDetectIntentResponse] | The top-level message returned from the StreamingDetectIntent method. Multiple response messages can be returned in order: 1. If the StreamingDetectIntentRequest.input_audio field was set, the recognition_result field is populated for one or more messages. See the StreamingRecognitionResult message for details about the result message sequence. 2. The next message contains response_id, query_result, alternative_query_results and optionally webhook_status if a WebHook was called. 3. If output_audio_config was specified in the request or agent-level speech synthesizer is configured, all subsequent messages contain output_audio and output_audio_config. |