Interface DocumentInterface<Metadata>

interface DocumentInterface<Metadata> {
    id?: string;
    metadata: Metadata;
    pageContent: string;
}

Type Parameters

  • Metadata extends Record<string, any> = Record<string, any>

Hierarchy (view full)

Implemented by

Properties

id?: string

An optional identifier for the document.

Ideally this should be unique across the document collection and formatted as a UUID, but this will not be enforced.

metadata: Metadata
pageContent: string