Share via


SearchIndexClient.GetKnowledgeAgentAsync(String, CancellationToken) Method

Definition

Retrieves an agent definition.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeAgent>> GetKnowledgeAgentAsync(string agentName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetKnowledgeAgentAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeAgent>>
override this.GetKnowledgeAgentAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeAgent>>
Public Overridable Function GetKnowledgeAgentAsync (agentName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KnowledgeAgent))

Parameters

agentName
String

The name of the agent to retrieve.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

agentName is null.

Applies to