Interface: IRetrievalAugmentor
Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:343
Primary contract for the Retrieval Augmentor implementation.
Properties
augmenterId
readonlyaugmenterId:string
Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:344
Methods
checkHealth()
checkHealth():
Promise<{details?:Record<string,unknown>;isHealthy:boolean; }>
Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:382
Returns
Promise<{ details?: Record<string, unknown>; isHealthy: boolean; }>
deleteDocuments()
deleteDocuments(
documentIds,dataSourceId?,options?):Promise<{errors?:object[];failureCount:number;successCount:number; }>
Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:371
Parameters
documentIds
string[]
dataSourceId?
string
options?
ignoreNotFound?
boolean
Returns
Promise<{ errors?: object[]; failureCount: number; successCount: number; }>
embedTexts()
embedTexts(
texts):Promise<number[][]>
Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:369
Batch-embed a list of texts using the same embedding model the augmentor
uses for retrieval. Exposed so consumers (e.g. CitationVerifier
via the agent-level verifyCitations: { retrievalAugmentor } shortcut)
can share a single embedding pipeline rather than wiring an embedder
twice with potentially-divergent model configs.
Parameters
texts
string[]
Returns
Promise<number[][]>
ingestDocuments()
ingestDocuments(
documents,options?):Promise<RagIngestionResult>
Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:352
Parameters
documents
RagDocumentInput | RagDocumentInput[]
options?
Returns
Promise<RagIngestionResult>
initialize()
initialize(
config,embeddingManager,vectorStoreManager):Promise<void>
Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:346
Parameters
config
RetrievalAugmentorServiceConfig
embeddingManager
vectorStoreManager
Returns
Promise<void>
retrieveContext()
retrieveContext(
queryText,options?):Promise<RagRetrievalResult>
Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:357
Parameters
queryText
string
options?
Returns
Promise<RagRetrievalResult>
shutdown()
shutdown():
Promise<void>
Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:384
Returns
Promise<void>
updateDocuments()
updateDocuments(
documents,options?):Promise<RagIngestionResult>
Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:377
Parameters
documents
RagDocumentInput | RagDocumentInput[]
options?
Returns
Promise<RagIngestionResult>