Dialogflow API C++ Client 2.13.0
A C++ Client Library for the Dialogflow API
|
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) |
Service for managing Agents.
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.
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.
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.
|
explicit |
google::cloud::dialogflow_cx::AgentsClient::~AgentsClient | ( | ) |
|
default |
|
default |
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.
request | 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 | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
Status google::cloud::dialogflow_cx::AgentsClient::DeleteAgent | ( | google::cloud::dialogflow::cx::v3::DeleteAgentRequest const & | request, |
Options | opts = {} |
||
) |
Deletes the specified agent.
request | 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 | Optional. Override the class-level options, such as retry and backoff policies. |
Status google::cloud::dialogflow_cx::AgentsClient::DeleteAgent | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Deletes the specified agent.
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. |
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 messageresponse
: ExportAgentResponserequest | 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 | Optional. Override the class-level options, such as retry and backoff policies. |
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.
request | 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 | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::dialogflow::cx::v3::Agent > google::cloud::dialogflow_cx::AgentsClient::GetAgent | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Retrieves the specified agent.
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. |
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.
request | 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 | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | 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 | Optional. Override the class-level options, such as retry and backoff policies. |
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. 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.
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. |
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.
|
default |
|
default |
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 messageresponse
: An Empty messageNote: You should always train flows prior to sending them queries. See the training documentation.
request | 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 | Optional. Override the class-level options, such as retry and backoff policies. |
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.
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. |
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.
request | 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 | Optional. Override the class-level options, such as retry and backoff policies. |
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.
request | 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 | Optional. Override the class-level options, such as retry and backoff policies. |
|
friend |
|
friend |