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
GetAgent(std::string const &, Options)
Retrieves the specified agent.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project that the agent to fetch is associated with. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::Agent > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAgent(google::cloud::dialogflow::v2::GetAgentRequest const &, Options)
Retrieves the specified agent.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::GetAgentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::Agent > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetAgent(google::cloud::dialogflow::v2::Agent const &, Options)
Creates/updates the specified agent.
Note: You should always train an agent prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
agent |
google::cloud::dialogflow::v2::Agent const &
Required. The agent to update. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::Agent > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetAgent(google::cloud::dialogflow::v2::SetAgentRequest const &, Options)
Creates/updates the specified agent.
Note: You should always train an agent prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::SetAgentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::Agent > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteAgent(std::string const &, Options)
Deletes the specified agent.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project that the agent to delete is associated with. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteAgent(google::cloud::dialogflow::v2::DeleteAgentRequest const &, Options)
Deletes the specified agent.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::DeleteAgentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
SearchAgents(std::string const &, Options)
Returns the list of agents.
Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project to list agents from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::v2::Agent > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchAgents(google::cloud::dialogflow::v2::SearchAgentsRequest, Options)
Returns the list of agents.
Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::SearchAgentsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::v2::Agent > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
TrainAgent(std::string const &, Options)
Trains the specified agent.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: An Empty message
Note: You should always train an agent prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project that the agent to train is associated with. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::protobuf::Struct > > |
A |
TrainAgent(google::cloud::dialogflow::v2::TrainAgentRequest const &, Options)
Trains the specified agent.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: An Empty message
Note: You should always train an agent prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::TrainAgentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::protobuf::Struct > > |
A |
ExportAgent(std::string const &, Options)
Exports the specified agent to a ZIP file.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: ExportAgentResponse
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project that the agent to export is associated with. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::ExportAgentResponse > > |
A |
ExportAgent(google::cloud::dialogflow::v2::ExportAgentRequest const &, Options)
Exports the specified agent to a ZIP file.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: ExportAgentResponse
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::ExportAgentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dialogflow::v2::ExportAgentResponse > > |
A |
ImportAgent(google::cloud::dialogflow::v2::ImportAgentRequest const &, Options)
Imports the specified agent from a ZIP file.
Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: An Empty message
The operation only tracks when importing is complete, not when it is done training.
Note: You should always train an agent prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::ImportAgentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::protobuf::Struct > > |
A |
RestoreAgent(google::cloud::dialogflow::v2::RestoreAgentRequest const &, Options)
Restores the specified agent from a ZIP file.
Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: An Empty message
The operation only tracks when restoring is complete, not when it is done training.
Note: You should always train an agent prior to sending it queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::RestoreAgentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::protobuf::Struct > > |
A |
GetValidationResult(google::cloud::dialogflow::v2::GetValidationResultRequest const &, Options)
Gets agent validation result.
Agent validation is performed during training time and is updated automatically when training is completed.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::v2::GetValidationResultRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::v2::ValidationResult > |
the result of the RPC. The response message type (google.cloud.dialogflow.v2.ValidationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |