import { MemoryTier } from "./memory-item.type.mjs";

//#region ../ai/src/contracts/memory/recall-options.type.d.ts
/**
 * Options for `memory.recall(query, options?)`.
 *
 * All fields are optional — the common call is `recall("some query")`,
 * which uses the factory-configured `k` and threshold against every
 * configured tier.
 */
type RecallOptions = {
  /**
   * Maximum number of memories to return. Overrides the factory's `k`
   * for this call. The result is the top-`k` across whichever tiers are
   * queried, ordered by descending `score`.
   */
  k?: number;
  /**
   * Restrict recall to a single tier. Omit to query every tier the
   * factory was configured with (working first, then semantic) and
   * merge the results.
   */
  tier?: MemoryTier;
  /**
   * Minimum semantic similarity for a hit, in `[0, 1]`. Overrides the
   * factory's `threshold` for this call. Ignored by the working tier,
   * which has no vector index.
   */
  threshold?: number;
  /**
   * Isolation key (4.15.0) — only memories remembered under the SAME
   * `scope` are eligible. The match is exact equality, enforced inside
   * every tier before hits are scored and merged, never bolted on by the
   * caller afterward.
   *
   * Omitting `scope` does NOT mean "every scope": an unscoped recall
   * reads only the unscoped (shared/global) pool. That is the fail-closed
   * default — reading another tenant's memories always requires naming
   * their scope explicitly.
   */
  scope?: string;
};
//#endregion
export { RecallOptions };
//# sourceMappingURL=recall-options.type.d.mts.map