Function streamText

streamText<
    Tools extends ToolSet = ToolSet,
    OutputSpec extends AnyAiOutput = AnyAiOutput,
>(
    args: StreamTextParameters<Tools, OutputSpec>,
): StreamTextResult<Tools, DefaultRuntimeContext, OutputSpec>
Use an LLM model to stream text generation.

This function is a wrapper over the AI SDK's streamText. The prompt sets model, messages, generation settings, maxSteps, skills, and providerOptions. Pass either a prompt filename with optional promptDir / variables, or a loaded or custom Prompt object. Other call arguments match generateText, plus onChunk, onEnd, and onError. onEnd is wrapped to add result, cost, and merged sources.
Type Parameters
- Tools extends ToolSet = ToolSet
- OutputSpec extends AnyAiOutput = AnyAiOutput
Parameters
- args: StreamTextParameters<Tools, OutputSpec>
  Streaming arguments. See StreamTextParameters.
Returns StreamTextResult<Tools, DefaultRuntimeContext, OutputSpec>
AI SDK stream result with textStream, stream, and metadata promises.