Interface DocumentInterface<Metadata>

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

Type Parameters

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

Hierarchy (view full)

DocumentInterface
- HashedDocumentInterface

Implemented by

Document

Index

Properties

metadata pageContent id?

Properties

metadata

metadata: Metadata

pageContent

pageContent: string

`Optional` id

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.

Generated using TypeDoc