lloyal-agents API Reference
    Preparing search index...

    Interface FormattedChatResult

    Result from chat template formatting

    Includes format-awareness fields for proper output parsing. Pass format and reasoningFormat directly to parseChatOutput() to decode the model's response.

    Example: Roundtrip: format -> generate -> parse

    const fmt = await ctx.formatChat(messagesJson, { tools: toolsJson });
    // ... generate tokens using fmt.prompt and fmt.grammar ...
    const parsed = ctx.parseChatOutput(output, fmt.format, {
      reasoningFormat: fmt.reasoningFormat,
      thinkingForcedOpen: fmt.thinkingForcedOpen,
      parser: fmt.parser,
    });

    SessionContext.parseChatOutput

    interface FormattedChatResult {
        format: number;
        grammar: string;
        grammarLazy: boolean;
        grammarTriggers: GrammarTrigger[];
        parser: string;
        preservedTokens: string[];
        prompt: string;
        reasoningFormat: ReasoningFormat;
        stopTokens: string[];
        thinkingForcedOpen: boolean;
    }
    Index

    Properties

    format grammar grammarLazy grammarTriggers parser preservedTokens prompt reasoningFormat stopTokens thinkingForcedOpen

    Properties

    format: number

    Detected chat format (pass to parseChatOutput)

    SessionContext.parseChatOutput

    grammar: string

    Grammar string for constrained generation (empty if no tools/schema)

    grammarLazy: boolean

    Whether grammar should be applied lazily (only after triggers fire)

    grammarTriggers: GrammarTrigger[]

    Grammar trigger conditions for lazy grammar activation

    parser: string

    PEG parser definition for PEG format models (pass to parseChatOutput options)

    preservedTokens: string[]

    Token strings preserved from grammar masking

    prompt: string

    Formatted prompt string ready for tokenization

    reasoningFormat: ReasoningFormat

    Reasoning format (pass to parseChatOutput options)

    ParseChatOutputOptions.reasoningFormat

    stopTokens: string[]

    Additional stop strings from the template

    thinkingForcedOpen: boolean

    Whether the thinking tag was forced open by the template

    Settings

    Member Visibility

    On This Page

    Properties