KnowledgeBaseRetrievalClient.Retrieve Method

Definition

Namespace:: Azure.Search.Documents.KnowledgeBases

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v12.0.0

Package:: Azure.Search.Documents v12.1.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
Retrieve(RequestContent, RequestContext)	KnowledgeBase retrieves relevant data from backing stores.
Retrieve(RequestContent, String, 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.
Retrieve(KnowledgeBaseRetrievalRequest, String, CancellationToken)	KnowledgeBase retrieves relevant data from backing stores.

Name

Description

Retrieve(RequestContent, RequestContext)

KnowledgeBase retrieves relevant data from backing stores.

Retrieve(RequestContent, String, 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.

Retrieve(KnowledgeBaseRetrievalRequest, String, CancellationToken)

KnowledgeBase retrieves relevant data from backing stores.

Retrieve(RequestContent, RequestContext)

Source:: KnowledgeBaseRetrievalClient.cs

Source:: KnowledgeBaseRetrievalClient.cs

KnowledgeBase retrieves relevant data from backing stores.

public virtual Azure.Response Retrieve(Azure.Core.RequestContent content, Azure.RequestContext context = default);

public virtual Azure.Response Retrieve(Azure.Core.RequestContent content, Azure.RequestContext context);

abstract member Retrieve : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.Retrieve : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response

Public Overridable Function Retrieve (content As RequestContent, Optional context As RequestContext = Nothing) As Response

Public Overridable Function Retrieve (content As RequestContent, context As RequestContext) As Response

Parameters

content: RequestContent

The content to send as the body of the request.

context: RequestContext

The request context.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

content is null.

RequestFailedException

Service returned a non-success status code.

Applies to

Retrieve(RequestContent, String, 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 Azure.Response Retrieve(Azure.Core.RequestContent content, string querySourceAuthorization = default, Azure.RequestContext context = default);

abstract member Retrieve : Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response
override this.Retrieve : Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response

Public Overridable Function Retrieve (content As RequestContent, Optional querySourceAuthorization As String = Nothing, Optional context As RequestContext = Nothing) As Response

Parameters

content: RequestContent

The content to send as the body of the request.

querySourceAuthorization: String

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

context: RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

content is null.

RequestFailedException

Service returned a non-success status code.

Applies to

Retrieve(KnowledgeBaseRetrievalRequest, String, CancellationToken)

Source:: KnowledgeBaseRetrievalClient.cs

KnowledgeBase retrieves relevant data from backing stores.

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

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

Public Overridable Function Retrieve (retrievalRequest As KnowledgeBaseRetrievalRequest, Optional querySourceAuthorization As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of KnowledgeBaseRetrievalResponse)

Parameters

retrievalRequest: KnowledgeBaseRetrievalRequest

The retrieval request to process.

querySourceAuthorization: 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 that can be used to cancel the operation.

Returns

Response<KnowledgeBaseRetrievalResponse>

Exceptions

ArgumentNullException

retrievalRequest is null.

RequestFailedException

Service returned a non-success status code.

Applies to

Feedback

War diese Seite hilfreich?