Kizuki
    Preparing search index...

    Interface Batch

    A group of passages sent to the model in one request.

    interface Batch {
        passages: {
            location: {
                cells?: string;
                heading?: string;
                notes?: boolean;
                page?: number;
                paragraph?: number;
                sheet?: string;
                slide?: number;
            };
            materialId: string;
            ordinal: number;
            passageId: string;
            sectionId: string;
            text: string;
        }[];
        sections: {
            heading?: boolean;
            level: number;
            ordinal: number;
            sectionId: string;
            title: string;
        }[];
    }
    Index
    passages sections
    passages: {
        location: {
            cells?: string;
            heading?: string;
            notes?: boolean;
            page?: number;
            paragraph?: number;
            sheet?: string;
            slide?: number;
        };
        materialId: string;
        ordinal: number;
        passageId: string;
        sectionId: string;
        text: string;
    }[]

    The passages in this request, in file order.

    sections: {
        heading?: boolean;
        level: number;
        ordinal: number;
        sectionId: string;
        title: string;
    }[]

    The sections the passages belong to, in file order. A section split across batches is in each of them.

    Type Declaration

    • Optionalheading?: boolean

      True when the title is a real heading of the material, not a page number or a file name.

    • level: number
    • ordinal: number
    • sectionId: string
    • title: string

    Settings
    Member Visibility

    On This Page
    Properties