RerankStartEvent

Namespace: Vercel.AI.Operations

public sealed class RerankStartEvent

Start event for rerank.

Inheritance: object

View source

Constructors

RerankStartEvent(string, string, IReadOnlyDictionary<string, object?>, string, string, IReadOnlyList<object?>, string, int?, int, IReadOnlyDictionary<string, string>?, JsonElement?)

public RerankStartEvent(string callId, string operationId, IReadOnlyDictionary<string, object?> runtimeContext, string provider, string modelId, IReadOnlyList<object?> documents, string query, int? topN, int maxRetries, IReadOnlyDictionary<string, string>? headers, JsonElement? providerOptions)

Creates a start event.

Parameters

Name	Type	Description
callId	string
operationId	string
runtimeContext	IReadOnlyDictionary<string, object>
provider	string
modelId	string
documents	IReadOnlyList<object>
query	string
topN	int?
maxRetries	int
headers	IReadOnlyDictionary<string, string>
providerOptions	JsonElement?

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

Headers

public IReadOnlyDictionary<string, string>? Headers { get; }

Request headers.

Value: IReadOnlyDictionary<string, string>

View source

MaxRetries

public int MaxRetries { get; }

Retry limit.

Value: int

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

ProviderOptions

public JsonElement? ProviderOptions { get; }

Provider options.

Value: JsonElement?

View source

Query

public string Query { get; }

Query.

Value: string

View source

RuntimeContext

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

Runtime context.

Value: IReadOnlyDictionary<string, object>

View source

TopN

public int? TopN { get; }

Maximum results.

Value: int?

View source