RetrievalRecord interface

Represents a single multi-modal record stored in the vector store.

Signature:

export declare interface RetrievalRecord 

Properties

Property Type Description
childIds readonly string[] The identifiers of chunked child records, if any.
content readonly ContentPart[] The list of multi-modal parts that make up the record content.
embeddings Float32Array The vector embeddings representing the record.
id string The unique identifier of the record.
metadata Record<string, string> The key-value metadata associated with the record.
parentId string The unique identifier of the parent document, if any.

RetrievalRecord.childIds

The identifiers of chunked child records, if any.

Signature:

childIds?: readonly string[];

RetrievalRecord.content

The list of multi-modal parts that make up the record content.

Signature:

content: readonly ContentPart[];

RetrievalRecord.embeddings

The vector embeddings representing the record.

Signature:

embeddings: Float32Array;

RetrievalRecord.id

The unique identifier of the record.

Signature:

id: string;

RetrievalRecord.metadata

The key-value metadata associated with the record.

Signature:

metadata: Record<string, string>;

RetrievalRecord.parentId

The unique identifier of the parent document, if any.

Signature:

parentId?: string;