recall()
Semantic and hybrid search with filters, thresholds, MMR, and rerank. Fail-closed hybrid/rerank since 0.6.0. Supports AbortSignal.
Signature
recall(options: RecallOptions): Promise<RecallResult[]>Options
| Field | Default | Description |
|---|---|---|
query | — | Natural-language query (required) |
topK | 5 | Max results (1–1000) |
threshold | 0 | Minimum cosine similarity |
filter | — | agent, includeArchived, metadata |
hybrid | — | true or weights; requires keywordSearch |
mmr | — | Diversification; true or { lambda } |
rerank | false | Requires configured reranker |
explain | false | Ranking diagnostics + timings |
signal | — | AbortSignal — throws CancellationError |
Fail-closed hybrid and rerank
Since 0.6.0
hybrid: truewithoutkeywordSearch→ValidationError(no semantic-only fallback)rerank: truewithoutreranker→ValidationError- Built-in rerankers throw
RerankErroron failure (no identity-order fallback)
Example
import { meta } from "wolbarg";
const hits = await ctx.recall({
query: "billing invoices",
topK: 8,
threshold: 0.25,
hybrid: { semanticWeight: 0.7, keywordWeight: 0.3 },
mmr: { lambda: 0.6 },
rerank: true,
filter: {
agent: "research",
metadata: meta.and(
meta.eq("topic", "billing"),
meta.gte("priority", 1),
),
},
signal: AbortSignal.timeout(10_000),
});