Skip to main content

Class: RetrievalAugmentor

Defined in: packages/agentos/src/rag/RetrievalAugmentor.ts:51

RetrievalAugmentor

Implements​

Orchestrates the RAG pipeline including ingestion, retrieval, and document management.

Implements​

Constructors​

Constructor​

new RetrievalAugmentor(): RetrievalAugmentor

Defined in: packages/agentos/src/rag/RetrievalAugmentor.ts:63

Constructs a RetrievalAugmentor instance. It is not operational until initialize is successfully called.

Returns​

RetrievalAugmentor

Properties​

augmenterId​

readonly augmenterId: string

Defined in: packages/agentos/src/rag/RetrievalAugmentor.ts:52

Implementation of​

IRetrievalAugmentor.augmenterId

Methods​

checkHealth()​

checkHealth(): Promise<{ details?: Record<string, unknown>; isHealthy: boolean; }>

Defined in: packages/agentos/src/rag/RetrievalAugmentor.ts:835

Returns​

Promise<{ details?: Record<string, unknown>; isHealthy: boolean; }>

Inherit Doc​

Implementation of​

IRetrievalAugmentor.checkHealth

deleteDocuments()​

deleteDocuments(documentIds, dataSourceId?, _options?): Promise<{ errors?: object[]; failureCount: number; successCount: number; }>

Defined in: packages/agentos/src/rag/RetrievalAugmentor.ts:730

Parameters​

documentIds​

string[]

dataSourceId?​

string

_options?​
ignoreNotFound?​

boolean

Returns​

Promise<{ errors?: object[]; failureCount: number; successCount: number; }>

Inherit Doc​

Implementation of​

IRetrievalAugmentor.deleteDocuments

ingestDocuments()​

ingestDocuments(documents, options?): Promise<RagIngestionResult>

Defined in: packages/agentos/src/rag/RetrievalAugmentor.ts:178

Parameters​

documents​

RagDocumentInput | RagDocumentInput[]

options?​

RagIngestionOptions

Returns​

Promise<RagIngestionResult>

Inherit Doc​

Implementation of​

IRetrievalAugmentor.ingestDocuments

initialize()​

initialize(config, embeddingManager, vectorStoreManager): Promise<void>

Defined in: packages/agentos/src/rag/RetrievalAugmentor.ts:70

Parameters​

config​

RetrievalAugmentorServiceConfig

embeddingManager​

IEmbeddingManager

vectorStoreManager​

IVectorStoreManager

Returns​

Promise<void>

Inherit Doc​

Implementation of​

IRetrievalAugmentor.initialize

registerRerankerProvider()​

registerRerankerProvider(provider): void

Defined in: packages/agentos/src/rag/RetrievalAugmentor.ts:163

Register a reranker provider with the RerankerService.

Call this after initialization to add reranker providers (e.g., CohereReranker, LocalCrossEncoderReranker) that will be available for reranking operations.

Parameters​

provider​

IRerankerProvider

A reranker provider instance implementing IRerankerProvider

Returns​

void

Throws​

If RerankerService is not configured

Example​

import { CohereReranker, LocalCrossEncoderReranker } from '@framers/agentos/rag/reranking';

// After initialization
augmentor.registerRerankerProvider(new CohereReranker({
  providerId: 'cohere',
  apiKey: process.env.COHERE_API_KEY!
}));

augmentor.registerRerankerProvider(new LocalCrossEncoderReranker({
  providerId: 'local',
  defaultModelId: 'cross-encoder/ms-marco-MiniLM-L-6-v2'
}));

retrieveContext()​

retrieveContext(queryText, options?): Promise<RagRetrievalResult>

Defined in: packages/agentos/src/rag/RetrievalAugmentor.ts:542

Parameters​

queryText​

string

options?​

RagRetrievalOptions

Returns​

Promise<RagRetrievalResult>

Inherit Doc​

Implementation of​

IRetrievalAugmentor.retrieveContext

shutdown()​

shutdown(): Promise<void>

Defined in: packages/agentos/src/rag/RetrievalAugmentor.ts:864

Returns​

Promise<void>

Inherit Doc​

Implementation of​

IRetrievalAugmentor.shutdown

updateDocuments()​

updateDocuments(documents, options?): Promise<RagIngestionResult>

Defined in: packages/agentos/src/rag/RetrievalAugmentor.ts:798

Parameters​

documents​

RagDocumentInput | RagDocumentInput[]

options?​

RagIngestionOptions

Returns​

Promise<RagIngestionResult>

Inherit Doc​

Implementation of​

IRetrievalAugmentor.updateDocuments