Skip to main content

Interface: AIBatchHandle

Defined in: packages/workflow-engine/src/ai/types.ts:616

Handle for tracking a submitted batch

Properties​

batchIds?​

optional batchIds?: string[]

Defined in: packages/workflow-engine/src/ai/types.ts:626

Every batch this submit fanned out into. Length 1 unless partitioned.


error?​

optional error?: string

Defined in: packages/workflow-engine/src/ai/types.ts:630


id​

id: string

Defined in: packages/workflow-engine/src/ai/types.ts:618

Batch identifier from the provider


provider?​

optional provider?: AIBatchProvider

Defined in: packages/workflow-engine/src/ai/types.ts:622

The provider used for this batch (for resume support)


refs?​

optional refs?: EngineBatchRef[]

Defined in: packages/workflow-engine/src/ai/types.ts:624

Versioned serializable handle(s). Persist in suspendedState.metadata.batchRefs.


requestCounts?​

optional requestCounts?: object

Defined in: packages/workflow-engine/src/ai/types.ts:627

completed​

completed: number

failed​

failed: number

total​

total: number


status​

status: "failed" | "pending" | "processing" | "completed"

Defined in: packages/workflow-engine/src/ai/types.ts:620

Current status of the batch


totalRequests?​

optional totalRequests?: number

Defined in: packages/workflow-engine/src/ai/types.ts:629

Total number of requests expected in the batch