Skip to content

RetrievalQualityChecker

new RetrievalQualityChecker(options?): RetrievalQualityChecker;
Parameter Type

options?

RetrievalQualityCheckerOptions

RetrievalQualityChecker

assess(results): Omit<QualityCheckResult, "reformulated" | "reformulatedQuery" | "backgroundReformulation">;

Assess retrieval quality based on score distribution. The score check itself is sub-millisecond (pure arithmetic).

Parameter Type

results

RetrievalResult[]

Omit<QualityCheckResult, "reformulated" | "reformulatedQuery" | "backgroundReformulation">


check(
query,
results,
isVoice?): Promise<QualityCheckResult>;

Full quality check with optional reformulation for text agents.

Parameter Type Default value Description

query

string

undefined

The original user query.

results

RetrievalResult[]

undefined

Retrieval results to evaluate.

isVoice

boolean

false

Whether this is a voice agent (reformulation goes to background).

Promise<QualityCheckResult>

Quality assessment with optional reformulated query.