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 ()
	SessionsClient (SessionsClient const &)=default
SessionsClient &	operator= (SessionsClient const &)=default
	SessionsClient (SessionsClient &&)=default
SessionsClient &	operator= (SessionsClient &&)=default
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 (ExperimentalTag, 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][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent]. More...

Friends
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][google.cloud.dialogflow.cx.v3.Sessions.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.

Definition at line 65 of file sessions_client.h.

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	(	ExperimentalTag	,
		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.

Note

The presence of the ExperimentalTag means that this function is experimental. It is subject to change (including removal) without notice.

Parameters

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

Returns

A bidirectional streaming interface with request (write) type: google::cloud::dialogflow::cx::v3::StreamingDetectIntentRequest and response (read) type: google::cloud::dialogflow::cx::v3::StreamingDetectIntentResponse

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	google::cloud::dialogflow::cx::v3::DetectIntentRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::dialogflow::cx::v3::DetectIntentResponse

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][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent].

Must be called after [MatchIntent][google.cloud.dialogflow.cx.v3.Sessions.MatchIntent], with input from [MatchIntentResponse][google.cloud.dialogflow.cx.v3.MatchIntentResponse]. Otherwise, the behavior is undefined.

Parameters

request	google::cloud::dialogflow::cx::v3::FulfillIntentRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::dialogflow::cx::v3::FulfillIntentResponse

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	google::cloud::dialogflow::cx::v3::MatchIntentRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::dialogflow::cx::v3::MatchIntentResponse

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

Definition at line 84 of file sessions_client.h.

operator==

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

friend

Definition at line 81 of file sessions_client.h.