Class AgentsClient (2.27.0)

Version 2.27.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

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.

Constructors

AgentsClient(AgentsClient const &)

Copy and move support

Parameter
Name	Description
	AgentsClient const &

AgentsClient(AgentsClient &&)

Copy and move support

Parameter
Name	Description
	AgentsClient &&

AgentsClient(std::shared_ptr< AgentsConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< AgentsConnection >
opts	Options

Operators

operator=(AgentsClient const &)

Copy and move support

Parameter
Name	Description
	AgentsClient const &

Returns
Type	Description
AgentsClient &

operator=(AgentsClient &&)

Copy and move support

Parameter
Name	Description
	AgentsClient &&

Returns
Type	Description
AgentsClient &

Functions

ListAgents(std::string const &, Options)

Returns the list of all agents in the specified location.

Parameters
Name	Description
parent	std::string const & Required. The location to list all agents for. Format: projects/<ProjectID>/locations/<LocationID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::Agent >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.cx.v3.Agent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAgents(google::cloud::dialogflow::cx::v3::ListAgentsRequest, Options)

Returns the list of all agents in the specified location.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ListAgentsRequest 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.ListAgentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::Agent >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.cx.v3.Agent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetAgent(std::string const &, Options)

Retrieves the specified agent.

Parameters
Name	Description
name	std::string const & Required. The name of the agent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Agent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAgent(google::cloud::dialogflow::cx::v3::GetAgentRequest const &, Options)

Retrieves the specified agent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::GetAgentRequest const & 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.GetAgentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Agent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateAgent(std::string const &, google::cloud::dialogflow::cx::v3::Agent const &, Options)

Creates an agent in the specified location.

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

Parameters
Name	Description
parent	std::string const & Required. The location to create a agent for. Format: projects/<ProjectID>/locations/<LocationID>.
agent	google::cloud::dialogflow::cx::v3::Agent const & Required. The agent to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Agent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateAgent(google::cloud::dialogflow::cx::v3::CreateAgentRequest const &, Options)

Creates an agent in the specified location.

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

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::CreateAgentRequest const & 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.CreateAgentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Agent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateAgent(google::cloud::dialogflow::cx::v3::Agent const &, google::protobuf::FieldMask const &, Options)

Updates the specified agent.

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

Parameters
Name	Description
agent	google::cloud::dialogflow::cx::v3::Agent const & Required. The agent to update.
update_mask	google::protobuf::FieldMask const & The mask to control which fields get updated. If the mask is not present, all fields will be updated.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Agent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateAgent(google::cloud::dialogflow::cx::v3::UpdateAgentRequest const &, Options)

Updates the specified agent.

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

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::UpdateAgentRequest const & 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.UpdateAgentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Agent >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteAgent(std::string const &, Options)

Deletes the specified agent.

Parameters
Name	Description
name	std::string const & Required. The name of the agent to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteAgent(google::cloud::dialogflow::cx::v3::DeleteAgentRequest const &, Options)

Deletes the specified agent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::DeleteAgentRequest const & 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.DeleteAgentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

ExportAgent(google::cloud::dialogflow::cx::v3::ExportAgentRequest const &, Options)

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
Name	Description
request	google::cloud::dialogflow::cx::v3::ExportAgentRequest const & 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.ExportAgentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dialogflow::cx::v3::ExportAgentResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.cx.v3.ExportAgentResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportAgent(NoAwaitTag, google::cloud::dialogflow::cx::v3::ExportAgentRequest const &, Options)

Exports the specified agent to a binary file.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::dialogflow::cx::v3::ExportAgentRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

ExportAgent(google::longrunning::Operation const &, Options)

Exports the specified agent to a binary file.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::dialogflow::cx::v3::ExportAgentResponse > >

RestoreAgent(google::cloud::dialogflow::cx::v3::RestoreAgentRequest const &, Options)

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
Name	Description
request	google::cloud::dialogflow::cx::v3::RestoreAgentRequest const & 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.RestoreAgentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::protobuf::Struct > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RestoreAgent(NoAwaitTag, google::cloud::dialogflow::cx::v3::RestoreAgentRequest const &, Options)

Restores the specified agent from a binary file.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::dialogflow::cx::v3::RestoreAgentRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

RestoreAgent(google::longrunning::Operation const &, Options)

Restores the specified agent from a binary file.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::protobuf::Struct > >

ValidateAgent(google::cloud::dialogflow::cx::v3::ValidateAgentRequest const &, Options)

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
Name	Description
request	google::cloud::dialogflow::cx::v3::ValidateAgentRequest const & 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.ValidateAgentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::AgentValidationResult >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.AgentValidationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAgentValidationResult(std::string const &, Options)

Gets the latest agent validation result.

Agent validation is performed when ValidateAgent is called.

Parameters
Name	Description
name	std::string const & Required. The agent name. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/validationResult.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::AgentValidationResult >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.AgentValidationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAgentValidationResult(google::cloud::dialogflow::cx::v3::GetAgentValidationResultRequest const &, Options)

Gets the latest agent validation result.

Agent validation is performed when ValidateAgent is called.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::GetAgentValidationResultRequest const & 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.GetAgentValidationResultRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::AgentValidationResult >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.AgentValidationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetGenerativeSettings(std::string const &, std::string const &, Options)

Gets the generative settings for the agent.

Parameters
Name	Description
name	std::string const & Required. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/generativeSettings.
language_code	std::string const & Required. Language code of the generative settings.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::GenerativeSettings >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.GenerativeSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetGenerativeSettings(google::cloud::dialogflow::cx::v3::GetGenerativeSettingsRequest const &, Options)

Gets the generative settings for the agent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::GetGenerativeSettingsRequest const & 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.GetGenerativeSettingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::GenerativeSettings >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.GenerativeSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateGenerativeSettings(google::cloud::dialogflow::cx::v3::GenerativeSettings const &, google::protobuf::FieldMask const &, Options)

Updates the generative settings for the agent.

Parameters
Name	Description
generative_settings	google::cloud::dialogflow::cx::v3::GenerativeSettings const & Required. Generative settings to update.
update_mask	google::protobuf::FieldMask const & Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::GenerativeSettings >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.GenerativeSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateGenerativeSettings(google::cloud::dialogflow::cx::v3::UpdateGenerativeSettingsRequest const &, Options)

Updates the generative settings for the agent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::UpdateGenerativeSettingsRequest const & 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.UpdateGenerativeSettingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::GenerativeSettings >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.GenerativeSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.