@themaximalist/llm.js
    Preparing search index...

    Interface OpenAIOptions

    interface OpenAIOptions {
        apiKey?: string;
        attachments?: Attachment[];
        baseUrl?: string;
        extended?: boolean;
        input?: string | Message[];
        json?: boolean;
        max_output_tokens?: number;
        max_thinking_tokens?: number;
        max_tokens?: number;
        messages?: Message[];
        model?: string;
        parser?: ParserResponse;
        qualityFilter?: QualityFilter;
        reasoning?: {
            effort: "low" | "medium" | "high";
            summary: "auto" | "concise" | "detailed";
        };
        service?: string;
        stream?: boolean;
        temperature?: number;
        think?: boolean;
        tools?: Tool[]
        | WrappedTool[]
        | OpenAITool[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiKey? attachments? baseUrl? extended? input? json? max_output_tokens? max_thinking_tokens? max_tokens? messages? model? parser? qualityFilter? reasoning? service? stream? temperature? think? tools?

    Properties

    apiKey?: string

    API Key for the service, Usage.local services do not need an API key

    attachments?: Attachment[]

    Attachments to send to the model

    baseUrl?: string

    Base URL for the service

    extended?: boolean

    Returns an extended response with Response, PartialStreamResponse and StreamResponse types

    input?: string | Message[]
    json?: boolean

    Enables JSON mode in LLM if available and parses output with parsers.json

    max_output_tokens?: number
    max_thinking_tokens?: number

    Maximum number of tokens to use when thinking is enabled

    max_tokens?: number

    Maximum number of tokens to generate

    messages?: Message[]

    Messages to send to the model

    model?: string

    Model to use, defaults to Ollama.DEFAULT_MODEL model

    parser?: ParserResponse

    Custom parser function, defaults include parsers.json, parsers.xml, parsers.codeBlock and parsers.markdown

    qualityFilter?: QualityFilter

    Quality filter when dealing with model usage

    reasoning?: {
        effort: "low" | "medium" | "high";
        summary: "auto" | "concise" | "detailed";
    }
    service?: string

    Service to use, defaults to Ollama

    stream?: boolean

    Enables streaming mode

    temperature?: number

    Temperature for the model

    think?: boolean

    Enables thinking mode

    tools?: Tool[] | WrappedTool[] | OpenAITool[]

    Tools available for the model to use, will enable Options.extended

    Settings

    Member Visibility

    On This Page

    Properties