Skip to main content

Interface: EmbeddedContent

The embedded content of a chunk of text stored in the database.

Properties

chunkAlgoHash

Optional chunkAlgoHash: string

Non-cryptographic hash of the actual chunking function (and its options) used to produce this chunk. Used to detect whether the chunk should be updated because the function or options have changed.

Defined in

packages/mongodb-rag-core/build/EmbeddedContent.d.ts:48


chunkIndex

Optional chunkIndex: number

The order of the chunk if this content was chunked from a larger page.

Defined in

packages/mongodb-rag-core/build/EmbeddedContent.d.ts:42


embedding

embedding: number[]

The vector embedding of the text.

Defined in

packages/mongodb-rag-core/build/EmbeddedContent.d.ts:26


metadata

Optional metadata: Object

Arbitrary metadata associated with the content. If the content text has metadata in Front Matter format, this metadata should match that metadata.

Index signature

▪ [k: string]: unknown

Type declaration

NameType
tags?string[]

Defined in

packages/mongodb-rag-core/build/EmbeddedContent.d.ts:35


sourceName

sourceName: string

The name of the data source the page was loaded from.

Defined in

packages/mongodb-rag-core/build/EmbeddedContent.d.ts:14


text

text: string

The text represented by the vector embedding.

Defined in

packages/mongodb-rag-core/build/EmbeddedContent.d.ts:18


tokenCount

tokenCount: number

The number of embedding tokens in the content.

Defined in

packages/mongodb-rag-core/build/EmbeddedContent.d.ts:22


updated

updated: Date

The date the content was last updated.

Defined in

packages/mongodb-rag-core/build/EmbeddedContent.d.ts:30


url

url: string

The URL of the page with the content.

Defined in

packages/mongodb-rag-core/build/EmbeddedContent.d.ts:10