Interface DocumentChunk

One searchable passage.

interface DocumentChunk {
    heading?: string;
    index: number;
    pageNum: number;
    text: string;
}

Properties

heading?: string

The nearest headings above the chunk, outermost first, joined with ' › '.

index: number

Position in the document, from 0. Stable for the same input and options.

pageNum: number

text: string