Dialogflow API C++ Client  2.1.0
A C++ Client Library for the Dialogflow API
Public Member Functions | Friends | List of all members
google::cloud::dialogflow_cx::AgentsClient Class Reference

Service for managing [Agents][google.cloud.dialogflow.cx.v3.Agent]. More...

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

Public Member Functions

 AgentsClient (std::shared_ptr< AgentsConnection > connection, Options opts={})
 
 ~AgentsClient ()
 
 AgentsClient (AgentsClient const &)=default
 
AgentsClientoperator= (AgentsClient const &)=default
 
 AgentsClient (AgentsClient &&)=default
 
AgentsClientoperator= (AgentsClient &&)=default
 
StreamRange< google::cloud::dialogflow::cx::v3::Agent > ListAgents (std::string const &parent, Options opts={})
 Returns the list of all agents in the specified location. More...
 
StreamRange< google::cloud::dialogflow::cx::v3::Agent > ListAgents (google::cloud::dialogflow::cx::v3::ListAgentsRequest request, Options opts={})
 Returns the list of all agents in the specified location. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::Agent > GetAgent (std::string const &name, Options opts={})
 Retrieves the specified agent. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::Agent > GetAgent (google::cloud::dialogflow::cx::v3::GetAgentRequest const &request, Options opts={})
 Retrieves the specified agent. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::Agent > CreateAgent (std::string const &parent, google::cloud::dialogflow::cx::v3::Agent const &agent, Options opts={})
 Creates an agent in the specified location. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::Agent > CreateAgent (google::cloud::dialogflow::cx::v3::CreateAgentRequest const &request, Options opts={})
 Creates an agent in the specified location. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::Agent > UpdateAgent (google::cloud::dialogflow::cx::v3::Agent const &agent, google::protobuf::FieldMask const &update_mask, Options opts={})
 Updates the specified agent. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::Agent > UpdateAgent (google::cloud::dialogflow::cx::v3::UpdateAgentRequest const &request, Options opts={})
 Updates the specified agent. More...
 
Status DeleteAgent (std::string const &name, Options opts={})
 Deletes the specified agent. More...
 
Status DeleteAgent (google::cloud::dialogflow::cx::v3::DeleteAgentRequest const &request, Options opts={})
 Deletes the specified agent. More...
 
future< StatusOr< google::cloud::dialogflow::cx::v3::ExportAgentResponse > > ExportAgent (google::cloud::dialogflow::cx::v3::ExportAgentRequest const &request, Options opts={})
 Exports the specified agent to a binary file. More...
 
future< StatusOr< google::protobuf::Struct > > RestoreAgent (google::cloud::dialogflow::cx::v3::RestoreAgentRequest const &request, Options opts={})
 Restores the specified agent from a binary file. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::AgentValidationResult > ValidateAgent (google::cloud::dialogflow::cx::v3::ValidateAgentRequest const &request, Options opts={})
 Validates the specified agent and creates or updates validation results. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::AgentValidationResult > GetAgentValidationResult (std::string const &name, Options opts={})
 Gets the latest agent validation result. More...
 
StatusOr< google::cloud::dialogflow::cx::v3::AgentValidationResult > GetAgentValidationResult (google::cloud::dialogflow::cx::v3::GetAgentValidationResultRequest const &request, Options opts={})
 Gets the latest agent validation result. More...
 

Friends

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

Detailed Description

Service for managing [Agents][google.cloud.dialogflow.cx.v3.Agent].

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 62 of file agents_client.h.

Constructor & Destructor Documentation

◆ AgentsClient() [1/3]

google::cloud::dialogflow_cx::AgentsClient::AgentsClient ( std::shared_ptr< AgentsConnection connection,
Options  opts = {} 
)
explicit

◆ ~AgentsClient()

google::cloud::dialogflow_cx::AgentsClient::~AgentsClient ( )

◆ AgentsClient() [2/3]

google::cloud::dialogflow_cx::AgentsClient::AgentsClient ( AgentsClient const &  )
default

◆ AgentsClient() [3/3]

google::cloud::dialogflow_cx::AgentsClient::AgentsClient ( AgentsClient &&  )
default

Member Function Documentation

◆ CreateAgent() [1/2]

StatusOr<google::cloud::dialogflow::cx::v3::Agent> google::cloud::dialogflow_cx::AgentsClient::CreateAgent ( google::cloud::dialogflow::cx::v3::CreateAgentRequest const &  request,
Options  opts = {} 
)

Creates an agent in the specified location.

Note: You should always train flows prior to sending them queries. See the training documentation.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::CreateAgentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Agent

◆ CreateAgent() [2/2]

StatusOr<google::cloud::dialogflow::cx::v3::Agent> google::cloud::dialogflow_cx::AgentsClient::CreateAgent ( std::string const &  parent,
google::cloud::dialogflow::cx::v3::Agent const &  agent,
Options  opts = {} 
)

Creates an agent in the specified location.

Note: You should always train flows prior to sending them queries. See the training documentation.

Parameters
parentRequired. The location to create a agent for. Format: projects/<Project ID>/locations/<Location ID>.
agentRequired. The agent to create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Agent

◆ DeleteAgent() [1/2]

Status google::cloud::dialogflow_cx::AgentsClient::DeleteAgent ( google::cloud::dialogflow::cx::v3::DeleteAgentRequest const &  request,
Options  opts = {} 
)

Deletes the specified agent.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::DeleteAgentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteAgent() [2/2]

Status google::cloud::dialogflow_cx::AgentsClient::DeleteAgent ( std::string const &  name,
Options  opts = {} 
)

Deletes the specified agent.

Parameters
nameRequired. The name of the agent to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ ExportAgent()

future<StatusOr<google::cloud::dialogflow::cx::v3::ExportAgentResponse> > google::cloud::dialogflow_cx::AgentsClient::ExportAgent ( google::cloud::dialogflow::cx::v3::ExportAgentRequest const &  request,
Options  opts = {} 
)

Exports the specified agent to a binary file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Parameters
requestgoogle::cloud::dialogflow::cx::v3::ExportAgentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::ExportAgentResponse

◆ GetAgent() [1/2]

StatusOr<google::cloud::dialogflow::cx::v3::Agent> google::cloud::dialogflow_cx::AgentsClient::GetAgent ( google::cloud::dialogflow::cx::v3::GetAgentRequest const &  request,
Options  opts = {} 
)

Retrieves the specified agent.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::GetAgentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Agent

◆ GetAgent() [2/2]

StatusOr<google::cloud::dialogflow::cx::v3::Agent> google::cloud::dialogflow_cx::AgentsClient::GetAgent ( std::string const &  name,
Options  opts = {} 
)

Retrieves the specified agent.

Parameters
nameRequired. The name of the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Agent

◆ GetAgentValidationResult() [1/2]

StatusOr<google::cloud::dialogflow::cx::v3::AgentValidationResult> google::cloud::dialogflow_cx::AgentsClient::GetAgentValidationResult ( google::cloud::dialogflow::cx::v3::GetAgentValidationResultRequest const &  request,
Options  opts = {} 
)

Gets the latest agent validation result.

Agent validation is performed when ValidateAgent is called.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::GetAgentValidationResultRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::AgentValidationResult

◆ GetAgentValidationResult() [2/2]

StatusOr<google::cloud::dialogflow::cx::v3::AgentValidationResult> google::cloud::dialogflow_cx::AgentsClient::GetAgentValidationResult ( std::string const &  name,
Options  opts = {} 
)

Gets the latest agent validation result.

Agent validation is performed when ValidateAgent is called.

Parameters
nameRequired. The agent name. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/validationResult.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::AgentValidationResult

◆ ListAgents() [1/2]

StreamRange<google::cloud::dialogflow::cx::v3::Agent> google::cloud::dialogflow_cx::AgentsClient::ListAgents ( google::cloud::dialogflow::cx::v3::ListAgentsRequest  request,
Options  opts = {} 
)

Returns the list of all agents in the specified location.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::ListAgentsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Agent

◆ ListAgents() [2/2]

StreamRange<google::cloud::dialogflow::cx::v3::Agent> google::cloud::dialogflow_cx::AgentsClient::ListAgents ( std::string const &  parent,
Options  opts = {} 
)

Returns the list of all agents in the specified location.

Parameters
parentRequired. The location to list all agents for. Format: projects/<Project ID>/locations/<Location ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Agent

◆ operator=() [1/2]

AgentsClient& google::cloud::dialogflow_cx::AgentsClient::operator= ( AgentsClient &&  )
default

◆ operator=() [2/2]

AgentsClient& google::cloud::dialogflow_cx::AgentsClient::operator= ( AgentsClient const &  )
default

◆ RestoreAgent()

future<StatusOr<google::protobuf::Struct> > google::cloud::dialogflow_cx::AgentsClient::RestoreAgent ( google::cloud::dialogflow::cx::v3::RestoreAgentRequest const &  request,
Options  opts = {} 
)

Restores the specified agent from a binary file.

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train flows prior to sending them queries. See the training documentation.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::RestoreAgentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::protobuf::Struct

◆ UpdateAgent() [1/2]

StatusOr<google::cloud::dialogflow::cx::v3::Agent> google::cloud::dialogflow_cx::AgentsClient::UpdateAgent ( google::cloud::dialogflow::cx::v3::Agent const &  agent,
google::protobuf::FieldMask const &  update_mask,
Options  opts = {} 
)

Updates the specified agent.

Note: You should always train flows prior to sending them queries. See the training documentation.

Parameters
agentRequired. The agent to update.
update_maskThe mask to control which fields get updated. If the mask is not present, all fields will be updated.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Agent

◆ UpdateAgent() [2/2]

StatusOr<google::cloud::dialogflow::cx::v3::Agent> google::cloud::dialogflow_cx::AgentsClient::UpdateAgent ( google::cloud::dialogflow::cx::v3::UpdateAgentRequest const &  request,
Options  opts = {} 
)

Updates the specified agent.

Note: You should always train flows prior to sending them queries. See the training documentation.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::UpdateAgentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Agent

◆ ValidateAgent()

StatusOr<google::cloud::dialogflow::cx::v3::AgentValidationResult> google::cloud::dialogflow_cx::AgentsClient::ValidateAgent ( google::cloud::dialogflow::cx::v3::ValidateAgentRequest const &  request,
Options  opts = {} 
)

Validates the specified agent and creates or updates validation results.

The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::ValidateAgentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::AgentValidationResult

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( AgentsClient const &  a,
AgentsClient const &  b 
)
friend

Definition at line 81 of file agents_client.h.

◆ operator==

bool operator== ( AgentsClient const &  a,
AgentsClient const &  b 
)
friend

Definition at line 78 of file agents_client.h.