Function streamText

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

This function is a wrapper over the AI SDK's streamText. The prompt file sets model, messages, temperature, maxTokens, and providerOptions. AI SDK-compatible tools are accepted structurally via CompatibleToolSet. Other AI SDK streamText options are accepted via StreamTextAiSdkOptions, except onFinish, which Output wraps to add optional cost data.
Type Parameters
- Tools extends ToolSet = ToolSet
- OutputSpec extends AnyAiOutput = AnyAiOutput
Parameters
- args: StreamTextParameters<Tools, OutputSpec>
  Streaming arguments. See StreamTextParameters.
Returns StreamTextResult<Tools, OutputSpec>
AI SDK stream result with textStream, fullStream, and metadata promises.