BatchOperationCall

Namespace: Vercel.AI.Operations

public sealed class BatchOperationCall

Arguments for a batch operation.

Inheritance: object

View source

Constructors

BatchOperationCall(string?, JsonElement?, IReadOnlyDictionary<string, string>, CancellationToken, int?, string?, string?, IReadOnlyList<NormalizedBatchRequest>?)

public BatchOperationCall(string? batchId, JsonElement? providerOptions, IReadOnlyDictionary<string, string> headers, CancellationToken cancellationToken, int? limit = null, string? cursor = null, string? webhookUrl = null, IReadOnlyList<NormalizedBatchRequest>? requests = null)

Creates a call.

Parameters

Name	Type	Description
batchId	string
providerOptions	JsonElement?
headers	IReadOnlyDictionary<string, string>
cancellationToken	CancellationToken
limit	int?
cursor	string
webhookUrl	string
requests	IReadOnlyList<NormalizedBatchRequest>

View source

Properties

BatchId

public string? BatchId { get; }

Batch id.

Value: string

View source

CancellationToken

public CancellationToken CancellationToken { get; }

Cancellation token.

Value: CancellationToken

View source

Cursor

public string? Cursor { get; }

Page cursor.

Value: string

View source

Headers

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

Headers including the user-agent suffix.

Value: IReadOnlyDictionary<string, string>

View source

Limit

public int? Limit { get; }

Page size.

Value: int?

View source

ProviderOptions

public JsonElement? ProviderOptions { get; }

Provider options.

Value: JsonElement?

View source

Receiver

public object? Receiver { get; set; }

True when this call was made on the batch API instance.

Value: object

View source

Requests

public IReadOnlyList<NormalizedBatchRequest>? Requests { get; }

Normalized requests.

Value: IReadOnlyList<NormalizedBatchRequest>

View source

WebhookUrl

public string? WebhookUrl { get; }

Webhook URL.

Value: string

View source