Interface: IRetrievalAugmentor
Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:255
Primary contract for the Retrieval Augmentor implementation.
Properties
augmenterId
readonlyaugmenterId:string
Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:256
Methods
checkHealth()
checkHealth():
Promise<{details?:Record<string,unknown>;isHealthy:boolean; }>
Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:285
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/rag/IRetrievalAugmentor.ts:274
Parameters
documentIds
string[]
dataSourceId?
string
options?
ignoreNotFound?
boolean
Returns
Promise<{ errors?: object[]; failureCount: number; successCount: number; }>
ingestDocuments()
ingestDocuments(
documents,options?):Promise<RagIngestionResult>
Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:264
Parameters
documents
RagDocumentInput | RagDocumentInput[]
options?
Returns
Promise<RagIngestionResult>
initialize()
initialize(
config,embeddingManager,vectorStoreManager):Promise<void>
Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:258
Parameters
config
RetrievalAugmentorServiceConfig
embeddingManager
vectorStoreManager
Returns
Promise<void>
retrieveContext()
retrieveContext(
queryText,options?):Promise<RagRetrievalResult>
Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:269
Parameters
queryText
string
options?
Returns
Promise<RagRetrievalResult>
shutdown()
shutdown():
Promise<void>
Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:287
Returns
Promise<void>
updateDocuments()
updateDocuments(
documents,options?):Promise<RagIngestionResult>
Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:280
Parameters
documents
RagDocumentInput | RagDocumentInput[]
options?
Returns
Promise<RagIngestionResult>