RerankEndEvent

Namespace: Vercel.AI.Operations

public sealed class RerankEndEvent

End event for rerank.

Inheritance: object

View source

Constructors

RerankEndEvent(string, string, IReadOnlyDictionary<string, object?>, string, string, IReadOnlyList<object?>, string, IReadOnlyList<RankedDocument>, IReadOnlyList<OperationWarning>, JsonElement?, RerankResponseInfo)

public RerankEndEvent(string callId, string operationId, IReadOnlyDictionary<string, object?> runtimeContext, string provider, string modelId, IReadOnlyList<object?> documents, string query, IReadOnlyList<RankedDocument> ranking, IReadOnlyList<OperationWarning> warnings, JsonElement? providerMetadata, RerankResponseInfo response)

Creates an end event.

Parameters

Name	Type	Description
callId	string
operationId	string
runtimeContext	IReadOnlyDictionary<string, object>
provider	string
modelId	string
documents	IReadOnlyList<object>
query	string
ranking	IReadOnlyList<RankedDocument>
warnings	IReadOnlyList<OperationWarning>
providerMetadata	JsonElement?
response	RerankResponseInfo

View source

Properties

CallId

public string CallId { get; }

Call id.

Value: string

View source

Documents

public IReadOnlyList<object?> Documents { get; }

Submitted documents.

Value: IReadOnlyList<object>

View source

ModelId

public string ModelId { get; }

Model id.

Value: string

View source

OperationId

public string OperationId { get; }

ai.rerank.

Value: string

View source

Provider

public string Provider { get; }

Provider id.

Value: string

View source

ProviderMetadata

public JsonElement? ProviderMetadata { get; }

Provider metadata.

Value: JsonElement?

View source

Query

public string Query { get; }

Query.

Value: string

View source

Ranking

public IReadOnlyList<RankedDocument> Ranking { get; }

Ranking visible to the callback. The result keeps its own copy.

Value: IReadOnlyList<RankedDocument>

View source

Response

public RerankResponseInfo Response { get; }

Response metadata.

Value: RerankResponseInfo

View source

RuntimeContext

public IReadOnlyDictionary<string, object?> RuntimeContext { get; }

Runtime context.

Value: IReadOnlyDictionary<string, object>

View source

Warnings

public IReadOnlyList<OperationWarning> Warnings { get; }

Warnings.

Value: IReadOnlyList<OperationWarning>

View source