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: |
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 |
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 |
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 |
GetAgent(std::string const &, Options)
Retrieves the specified agent.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the agent. Format: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 messageresponse
: 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 |
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 |
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 messageresponse
: 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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::protobuf::Struct > > |
A |
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 |
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 |
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: |
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 |
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 |
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 |
GetGenerativeSettings(std::string const &, std::string const &, Options)
Gets the generative settings for the agent.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Format: |
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 |
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 |
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 |
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 |
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 |
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 |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::ListLocationsRequest
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::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::GetLocationRequest 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::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
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::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest 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::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::CancelOperationRequest 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 |