Class: HydeRetriever
Defined in: packages/agentos/src/rag/HydeRetriever.ts:123
HyDE retriever: generates a hypothetical answer, embeds it, and searches the vector store with adaptive thresholding.
Constructors
Constructor
new HydeRetriever(
opts):HydeRetriever
Defined in: packages/agentos/src/rag/HydeRetriever.ts:128
Parameters
opts
config?
Partial<HydeConfig>
embeddingManager
llmCaller
Returns
HydeRetriever
Accessors
enabled
Get Signature
get enabled():
boolean
Defined in: packages/agentos/src/rag/HydeRetriever.ts:139
Whether HyDE is enabled.
Returns
boolean
Methods
generateHypothesis()
generateHypothesis(
query):Promise<{hypothesis:string;latencyMs:number; }>
Defined in: packages/agentos/src/rag/HydeRetriever.ts:159
Generate a hypothetical answer for a query.
Parameters
query
string
Returns
Promise<{ hypothesis: string; latencyMs: number; }>
retrieve()
retrieve(
opts):Promise<HydeRetrievalResult>
Defined in: packages/agentos/src/rag/HydeRetriever.ts:176
Embed the hypothesis and search the vector store. Uses adaptive thresholding: starts at initialThreshold, steps down until results are found or minThreshold is reached.
Parameters
opts
collectionName
string
hypothesis?
string
Pre-generated hypothesis (skip generation if provided).
query
string
queryOptions?
Partial<QueryOptions>
vectorStore
Returns
Promise<HydeRetrievalResult>
retrieveContext()
retrieveContext(
opts):Promise<{chunkCount:number;context:string;effectiveThreshold:number;hypothesis:string;latencyMs:number; }>
Defined in: packages/agentos/src/rag/HydeRetriever.ts:269
Convenience: retrieve and format as augmented context string.
Parameters
opts
collectionName
string
query
string
queryOptions?
Partial<QueryOptions>
separator?
string
vectorStore
Returns
Promise<{ chunkCount: number; context: string; effectiveThreshold: number; hypothesis: string; latencyMs: number; }>