A document or chunk record stored in a vector store, containing multimodal content, embeddings, and metadata.
Signature:
export declare interface RetrievalRecord
Properties
| Property | Type | Description |
|---|---|---|
| childIds | string[] | undefined | Optional IDs of child chunk records derived from this parent document. |
| content | TaskPart[] | Multimodal content parts of the record. |
| embeddings | Array<Float32Array | number[]> | Embedding vectors associated with the record. |
| id | string | Unique identifier for the record. |
| metadata | Record<string, string> | undefined | Optional key-value metadata associated with the record. |
| parentId | string | undefined | Optional ID of the parent document record if this record is a chunk. |
RetrievalRecord.childIds
Optional IDs of child chunk records derived from this parent document.
Signature:
childIds?: string[];
RetrievalRecord.content
Multimodal content parts of the record.
Signature:
content: TaskPart[];
RetrievalRecord.embeddings
Embedding vectors associated with the record.
Signature:
embeddings: Array<Float32Array | number[]>;
RetrievalRecord.id
Unique identifier for the record.
Signature:
id: string;
RetrievalRecord.metadata
Optional key-value metadata associated with the record.
Signature:
metadata?: Record<string, string>;
RetrievalRecord.parentId
Optional ID of the parent document record if this record is a chunk.
Signature:
parentId?: string;