Service for managing Agents. More...

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

Public Member Functions
	AgentsClient (std::shared_ptr< AgentsConnection > connection, Options opts={})

	~AgentsClient ()

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...

Copy and move support
	AgentsClient (AgentsClient const &)=default

AgentsClient &	operator= (AgentsClient const &)=default

	AgentsClient (AgentsClient &&)=default

AgentsClient &	operator= (AgentsClient &&)=default

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

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

Detailed Description

Service for managing Agents.

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

◆ 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

request	google::cloud::dialogflow::cx::v3::CreateAgentRequest
opts	Optional. 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

parent	Required. The location to create a agent for. Format: `projects/<Project ID>/locations/<Location ID>`.
agent	Required. The agent to create.
opts	Optional. 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

request	google::cloud::dialogflow::cx::v3::DeleteAgentRequest
opts	Optional. 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

name	Required. The name of the agent to delete. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
opts	Optional. 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:

metadata: An empty Struct message
response: ExportAgentResponse

Parameters

request	google::cloud::dialogflow::cx::v3::ExportAgentRequest
opts	Optional. 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

request	google::cloud::dialogflow::cx::v3::GetAgentRequest
opts	Optional. 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

name	Required. The name of the agent. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
opts	Optional. 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

request	google::cloud::dialogflow::cx::v3::GetAgentValidationResultRequest
opts	Optional. 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

name	Required. The agent name. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/validationResult`.
opts	Optional. 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

request	google::cloud::dialogflow::cx::v3::ListAgentsRequest
opts	Optional. 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

parent	Required. The location to list all agents for. Format: `projects/<Project ID>/locations/<Location ID>`.
opts	Optional. 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:

metadata: An empty Struct message
response: An Empty message

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

Parameters

request	google::cloud::dialogflow::cx::v3::RestoreAgentRequest
opts	Optional. 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

agent	Required. The agent to update.
update_mask	The mask to control which fields get updated. If the mask is not present, all fields will be updated.
opts	Optional. 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

request	google::cloud::dialogflow::cx::v3::UpdateAgentRequest
opts	Optional. 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

request	google::cloud::dialogflow::cx::v3::ValidateAgentRequest
opts	Optional. 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

◆ operator==

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

friend

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ AgentsClient() [1/3]

◆ ~AgentsClient()

◆ AgentsClient() [2/3]

◆ AgentsClient() [3/3]

Member Function Documentation

◆ CreateAgent() [1/2]

◆ CreateAgent() [2/2]

◆ DeleteAgent() [1/2]

◆ DeleteAgent() [2/2]

◆ ExportAgent()

◆ GetAgent() [1/2]

◆ GetAgent() [2/2]

◆ GetAgentValidationResult() [1/2]

◆ GetAgentValidationResult() [2/2]

◆ ListAgents() [1/2]

◆ ListAgents() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ RestoreAgent()

◆ UpdateAgent() [1/2]

◆ UpdateAgent() [2/2]

◆ ValidateAgent()

Friends And Related Function Documentation

◆ operator!=

◆ operator==