SearchIndexClient.GetKnowledgeAgent(String, CancellationToken) Method

Definition

Namespace:: Azure.Search.Documents.Indexes

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.7.0-beta.5

Source:: SearchIndexClient.KnowledgeAgent.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Retrieves an agent definition.

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeAgent> GetKnowledgeAgent(string agentName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetKnowledgeAgent : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeAgent>
override this.GetKnowledgeAgent : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.KnowledgeAgent>

Public Overridable Function GetKnowledgeAgent (agentName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of KnowledgeAgent)

Parameters

agentName: String

The name of the agent to retrieve.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<KnowledgeAgent>

Exceptions

ArgumentNullException

agentName is null.

Applies to