RetrievalQualityChecker
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RetrievalQualityChecker(options?): RetrievalQualityChecker;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
Returns
Section titled “Returns”RetrievalQualityChecker
Methods
Section titled “Methods”assess()
Section titled “assess()”assess(results): Omit<QualityCheckResult, "reformulated" | "reformulatedQuery" | "backgroundReformulation">;Assess retrieval quality based on score distribution. The score check itself is sub-millisecond (pure arithmetic).
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
Returns
Section titled “Returns”Omit<QualityCheckResult, "reformulated" | "reformulatedQuery" | "backgroundReformulation">
check()
Section titled “check()”check( query, results,isVoice?): Promise<QualityCheckResult>;Full quality check with optional reformulation for text agents.
Parameters
Section titled “Parameters”| Parameter | Type | Default value | Description |
|---|---|---|---|
|
|
|
|
The original user query. |
|
|
|
Retrieval results to evaluate. |
|
|
|
|
|
Whether this is a voice agent (reformulation goes to background). |
Returns
Section titled “Returns”Promise<QualityCheckResult>
Quality assessment with optional reformulated query.