Dialogflow v3 API - Class AgentsClientImpl (2.17.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

Inherited Members

AgentsClient.DefaultEndpoint

AgentsClient.DefaultScopes

AgentsClient.ServiceMetadata

AgentsClient.CreateAsync(CancellationToken)

AgentsClient.Create()

AgentsClient.ShutdownDefaultChannelsAsync()

AgentsClient.ListAgents(string, string, int?, CallSettings)

AgentsClient.ListAgentsAsync(string, string, int?, CallSettings)

AgentsClient.ListAgents(LocationName, string, int?, CallSettings)

AgentsClient.ListAgentsAsync(LocationName, string, int?, CallSettings)

AgentsClient.GetAgentAsync(GetAgentRequest, CancellationToken)

AgentsClient.GetAgent(string, CallSettings)

AgentsClient.GetAgentAsync(string, CallSettings)

AgentsClient.GetAgentAsync(string, CancellationToken)

AgentsClient.GetAgent(AgentName, CallSettings)

AgentsClient.GetAgentAsync(AgentName, CallSettings)

AgentsClient.GetAgentAsync(AgentName, CancellationToken)

AgentsClient.CreateAgentAsync(CreateAgentRequest, CancellationToken)

AgentsClient.CreateAgent(string, Agent, CallSettings)

AgentsClient.CreateAgentAsync(string, Agent, CallSettings)

AgentsClient.CreateAgentAsync(string, Agent, CancellationToken)

AgentsClient.CreateAgent(LocationName, Agent, CallSettings)

AgentsClient.CreateAgentAsync(LocationName, Agent, CallSettings)

AgentsClient.CreateAgentAsync(LocationName, Agent, CancellationToken)

AgentsClient.UpdateAgentAsync(UpdateAgentRequest, CancellationToken)

AgentsClient.UpdateAgent(Agent, FieldMask, CallSettings)

AgentsClient.UpdateAgentAsync(Agent, FieldMask, CallSettings)

AgentsClient.UpdateAgentAsync(Agent, FieldMask, CancellationToken)

AgentsClient.DeleteAgentAsync(DeleteAgentRequest, CancellationToken)

AgentsClient.DeleteAgent(string, CallSettings)

AgentsClient.DeleteAgentAsync(string, CallSettings)

AgentsClient.DeleteAgentAsync(string, CancellationToken)

AgentsClient.DeleteAgent(AgentName, CallSettings)

AgentsClient.DeleteAgentAsync(AgentName, CallSettings)

AgentsClient.DeleteAgentAsync(AgentName, CancellationToken)

AgentsClient.ExportAgentAsync(ExportAgentRequest, CancellationToken)

AgentsClient.PollOnceExportAgent(string, CallSettings)

AgentsClient.PollOnceExportAgentAsync(string, CallSettings)

AgentsClient.RestoreAgentAsync(RestoreAgentRequest, CancellationToken)

AgentsClient.PollOnceRestoreAgent(string, CallSettings)

AgentsClient.PollOnceRestoreAgentAsync(string, CallSettings)

AgentsClient.ValidateAgentAsync(ValidateAgentRequest, CancellationToken)

AgentsClient.GetAgentValidationResultAsync(GetAgentValidationResultRequest, CancellationToken)

AgentsClient.GetAgentValidationResult(string, CallSettings)

AgentsClient.GetAgentValidationResultAsync(string, CallSettings)

AgentsClient.GetAgentValidationResultAsync(string, CancellationToken)

AgentsClient.GetAgentValidationResult(AgentValidationResultName, CallSettings)

AgentsClient.GetAgentValidationResultAsync(AgentValidationResultName, CallSettings)

AgentsClient.GetAgentValidationResultAsync(AgentValidationResultName, CancellationToken)

AgentsClient.GetGenerativeSettingsAsync(GetGenerativeSettingsRequest, CancellationToken)

AgentsClient.GetGenerativeSettings(string, string, CallSettings)

AgentsClient.GetGenerativeSettingsAsync(string, string, CallSettings)

AgentsClient.GetGenerativeSettingsAsync(string, string, CancellationToken)

AgentsClient.GetGenerativeSettings(AgentGenerativeSettingsName, string, CallSettings)

AgentsClient.GetGenerativeSettingsAsync(AgentGenerativeSettingsName, string, CallSettings)

AgentsClient.GetGenerativeSettingsAsync(AgentGenerativeSettingsName, string, CancellationToken)

AgentsClient.UpdateGenerativeSettingsAsync(UpdateGenerativeSettingsRequest, CancellationToken)

AgentsClient.UpdateGenerativeSettings(GenerativeSettings, FieldMask, CallSettings)

AgentsClient.UpdateGenerativeSettingsAsync(GenerativeSettings, FieldMask, CallSettings)

AgentsClient.UpdateGenerativeSettingsAsync(GenerativeSettings, FieldMask, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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
Name	Description
`grpcClient`	`AgentsAgentsClient` The underlying gRPC client.
`settings`	`AgentsSettings` The base AgentsSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

ExportAgentOperationsClient

public override OperationsClient ExportAgentOperationsClient { get; }

The long-running operations client for ExportAgent.

Property Value
Type	Description
`OperationsClient`

Overrides

AgentsClient.ExportAgentOperationsClient

GrpcClient

public override Agents.AgentsClient GrpcClient { get; }

The underlying gRPC Agents client

Property Value
Type	Description
`AgentsAgentsClient`

Overrides

AgentsClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

AgentsClient.LocationsClient

RestoreAgentOperationsClient

public override OperationsClient RestoreAgentOperationsClient { get; }

The long-running operations client for RestoreAgent.

Property Value
Type	Description
`OperationsClient`

Overrides

AgentsClient.RestoreAgentOperationsClient

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
Name	Description
`request`	`CreateAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Agent`	The RPC response.

Overrides

AgentsClient.CreateAgent(CreateAgentRequest, CallSettings)

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
Name	Description
`request`	`CreateAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskAgent`	A Task containing the RPC response.

Overrides

AgentsClient.CreateAgentAsync(CreateAgentRequest, CallSettings)

DeleteAgent(DeleteAgentRequest, CallSettings)

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

Deletes the specified agent.

Parameters
Name	Description
`request`	`DeleteAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

AgentsClient.DeleteAgent(DeleteAgentRequest, CallSettings)

DeleteAgentAsync(DeleteAgentRequest, CallSettings)

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

Deletes the specified agent.

Parameters
Name	Description
`request`	`DeleteAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Overrides

AgentsClient.DeleteAgentAsync(DeleteAgentRequest, CallSettings)

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
Name	Description
`request`	`ExportAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationExportAgentResponseStruct`	The RPC response.

Overrides

AgentsClient.ExportAgent(ExportAgentRequest, CallSettings)

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
Name	Description
`request`	`ExportAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationExportAgentResponseStruct`	A Task containing the RPC response.

Overrides

AgentsClient.ExportAgentAsync(ExportAgentRequest, CallSettings)

GetAgent(GetAgentRequest, CallSettings)

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

Retrieves the specified agent.

Parameters
Name	Description
`request`	`GetAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Agent`	The RPC response.

Overrides

AgentsClient.GetAgent(GetAgentRequest, CallSettings)

GetAgentAsync(GetAgentRequest, CallSettings)

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

Retrieves the specified agent.

Parameters
Name	Description
`request`	`GetAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskAgent`	A Task containing the RPC response.

Overrides

AgentsClient.GetAgentAsync(GetAgentRequest, CallSettings)

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
Name	Description
`request`	`GetAgentValidationResultRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`AgentValidationResult`	The RPC response.

Overrides

AgentsClient.GetAgentValidationResult(GetAgentValidationResultRequest, CallSettings)

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
Name	Description
`request`	`GetAgentValidationResultRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskAgentValidationResult`	A Task containing the RPC response.

Overrides

AgentsClient.GetAgentValidationResultAsync(GetAgentValidationResultRequest, CallSettings)

GetGenerativeSettings(GetGenerativeSettingsRequest, CallSettings)

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

Gets the generative settings for the agent.

Parameters
Name	Description
`request`	`GetGenerativeSettingsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`GenerativeSettings`	The RPC response.

Overrides

AgentsClient.GetGenerativeSettings(GetGenerativeSettingsRequest, CallSettings)

GetGenerativeSettingsAsync(GetGenerativeSettingsRequest, CallSettings)

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

Gets the generative settings for the agent.

Parameters
Name	Description
`request`	`GetGenerativeSettingsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskGenerativeSettings`	A Task containing the RPC response.

Overrides

AgentsClient.GetGenerativeSettingsAsync(GetGenerativeSettingsRequest, CallSettings)

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
Name	Description
`request`	`ListAgentsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListAgentsResponseAgent`	A pageable sequence of Agent resources.

Overrides

AgentsClient.ListAgents(ListAgentsRequest, CallSettings)

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
Name	Description
`request`	`ListAgentsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListAgentsResponseAgent`	A pageable asynchronous sequence of Agent resources.

Overrides

AgentsClient.ListAgentsAsync(ListAgentsRequest, CallSettings)

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:

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationEmptyStruct`	The RPC response.

Overrides

AgentsClient.RestoreAgent(RestoreAgentRequest, CallSettings)

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:

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationEmptyStruct`	A Task containing the RPC response.

Overrides

AgentsClient.RestoreAgentAsync(RestoreAgentRequest, CallSettings)

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
Name	Description
`request`	`UpdateAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Agent`	The RPC response.

Overrides

AgentsClient.UpdateAgent(UpdateAgentRequest, CallSettings)

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
Name	Description
`request`	`UpdateAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskAgent`	A Task containing the RPC response.

Overrides

AgentsClient.UpdateAgentAsync(UpdateAgentRequest, CallSettings)

UpdateGenerativeSettings(UpdateGenerativeSettingsRequest, CallSettings)

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

Updates the generative settings for the agent.

Parameters
Name	Description
`request`	`UpdateGenerativeSettingsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`GenerativeSettings`	The RPC response.

Overrides

AgentsClient.UpdateGenerativeSettings(UpdateGenerativeSettingsRequest, CallSettings)

UpdateGenerativeSettingsAsync(UpdateGenerativeSettingsRequest, CallSettings)

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

Updates the generative settings for the agent.

Parameters
Name	Description
`request`	`UpdateGenerativeSettingsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskGenerativeSettings`	A Task containing the RPC response.

Overrides

AgentsClient.UpdateGenerativeSettingsAsync(UpdateGenerativeSettingsRequest, CallSettings)

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
Name	Description
`request`	`ValidateAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`AgentValidationResult`	The RPC response.

Overrides

AgentsClient.ValidateAgent(ValidateAgentRequest, CallSettings)

ValidateAgentAsync(ValidateAgentRequest, CallSettings)

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

Parameters
Name	Description
`request`	`ValidateAgentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskAgentValidationResult`	A Task containing the RPC response.

Overrides

AgentsClient.ValidateAgentAsync(ValidateAgentRequest, CallSettings)