@plust/datasleuth - v0.2.0
    Preparing search index...

    Interface SummarizeOptions

    Options for the summarization step

    interface SummarizeOptions {
        maxLength?: number;
        llm?: LanguageModelV1;
        temperature?: number;
        format?: SummaryFormat;
        focus?: string | string[];
        includeCitations?: boolean;
        includeInResults?: boolean;
        customPrompt?: string;
        additionalInstructions?: string;
        retry?: { maxRetries?: number; baseDelay?: number };
        [key: string]: any;
    }

    Hierarchy

    • StepOptions
      • SummarizeOptions

    Indexable

    • [key: string]: any
    Index

    Properties

    maxLength? llm? temperature? format? focus? includeCitations? includeInResults? customPrompt? additionalInstructions? retry?

    Properties

    maxLength?: number

    Maximum length of the generated summary (characters)

    llm?: LanguageModelV1

    Model to use for summarization (from the AI SDK)

    temperature?: number

    Temperature for the LLM generation (0.0 to 1.0)

    format?: SummaryFormat

    Format for the summary (paragraph, bullet, structured)

    focus?: string | string[]

    Focus areas for the summary (aspects to emphasize)

    includeCitations?: boolean

    Whether to include citations in the summary

    includeInResults?: boolean

    Whether to add the summary to the final results

    customPrompt?: string

    Custom prompt for summary generation

    additionalInstructions?: string

    Additional instructions for summary generation

    retry?: { maxRetries?: number; baseDelay?: number }

    Retry configuration for LLM calls

    Type declaration

    • OptionalmaxRetries?: number

      Maximum number of retries

    • OptionalbaseDelay?: number

      Base delay between retries in ms

    Settings

    Member Visibility

    On This Page

    Properties