VoyageProvider.VoyageRerankingModel

Namespace: Vercel.AI.Voyage

public sealed class VoyageProvider.VoyageRerankingModel : IRerankingModel

Voyage reranking model.

Inheritance: object

Implements: IRerankingModel

View source

Constructors

VoyageRerankingModel(VoyageProvider, string)

public VoyageRerankingModel(VoyageProvider provider, string modelId)

Creates a reranking model.

Parameters

Name	Type	Description
provider	VoyageProvider
modelId	string

View source

Properties

ModelId

public string ModelId { get; }

Model id.

Value: string

View source

Provider

public string Provider { get; }

Provider id.

Value: string

View source

Methods

DoRerankAsync(string, IReadOnlyList<string>, int?, CancellationToken, IReadOnlyDictionary<string, string?>?)

public Task<RerankResult> DoRerankAsync(string query, IReadOnlyList<string> documents, int? topN, CancellationToken cancellationToken, IReadOnlyDictionary<string, string?>? headers = null)

Reranks documents for a query. <code class=“paramref”>headers</code> are sent with this call and override the provider headers.

Parameters

Name	Type	Description
query	string
documents	IReadOnlyList<string>
topN	int?
cancellationToken	CancellationToken
headers	IReadOnlyDictionary<string, string>

Returns: Task<RerankResult>

View source

RerankAsync(VoyageRerankRequest, CancellationToken)

public Task<VoyageRerankResult> RerankAsync(VoyageRerankRequest request, CancellationToken cancellationToken)

Reranks text or JSON documents.

Parameters

Name	Type	Description
request	VoyageRerankRequest
cancellationToken	CancellationToken

Returns: Task<VoyageRerankResult>

View source