Verified example · TypeScript
Runtime streaming
examples/runtime-streaming.ts
@cavi-ai/api-clientv0.21.007f0ee45
import { ApiClientError, ApiClientErrorCode, type CapabilityClient, type StreamRunBody } from "@cavi-ai/api-client";
export async function streamText(
client: CapabilityClient,
body: StreamRunBody,
write: (text: string) => void,
signal: AbortSignal,
reportError?: (error: unknown) => void,
) {
let text: string | undefined;
let terminalText: string | undefined;
let runError: string | undefined;
let transportError: unknown;
const result = await client.streamRun(body, {
onEvent(event) {
if (event.event === "message.delta") {
text = (text ?? "") + event.delta;
write(event.delta);
}
if (event.event === "run.completed") terminalText = event.output;
if (event.event === "run.failed") runError = event.error;
},
onError(error) {
transportError = error;
reportError?.(error);
},
}, { signal });
if (!result.ok) throw new ApiClientError(result.gap.note, {
code: ApiClientErrorCode.RequestFailed, cause: result.gap,
});
if (result.data.outcome !== "completed") {
const code = result.data.outcome === "failed" ? "run_failed"
: result.data.outcome === "cancelled" ? "run_cancelled" : "run_incomplete";
throw new ApiClientError(`Stream ended with outcome ${result.data.outcome ?? "unknown"}`, {
type: "run", code, cause: { ...result.data, error: runError, transportError },
});
}
const answer = terminalText ?? text;
if (answer === undefined) {
throw new ApiClientError("Stream completed without a text answer.", {
type: "run", code: "run_output_missing", cause: result.data,
});
}
return { ...result.data, text: answer };
}
Package imports
Referenced by
Artifact provenance
- Package
- @cavi-ai/api-client@0.21.0
- Release
- v0.21.0
- Commit
07f0ee45424c267278f7b0c89a7dcea4e2492cc1- Source
examples/runtime-streaming.ts- Tarball SHA-256
0924b5d3a7a40869bd44fedc47a9b8eb9844c2af1fd5c7ca77469d8b7c0b8558- Content SHA-256
24eff463c41582eaf5e70c58f42e5ae13bd12d02fa14ae2a886afa3abf5cdf48