Documentation
    Preparing search index...

    Interface SearchDocument

    Document structure to be indexed by search engine adapters.

    interface SearchDocument {
        category?: string;
        content: string;
        id: string;
        metadata?: Record<string, any>;
        path?: string;
        summary?: string;
        tags?: string[];
        title: string;
    }
    Index

    Properties

    category? content id metadata? path? summary? tags? title

    Properties

    category?: string

    Category identifier or folder path.

    content

    content: string

    Full text content or body of the document.

    id: string

    Unique identifier of the document.

    metadata?: Record<string, any>

    Additional unstructured metadata key-value pairs.

    path?: string

    Optional relative or absolute file path.

    summary?: string

    Optional summary or excerpt.

    tags?: string[]

    Tag list attached to the document.

    title: string

    Primary title or heading of the document.

    Settings

    Member Visibility

    On This Page

    Properties