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.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
SessionsClient(SessionsClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SessionsClient const &
|
SessionsClient(SessionsClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SessionsClient &&
|
SessionsClient(std::shared_ptr< SessionsConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< SessionsConnection >
|
opts |
Options
|
Operators
operator=(SessionsClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SessionsClient const &
|
| Returns | |
|---|---|
| Type | Description |
SessionsClient & |
|
operator=(SessionsClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
SessionsClient &&
|
| Returns | |
|---|---|
| Type | Description |
SessionsClient & |
|
Functions
DetectIntent(google::cloud::dialogflow::cx::v3::DetectIntentRequest const &, Options)
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 | |
|---|---|
| Name | Description |
request |
google::cloud::dialogflow::cx::v3::DetectIntentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::DetectIntentResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.DetectIntentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
AsyncStreamingDetectIntent(Options)
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.
| Parameter | |
|---|---|
| Name | Description |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc< google::cloud::dialogflow::cx::v3::StreamingDetectIntentRequest, google::cloud::dialogflow::cx::v3::StreamingDetectIntentResponse > > |
An object representing the bidirectional streaming RPC. Applications can send multiple request messages and receive multiple response messages through this API. Bidirectional streaming RPCs can impose restrictions on the sequence of request and response messages. Please consult the service documentation for details. The request message type (google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest) and response messages (google.cloud.dialogflow.cx.v3.StreamingDetectIntentResponse) are mapped to C++ classes using the Protobuf mapping rules. |
MatchIntent(google::cloud::dialogflow::cx::v3::MatchIntentRequest const &, Options)
Returns preliminary intent match results, doesn't change the session status.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dialogflow::cx::v3::MatchIntentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::MatchIntentResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.MatchIntentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
FulfillIntent(google::cloud::dialogflow::cx::v3::FulfillIntentRequest const &, Options)
Fulfills a matched intent returned by MatchIntent.
Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::dialogflow::cx::v3::FulfillIntentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::FulfillIntentResponse > |
the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.FulfillIntentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |