SessionsClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
A session represents an interaction with a user. You retrieve user input
and pass it to the DetectIntent
(or StreamingDetectIntent
)
method to determine user intent and respond.
Methods
SessionsClient
SessionsClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
Constructor.
Parameters | |
---|---|
Name | Description |
channel |
grpc.Channel
DEPRECATED. A |
credentials |
google.auth.credentials.Credentials
The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to |
client_config |
dict
DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is 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 |
client_options |
Union[dict, google.api_core.client_options.ClientOptions]
Client options used to set user options on the client. API Endpoint should be set through client_options. |
detect_intent
detect_intent(session, query_input, query_params=None, output_audio_config=None, output_audio_config_mask=None, input_audio=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
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.
.. rubric:: Example
import dialogflow_v2
client = dialogflow_v2.SessionsClient()
session = client.session_path('[PROJECT]', '[SESSION]')
TODO: Initialize
query_input
:query_input = {}
response = client.detect_intent(session, query_input)
Parameters | |
---|---|
Name | Description |
session |
str
Required. The name of the session this query is sent to. Format: |
query_input |
Union[dict, 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. If a dict is provided, it must be of the same form as the protobuf message QueryInput |
query_params |
Union[dict, QueryParameters]
The parameters of this query. If a dict is provided, it must be of the same form as the protobuf message QueryParameters |
output_audio_config |
Union[dict, OutputAudioConfig]
Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated. If a dict is provided, it must be of the same form as the protobuf message OutputAudioConfig |
output_audio_config_mask |
Union[dict, FieldMask]
Mask for |
input_audio |
bytes
The natural language speech audio to be processed. This field should be populated iff |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
from_service_account_file
from_service_account_file(filename, *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 |
dialogflow_v2.SessionsClient | The constructed client. |
from_service_account_json
from_service_account_json(filename, *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 |
dialogflow_v2.SessionsClient | The constructed client. |
session_path
session_path(project, session)
Return a fully-qualified session string.
streaming_detect_intent
streaming_detect_intent(requests, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
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).
.. rubric:: Example
import dialogflow_v2
client = dialogflow_v2.SessionsClient()
TODO: Initialize
session
:session = ''
TODO: Initialize
query_input
:query_input = {} request = {'session': session, 'query_input': query_input}
requests = [request] for element in client.streaming_detect_intent(requests): ... # process element ... pass
Parameters | |
---|---|
Name | Description |
requests |
iterator[dict|google.cloud.dialogflow_v2.proto.session_pb2.StreamingDetectIntentRequest]
The input objects. If a dict is provided, it must be of the same form as the protobuf message StreamingDetectIntentRequest |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |