RerankResult

Namespace: Vercel.AI.Operations

public sealed class RerankResult

Result of CancellationToken).

Inheritance: object

View source

Constructors

RerankResult(IReadOnlyList<object?>, IReadOnlyList<RankedDocument>, JsonElement?, RerankResponseInfo)

public RerankResult(IReadOnlyList<object?> originalDocuments, IReadOnlyList<RankedDocument> ranking, JsonElement? providerMetadata, RerankResponseInfo response)

Creates a rerank result. The ranking list is copied.

Parameters

Name	Type	Description
originalDocuments	IReadOnlyList<object>
ranking	IReadOnlyList<RankedDocument>
providerMetadata	JsonElement?
response	RerankResponseInfo

View source

Properties

OriginalDocuments

public IReadOnlyList<object?> OriginalDocuments { get; }

Documents that were submitted.

Value: IReadOnlyList<object>

View source

ProviderMetadata

public JsonElement? ProviderMetadata { get; }

Provider metadata.

Value: JsonElement?

View source

Ranking

public IReadOnlyList<RankedDocument> Ranking { get; }

Ranking. Mutations of the list passed to onEnd do not change this copy.

Value: IReadOnlyList<RankedDocument>

View source

RerankedDocuments

public IReadOnlyList<object?> RerankedDocuments { get; }

Documents in ranking order.

Value: IReadOnlyList<object>

View source

Response

public RerankResponseInfo Response { get; }

Response metadata.

Value: RerankResponseInfo

View source