google::cloud::dialogflow_cx::SessionsClient Class Reference

A session represents an interaction with a user. More...

#include <google/cloud/dialogflow_cx/sessions_client.h>

Public Member Functions
	SessionsClient (std::shared_ptr< SessionsConnection > connection, Options opts={})
	~SessionsClient ()
StatusOr< google::cloud::dialogflow::cx::v3::DetectIntentResponse >	DetectIntent (google::cloud::dialogflow::cx::v3::DetectIntentRequest const &request, Options opts={})
	Processes a natural language query and returns structured, actionable data as a result. More...
std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc< google::cloud::dialogflow::cx::v3::StreamingDetectIntentRequest, google::cloud::dialogflow::cx::v3::StreamingDetectIntentResponse > >	AsyncStreamingDetectIntent (Options opts={})
	Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. More...
StatusOr< google::cloud::dialogflow::cx::v3::MatchIntentResponse >	MatchIntent (google::cloud::dialogflow::cx::v3::MatchIntentRequest const &request, Options opts={})
	Returns preliminary intent match results, doesn't change the session status. More...
StatusOr< google::cloud::dialogflow::cx::v3::FulfillIntentResponse >	FulfillIntent (google::cloud::dialogflow::cx::v3::FulfillIntentRequest const &request, Options opts={})
	Fulfills a matched intent returned by MatchIntent. More...
Copy and move support
	SessionsClient (SessionsClient const &)=default
SessionsClient &	operator= (SessionsClient const &)=default
	SessionsClient (SessionsClient &&)=default
SessionsClient &	operator= (SessionsClient &&)=default

Friends
Equality
bool	operator== (SessionsClient const &a, SessionsClient const &b)
bool	operator!= (SessionsClient const &a, SessionsClient const &b)

Detailed Description

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.

Constructor & Destructor Documentation

SessionsClient() [1/3]

google::cloud::dialogflow_cx::SessionsClient::SessionsClient ( std::shared_ptr< SessionsConnection >  connection, Options  opts = {}  )

explicit

~SessionsClient()

google::cloud::dialogflow_cx::SessionsClient::~SessionsClient

(

)

SessionsClient() [2/3]

google::cloud::dialogflow_cx::SessionsClient::SessionsClient ( SessionsClient const &  )

default

SessionsClient() [3/3]

google::cloud::dialogflow_cx::SessionsClient::SessionsClient ( SessionsClient &&  )

default

Member Function Documentation

AsyncStreamingDetectIntent()

std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc< google::cloud::dialogflow::cx::v3::StreamingDetectIntentRequest, google::cloud::dialogflow::cx::v3::StreamingDetectIntentResponse > > google::cloud::dialogflow_cx::SessionsClient::AsyncStreamingDetectIntent

(

Options

opts = {}

)

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

opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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.

DetectIntent()

StatusOr< google::cloud::dialogflow::cx::v3::DetectIntentResponse > google::cloud::dialogflow_cx::SessionsClient::DetectIntent	(	google::cloud::dialogflow::cx::v3::DetectIntentRequest const &	request,
		Options	opts = {}
	)

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

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.DetectIntentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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 `StatusOr` contains the error details.

FulfillIntent()

StatusOr< google::cloud::dialogflow::cx::v3::FulfillIntentResponse > google::cloud::dialogflow_cx::SessionsClient::FulfillIntent	(	google::cloud::dialogflow::cx::v3::FulfillIntentRequest const &	request,
		Options	opts = {}
	)

Fulfills a matched intent returned by MatchIntent.

Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.FulfillIntentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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 `StatusOr` contains the error details.

MatchIntent()

StatusOr< google::cloud::dialogflow::cx::v3::MatchIntentResponse > google::cloud::dialogflow_cx::SessionsClient::MatchIntent	(	google::cloud::dialogflow::cx::v3::MatchIntentRequest const &	request,
		Options	opts = {}
	)

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

Parameters

request	Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.MatchIntentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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 `StatusOr` contains the error details.

operator=() [1/2]

SessionsClient & google::cloud::dialogflow_cx::SessionsClient::operator= ( SessionsClient &&  )

default

operator=() [2/2]

SessionsClient & google::cloud::dialogflow_cx::SessionsClient::operator= ( SessionsClient const &  )

default

Friends And Related Function Documentation

operator!=

bool operator!= ( SessionsClient const &  a, SessionsClient const &  b  )

friend

operator==

bool operator== ( SessionsClient const &  a, SessionsClient const &  b  )

friend