InferenceClient.SemanticRerank Method

Definition

Namespace:: Azure.Data.AI

Assembly:: Azure.Data.AI.dll

Package:: Azure.Data.AI v1.0.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
SemanticRerank(RequestContent, RequestContext)	[Protocol Method] Reranks documents by their relevance to a query. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
SemanticRerank(SemanticRerankingInferenceContent, CancellationToken)	Reranks documents by their relevance to a query.

Name

Description

SemanticRerank(RequestContent, RequestContext)

[Protocol Method] Reranks documents by their relevance to a query.

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

SemanticRerank(SemanticRerankingInferenceContent, CancellationToken)

Reranks documents by their relevance to a query.

SemanticRerank(RequestContent, RequestContext)

Source:: InferenceClient.cs

[Protocol Method] Reranks documents by their relevance to a query.

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

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

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

Public Overridable Function SemanticRerank (content As RequestContent, Optional context As RequestContext = Nothing) As 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

Response

The response returned from the service.

Exceptions

ArgumentNullException

content is null.

RequestFailedException

Service returned a non-success status code.

Applies to

SemanticRerank(SemanticRerankingInferenceContent, CancellationToken)

Source:: InferenceClient.cs

Reranks documents by their relevance to a query.

public virtual Azure.Response<Azure.Data.AI.SemanticRerankingInferenceResult> SemanticRerank(Azure.Data.AI.SemanticRerankingInferenceContent request, System.Threading.CancellationToken cancellationToken = default);

abstract member SemanticRerank : Azure.Data.AI.SemanticRerankingInferenceContent * System.Threading.CancellationToken -> Azure.Response<Azure.Data.AI.SemanticRerankingInferenceResult>
override this.SemanticRerank : Azure.Data.AI.SemanticRerankingInferenceContent * System.Threading.CancellationToken -> Azure.Response<Azure.Data.AI.SemanticRerankingInferenceResult>

Public Overridable Function SemanticRerank (request As SemanticRerankingInferenceContent, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SemanticRerankingInferenceResult)