functai for TypeScript - v0.1.0
    Preparing search index...

    Class BeforeCallHook

    An AI function about to be asked.

    Hierarchy

    • HookEvent
      • BeforeCallHook
    Index
    constructor
    allTools conversation function inputs instruction lm path program sections settings tools turn
    entries remember

    • Parameters

      • f: {
            allTools: readonly string[];
            conversation: string | null;
            function: string;
            inputs: Rec;
            instruction: string;
            lm: string | null;
            path: string;
            program: unknown;
            sections: string[];
            settings: Rec;
            tools: string[];
            turn: string | null;
        }

      Returns BeforeCallHook

    allTools: readonly string[]

    The function's own tools.

    conversation: string | null
    function: string

    The function's name.

    inputs: Rec

    Its inputs, bound.

    instruction: string

    The instruction as it stands: the program's, or a replacement.

    lm: string | null
    path: string

    Its place in the call tree, by names: support/answer.

    program: unknown
    sections: string[]

    The sections so far.

    settings: Rec

    lm15 settings as they stand (temperature, maxTokens, …).

    tools: string[]

    The names of the tools offered.

    turn: string | null

    • This plugin's entries of a kind on the branch of the turn the call runs in ([] outside a conversation).

      Parameters

      • kind: string

      Returns Rec[]

    • Keep an entry of this plugin at the turn the call runs in (outside a conversation, a TypeError).

      Parameters

      • kind: string
      • data: unknown

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods