Skip to main content

Interface: StreamTextResult

Defined in: packages/agentos/src/api/streamText.ts:66

The object returned immediately by streamText.

Consumers may iterate textStream for raw token deltas, fullStream for all event types, or simply await the promise properties for aggregated results once the stream has drained.

Properties

fullStream

fullStream: AsyncIterable<StreamPart>

Defined in: packages/agentos/src/api/streamText.ts:70

Async iterable that yields all StreamPart events in order.


model

model: Promise<string>

Defined in: packages/agentos/src/api/streamText.ts:89

Resolves to the resolved model id once the stream has started.


provider

provider: Promise<string>

Defined in: packages/agentos/src/api/streamText.ts:87

Resolves to the resolved provider id (e.g. openrouter, anthropic) once the stream has started. Available eagerly because routing happens before the first chunk; exposed as a Promise so the type lines up with the rest of this contract and so callers don't see undefined while the stream is still spinning up. Used by wilds-ai's [llm-call] telemetry line for per-step latency attribution (production fix 2026-05-05 — narrator-stream rows were logging provider=unknown model=unknown, which made model-routing audits significantly harder).


text

text: Promise<string>

Defined in: packages/agentos/src/api/streamText.ts:72

Resolves to the fully assembled assistant reply when the stream completes.


textStream

textStream: AsyncIterable<string>

Defined in: packages/agentos/src/api/streamText.ts:68

Async iterable that yields only raw text-delta strings (filters out non-text parts).


toolCalls

toolCalls: Promise<ToolCallRecord[]>

Defined in: packages/agentos/src/api/streamText.ts:76

Resolves to the ordered list of ToolCallRecords when the stream completes.


usage

usage: Promise<TokenUsage>

Defined in: packages/agentos/src/api/streamText.ts:74

Resolves to aggregated TokenUsage when the stream completes.