Dialogflow v3 API - Class Agents.AgentsBase (2.20.0)

Version 2.20.0

• 2.21.0 (latest)
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[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

Inheritance

object > Agents.AgentsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

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 message
• response: [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 message
• response: 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).