Interface RagDocumentInput

Represents raw document content provided for ingestion.

interface RagDocumentInput {
    id: string;
    content: string;
    dataSourceId?: string;
    source?: string;
    metadata?: Record<string, MetadataValue>;
    language?: string;
    timestamp?: string;
    embedding?: number[];
    embeddingModelId?: string;
}

Properties

id content dataSourceId? source? metadata? language? timestamp? embedding? embeddingModelId?

Properties

id

id: string

Stable identifier for the document (chunk IDs will derive from this).

content

content: string

Raw text that will be chunked and embedded.

Optional dataSourceId

dataSourceId?: string

Optional override for which data source / collection to push this document into.

Optional source

source?: string

Original source pointer (URL, file path, API, etc.).

Optional metadata

metadata?: Record<string, MetadataValue>

Arbitrary metadata stored alongside chunks; values must be vector-store friendly.

Optional language

language?: string

ISO language tag for the content.

Optional timestamp

timestamp?: string

ISO timestamp describing when this content was produced/updated.

Optional embedding

embedding?: number[]

Optional pre-computed embedding vector.

Optional embeddingModelId

embeddingModelId?: string

Identifier of the embedding model used when embedding is supplied.

Settings

Member Visibility

Theme

On This Page

idcontentdataSourceIdsourcemetadatalanguagetimestampembeddingembeddingModelId