output
    Preparing search index...

    Type Alias StreamTextParameters<Tools, OutputSpec>

    StreamTextParameters: {
        maxSteps?: number;
        onFinish?: WrappedStreamTextOnFinishCallback<Tools>;
        prompt: string;
        promptDir?: string;
        skills?:
            | Skill[]
            | (
                (
                    input: Record<string, string | number | boolean> | undefined,
                ) => Skill[]
            );
        variables?: Record<string, string | number | boolean>;
    } & Omit<StreamTextAiSdkOptions<Tools, OutputSpec>, "onFinish">

    Parameters accepted by streamText.

    Type Parameters

    • Tools extends ToolSet = ToolSet
    • OutputSpec extends AnyAiOutput = AnyAiOutput

    Type Declaration

    • OptionalmaxSteps?: number

      Used to create a default stepCountIs(maxSteps) when tools are present and stopWhen is omitted

    • OptionalonFinish?: WrappedStreamTextOnFinishCallback<Tools>

      Callback when stream finishes. Receives the wrapped event with optional cost.

    • prompt: string

      Prompt file name

    • OptionalpromptDir?: string

      Override the stack-resolved prompt directory

    • Optionalskills?:
          | Skill[]
          | (
              (
                  input: Record<string, string | number | boolean> | undefined,
              ) => Skill[]
          )

      Skill packages to provide to the LLM through the load_skill tool. Function resolvers must be synchronous.

    • Optionalvariables?: Record<string, string | number | boolean>

      Variables to interpolate into the prompt file

    Settings

    Member Visibility