Dialogflow API C++ Client  2.4.0
A C++ Client Library for the Dialogflow API
Public Member Functions | Friends | List of all members
google::cloud::dialogflow_es::SessionsClient Class Reference

A service used for session interactions. More...

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

Public Member Functions

 SessionsClient (std::shared_ptr< SessionsConnection > connection, Options opts={})
 
 ~SessionsClient ()
 
 SessionsClient (SessionsClient const &)=default
 
SessionsClientoperator= (SessionsClient const &)=default
 
 SessionsClient (SessionsClient &&)=default
 
SessionsClientoperator= (SessionsClient &&)=default
 
StatusOr< google::cloud::dialogflow::v2::DetectIntentResponse > DetectIntent (std::string const &session, google::cloud::dialogflow::v2::QueryInput const &query_input, Options opts={})
 Processes a natural language query and returns structured, actionable data as a result. More...
 
StatusOr< google::cloud::dialogflow::v2::DetectIntentResponse > DetectIntent (google::cloud::dialogflow::v2::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::v2::StreamingDetectIntentRequest, google::cloud::dialogflow::v2::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...
 

Friends

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

Detailed Description

A service used for session interactions.

For more information, see the API interactions guide.

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_es::SessionsClient::SessionsClient ( std::shared_ptr< SessionsConnection connection,
Options  opts = {} 
)
explicit

◆ ~SessionsClient()

google::cloud::dialogflow_es::SessionsClient::~SessionsClient ( )

◆ SessionsClient() [2/3]

google::cloud::dialogflow_es::SessionsClient::SessionsClient ( SessionsClient const &  )
default

◆ SessionsClient() [3/3]

google::cloud::dialogflow_es::SessionsClient::SessionsClient ( SessionsClient &&  )
default

Member Function Documentation

◆ AsyncStreamingDetectIntent()

std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc< google::cloud::dialogflow::v2::StreamingDetectIntentRequest, google::cloud::dialogflow::v2::StreamingDetectIntentResponse> > google::cloud::dialogflow_es::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).

If you might use Agent Assist or other CCAI products now or in the future, consider using [StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.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.

Note
The presence of the ExperimentalTag means that this function is experimental. It is subject to change (including removal) without notice.
Parameters
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
A bidirectional streaming interface with request (write) type: google::cloud::dialogflow::v2::StreamingDetectIntentRequest and response (read) type: google::cloud::dialogflow::v2::StreamingDetectIntentResponse

◆ DetectIntent() [1/2]

StatusOr<google::cloud::dialogflow::v2::DetectIntentResponse> google::cloud::dialogflow_es::SessionsClient::DetectIntent ( google::cloud::dialogflow::v2::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 contexts and session entity types to be updated, which in turn might affect results of future queries.

If you might use Agent Assist or other CCAI products now or in the future, consider using [AnalyzeContent][google.cloud.dialogflow.v2.Participants.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.

Parameters
requestgoogle::cloud::dialogflow::v2::DetectIntentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::DetectIntentResponse

◆ DetectIntent() [2/2]

StatusOr<google::cloud::dialogflow::v2::DetectIntentResponse> google::cloud::dialogflow_es::SessionsClient::DetectIntent ( std::string const &  session,
google::cloud::dialogflow::v2::QueryInput const &  query_input,
Options  opts = {} 
)

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 or other CCAI products now or in the future, consider using [AnalyzeContent][google.cloud.dialogflow.v2.Participants.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.

Parameters
sessionRequired. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters. For more information, see the API interactions guide. Note: Always use agent versions for production traffic. See Versions and environments.
query_inputRequired. 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.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::DetectIntentResponse

◆ operator=() [1/2]

SessionsClient& google::cloud::dialogflow_es::SessionsClient::operator= ( SessionsClient &&  )
default

◆ operator=() [2/2]

SessionsClient& google::cloud::dialogflow_es::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.