Interface IRetrievalAugmentor

Primary contract for the Retrieval Augmentor implementation.

interface IRetrievalAugmentor {
    augmenterId: string;
    initialize(config, embeddingManager, vectorStoreManager): Promise<void>;
    ingestDocuments(documents, options?): Promise<RagIngestionResult>;
    retrieveContext(queryText, options?): Promise<RagRetrievalResult>;
    embedTexts(texts): Promise<number[][]>;
    deleteDocuments(documentIds, dataSourceId?, options?): Promise<{
        successCount: number;
        failureCount: number;
        errors?: {
            documentId: string;
            message: string;
            details?: any;
        }[];
    }>;
    updateDocuments(documents, options?): Promise<RagIngestionResult>;
    checkHealth(): Promise<{
        isHealthy: boolean;
        details?: Record<string, unknown>;
    }>;
    shutdown(): Promise<void>;
}

Implemented by

Methods

initialize ingestDocuments retrieveContext embedTexts deleteDocuments updateDocuments checkHealth shutdown

Properties

augmenterId

Methods

initialize

ingestDocuments

retrieveContext

embedTexts

  • embedTexts(texts): Promise<number[][]>

  • 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[][]>

deleteDocuments

  • deleteDocuments(documentIds, dataSourceId?, options?): Promise<{
        successCount: number;
        failureCount: number;
        errors?: {
            documentId: string;
            message: string;
            details?: any;
        }[];
    }>

  • Parameters

    • documentIds: string[]
    • Optional dataSourceId: string
    • Optional options: {
          ignoreNotFound?: boolean;
      }
      • Optional ignoreNotFound?: boolean

    Returns Promise<{
        successCount: number;
        failureCount: number;
        errors?: {
            documentId: string;
            message: string;
            details?: any;
        }[];
    }>

updateDocuments

checkHealth

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

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

shutdown

Properties

Readonly augmenterId

augmenterId: string

Settings

Member Visibility

Theme

On This Page

initializeingestDocumentsretrieveContextembedTextsdeleteDocumentsupdateDocumentscheckHealthshutdownaugmenterId