recall()

Signature

await ctx.recall(options: RecallOptions): Promise<RecallResult[]>

Parameters

• query — natural language search text
• topK — max results (default 5)
• threshold — minimum cosine similarity 0–1 (default 0)
• filter.agent — optional agent filter
• filter.includeArchived — include compressed sources

Similarity scoring

Results are ranked by cosine similarity (higher is better). Each hit includes the original content, metadata, and score.

Example

const memories = await ctx.recall({
  query: "How do recurring invoices work?",
  topK: 5,
  threshold: 0.75,
  filter: { agent: "research" },
});

for (const hit of memories) {
  console.log(hit.similarity, hit.content.text, hit.metadata);
}