[BindServiceMethod(typeof(Agents), "BindService")]
public abstract class Agents.AgentsBase
Reference documentation and code samples for the Dialogflow v3 API class Agents.AgentsBase.
Base class for server-side implementations of Agents
Namespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Methods
CreateAgent(CreateAgentRequest, ServerCallContext)
public virtual Task<Agent> CreateAgent(CreateAgentRequest request, ServerCallContext context)
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 |
CreateAgentRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskAgent |
The response to send back to the client (wrapped by a task). |
DeleteAgent(DeleteAgentRequest, ServerCallContext)
public virtual Task<Empty> DeleteAgent(DeleteAgentRequest request, ServerCallContext context)
Deletes the specified agent.
Parameters | |
---|---|
Name | Description |
request |
DeleteAgentRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskEmpty |
The response to send back to the client (wrapped by a task). |
ExportAgent(ExportAgentRequest, ServerCallContext)
public virtual Task<Operation> ExportAgent(ExportAgentRequest request, ServerCallContext context)
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][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
Parameters | |
---|---|
Name | Description |
request |
ExportAgentRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskOperation |
The response to send back to the client (wrapped by a task). |
GetAgent(GetAgentRequest, ServerCallContext)
public virtual Task<Agent> GetAgent(GetAgentRequest request, ServerCallContext context)
Retrieves the specified agent.
Parameters | |
---|---|
Name | Description |
request |
GetAgentRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskAgent |
The response to send back to the client (wrapped by a task). |
GetAgentValidationResult(GetAgentValidationResultRequest, ServerCallContext)
public virtual Task<AgentValidationResult> GetAgentValidationResult(GetAgentValidationResultRequest request, ServerCallContext context)
Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
Parameters | |
---|---|
Name | Description |
request |
GetAgentValidationResultRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskAgentValidationResult |
The response to send back to the client (wrapped by a task). |
GetGenerativeSettings(GetGenerativeSettingsRequest, ServerCallContext)
public virtual Task<GenerativeSettings> GetGenerativeSettings(GetGenerativeSettingsRequest request, ServerCallContext context)
Gets the generative settings for the agent.
Parameters | |
---|---|
Name | Description |
request |
GetGenerativeSettingsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskGenerativeSettings |
The response to send back to the client (wrapped by a task). |
ListAgents(ListAgentsRequest, ServerCallContext)
public virtual Task<ListAgentsResponse> ListAgents(ListAgentsRequest request, ServerCallContext context)
Returns the list of all agents in the specified location.
Parameters | |
---|---|
Name | Description |
request |
ListAgentsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskListAgentsResponse |
The response to send back to the client (wrapped by a task). |
RestoreAgent(RestoreAgentRequest, ServerCallContext)
public virtual Task<Operation> RestoreAgent(RestoreAgentRequest request, ServerCallContext context)
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 |
RestoreAgentRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskOperation |
The response to send back to the client (wrapped by a task). |
UpdateAgent(UpdateAgentRequest, ServerCallContext)
public virtual Task<Agent> UpdateAgent(UpdateAgentRequest request, ServerCallContext context)
Updates the specified agent.
Note: You should always train flows prior to sending them queries. See the training documentation.
Parameters | |
---|---|
Name | Description |
request |
UpdateAgentRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskAgent |
The response to send back to the client (wrapped by a task). |
UpdateGenerativeSettings(UpdateGenerativeSettingsRequest, ServerCallContext)
public virtual Task<GenerativeSettings> UpdateGenerativeSettings(UpdateGenerativeSettingsRequest request, ServerCallContext context)
Updates the generative settings for the agent.
Parameters | |
---|---|
Name | Description |
request |
UpdateGenerativeSettingsRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskGenerativeSettings |
The response to send back to the client (wrapped by a task). |
ValidateAgent(ValidateAgentRequest, ServerCallContext)
public virtual Task<AgentValidationResult> ValidateAgent(ValidateAgentRequest request, ServerCallContext context)
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 |
ValidateAgentRequest The request received from the client. |
context |
ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
TaskAgentValidationResult |
The response to send back to the client (wrapped by a task). |