KnowledgeBaseRetrievalClient.RetrieveAsync Method

Definition

Namespace:: Azure.Search.Documents.KnowledgeBases

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v12.0.0

Package:: Azure.Search.Documents v11.8.0-beta.1

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.

Overloads

Name	Description
RetrieveAsync(RequestContent, RequestContext)	[Protocol Method] KnowledgeBase retrieves relevant data from backing stores. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RetrieveAsync(KnowledgeBaseRetrievalRequest, CancellationToken)	KnowledgeBase retrieves relevant data from backing stores.
RetrieveAsync(KnowledgeBaseRetrievalRequest, String, CancellationToken)	KnowledgeBase retrieves relevant data from backing stores.

Name

Description

RetrieveAsync(RequestContent, RequestContext)

[Protocol Method] KnowledgeBase retrieves relevant data from backing stores.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

RetrieveAsync(KnowledgeBaseRetrievalRequest, CancellationToken)

KnowledgeBase retrieves relevant data from backing stores.

RetrieveAsync(KnowledgeBaseRetrievalRequest, String, CancellationToken)

KnowledgeBase retrieves relevant data from backing stores.

RetrieveAsync(RequestContent, RequestContext)

Source:: KnowledgeBaseRetrievalClient.cs

[Protocol Method] KnowledgeBase retrieves relevant data from backing stores.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual System.Threading.Tasks.Task<Azure.Response> RetrieveAsync(Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member RetrieveAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RetrieveAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function RetrieveAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

content: RequestContent

The content to send as the body of the request.

context: RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

content is null.

RequestFailedException

Service returned a non-success status code.

Applies to

RetrieveAsync(KnowledgeBaseRetrievalRequest, CancellationToken)

Source:: KnowledgeBaseRetrievalClient.cs

KnowledgeBase retrieves relevant data from backing stores.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalResponse>> RetrieveAsync(Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalRequest retrievalRequest, System.Threading.CancellationToken cancellationToken = default);

abstract member RetrieveAsync : Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalRequest * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalResponse>>
override this.RetrieveAsync : Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalRequest * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalResponse>>

Public Overridable Function RetrieveAsync (retrievalRequest As KnowledgeBaseRetrievalRequest, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KnowledgeBaseRetrievalResponse))

Parameters

retrievalRequest: KnowledgeBaseRetrievalRequest

The retrieval request to process.

cancellationToken: CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Task<Response<KnowledgeBaseRetrievalResponse>>

Exceptions

ArgumentNullException

retrievalRequest is null.

RequestFailedException

Service returned a non-success status code.

Applies to

RetrieveAsync(KnowledgeBaseRetrievalRequest, String, CancellationToken)

Source:: KnowledgeBaseRetrievalClient.cs

KnowledgeBase retrieves relevant data from backing stores.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalResponse>> RetrieveAsync(Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalRequest retrievalRequest, string xMsQuerySourceAuthorization = default, System.Threading.CancellationToken cancellationToken = default);

abstract member RetrieveAsync : Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalRequest * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalResponse>>
override this.RetrieveAsync : Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalRequest * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalResponse>>

Public Overridable Function RetrieveAsync (retrievalRequest As KnowledgeBaseRetrievalRequest, Optional xMsQuerySourceAuthorization As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KnowledgeBaseRetrievalResponse))

Parameters

retrievalRequest: KnowledgeBaseRetrievalRequest

The retrieval request to process.

xMsQuerySourceAuthorization: String

Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<KnowledgeBaseRetrievalResponse>>

Exceptions

ArgumentNullException

retrievalRequest is null.

Applies to

Feedback

Was this page helpful?