Lightweight, in-memory implementation of VectorStore in TypeScript.
Signature:
export declare class MemoryVectorStore implements VectorStore
Methods
| Method | Modifiers | Description |
|---|---|---|
| upsert(records) | Upserts records into the vector store. | |
| delete(ids) | Deletes records by their IDs. | |
| deleteByMetadata(metadataFilter) | Deletes records matching a metadata filter. | |
| search(queryEmbedding, topK, metadataFilter) | Searches for top-K matching records. | |
| get(ids) | Retrieves records by IDs. | |
| getAllRecordIds() | Gets all unique record IDs. | |
| deleteAll() | Deletes all records. | |
| close() | Closes the vector store. |
MemoryVectorStore.upsert() {#memoryvectorstoreupsert}
Upserts records into the vector store.
Signature:
upsert(records: readonly RetrievalRecord[]): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| records | readonly RetrievalRecord[] |
Returns:
void
MemoryVectorStore.delete() {#memoryvectorstoredelete}
Deletes records by their IDs.
Signature:
delete(ids: readonly string[]): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| ids | readonly string[] |
Returns:
void
MemoryVectorStore.deleteByMetadata() {#memoryvectorstoredeletebymetadata}
Deletes records matching a metadata filter.
Signature:
deleteByMetadata(metadataFilter: Record<string, string>): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| metadataFilter | Record<string, string> |
Returns:
void
MemoryVectorStore.search() {#memoryvectorstoresearch}
Searches for top-K matching records.
Signature:
search(queryEmbedding: Float32Array | readonly number[], topK: number, metadataFilter?: Record<string, string>): RetrievalRecord[];
Parameters
| Parameter | Type | Description |
|---|---|---|
| queryEmbedding | Float32Array | readonly number[] | |
| topK | number | |
| metadataFilter | Record<string, string> |
Returns:
RetrievalRecord[]
MemoryVectorStore.get() {#memoryvectorstoreget}
Retrieves records by IDs.
Signature:
get(ids: readonly string[]): RetrievalRecord[];
Parameters
| Parameter | Type | Description |
|---|---|---|
| ids | readonly string[] |
Returns:
RetrievalRecord[]
MemoryVectorStore.getAllRecordIds() {#memoryvectorstoregetallrecordids}
Gets all unique record IDs.
Signature:
getAllRecordIds(): string[];
Returns:
string[]
MemoryVectorStore.deleteAll() {#memoryvectorstoredeleteall}
Deletes all records.
Signature:
deleteAll(): void;
Returns:
void
MemoryVectorStore.close() {#memoryvectorstoreclose}
Closes the vector store.
Signature:
close(): void;
Returns:
void