Batch

Namespace: Vercel.AI.Operations

public static class Batch

Batch operations. Maps to startBatch, getBatchStatus, getBatchResults, listBatches, and cancelBatch.

Inheritance: object

View source

Methods

CancelBatchAsync(BatchRequestOptions, CancellationToken)

public static Task<BatchCancelResult> CancelBatchAsync(BatchRequestOptions request, CancellationToken cancellationToken = default)

Requests cancellation.

Parameters

Name	Type	Description
request	BatchRequestOptions
cancellationToken	CancellationToken

Returns: Task<BatchCancelResult>

View source

GetAllBatchResultsAsync(BatchRequestOptions, CancellationToken)

public static Task<IReadOnlyList<BatchItemResult>> GetAllBatchResultsAsync(BatchRequestOptions request, CancellationToken cancellationToken = default)

Reads every result of CancellationToken) into a list.

Parameters

Name	Type	Description
request	BatchRequestOptions
cancellationToken	CancellationToken

Returns: Task<IReadOnlyList<BatchItemResult>>

View source

GetBatchResults(BatchRequestOptions, CancellationToken)

public static IAsyncEnumerable<BatchItemResult> GetBatchResults(BatchRequestOptions request, CancellationToken cancellationToken = default)

Opens results immediately and normalizes them as they are read. Each item is read from the provider only when the caller asks for it. Use CancellationToken) to read every result into a list.

Parameters

Name	Type	Description
request	BatchRequestOptions
cancellationToken	CancellationToken

Returns: IAsyncEnumerable<BatchItemResult>

View source

GetBatchStatusAsync(BatchRequestOptions, CancellationToken)

public static Task<BatchStatus> GetBatchStatusAsync(BatchRequestOptions request, CancellationToken cancellationToken = default)

Reads the latest status.

Parameters

Name	Type	Description
request	BatchRequestOptions
cancellationToken	CancellationToken

Returns: Task<BatchStatus>

View source

ListBatchesAsync(BatchRequestOptions, CancellationToken)

public static Task<BatchListResult> ListBatchesAsync(BatchRequestOptions request, CancellationToken cancellationToken = default)

Lists one page. doListBatches is invoked on the batch API instance.

Parameters

Name	Type	Description
request	BatchRequestOptions
cancellationToken	CancellationToken

Returns: Task<BatchListResult>

View source

StartBatchAsync(BatchRequestOptions, CancellationToken)

public static Task<BatchStartResult> StartBatchAsync(BatchRequestOptions request, CancellationToken cancellationToken = default)

Validates and starts a batch.

Parameters

Name	Type	Description
request	BatchRequestOptions
cancellationToken	CancellationToken

Returns: Task<BatchStartResult>

View source