Extractor

A named, typed, structured thing to learn from a conversation. Always schema-driven — no Mastra-style tag-scraping inline mode.

Type Parameters

Type Parameter	Default type
T	unknown

Properties

includePrevious

readonly includePrevious: boolean;

Include the previously extracted value in the prompt. Default true.

---

instructions

readonly instructions: string | ((c) => string | Promise<string>);

---

name

readonly name: string;

---

onExtracted?

readonly optional onExtracted?: (c) => void | T | Promise<void | T>;

Interceptor: returning a value replaces it before persistence; throwing records a per-slug failure.

Parameters

Parameter	Type
c	ExtractorOnExtractedContext<T>

Returns

void | T | Promise<void | T>

---

persist

readonly persist: boolean;

Persist to PersistentMemoryStore. false = emit + run onExtracted only. Default true.

---

schema

readonly schema:
  | ZodType<T, unknown, $ZodTypeInternals<T, unknown>>
  | ((c) =>
  | ZodType<T, unknown, $ZodTypeInternals<T, unknown>>
  | Promise<ZodType<T, unknown, $ZodTypeInternals<T, unknown>>>);

---

scope

readonly scope: MemoryBlockScope;

---

slug

readonly slug: string;

Derived from name via slugifyExtractorName.