Briyah SDK - v2.0.18
    Preparing search index...

    Interface DocumentSummary

    One document as an agent sees it listed.

    interface DocumentSummary {
        addedAt?: string;
        chars: number;
        documentId: string;
        kind?: string;
        name: string;
        pages: number;
        state?: "failed" | "ready" | "indexing";
        summary?: string;
    }
    Index
    addedAt? chars documentId kind? name pages state? summary?
    addedAt?: string

    ISO date it was added.

    chars: number

    Size of its text, so an agent can judge what holding it would cost.

    documentId: string

    Unique within the source. What every tool takes.

    kind?: string

    The host's word for what it is, e.g. contract or loss run.

    name: string

    What a person calls it — a title, or the file name.

    pages: number

    Pages as a reader counts them. A Word document is one.

    state?: "failed" | "ready" | "indexing"

    Whether it can be searched yet. A document still being indexed can be read but not found; one that failed can be read if its text exists at all. Defaults to ready.

    summary?: string

    A paragraph describing it, when the host has one.

    Settings
    Member Visibility

    On This Page
    Properties