agentfootprint/dist/esm/rag/splitDocuments.d.ts

The explainable agent framework — backtrack a wrong answer to the exact context that caused it (evidence, not guesses). Built on footprintjs.

import type { Chunk, LoadedDocument, Splitter } from './types.js';
export interface SplitDocumentsOptions {
    /**
     * Verify each piece against its own offsets and throw on a mismatch.
     * Default true. There is no good reason to turn it off except a splitter
     * that deliberately rewrites text, in which case its citations cannot be
     * checked against the source and you should know that.
     */
    readonly verifyOffsets?: boolean;
}
/**
 * Cut documents into chunks.
 *
 * @throws when a splitter returns a piece whose offsets do not match its text.
 *
 * @example
 * ```ts
 * const chunks = splitDocuments(documents, byHeading());
 * ```
 */
export declare function splitDocuments(documents: readonly LoadedDocument[], splitter: Splitter, options?: SplitDocumentsOptions): readonly Chunk[];