public sealed class AgentsClientImpl : AgentsClientReference documentation and code samples for the Dialogflow v3 API class AgentsClientImpl.
Agents client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Dialogflow.Cx.V3Assembly
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 | AgentsAgentsClientThe underlying gRPC client. |
settings | AgentsSettingsThe base AgentsSettings used within this client. |
logger | ILoggerOptional 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 | |
GrpcClient
public override Agents.AgentsClient GrpcClient { get; }The underlying gRPC Agents client
| Property Value | |
|---|---|
| Type | Description |
AgentsAgentsClient | |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient | |
RestoreAgentOperationsClient
public override OperationsClient RestoreAgentOperationsClient { get; }The long-running operations client for RestoreAgent.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
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 | CreateAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Agent | The RPC response. |
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 | CreateAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAgent | A Task containing the RPC response. |
DeleteAgent(DeleteAgentRequest, CallSettings)
public override void DeleteAgent(DeleteAgentRequest request, CallSettings callSettings = null)Deletes the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteAgentAsync(DeleteAgentRequest, CallSettings)
public override Task DeleteAgentAsync(DeleteAgentRequest request, CallSettings callSettings = null)Deletes the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
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 messageresponse: [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
| Parameters | |
|---|---|
| Name | Description |
request | ExportAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationExportAgentResponseStruct | The RPC response. |
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 messageresponse: [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
| Parameters | |
|---|---|
| Name | Description |
request | ExportAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationExportAgentResponseStruct | A Task containing the RPC response. |
GetAgent(GetAgentRequest, CallSettings)
public override Agent GetAgent(GetAgentRequest request, CallSettings callSettings = null)Retrieves the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request | GetAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Agent | The RPC response. |
GetAgentAsync(GetAgentRequest, CallSettings)
public override Task<Agent> GetAgentAsync(GetAgentRequest request, CallSettings callSettings = null)Retrieves the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request | GetAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAgent | A Task containing the RPC response. |
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 | GetAgentValidationResultRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AgentValidationResult | The RPC response. |
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 | GetAgentValidationResultRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAgentValidationResult | A Task containing the RPC response. |
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 | ListAgentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListAgentsResponseAgent | A pageable sequence of Agent resources. |
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 | ListAgentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListAgentsResponseAgent | A pageable asynchronous sequence of Agent resources. |
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 messageresponse: An Empty message
Note: You should always train flows prior to sending them queries. See the training documentation.
| Parameters | |
|---|---|
| Name | Description |
request | RestoreAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyStruct | The RPC response. |
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 messageresponse: An Empty message
Note: You should always train flows prior to sending them queries. See the training documentation.
| Parameters | |
|---|---|
| Name | Description |
request | RestoreAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyStruct | A Task containing the RPC response. |
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 | UpdateAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Agent | The RPC response. |
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 | UpdateAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAgent | A Task containing the RPC response. |
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 | ValidateAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AgentValidationResult | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | ValidateAgentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAgentValidationResult | A Task containing the RPC response. |