Cell API
    Preparing search index...

    Interface PortableFunctionCallingOptions

    The ChatOptions represent the common options, portable across different chat models.

    interface PortableFunctionCallingOptions {
        extra?: Record<string, unknown>;
        frequencyPenalty?: number;
        functionCallbacks: FunctionCallback[];
        functions: Set<string>;
        httpHeaders?: Record<string, string>;
        maxTokens?: number;
        model?: string;
        prediction?: Prediction | null;
        presencePenalty?: number;
        proxyToolCalls?: boolean;
        signal?: AbortSignal;
        stopSequences?: string[];
        temperature?: number;
        toolContext?: ToolContext;
        topK?: number;
        topP?: number;
    }

    Hierarchy (View Summary)

    Index
    extra?: Record<string, unknown>
    frequencyPenalty?: number
    functionCallbacks: FunctionCallback[]

    Function Callbacks to be registered with the ChatClient. For Prompt Options the functionCallbacks are automatically enabled for the duration of the prompt execution. For Default Options the FunctionCallbacks are registered but disabled by default. You have to use "functions" property to list the function names from the ChatClient registry to be used in the chat completion requests.

    functions: Set<string>

    List of function names from the ChatClient registry to be used in the next chat completion requests.

    httpHeaders?: Record<string, string>
    maxTokens?: number
    model?: string
    prediction?: Prediction | null
    presencePenalty?: number
    proxyToolCalls?: boolean
    signal?: AbortSignal
    stopSequences?: string[]
    temperature?: number
    toolContext?: ToolContext
    topK?: number
    topP?: number