SemanticRetriever coordinates document chunking, multimodal embedding, and high-dimensional vector search.
Signature:
export declare class SemanticRetriever
Methods
| Method | Modifiers | Description |
|---|---|---|
| close() | Closes the retriever and frees resources. | |
| createFromComponents(components) | static |
Creates a SemanticRetriever from SemanticRetrieverComponents. |
| delete(idsOrFilter) | Deletes records and their chunks by ID(s), or records matching metadata filter. | |
| deleteAll() | Deletes all records from the retriever. | |
| getAllRecordIds() | Retrieves all unique top-level record IDs stored in the retriever. | |
| insertAudio(id, audioData, metadata) | Inserts pre-decoded PCM float audio samples into the retriever. | |
| insertContent(id, parts, metadata) | Inserts multimodal content parts under a single unique ID. | |
| insertDocument(id, text, metadata) | Inserts a text document into the retriever with automatic chunking. | |
| insertImage(id, imageBytes, metadata) | Inserts an image into the retriever. | |
| retrieve(query, options) | Retrieves top-K nearest matching records based on a text or multimodal query. |
SemanticRetriever.close()
Closes the retriever and frees resources.
Signature:
close(): void;
Returns:
void
SemanticRetriever.createFromComponents()
Creates a SemanticRetriever from SemanticRetrieverComponents.
Signature:
static createFromComponents(components: SemanticRetrieverComponents): Promise<SemanticRetriever>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| components | SemanticRetrieverComponents | The SemanticRetriever components. A Promise resolving to the SemanticRetriever instance. |
Returns:
Promise<SemanticRetriever>
SemanticRetriever.delete()
Deletes records and their chunks by ID(s), or records matching metadata filter.
Signature:
delete(idsOrFilter: string | readonly string[] | Record<string, string>): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| idsOrFilter | string | readonly string[] | Record<string, string> |
Returns:
Promise<void>
SemanticRetriever.deleteAll()
Deletes all records from the retriever.
Signature:
deleteAll(): Promise<void>;
Returns:
Promise<void>
SemanticRetriever.getAllRecordIds()
Retrieves all unique top-level record IDs stored in the retriever.
Signature:
getAllRecordIds(): Promise<string[]>;
Returns:
Promise<string[]>
SemanticRetriever.insertAudio()
Inserts pre-decoded PCM float audio samples into the retriever.
Signature:
insertAudio(id: string, audioData: Float32Array, metadata?: Record<string, string>): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| audioData | Float32Array | |
| metadata | Record<string, string> |
Returns:
Promise<void>
SemanticRetriever.insertContent()
Inserts multimodal content parts under a single unique ID.
Signature:
insertContent(id: string, parts: readonly ContentPart[], metadata?: Record<string, string>): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| parts | readonly ContentPart[] | |
| metadata | Record<string, string> |
Returns:
Promise<void>
SemanticRetriever.insertDocument()
Inserts a text document into the retriever with automatic chunking.
Signature:
insertDocument(id: string, text: string, metadata?: Record<string, string>): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| text | string | |
| metadata | Record<string, string> |
Returns:
Promise<void>
SemanticRetriever.insertImage()
Inserts an image into the retriever.
Signature:
insertImage(id: string, imageBytes: Uint8Array, metadata?: Record<string, string>): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| imageBytes | Uint8Array | |
| metadata | Record<string, string> |
Returns:
Promise<void>
SemanticRetriever.retrieve()
Retrieves top-K nearest matching records based on a text or multimodal query.
Signature:
retrieve(query: string | readonly ContentPart[], options?: RetrievalOptions): Promise<RetrievalResult[]>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| query | string | readonly ContentPart[] | |
| options | RetrievalOptions |
Returns:
Promise<RetrievalResult[]>