Dialogflow v3 API - Class AgentsClientImpl (2.16.0)

public sealed class AgentsClientImpl : AgentsClient

Reference documentation and code samples for the Dialogflow v3 API class AgentsClientImpl.

Agents client wrapper implementation, for convenient use.

Inheritance

object > AgentsClient > AgentsClientImpl

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Agents][google.cloud.dialogflow.cx.v3.Agent].

Constructors

AgentsClientImpl(AgentsClient, AgentsSettings, ILogger)

public AgentsClientImpl(Agents.AgentsClient grpcClient, AgentsSettings settings, ILogger logger)

Constructs a client wrapper for the Agents service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientAgentsAgentsClient

The underlying gRPC client.

settingsAgentsSettings

The base AgentsSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

ExportAgentOperationsClient

public override OperationsClient ExportAgentOperationsClient { get; }

The long-running operations client for ExportAgent.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override Agents.AgentsClient GrpcClient { get; }

The underlying gRPC Agents client

Property Value
TypeDescription
AgentsAgentsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

RestoreAgentOperationsClient

public override OperationsClient RestoreAgentOperationsClient { get; }

The long-running operations client for RestoreAgent.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

CreateAgent(CreateAgentRequest, CallSettings)

public override Agent CreateAgent(CreateAgentRequest request, CallSettings callSettings = null)

Creates an agent in the specified location.

Note: You should always train flows prior to sending them queries. See the training documentation.

Parameters
NameDescription
requestCreateAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Agent

The RPC response.

Overrides

CreateAgentAsync(CreateAgentRequest, CallSettings)

public override Task<Agent> CreateAgentAsync(CreateAgentRequest request, CallSettings callSettings = null)

Creates an agent in the specified location.

Note: You should always train flows prior to sending them queries. See the training documentation.

Parameters
NameDescription
requestCreateAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAgent

A Task containing the RPC response.

Overrides

DeleteAgent(DeleteAgentRequest, CallSettings)

public override void DeleteAgent(DeleteAgentRequest request, CallSettings callSettings = null)

Deletes the specified agent.

Parameters
NameDescription
requestDeleteAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteAgentAsync(DeleteAgentRequest, CallSettings)

public override Task DeleteAgentAsync(DeleteAgentRequest request, CallSettings callSettings = null)

Deletes the specified agent.

Parameters
NameDescription
requestDeleteAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

ExportAgent(ExportAgentRequest, CallSettings)

public override Operation<ExportAgentResponse, Struct> ExportAgent(ExportAgentRequest request, CallSettings callSettings = null)

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
NameDescription
requestExportAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationExportAgentResponseStruct

The RPC response.

Overrides

ExportAgentAsync(ExportAgentRequest, CallSettings)

public override Task<Operation<ExportAgentResponse, Struct>> ExportAgentAsync(ExportAgentRequest request, CallSettings callSettings = null)

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
NameDescription
requestExportAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationExportAgentResponseStruct

A Task containing the RPC response.

Overrides

GetAgent(GetAgentRequest, CallSettings)

public override Agent GetAgent(GetAgentRequest request, CallSettings callSettings = null)

Retrieves the specified agent.

Parameters
NameDescription
requestGetAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Agent

The RPC response.

Overrides

GetAgentAsync(GetAgentRequest, CallSettings)

public override Task<Agent> GetAgentAsync(GetAgentRequest request, CallSettings callSettings = null)

Retrieves the specified agent.

Parameters
NameDescription
requestGetAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAgent

A Task containing the RPC response.

Overrides

GetAgentValidationResult(GetAgentValidationResultRequest, CallSettings)

public override AgentValidationResult GetAgentValidationResult(GetAgentValidationResultRequest request, CallSettings callSettings = null)

Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.

Parameters
NameDescription
requestGetAgentValidationResultRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AgentValidationResult

The RPC response.

Overrides

GetAgentValidationResultAsync(GetAgentValidationResultRequest, CallSettings)

public override Task<AgentValidationResult> GetAgentValidationResultAsync(GetAgentValidationResultRequest request, CallSettings callSettings = null)

Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.

Parameters
NameDescription
requestGetAgentValidationResultRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAgentValidationResult

A Task containing the RPC response.

Overrides

GetGenerativeSettings(GetGenerativeSettingsRequest, CallSettings)

public override GenerativeSettings GetGenerativeSettings(GetGenerativeSettingsRequest request, CallSettings callSettings = null)

Gets the generative settings for the agent.

Parameters
NameDescription
requestGetGenerativeSettingsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GenerativeSettings

The RPC response.

Overrides

GetGenerativeSettingsAsync(GetGenerativeSettingsRequest, CallSettings)

public override Task<GenerativeSettings> GetGenerativeSettingsAsync(GetGenerativeSettingsRequest request, CallSettings callSettings = null)

Gets the generative settings for the agent.

Parameters
NameDescription
requestGetGenerativeSettingsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskGenerativeSettings

A Task containing the RPC response.

Overrides

ListAgents(ListAgentsRequest, CallSettings)

public override PagedEnumerable<ListAgentsResponse, Agent> ListAgents(ListAgentsRequest request, CallSettings callSettings = null)

Returns the list of all agents in the specified location.

Parameters
NameDescription
requestListAgentsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListAgentsResponseAgent

A pageable sequence of Agent resources.

Overrides

ListAgentsAsync(ListAgentsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAgentsResponse, Agent> ListAgentsAsync(ListAgentsRequest request, CallSettings callSettings = null)

Returns the list of all agents in the specified location.

Parameters
NameDescription
requestListAgentsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListAgentsResponseAgent

A pageable asynchronous sequence of Agent resources.

Overrides

RestoreAgent(RestoreAgentRequest, CallSettings)

public override Operation<Empty, Struct> RestoreAgent(RestoreAgentRequest request, CallSettings callSettings = null)

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:

Note: You should always train flows prior to sending them queries. See the training documentation.

Parameters
NameDescription
requestRestoreAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyStruct

The RPC response.

Overrides

RestoreAgentAsync(RestoreAgentRequest, CallSettings)

public override Task<Operation<Empty, Struct>> RestoreAgentAsync(RestoreAgentRequest request, CallSettings callSettings = null)

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:

Note: You should always train flows prior to sending them queries. See the training documentation.

Parameters
NameDescription
requestRestoreAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyStruct

A Task containing the RPC response.

Overrides

UpdateAgent(UpdateAgentRequest, CallSettings)

public override Agent UpdateAgent(UpdateAgentRequest request, CallSettings callSettings = null)

Updates the specified agent.

Note: You should always train flows prior to sending them queries. See the training documentation.

Parameters
NameDescription
requestUpdateAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Agent

The RPC response.

Overrides

UpdateAgentAsync(UpdateAgentRequest, CallSettings)

public override Task<Agent> UpdateAgentAsync(UpdateAgentRequest request, CallSettings callSettings = null)

Updates the specified agent.

Note: You should always train flows prior to sending them queries. See the training documentation.

Parameters
NameDescription
requestUpdateAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAgent

A Task containing the RPC response.

Overrides

UpdateGenerativeSettings(UpdateGenerativeSettingsRequest, CallSettings)

public override GenerativeSettings UpdateGenerativeSettings(UpdateGenerativeSettingsRequest request, CallSettings callSettings = null)

Updates the generative settings for the agent.

Parameters
NameDescription
requestUpdateGenerativeSettingsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GenerativeSettings

The RPC response.

Overrides

UpdateGenerativeSettingsAsync(UpdateGenerativeSettingsRequest, CallSettings)

public override Task<GenerativeSettings> UpdateGenerativeSettingsAsync(UpdateGenerativeSettingsRequest request, CallSettings callSettings = null)

Updates the generative settings for the agent.

Parameters
NameDescription
requestUpdateGenerativeSettingsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskGenerativeSettings

A Task containing the RPC response.

Overrides

ValidateAgent(ValidateAgentRequest, CallSettings)

public override AgentValidationResult ValidateAgent(ValidateAgentRequest request, CallSettings callSettings = null)

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
NameDescription
requestValidateAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AgentValidationResult

The RPC response.

Overrides

ValidateAgentAsync(ValidateAgentRequest, CallSettings)

public override Task<AgentValidationResult> ValidateAgentAsync(ValidateAgentRequest request, CallSettings callSettings = null)

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
NameDescription
requestValidateAgentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAgentValidationResult

A Task containing the RPC response.

Overrides