Class RetrievalAugmentor

constructor

• new RetrievalAugmentor(): RetrievalAugmentor

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

  Returns RetrievalAugmentor

initialize

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

• Parameters

  • config: RetrievalAugmentorServiceConfig
  • embeddingManager: IEmbeddingManager
  • vectorStoreManager: IVectorStoreManager

  Returns Promise<void>

  Inherit Doc

ingestDocuments

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

• Parameters

  • documents: RagDocumentInput | RagDocumentInput[]
  • Optional options: RagIngestionOptions

  Returns Promise<RagIngestionResult>

  Inherit Doc

retrieveContext

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

• Parameters

  • queryText: string
  • Optional options: RagRetrievalOptions

  Returns Promise<RagRetrievalResult>

  Inherit Doc

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;
      }[];
  }>

  Inherit Doc

updateDocuments

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

• Parameters

  • documents: RagDocumentInput | RagDocumentInput[]
  • Optional options: RagIngestionOptions

  Returns Promise<RagIngestionResult>

  Inherit Doc

checkHealth

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

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

  Inherit Doc

shutdown

• shutdown(): Promise<void>

• Returns Promise<void>

  Inherit Doc

Readonly augmenterId