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;
    tenantId?: string;
    aclGroups?: string[];
    classification?: "internal" | "public" | "confidential" | "restricted";
    status?: "active" | "archived" | "deprecated" | "draft";
    effectiveDate?: string;
    expiresAt?: string;
}

Properties

id content dataSourceId? source? metadata? language? timestamp? embedding? embeddingModelId? tenantId? aclGroups? classification? status? effectiveDate? expiresAt?

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.

Optional tenantId

tenantId?: string

Tenant the document belongs to. Used for multi-tenant isolation.

Optional aclGroups

aclGroups?: string[]

ACL groups allowed to retrieve this document. Empty/undefined means the document inherits the data source's default ACL (typically unrestricted within the tenant).

Optional classification

classification?: "internal" | "public" | "confidential" | "restricted"

Sensitivity classification. Drives default redaction policy and audit obligations.

Optional status

status?: "active" | "archived" | "deprecated" | "draft"

Lifecycle status. active chunks are returned by default; draft/archived/deprecated are excluded unless the retrieval options opt them in.

Optional effectiveDate

effectiveDate?: string

ISO timestamp: when this document became authoritative.

Optional expiresAt

expiresAt?: string

ISO timestamp: when this document stops being authoritative.

Settings

Member Visibility

Theme

On This Page

idcontentdataSourceIdsourcemetadatalanguagetimestampembeddingembeddingModelIdtenantIdaclGroupsclassificationstatuseffectiveDateexpiresAt