Verified example · TypeScript
Runtime batch
examples/runtime-batch.ts
@cavi-ai/api-clientv0.21.007f0ee45
import { ApiClientError, ApiClientErrorCode, ApiClientErrorType, type CapabilityClient, type RuntimeBatchRequest } from "@cavi-ai/api-client";
export async function submitBatchAndCollect(
client: CapabilityClient,
requests: RuntimeBatchRequest[],
options: { maxPolls?: number; pollIntervalMs?: number } = {},
) {
const { maxPolls = 60, pollIntervalMs = 60_000 } = options;
if (!Number.isInteger(maxPolls) || maxPolls < 0 || !Number.isFinite(pollIntervalMs) || pollIntervalMs < 0) {
throw new ApiClientError("Use a non-negative poll count and interval.", {
type: ApiClientErrorType.Validation, code: ApiClientErrorCode.InvalidRequest,
});
}
const submitted = await client.submitBatch(requests);
if (!submitted.ok) throw new ApiClientError(submitted.gap.note, {
code: ApiClientErrorCode.RequestFailed, cause: submitted.gap,
});
let batch = submitted.data;
for (let poll = 0; !batch.resultsAvailable && poll < maxPolls; poll += 1) {
if (["failed", "cancelled"].includes(batch.status)) break;
await new Promise((resolve) => setTimeout(resolve, pollIntervalMs));
const next = await client.getBatch(batch.batch_id);
if (!next.ok) throw new ApiClientError(next.gap.note, {
code: ApiClientErrorCode.RequestFailed, cause: next.gap,
});
batch = next.data;
}
if (!batch.resultsAvailable) {
// Keep the ID: stopping this local wait does not cancel the backend batch.
throw new ApiClientError(`Batch ${batch.batch_id} is not ready (status: ${batch.status}); retrieve it later or cancel explicitly.`, {
code: ApiClientErrorCode.RequestFailed, cause: batch,
});
}
const results = await client.getBatchResults(batch.batch_id);
if (!results.ok) throw new ApiClientError(results.gap.note, {
code: ApiClientErrorCode.RequestFailed, cause: results.gap,
});
// Callers must inspect each item's outcome, including errored/canceled/expired.
return results.data;
}
Package imports
Referenced by
Artifact provenance
- Package
- @cavi-ai/api-client@0.21.0
- Release
- v0.21.0
- Commit
07f0ee45424c267278f7b0c89a7dcea4e2492cc1- Source
examples/runtime-batch.ts- Tarball SHA-256
0924b5d3a7a40869bd44fedc47a9b8eb9844c2af1fd5c7ca77469d8b7c0b8558- Content SHA-256
24eff463c41582eaf5e70c58f42e5ae13bd12d02fa14ae2a886afa3abf5cdf48