Interface: UnifiedRetrieverDeps

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:94

Dependencies injected into the UnifiedRetriever.

All dependencies are optional — the retriever gracefully skips sources whose dependencies are not provided. This allows incremental adoption: start with just vector + BM25, then add GraphRAG, RAPTOR, memory, etc.

Example

const deps: UnifiedRetrieverDeps = {
  hybridSearcher: myHybridSearcher,
  rerank: async (q, chunks, n) => chunks.slice(0, n),
  emit: (event) => console.log(event.type),
};

Properties

collectionName?

optional collectionName: string

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:105

Vector store collection name for hybrid search.

Default

'knowledge-base'

---

decompose()?

optional decompose: (query, maxSubQueries) => Promise<string[]>

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:176

Query decomposition callback for complex strategies.

Parameters

query

string

The original multi-part query.

maxSubQueries

number

Maximum sub-queries to generate.

Returns

Promise<string[]>

Array of decomposed sub-query strings.

---

deepResearch()?

optional deepResearch: (query, sources) => Promise<{ sources: RetrievedChunk[]; synthesis: string; }>

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:164

Deep research synthesis callback.

Parameters

query

string

The user query.

sources

string[]

Source hints for research.

Returns

Promise<{ sources: RetrievedChunk[]; synthesis: string; }>

Synthesis narrative and source chunks.

---

defaultMood?

optional defaultMood: object

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:213

Default PAD mood state for memory operations. Used when no mood context is available.

arousal

arousal: number

dominance

dominance: number

valence

valence: number

---

defaultTopK?

optional defaultTopK: number

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:194

Default topK for final results.

Default

10

---

emit()?

optional emit: (event) => void

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:182

Event listener callback for retrieval lifecycle events.

Parameters

event

UnifiedRetrieverEvent

A typed UnifiedRetriever event.

Returns

void

---

graphEngine?

optional graphEngine: IGraphRAGEngine

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:117

GraphRAG engine for entity/relationship traversal. When provided, enables the graph source.

---

hybridSearcher?

optional hybridSearcher: HybridSearcher

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:99

Hybrid dense+sparse searcher (vector + BM25). When provided, enables the vector and bm25 sources.

---

hydeRetriever?

optional hydeRetriever: HydeRetriever

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:130

HyDE (Hypothetical Document Embedding) retriever. When provided and plan.hyde.enabled is true, generates hypothetical answers before embedding for improved recall.

---

maxSubQueries?

optional maxSubQueries: number

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:200

Maximum sub-queries for complex decomposition.

Default

5

---

memoryCacheThreshold?

optional memoryCacheThreshold: number

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:207

Memory cache hit confidence threshold. Episodic memories above this confidence skip external sources.

Default

0.85

---

memoryManager?

optional memoryManager: ICognitiveMemoryManager

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:123

Cognitive memory manager. When provided, enables the memory source and memory feedback loop.

---

multimodalIndexer?

optional multimodalIndexer: MultimodalIndexer

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:136

Multimodal indexer for image/audio/video search. When provided, enables the multimodal source.

---

raptorTree?

optional raptorTree: RaptorTree

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:111

RAPTOR hierarchical summary tree. When provided, enables the raptor source.

---

rerank()?

optional rerank: (query, chunks, topN) => Promise<RetrievedChunk[]>

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:155

Cross-encoder or LLM-based reranker.

Parameters

query

string

The user query for relevance scoring.

chunks

RetrievedChunk[]

Candidate chunks to rerank.

topN

number

Maximum chunks to keep after reranking.

Returns

Promise<RetrievedChunk[]>

Reranked chunks.

---

rrfK?

optional rrfK: number

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:188

RRF constant k. Higher values flatten score differences.

Default

60

---

vectorSearch()?

optional vectorSearch: (query, topK) => Promise<RetrievedChunk[]>

Defined in: packages/agentos/src/rag/unified/UnifiedRetriever.ts:145

Vector search function (fallback when hybridSearcher is not available).

Parameters

query

string

The search query.

topK

number

Maximum results to return.

Returns

Promise<RetrievedChunk[]>

Retrieved chunks.