Skip to main content

Interface: RagRetrievalDiagnostics

Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:130

Diagnostics emitted by retrieval operations.

Properties​

dataSourceHits?​

optional dataSourceHits: Record<string, number>

Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:136

effectiveDataSourceIds?​

optional effectiveDataSourceIds: string[]

Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:137

embeddingTimeMs?​

optional embeddingTimeMs: number

Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:131

hyde?​

optional hyde: object

Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:148

HyDE-specific diagnostics, populated when HyDE retrieval is active.

  • hypothesis: The generated (or pre-supplied) hypothetical answer.
  • hypothesisLatencyMs: Time spent generating the hypothesis via LLM.
  • effectiveThreshold: Final similarity threshold after adaptive stepping.
  • thresholdSteps: Number of times the threshold was lowered before results were found (0 means the initial threshold succeeded).

effectiveThreshold​

effectiveThreshold: number

hypothesis​

hypothesis: string

hypothesisLatencyMs​

hypothesisLatencyMs: number

thresholdSteps​

thresholdSteps: number

messages?​

optional messages: string[]

Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:138

policy?​

optional policy: object

Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:154

confidence​

confidence: RetrievalConfidenceSummary

escalations​

escalations: string[]

profile​

profile: MemoryRetrievalProfile

rerankingTimeMs?​

optional rerankingTimeMs: number

Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:133

retrievalTimeMs?​

optional retrievalTimeMs: number

Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:132

strategyUsed?​

optional strategyUsed: "hybrid" | "similarity" | "mmr"

Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:135

totalTokensInContext?​

optional totalTokensInContext: number

Defined in: packages/agentos/src/rag/IRetrievalAugmentor.ts:134