Interface RagRetrievedChunk

Structure describing a retrieved chunk.

interface RagRetrievedChunk {
    id: string;
    content: string;
    originalDocumentId: string;
    dataSourceId?: string;
    source?: string;
    metadata?: Record<string, MetadataValue>;
    relevanceScore?: number;
    embedding?: number[];
}

Properties

id content originalDocumentId dataSourceId? source? metadata? relevanceScore? embedding?

Properties

id

id: string

content

content: string

originalDocumentId

originalDocumentId: string

Original document ID for traceability.

Optional dataSourceId

dataSourceId?: string

Data source / collection identifier.

Optional source

source?: string

Optional human-friendly source description.

Optional metadata

metadata?: Record<string, MetadataValue>

Metadata that traveled with the chunk.

Optional relevanceScore

relevanceScore?: number

Similarity or relevance score returned by the vector store.

Optional embedding

embedding?: number[]

Embedding vector if includeEmbeddings was requested.

Settings

Member Visibility

Theme

On This Page

idcontentoriginalDocumentIddataSourceIdsourcemetadatarelevanceScoreembedding