Compare commits

..
Author SHA1 Message Date
Nicolò Boschi 0022d427d3 feat(integrations): add hindsight-opencode-coding plugin
Reflect-only long-term memory for coding agents in OpenCode, with a git+chat
backfill and (opt-in) live session write-back.

- reflect + INJECT: on a task, reflect() the symptom and push the root-cause
  answer into the system prompt (no tools/recall).
- backfill: every commit (full message + full diff, commit timestamp + git
  metadata) under a 'git' retain strategy; each chat as a JSON user/assistant
  transcript with custom extraction (<=2 coherent facts) under a 'chat' strategy;
  observations on; optional codebase knowledge pages.
- live write-back (opt-in HINDSIGHT_RETAIN_SESSIONS): every N turns upsert the
  tool-filtered transcript under a stable conversation:<sessionID> document_id.
2026-07-02 13:55:40 +02:00
Nicolò Boschi 1f9bad0858 feat(knowledge-base): default pages to living-document trigger + 4096 tokens
Client-created pages had no server curation applying a trigger, so they fell back
to the plain mental-model default (no refresh, full mode, all fact types). Make a
knowledge page a living document by default: when the client omits `trigger`, use
observation-only + delta + exclude_mental_models + refresh_after_consolidation;
when it omits `max_tokens`, default to 4096 (vs the mental-model 2048). Clients
can still override either.
2026-07-02 10:30:40 +02:00
Nicolò Boschi 138bf02f29 refactor(knowledge-base): drop server-side curation + folder missions
The knowledge base is now purely client-managed (CRUD over folders/pages); the
server no longer auto-curates. Removes the folder curator entirely and the
folder `mission` concept, and leads the sidebar with Knowledge Base.

- Remove engine/knowledge_curator.py, the curate_folder task (handler + dispatch
  + submit_async_curate_folder / _bank_folders), the post-consolidation curation
  hook, and the folder-create / mission-update curation triggers.
- Remove folder `mission` and `last_curated_at` (columns + engine + API + UI);
  keep `managed` as a client-set flag. Migration a5b6 now adds `managed` only;
  the last_curated_at migration is dropped and the unique-index migration
  repointed. Single alembic head preserved.
- API: KnowledgeNode/CreateFolderRequest/UpdateNodeRequest lose `mission`;
  PATCH node handles name/parent_id only.
- Control plane: sidebar leads with Knowledge Base (before Memories); remove the
  mission field, edit-mission dialog, and mission display from the KB view.
- Delete the curator tests; regenerate OpenAPI + SDK clients.
2026-07-02 10:30:39 +02:00
Nicolò Boschi df178aae8a refactor(hindsight-fs): mirror the knowledge-base tree, not mental models
Re-point hindsight-fs at the knowledge base so it projects a bank's folder/page
hierarchy as nested directories + .md files, instead of a flat list of mental
models.

- client: fetch GET /knowledge-base/tree + /export (two calls, any bank size)
  and join by page id; replaces the paginated mental-models list.
- format: planMirror() walks the tree into folder dirs + page files at nested
  paths (slug per segment, collision-safe); pages render the page's OKF doc.
- sync: create folder dirs, write pages at nested paths, prune removed pages and
  emptied folders; state keyed by relative path + tracked dirs.
- config/cli: drop the mental-model `detail` flag; `list` prints folders+pages;
  help/README updated. Tests rewritten for the tree/export model.

Verified live against a bank's knowledge base: the `people` folder mirrors to
people/anna.md + people/marco.md with OKF frontmatter.
2026-07-02 10:30:39 +02:00
Nicolò Boschi a43026b8f4 feat(hindsight-fs): mirror a bank's mental models as a live local folder
Add @vectorize-io/hindsight-fs, a CLI under hindsight-tools/ that mirrors a
Hindsight bank's mental models as real markdown files (YAML frontmatter + body)
in a local directory, refreshed from the API on an interval. Once mounted,
ordinary shell tools (ls, cat, grep, find, ...) work against current memory.

- Pull-based sync engine: full list each tick, write changed/new/tampered
  files, skip unchanged (content-hashed), prune deleted models. Atomic writes;
  a transient API error never wipes the mirror.
- One-way mirror enforced two ways: files are read-only (0444) so agent edits
  fail with EACCES, plus a tamper-revert backstop that compares on-disk bytes
  and overwrites drift on the next pass. --writable opts out.
- Commands: mount/start/stop/restart/sync/status/list/logs/unmount. Background
  daemon via detached process + pidfile; per-mount config is remembered.
- status doubles as a healthcheck: --json report and a non-zero exit when the
  mount is dead/failed/stale (--stale-after overrides the threshold).
- Tests: unit (sync engine, frontmatter, health) + e2e that spawns the real
  CLI against a mock API and exercises real bash commands. 26 tests.
2026-07-02 10:30:39 +02:00
Nicolò Boschi 5c425e276e feat(knowledge-base): self-curating knowledge base (OKF pages + folder missions)
Server-side knowledge base: a hierarchy of folders and pages over mental
models, projected to the Open Knowledge Format, with a mission-driven curator
that maintains pages automatically after each consolidation.

- knowledge_pages table (PG + Oracle): parent_id tree, kind folder/page,
  mission, managed, last_curated_at; partial unique index on (folder, name)
  for concurrency-safe dedup; added to BACKUP_TABLES.
- api/okf.py: OKF serializer (frontmatter + body, index/log, constellation graph).
- engine/knowledge_curator.py: folder curator (LLM op plan + safe apply); reads
  new memories since last curation (delta, not recall); ops create/merge/delete
  page + spawn sub-folder (bounded depth<=3, <=8). Runs as an async curate_folder
  task on folder/mission create and after consolidation. Curator pages use an
  observation-only delta trigger with exclude_mental_models.
- MemoryEngine: folder/page CRUD, tree, curate, async submit + worker handler.
- /v1/default/banks/{bank}/knowledge-base/* endpoints.
- Control plane: knowledge-base tree view + constellation toggle, missions,
  OKF page panel + bundle export; proxies, client, sidebar, i18n.
- Tests: okf unit, knowledge-base HTTP, curator apply + dedup guard, hs_llm_core e2e.
- Regenerated OpenAPI + SDK clients + docs-skill.
2026-07-02 10:30:39 +02:00
Nicolò Boschi 265192e509 docs: restore audio in v0.8.4 release-notes video 2026-07-01 14:26:54 +02:00
Nicolò Boschi 8f2cee4568 docs: changelog and blog post for v0.8.4 (#2474)
* docs: changelog and blog post for v0.8.4

* docs: add compressed release-notes video for v0.8.4 blog
2026-07-01 14:17:12 +02:00
Nicolò Boschi 92f433c904 Release v0.8.4
- Update version to 0.8.4 in all components
- Regenerate OpenAPI spec and client SDKs
- Python packages: hindsight-api, hindsight-dev, hindsight-all, hindsight-embed
- Python client: hindsight-clients/python
- TypeScript client: hindsight-clients/typescript
- hindsight-all npm wrapper: hindsight-all-npm
- Rust CLI: hindsight-cli
- Control Plane: hindsight-control-plane
- Helm chart
- Sync documentation to version-0.8
2026-07-01 13:43:13 +02:00
Parafee41 f8ce15b9bf show full memory details in explorer (#2490) 2026-07-01 13:37:08 +02:00
Nicolò Boschi d68f618969 feat(stats): distributed bank_stats cache + ?refresh param + stats perf suite (#2495)
* feat(stats): distributed (table-backed) bank_stats cache on PostgreSQL

get_bank_stats aggregates over memory_links/unit_entities — a multi-second scan
on large banks. It was cached per-process (in-memory), so every API worker
recomputed once per TTL and the first caller after expiry stalled.

Add a bank_stats_cache table and a DistributedBankStatsCache that shares one
worker's computation across all workers. Same get_or_load/invalidate contract as
the in-memory cache, so the hot path is a single PK SELECT on a hit; only a miss
runs the existing _compute_bank_stats loader and UPSERTs the row (ON CONFLICT,
no lock — concurrent misses recompute, last write wins). All DB touches are
best-effort: an unreachable/missing cache table degrades to computing uncached
rather than failing the endpoint. PostgreSQL only; Oracle keeps the in-memory
cache (selected by dialect at construction).

* feat(stats): add ?refresh query param to force fresh /stats (default off)

Adds force_refresh to get_bank_stats (and both cache backends): when set, the
cached value is bypassed and recomputed, and the fresh result refreshes the
cache for subsequent callers. Exposed on GET /stats as ?refresh=true (default
false). Regenerated OpenAPI spec + clients.

* test(perf): add stats benchmark suite + huge prod-sim scale

New 'stats' perf suite measures get_bank_stats: uncached aggregation latency
(node/link counts + entity rollup) vs cached, run with the result cache disabled
so the headline numbers are the real per-poll cost. Adds a 'huge' prod-simulation
scale that bulk-loads ~500k units / ~17.8M physical memory_links via COPY (entity
links derived from unit_entities, not stored).

* test(stats): exclude bank_stats_cache from backup guard + HTTP refresh test

- bank_stats_cache is a derived TTL cache (no FK to banks, repopulates on
  demand), so exclude it from test_backup_tables_covers_entire_schema rather
  than back up stale cache rows — a restore starts it cold.
- Add a ?refresh=true assertion to the /stats HTTP integration test.

* fix(cli): pass refresh arg to get_agent_stats after ?refresh param

The new /stats ?refresh query param adds a positional arg to the progenitor-
generated get_agent_stats; the CLI reads the cached value, so pass None.
2026-07-01 13:35:54 +02:00
Nicolò Boschi 33e9db64a1 test: fix CI regressions (Vertex/litellmrouter construction, dedup config, trace recorder leak) (#2491)
* test(consolidation): fix dedup merge-path tests missing text-search config

The dedup merge/update path builds a search_vector UPDATE clause from
config.text_search_extension (+ _native_language) since #2425, but the
_dedup_reconcile_create / _dedup_reconcile_update test configs only set
consolidation_dedup_threshold, so the two merge-path tests raised
AttributeError: 'types.SimpleNamespace' object has no attribute
'text_search_extension' on main.

Add the two fields (production defaults native/english) to those configs.
The clause reuses $1, so the existing positional-arg assertions are unchanged.

* test(fact-extraction): pass Vertex AI settings when building LLMConfig

Regression: LLMConfig was refactored to use vertexai_project_id/region/
service_account_key as-passed (the caller resolves the global-config fallback),
but the llm_config fixture never forwarded them. So with the CI provider set to
vertexai, LLMConfig raised "HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID is required"
even though the env var was set — the test errored in the test-api job.

Forward the three Vertex settings from config (mirroring MemoryEngine's own
LLMConfig construction). Verified: LLMConfig(provider="vertexai", ...) now
constructs with project_id passed, and still raises when it is omitted.

* test(llm-provider): forward provider-specific settings in _make_llm

_make_llm() built an LLMProvider from the env-selected provider without
forwarding provider-specific settings, so the vertexai and litellmrouter
acceptance-matrix jobs failed at construction ("VERTEXAI_PROJECT_ID is required"
/ "litellmrouter requires a config object"). LLMProvider uses these as-passed
(it does not resolve them from global config), so forward
vertexai_project_id/region/service_account_key and litellmrouter_config.

* test(llm-trace): drop leaked span recorders after each test (#2229)

Root cause of the flaky test_llm_trace::test_disabled_writes_no_rows:
MemoryEngine.__init__ registers its LLM-trace recorder in a process-global
registry, and only close() removes it. Tests that construct an engine directly
(test_per_operation_llm_config, test_llm_reasoning_effort_env, etc.) never
close it, leaking an ENABLED recorder. Locally those recorders' writes fail
(uninitialized backend), but in CI a leaked recorder with a live backend
records a later test's LLM calls into the shared DB — so test_disabled_writes_
no_rows sees rows for its bank even though its own recorder is disabled
(assert N == 0). Reproduced: after test_per_operation_llm_config the registry
holds 8 enabled recorders.

Add an autouse fixture that snapshots the registry and removes anything a test
leaked. Verified: the registry drops from 8 leaked recorders back to 1.
_teardown_memory_engine already guards the fixtures; this guards direct
constructions. 53 trace + leak-risk tests pass together under -n2.
2026-07-01 13:35:22 +02:00
Nicolò Boschi 0c8699dc20 docs: document CODEX_HOME isolation for long-running Codex services (#2496)
Hindsight already honors CODEX_HOME (openai-codex LLM + embeddings), but it
was only mentioned in the 0.8.3 changelog. Long-running services sharing
~/.codex/auth.json with another Codex process can get their refresh token
rotated out, leaving /reflect broken while /health stays green.

Add a 'Isolating Codex auth for long-running services' section to the Models
docs and a pointer next to the openai-codex snippet in configuration.

Refs #2476
2026-07-01 12:04:31 +02:00
Nicolò Boschi 251c451fc3 chore(search): remove HINDSIGHT_API_LAZY_RERANKER flag (#2478)
Lazy reranker init was the only mode in which CrossEncoderReranker.ensure_initialized()
could double-load the model: its check-then-act over the `await` is a real race, but
in the default (eager) path init_cross_encoder() runs at startup — single-threaded,
before any request — so the per-request guard always short-circuits and the window
never opens (see PR #2445 discussion).

Rather than guard the lazy path with a lock, drop the flag entirely. The cross-encoder
is now always initialized eagerly at startup, which removes the race by construction and
the first-recall latency cliff. The only thing the flag bought was skipping an ~80MB
model load for retain-only deployments — not worth the extra config surface and the
concurrency footgun.

- Remove ENV_LAZY_RERANKER, the config field, and from_env() wiring
- Remove the lazy_reranker constructor param; always append init_cross_encoder()
- Drop the now-dead kwarg/env from tests; rename the ensure_initialized timeout tests
- Update docs + regenerate the docs skill mirror

ensure_initialized() is kept as a cheap idempotent guard on the recall path.
2026-07-01 12:01:29 +02:00
Evo 8ed49e4387 fix(retain): honor configured LLM temperature in the batch fact-extraction path (#2469 follow-up) (#2485)
* fix(retain): honor configured LLM temperature in batch fact-extraction

#2469 de-hardcoded the streaming path but the batch _build_request_body still
sent temperature=0.1 unconditionally, so HINDSIGHT_API_LLM_TEMPERATURE=none was
ignored and Azure GPT-5.5 batch retain kept rejecting requests. Omit the field
when the configured retain temperature is None, mirroring LLMProvider.call.

* test(retain): cover batch _build_request_body temperature threading
2026-07-01 11:56:00 +02:00
Parafee41 82afa76182 fix(cli): explore header selection (#2489) 2026-07-01 11:49:25 +02:00
DK09876 4c307ce4e7 release(openhands): v0.1.1 2026-06-30 07:38:51 -07:00
DK09876 252b013243 release(continue): v0.1.1 2026-06-30 07:38:31 -07:00
DK09876 a6b0f82124 release(aider): v0.1.1 2026-06-30 07:33:43 -07:00
Nicolò Boschi a27754fb15 fix(llm): make per-operation temperature configurable (#2459) (#2469)
* fix(llm): make per-operation temperature configurable (#2459)

Internal LLM calls used hardcoded temperatures (verification 0.0, fact
extraction 0.1, reflect thinking 0.9, consolidation 0.0, bank mission 0.3).
Models like Azure gpt-5.5 reject any explicit temperature other than their
default, breaking retain/reflect/verification.

Expose each as an env knob with a global override:
- HINDSIGHT_API_LLM_TEMPERATURE (global) + _VERIFICATION/_RETAIN/_REFLECT/
  _CONSOLIDATION/_MISSION (per-operation override).
- Resolution: per-operation env -> global env -> historical default.
- A value of none/default/off/empty omits the temperature parameter entirely,
  so HINDSIGHT_API_LLM_TEMPERATURE=none fixes gpt-5.5 in one variable.

call() already drops temperature=None across providers, so the None config
value naturally omits the param. Defaults preserve prior behavior exactly
(fully backwards compatible). Server-level/static config.

* test(llm): verify per-operation temperature reaches the LLM call

MockLLM now records the temperature it receives, and a new pipeline test
drives the real engine: retain forwards 0.1 to fact extraction, the reflect
thinking path forwards 0.9, and HINDSIGHT_API_LLM_TEMPERATURE=none omits the
parameter (None) on a live call.

* test(llm): set llm_temperature_retain on the fact-extraction retry mock config

The retry tests build a MagicMock(spec=HindsightConfig); dataclass
annotation-only fields aren't in the spec, so the new llm_temperature_retain
field (now read at the extraction call site) must be set explicitly.
2026-06-30 16:25:14 +02:00
Nicolò Boschi 40fe7aac86 fix(llm): propagate per-scope LLM timeout + retry policy to the provider (#2452) (#2470)
The per-operation LLM request settings were resolved into HindsightConfig but
never reached the provider that uses them, so configuring them was a silent
no-op:

- *_llm_timeout (retain/reflect/consolidation) and the global llm_timeout never
  reached the provider impl; it fell back to HINDSIGHT_API_LLM_TIMEOUT/120s, so
  HINDSIGHT_API_RETAIN_LLM_TIMEOUT=300 did nothing ("LiteLLM call exceeded
  timeout=120.0s").
- reflect_llm_max_retries/initial_backoff/max_backoff and
  consolidation_llm_initial_backoff/max_backoff were never consumed; reflect and
  consolidation used the hardcoded call()/call_with_tools() defaults (10/5),
  ignoring the documented "falls back to llm_max_retries" contract.

Fix: resolve each operation's effective request defaults (per-op override else
global) in MemoryEngine and carry them on the LLMProvider:

- timeout is threaded config -> LLMProvider -> create_llm_provider -> provider
  impl for the providers that honour a configurable request timeout (LiteLLM,
  LiteLLM Router, OpenAI-compatible, Nous). None preserves each provider's own
  default, so Anthropic/Gemini keep their bespoke timeouts and the no-config
  path is byte-identical.
- max_retries/initial_backoff/max_backoff become LLMProvider instance defaults
  that call()/call_with_tools() use when the per-call arg is omitted. Explicit
  per-call args (retain's resolved values, reflect's fast structured-extraction
  path) still win; providers built without config (from_env, tests) keep the
  10/5 method fallback.

The four operation scopes (default/retain/reflect/consolidation) and multi-LLM
chain members all share their operation's resolved values via a small
_LLMCallDefaults bundle.

max_concurrent is intentionally left as-is (process-global semaphores read from
env at startup, server-level only); the docs are clarified to call out that
distinction.

Also fixes a pre-existing breakage in test_llm_router_provider's __new__-based
helper (missing _default_headers after #2466) so the suite is green.

Tests: tests/test_llm_timeout_propagation.py covers provider-impl timeout
threading, the call() retry-policy fallback/override, and per-op
resolution/fallback in MemoryEngine.
2026-06-30 16:25:02 +02:00
Nicolò Boschi 7393400f34 release(openclaw): v0.9.0 2026-06-30 11:25:18 +02:00
3b7d18d474 fix(openclaw): skip synthetic tool_result user messages in sliceLastTurnsByUserBoundary (#2307)
* fix: skip synthetic tool_result user messages in sliceLastTurnsByUserBoundary

OpenClaw normalizes tool_result blocks into role:"user" messages with a
tool_result content block. The sliceLastTurnsByUserBoundary function used
to count every role:"user" message as a turn boundary, causing synthetic
tool_result messages to fill the retention window and exclude actual user
input from retained transcripts.

This change adds a hasRealTextContent guard that skips user messages
containing only tool_result blocks, ensuring only genuine user text is
counted as turn boundaries for both retain and recall window slicing.

Fixes: retained transcripts missing user input when tool calls are present

* fix: skip synthetic tool_result user messages in sliceLastTurnsByUserBoundary

* fix: skip synthetic tool_result user messages in sliceLastTurnsByUserBoundary

* style(openclaw): prettier-format hasRealTextContent block

---------

Co-authored-by: Kumaxs <[email protected]>
Co-authored-by: Nicolò Boschi <[email protected]>
2026-06-30 11:23:09 +02:00
Nicolò Boschi 6e18858e32 release(cursor-cli): v0.3.0 2026-06-30 11:20:40 +02:00
84e67efbf4 fix(cursor-cli): parse Cursor 3.x role-nested agent transcripts (#2465)
* fix(cursor-cli): parse Cursor 3.x role-nested agent transcripts

Cursor CLI writes agent-transcripts/*.jsonl as
{role, message: {content: [blocks]}} without a top-level type field.
The retain hook's transcript reader only handled flat and type-nested
SDK envelopes, so real transcripts parsed to zero messages and retain
appeared to succeed while storing nothing.

Port the third parser branch from the Cursor editor integration and add
a regression test. Closes the gap flagged as "Should fix #4" during
review of #1975.

Co-authored-by: Cursor <[email protected]>

* feat(cursor-cli): gate text-mode tool markers behind includeTools (default off)

The shared transcript parser surfaced [tool_use]/[tool_result] markers in
the plain-text view, changing what lands in recall queries and light retain.
Gate those markers behind a new includeTools config flag (default off), so
the default light read keeps only natural-language text as before.

Also collapse the now-dead user/assistant event_type branches in the rich
reader (handled by _parse_transcript_entry) and drop the redundant
_extract_text_from_blocks helper, folding the three text/rich finalization
paths into a single _finalize_entry.

---------

Co-authored-by: mutex <[email protected]>
Co-authored-by: Cursor <[email protected]>
Co-authored-by: Nicolò Boschi <[email protected]>
2026-06-30 11:19:29 +02:00
ef2e8ab7ff fix(openclaw): apply configured defaults to dynamic banks (#2441)
* fix(openclaw): apply configured defaults to dynamic banks

Co-authored-by: Cursor <[email protected]>

* fix(openclaw): route knowledge tools through identity resolution for user-scoped banks

Knowledge tool factories now use resolveAndCacheIdentity before deriving bank IDs,
matching auto-recall/retain so PluginToolContext sessions hit the correct per-user
bank. Unresolved user identity returns a clear tool error instead of querying
anonymous/openclaw fallbacks, and bank defaults are applied before execution.

Co-authored-by: Cursor <[email protected]>

* fix(agent-sdk): stop mapping max_results to recall max_tokens

NemoClaw passed max_results=25 expecting a result-count cap, but the SDK
used it as max_tokens=25 and starved recall. max_tokens now defaults to
1024 from max_tokens only; max_results slices the results array (1-50).

Co-authored-by: Cursor <[email protected]>

* refactor(openclaw): drop dead alias exports + tighten entityLabels shape

- Remove unused @deprecated hasConfiguredMissions/applyConfiguredMissions
  aliases (new exports nothing imports).
- normalizeEntityLabels now only accepts the server's shapes (a list, or a
  { attributes: [...] } object); a plain keyed object is dropped client-side
  instead of being sent and silently ignored by parse_entity_labels.
- Update docs (types.ts, plugin.json, README) and tests to match.

* fix(agent-sdk): drop unsupported max_results from recall tool

The recall tool's max_results was previously aliased to the recall token
budget (a no-op for result count). Rather than make it a real cap, remove
it entirely — the tool accepts only max_tokens; use recallTopK for an
auto-recall count cap.

Also document the new per-user dynamic bank defaults (retainExtractionMode,
enableObservations, enableAutoConsolidation, dispositions, entityLabels) on
the docs-site OpenClaw page and fix its stale max_results guidance.

---------

Co-authored-by: DK09876 <[email protected]>
Co-authored-by: Cursor <[email protected]>
Co-authored-by: Nicolò Boschi <[email protected]>
2026-06-30 11:03:26 +02:00
Issam Bousfiha cc45e16904 feat(opencode): add env var overrides for retain and recall options (#2336)
* feat(config): add env var overrides for retain and recall options

Add missing environment variable overrides for configuration options
that were only settable via plugin options or config file:
- HINDSIGHT_RETAIN_EVERY_N_TURNS
- HINDSIGHT_RETAIN_OVERLAP_TURNS
- HINDSIGHT_RECALL_TAGS / HINDSIGHT_RETAIN_TAGS
- HINDSIGHT_RECALL_TAGS_MATCH
- HINDSIGHT_RECALL_PROMPT_PREAMBLE
- HINDSIGHT_RECALL_CONTEXT

* feat(config): add HINDSIGHT_BANK_ID_PREFIX env override

* fix(opencode): rename HINDSIGHT_RECALL_CONTEXT to HINDSIGHT_RETAIN_CONTEXT

The env var HINDSIGHT_RECALL_CONTEXT mapped to retainContext, which
breaks the naming convention where RECALL_* maps to recall* properties
and RETAIN_* maps to retain* properties.
2026-06-30 11:00:54 +02:00
Minghao Xiao 82b01ace5e fix(reflect): unwrap JSON answer envelopes (#2345)
* fix(reflect): unwrap JSON answer envelopes

* fix(reflect): clarify leaked done argument recovery
2026-06-30 10:53:45 +02:00
Parafee41 962140eef6 feat(claude-code): Add recall tag filters to memory hook (#2331)
* Add recall tag filters

* Support per-bank recall tag filters

* Use recall tag config names
2026-06-30 10:53:09 +02:00
EvoandNicolò Boschi 5e73d5ff62 fix(llm): wire default_headers into LiteLLM-backed providers (#2458) (#2466)
* fix(llm): wire default_headers into LiteLLM-backed providers (#2458)

HINDSIGHT_API_LLM_DEFAULT_HEADERS is documented and parsed but only wired
into the Anthropic provider, so it silently no-ops for the litellm /
litellmrouter / bedrock providers -- the proxy-routing providers where
custom headers (auditing, policy, request-tracing) matter most. The
create_llm_provider docstring even noted "other providers may opt in as
needed"; this opts the LiteLLM-backed providers in.

Forward the configured headers to litellm.acompletion via the extra_headers
kwarg, mirroring the existing Anthropic default_headers wiring. setdefault
keeps any explicit per-call extra_headers authoritative, and the dict is
defensively copied on construction and per call to avoid cross-request
contamination. LiteLLMRouterLLM inherits this through its **kwargs forward
to the shared LiteLLM base.

Adds regression tests covering storage, the acompletion extra_headers path,
the no-headers omission, router forwarding, and copy-isolation.

Closes #2458

* fix(llm): forward default_headers from LiteLLM Router call path

The Router subclass overrides _build_common_kwargs without calling super(),
so stored default_headers never reached acompletion for the litellmrouter
provider. Inject extra_headers in the override too, and replace the
storage-only router test with call()-driven coverage.

* style: apply ruff format to migrations.py (pre-existing lint drift)

Newer ruff collapses two multi-line log strings that now fit the line
length. The file was byte-identical to main; this brings it in sync with
the lint gate so verify-generated-files passes.

---------

Co-authored-by: Nicolò Boschi <[email protected]>
2026-06-30 10:52:26 +02:00
Evoandr266-tech 2c47b8b0d5 docs: document SDK version and MCP metadata helpers (#2291)
Co-authored-by: r266-tech <[email protected]>
2026-06-30 10:51:58 +02:00
Nicolò BoschiandChris Latimer 00968a1ce4 fix(retain): preserve exception message in fact_extraction error summary (#2468)
`test_extraction_failure_at_retry_cap_fails_terminally` (added in #2418,
guarding the recovered-worker path from #2413) asserts that when fact
extraction fails terminally, the original exception message survives
into `async_operations.error_message` so an operator can tell apart a
structured-JSON parse failure from a rate-limit reset from a network
5xx — all of which can surface as the same exception types in different
code paths.

The formatter was joining only `type(err).__name__`, producing rows like
"chunk 0: RuntimeError". The exception message was discarded, leaving
worker failures unactionable and silently defeating the test. The test
ran for the first time on this branch (its original PR's test-api job
was skipped) and surfaced the bug.

Add the message to the summary: "chunk 0: RuntimeError: structured JSON
parse failed after all retain_extract_facts attempts". Same shape, just
the field the test was added to enforce.

Drive-by: pre-existing, unrelated to the include_entity_links work in
this PR — but the test is wired in now and CI won't go green without it.

Co-authored-by: Chris Latimer <[email protected]>
2026-06-30 10:48:39 +02:00
EvoandNicolò Boschi b7080a16cf fix(llm-trace): stash litellm tool-call usage so token cost survives arg-parse failures (#2444)
* fix(llm-trace): stash litellm tool-call usage so token cost survives arg-parse failures (completes #2396)

* test(llm-trace): cover litellm tool-call arg-parse usage stash

Add a real-provider regression test for the fix in this PR: the existing
wrapper-level tools test uses a provider that already stashes, so it does
not guard LiteLLMLLM.call_with_tools. This drives the real provider with a
billed response whose tool arguments are malformed JSON and asserts the
error trace keeps the provider-reported tokens (input/output/cached). The
LiteLLMRouterLLM subclass inherits call_with_tools, so it is covered too.

Verified it fails (input_tokens=None) when the stash line is removed.

---------

Co-authored-by: Nicolò Boschi <[email protected]>
2026-06-30 10:46:23 +02:00
Nicolò Boschi c0aed313f4 fix(clients): thread recall min_scores through the maintained TypeScript SDK wrapper (#2467) 2026-06-30 10:39:22 +02:00
Nicolò Boschi 2c53629420 release(langgraph): v0.3.0 2026-06-30 10:30:12 +02:00
Parafee41andNicolò Boschi 760bfc7447 fix(langgraph): resolve tool bank IDs from config (#2443)
* fix(langgraph): resolve tool bank IDs from config

* review(langgraph): rename injected config param to avoid shadowing

Rename the injected RunnableConfig tool parameter to runnable_config so it
no longer shadows the outer Hindsight config = get_config().

---------

Co-authored-by: Nicolò Boschi <[email protected]>
2026-06-30 10:28:54 +02:00
Evo cce0a2cb39 fix(clients): thread recall min_scores through the maintained Python SDK wrapper (#2446)
#2422 added the public RecallRequest.min_scores (per-stage score floors) to
the HTTP/MCP API and the generated clients, but the hand-maintained
high-level Python wrapper (hindsight_client.recall/arecall) never got it, so
high-level SDK users can't use the feature without dropping to the raw
generated client.

Thread an optional min_scores dict through recall()/arecall() into
RecallRequest, mirroring the existing tag_groups dict->from_dict pattern.
Unknown keys raise ValueError so a misspelled floor fails loud instead of
silently applying no filter. Parity test mirrors
tests/test_recall_prefer_observations.py.

Follow-up to #2422.
2026-06-30 10:23:39 +02:00
Parafee41 1c1cf4ce56 fix(consolidation): default missing dedup action to keep (#2454)
* fix(consolidation): default missing dedup action to keep

* sync generated test formatting
2026-06-30 10:19:48 +02:00
Sanderhoff-alt a99a1ebf9b chore(docs): sync hindsight docs skill references (#2461)
Update generated hindsight-docs skill references with Requesty provider
entries that are already present in the source documentation.

This keeps the generated skill bundle in sync with the docs generator so
pre-commit no longer rewrites these files.
2026-06-30 10:18:32 +02:00
Sanderhoff-alt 12a6739fc9 refactor(extensions): centralize operation names (#2419)
Add PrecheckOperation, BankReadOperation, and BankWriteOperation
StrEnum types for operation validator hook contexts. Use them at
every precheck and validate_bank_read/write call site while
preserving string comparison compatibility for existing extensions.

Tests:
- uv run pytest tests/test_extensions.py -q
- ./scripts/hooks/lint.sh
2026-06-30 10:18:20 +02:00
Sanderhoff-alt d8ee10a78d chore(repo): remove playwright debug artifacts (#2460)
Remove accidentally committed Playwright MCP logs, page snapshots, and
root-level screenshot artifacts.

Ignore future Playwright MCP output so local browser debugging does not
show up as repository changes.
2026-06-30 10:18:05 +02:00
Evo ab01144b26 fix(config): thread groq/openai service_tier into constructed LLM providers (#2438)
HINDSIGHT_API_LLM_GROQ_SERVICE_TIER (default "auto") and
HINDSIGHT_API_LLM_OPENAI_SERVICE_TIER (OpenAI Flex, "50% cheaper") are parsed
into HindsightConfig but were never threaded into any constructed LLM provider.
The per-operation LLMConfig builds in memory_engine.py and LLMProvider.from_env
thread bedrock_service_tier and gemini_service_tier from config, but omitted
groq/openai, so setting either knob was a silent no-op. groq is the default
provider, so the cost-tier control was dead on the default path.

The constructor already accepts both fields and the providers already consume
them (gated on provider == "groq"/"openai"), so this only wires the missing
feed-in from config, mirroring the existing bedrock/gemini lines.
2026-06-30 10:16:59 +02:00
Evo 072b3278ba fix(config): thread groq/openai service_tier into constructed LLM providers (#2438)
HINDSIGHT_API_LLM_GROQ_SERVICE_TIER (default "auto") and
HINDSIGHT_API_LLM_OPENAI_SERVICE_TIER (OpenAI Flex, "50% cheaper") are parsed
into HindsightConfig but were never threaded into any constructed LLM provider.
The per-operation LLMConfig builds in memory_engine.py and LLMProvider.from_env
thread bedrock_service_tier and gemini_service_tier from config, but omitted
groq/openai, so setting either knob was a silent no-op. groq is the default
provider, so the cost-tier control was dead on the default path.

The constructor already accepts both fields and the providers already consume
them (gated on provider == "groq"/"openai"), so this only wires the missing
feed-in from config, mirroring the existing bedrock/gemini lines.
2026-06-30 10:14:56 +02:00
Nicolò Boschi 74e82a3ea8 fix(parsers): handle UTF-8 text files with ASCII prefix in markitdown (#2456)
markitdown samples only the first chunk for charset detection, so a UTF-8
file (e.g. a JSON transcript) with a long ASCII-only prefix is mis-detected
as ASCII. Its JSON/ipynb converter then reads the whole file with the wrong
charset and crashes on the first multibyte byte during converter selection,
before the plain-text converter can run.

Pass an explicit UTF-8 charset hint to markitdown for text-like files whose
bytes are valid UTF-8, sidestepping the faulty detection. Binary and genuinely
non-UTF-8 files fall back to markitdown's own detection.
2026-06-30 10:14:27 +02:00
Evo a5b752a983 docs(api): correct stale memory-type taxonomy in published READMEs (#2447)
The top feature bullet of both primary published packages (hindsight-api
and hindsight-api-slim) says 'World facts, bank actions, and formed
opinions', but the live recall taxonomy is world/experience/observation:
'opinion' was removed (recall now 422-rejects it) and 'bank' was renamed
to 'experience'. Sync the bullet to VALID_RECALL_FACT_TYPES so the first
thing a PyPI/GitHub visitor reads matches the actual API contract.

Scoped to the taxonomy bullet only; opinion *formation* as a behavior is
unchanged.
2026-06-30 10:12:53 +02:00
Parafee41 7b878f89a7 fix(retain): clarify fact type boundary for user rules (#2440)
* clarify retain fact type boundary

* sync generated test formatting
2026-06-30 10:08:55 +02:00
Evo 1b92c8230f docs(api): drop removed 'opinion' fact_type from MemoryFact schema description (#2439)
The `MemoryFact.fact_type` field description still advertises 'opinion' as a
valid value, but it was removed from the fact-type enum: the DB CheckConstraint
and VALID_RECALL_FACT_TYPES now allow only 'world', 'experience', and
'observation', and the API hard-rejects 'opinion'. An SDK/API consumer reading
the response schema is misled into thinking 'opinion' is a real fact_type.

Drop 'opinion' so the schema description matches what the API actually returns
and accepts. Follow-up to the opinion-fact-type cleanup in #2198/#2302/#2335.
2026-06-30 10:08:09 +02:00
Parafee41 0178d91333 docs: fix operation image alt text (#2436)
* docs: fix operation image alt text

* Sync linted slim tests
2026-06-30 10:07:06 +02:00
Evoandr266-tech 017b8d7271 Respect vector extension during migration bootstrap (#2426)
Co-authored-by: r266-tech <[email protected]>
2026-06-30 10:06:29 +02:00
qxxaaandNicolò Boschi 21176f8ee8 Fix(consolidation): populate search_vector on observation INSERT/UPDATE in consolidator (#2425)
* fix: populate search_vector on observation INSERT/UPDATE in consolidator

The consolidator creates and updates observations without populating the
search_vector tsvector column. Under the native text search extension,
this means observations are invisible to BM25 full-text retrieval - the
BM25 arm returns 0 candidates regardless of query content.

Four code paths write observation text to memory_units:
1. _dedup_reconcile_create (merge into existing twin)
2. _dedup_reconcile_update (drift-merge into different twin)
3. _execute_update_action (LLM rewrite of existing observation)
4. _create_observation_directly (new observation INSERT)

None populated search_vector. This patch adds conditional tsvector
generation gated on config.text_search_extension == 'native', matching
the existing pattern in ops_postgresql.insert_facts_batch. Non-native
backends (pg_textsearch, pgroonga, pg_search) continue to leave
search_vector NULL as they index base text columns directly.

The INSERT path (Site 4) splits the existing else branch into an
explicit elif/else to avoid applying native tsvector logic to backends
that don't use it.

Fixes: observations invisible to BM25 retrieval arm.

* Implement test for search vector population in observations

Add test for observation creation with native search vector

* style: run lint

* fix(consolidation): backfill search_vector for existing native observations

The writer fix only populates search_vector for observations created or
updated after deploy. Observations already written under the native
backend keep a NULL search_vector and stay invisible to BM25 until
re-consolidated. Add migration c3f7a1b9d2e4 to backfill them, gated on the
native tsvector column type and scoped to fact_type='observation' with a
NULL search_vector (idempotent). Matches the writer's text-only tsvector
and the configured native language.

* chore: remove accidentally committed git-lfs hooks

post-checkout/post-commit/post-merge/pre-push were git-lfs stubs picked
up from the contributor's local hookspath and committed by mistake. They
are unrelated to this change; the project's real .githooks/pre-commit is
left intact.

---------

Co-authored-by: Nicolò Boschi <[email protected]>
2026-06-30 10:05:11 +02:00
Ben 74bdfc9475 Blog: Entity resolution in agent memory (#2424)
* Add entity resolution deep-dive blog post

Technical deep-dive on entity resolution in agent memory, grounded in
Hindsight's implementation: name similarity + a co-occurrence graph +
temporal recency (no embeddings/LLM for resolution), the 0.6 merge
threshold, and the conservative-merge design.
2026-06-29 14:22:04 -04:00
Evo b0038e9855 cli: show operation filenames (#2435) 2026-06-29 12:05:05 +02:00
Thibault Jaigu 6eb85570af feat: add Requesty as an OpenAI-compatible provider (#2399)
Requesty is an OpenAI-compatible LLM gateway. This mirrors the existing
OpenRouter named-provider wiring 1:1:

- llm_wrapper.py / openai_compatible_llm.py: add "requesty" to the
  provider lists and a base_url branch -> https://router.requesty.ai/v1
- config.py: default model map (openai/gpt-4o-mini), embeddings env vars,
  dataclass fields, and from_env wiring (REQUESTY_API_KEY fallbacks)
- embeddings.py: requesty branch (same /v1 base) + Supported list
- docs/llmProviders.json: factual provider entries

Tested live against https://router.requesty.ai/v1/chat/completions
(model openai/gpt-4o-mini) -> HTTP 200.
2026-06-29 11:42:48 +02:00
Parafee41 85599f3ef5 Limit reflect structured output retries (#2433) 2026-06-29 10:42:26 +02:00
Evo dd83bffeef docs(recall): align min_scores score field names (#2432)
* docs(recall): align min_scores score field names

* test: apply generated formatting
2026-06-29 10:41:59 +02:00
Evoandr266-tech 911d27fc5f fix(embed): locate pythonw beside installed API script (#2411)
Co-authored-by: r266-tech <[email protected]>
2026-06-29 10:39:03 +02:00
DK09876andClaude Opus 4.8 a0af096081 fix(aider,openhands): close client on exit + OpenHands Docker MCP docs (#2417)
From real-app integration testing:

- aider: close the Hindsight client when the wrapper owns it, so aiohttp no
  longer prints 'Unclosed connector' warnings after aider exits. Test-injected
  clients are left to the caller. Bump 0.1.1.
- openhands: document that the OpenHands Docker app loads MCP from UI settings
  (not the project config.toml), and that the server must be added as a
  Streamable HTTP server (not SSE) reachable via host.docker.internal. Same hint
  printed by 'init'. Bump 0.1.1.

Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
2026-06-26 17:27:59 -07:00
DK09876andClaude Opus 4.8 fcb2c958e7 feat(devin-desktop): rename Windsurf→Devin Desktop + fix(continue) thread-safe adapter (#2410)
* feat(devin-desktop): rename windsurf integration to Devin Desktop

Cognition rebranded Windsurf to Devin Desktop (June 2026); Cascade is EOL
July 1. Rename the (unreleased) windsurf integration to devin-desktop before
first publish:

- Package hindsight-windsurf -> hindsight-devin-desktop (module
  hindsight_devin_desktop, CLI hindsight-devin-desktop, DevinDesktopConfig,
  bank default 'devin-desktop', HINDSIGHT_DEVIN_DESKTOP_BANK_ID)
- Rule now writes to .devin/rules/hindsight.md (preferred path) instead of
  the legacy .windsurf/rules/; trigger: always_on unchanged
- MCP config path stays ~/.codeium/windsurf/mcp_config.json (Devin Desktop's
  on-disk data dir, unchanged by the rebrand)
- Official Devin logo; docs + integrations.json + README refreshed with the
  'formerly Windsurf' framing
- Registries updated: test.yml job, release-integration.sh, generate_changelog,
  integrations.json (strict JSON), docs page

26 unit tests + gated live-MCP E2E pass; ruff check+format clean; real-app
smoke against local Hindsight verified (init writes both files; live recall
returns seeded facts).

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

* fix(continue): resolve a fresh Hindsight client per request (thread-safe)

The adapter runs on a ThreadingHTTPServer (one worker thread per request) but
shared a single Hindsight client across all of them. The client's aiohttp
session is bound to the thread/event-loop that first used it, so the first
@hindsight recall worked and every one after threw 'Timeout context manager
should be used inside a task' — Continue then showed an error context item and
the model answered with no memory.

Resolve the client per request (test-injected clients still used as-is), and
close per-request clients in a finally so the fresh aiohttp session doesn't leak
a connector each call. Bump to 0.1.1.

Found via a real in-editor VS Code test. Adds a regression test asserting
per-request client resolution across the threaded server.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
2026-06-26 17:27:39 -07:00
Nicolò Boschi 758f346d30 feat(recall): structured per-stage scores and two-level min_scores filtering (#2422)
Replace the recall result's single `score` with a `scores` object exposing the
scores from each pipeline stage, and replace the `min_score` request param with
`min_scores`, a per-stage filter that operates at two levels.

Response — each result carries `scores`:
- final     : the value results are ranked by
- reranker  : cross-encoder normalized relevance (null for passthrough rerankers)
- semantic  : raw vector cosine similarity (null if not surfaced semantically)
- text      : raw keyword/BM25 score (null if not surfaced by keyword search)

Per-arm semantic/text scores are aggregated across retrieval arms during RRF /
interleave fusion (ArmScores on MergedCandidate), since fusion otherwise keeps
only the first-seen arm's score per doc.

Request — `min_scores` floors (inclusive, AND-ed, opt-in; default no filtering):
- semantic / text : retrieval-level cutoffs pushed into the SQL arms, overriding
  the global similarity / BM25 minimums for the request (prune before fusion)
- reranker / final: post-query filters on the scored results

There is deliberately no default threshold: the cross-encoder's absolute scores
are reliable for ordering but not calibrated across queries (a clearly-relevant
match can score ~0.001 on one query and ~1.0 on another), so a fixed cutoff would
silently drop good results.

Also surfaces proof_norm in the search trace and reworks the control-plane trace
view to render scores at full precision (no rounding) and show the per-stage
`scores` breakdown; relabels the trace's "CE" column to "reranker score".

Threaded through engine, HTTP, MCP (both recall tools), and the control-plane
proxy; OpenAPI spec, Python/TS/Go/Rust clients, and the docs-skill mirror
regenerated; docs updated.
2026-06-26 17:12:27 +02:00
qxxaa 78d32cd16c fix(retain): merge JSON arrays in append mode to preserve conversation-aware chunking (#2412)
* fix(retain): merge JSON arrays in append mode to preserve conversation-aware chunking

When update_mode=append prepends existing document text as a second
content item, combined_content is built with "\n".join(...). For
conversation-format content (flat JSON arrays of message dicts), this
produces "[...]\n[...]" which is not valid JSON.

On subsequent append cycles, chunk_text() fails to parse the corrupted
original_text. _chunk_jsonl() also rejects it (lines are arrays, not
dicts). The text falls through to RecursiveCharacterTextSplitter, which
splits on sentence boundaries with no awareness of conversation turn
structure. This produces chunks that begin mid-sentence without speaker
attribution, causing the extraction LLM to misattribute statements.

Fix: after the append-mode block assembles contents_dicts with the
existing and new content items, detect when all items are JSON arrays
of dicts and merge them into a single flat array. Non-conversation
content (plain text, JSONL) is unaffected.

close #2409

* Enhance chunking tests for JSON array formats

Add tests for chunking newline-joined and merged JSON arrays.

* Add test for valid JSON in append mode

This test ensures that appending conversation arrays maintains the original_text as a valid flat JSON array after multiple append cycles, preventing degradation of the data structure.

* add missing json import to test_retain_append_mode
2026-06-26 15:28:53 +02:00
Fox Kiester fb475cc5bc docs: add Epimetheus - pi community integration (#2414) 2026-06-26 14:54:26 +02:00
Evo 1621e5d261 docs(mental-models): document scheduled refresh triggers (#2421) 2026-06-26 14:54:03 +02:00
Nicolò Boschi 91e095afa9 fix(control-plane): show pending uploaded documents from server operations (#2420)
Render in-flight and failed file uploads in the Documents view by deriving
them from the server's file_convert_retain operations — no client-side store
or client-generated document ids.

- surface document_id + original_filename on the operations list endpoint
  (already stored in the operation's result_metadata)
- documents-view derives pending/failed rows from those operations, deduped
  against the real document list by document_id, and polls while in-flight
- bridge the brief window where an operation reports completed before the
  document becomes visible in listDocuments, so the row never flickers

Supersedes #2346 (client-side sessionStorage approach). Closes #2314.
2026-06-26 11:46:31 +02:00
Parafee41 815d99f5ba test(worker): cover retry-capped retain extraction failures (#2418) 2026-06-26 10:56:20 +02:00
Ben 2452f72e75 Blog: Zapier persistent memory (#2408)
* Add Zapier persistent memory blog post

Adds the integration walkthrough for the Hindsight Zapier app: persistent
memory for any Zap via Retain/Recall/Reflect actions plus REST-Hook
triggers that start Zaps from memory events.
2026-06-25 14:50:15 -04:00
Nicolò Boschi dae18b1faf feat(mental-models): cron-scheduled mental model refresh (#2377)
Adds a third, independent way to refresh a mental model — on a cron schedule —
alongside the existing auto (refresh_after_consolidation) and manual paths,
driven by the background MaintenanceLoop ticker.

API/engine:
- trigger.refresh_cron (UTC 5-field cron, croniter-validated); mutually
  exclusive with refresh_after_consolidation.
- PG-only discovery routine public.mental_models_with_cron() (migration
  f4d1c2b3a5e6); cron due-ness evaluated in Python, refresh only when stale.
- HINDSIGHT_API_MENTAL_MODEL_REFRESH_TICK_SECONDS check cadence.
- One timing line logged per maintenance sweep.

Control plane:
- Single "Refresh trigger" choice (Manual / On new memories / On a schedule)
  with per-option sub-labels; cron input shown only when scheduled.
- Live cron schedule preview (human-readable + next/upcoming runs, UTC+local).
- "Next refresh" shown next to "last refreshed" in list, dashboard, and dialog.
- Fixed an app-wide off-by-one in formatRelativeTime.

Regenerated OpenAPI + clients + bank-template schema; i18n across all locales.
2026-06-25 18:27:14 +02:00
Nicolò Boschi 6a10b6241d refactor(llm): make LLMProvider constructor config-free; resolve fallbacks at callers (#2405)
The constructor previously reached into global HindsightConfig (via get_config /
_get_raw_config) to backfill any None argument: default_headers,
gemini_safety_settings, gemini_service_tier, prompt_cache_enabled,
litellmrouter_config, and the vertexai project/region/service-account key. That
hidden global read is exactly what made indexed multi-LLM members hard to
configure independently — each #2384/#2401 fix was "thread one more field so an
explicit value can win over the constructor's global fallback."

Remove all of it. The constructor now uses its arguments verbatim (plus pure
normalizations: the Gemini tier parse, the non-Gemini tier reset, the google/
model-prefix strip, and the us-central1 region default). Resolving the
server-level default for an omitted field is the caller's responsibility:

- MemoryEngine's four per-op base builds pass the global LLM config explicitly
  (gemini_safety_settings comes from the raw config since the StaticConfigProxy
  blocks that one bank-configurable field; the rest are static).
- _member_to_llm resolves member-value-or-global for each field, preserving how a
  chain member inherits global defaults.
- LLMProvider.from_env reads the remaining fields straight from os.getenv, staying
  a lightweight env-only loader (no full-config build).

This makes a provider's effective settings a pure function of its arguments,
which is what lets each member of a multi-LLM chain be configured independently.
Behavior is unchanged for single-LLM, member, and from_env paths.

Tests: update the vertexai/gemini-safety unit tests to the explicit-args contract
(they previously fed the constructor via env), and add two tests asserting the
constructor ignores global config for headers/prompt-cache/safety-settings.
2026-06-25 15:03:14 +02:00
Nicolò Boschi 47992d843b feat(config): let multi-LLM members configure litellmrouter config + Vertex SA key (#2401)
Follow-up to #2384. That PR let an indexed multi-LLM member carry its own
Vertex AI project/region, but two parity gaps remained vs the primary provider:

- A `litellmrouter` member had no per-member router config, so it silently fell
  back to the global `HINDSIGHT_API_LLM_LITELLMROUTER_CONFIG` — a chain could not
  fail over between differently-routed LiteLLM routers (same bug class #2384 fixed
  for Vertex).
- A `vertexai` member used only the global service-account key, so cross-project
  failover with distinct credentials was impossible (project/region alone weren't
  enough).

Adds `litellmrouter_config` and `vertexai_service_account_key` to
`LLMMemberConfig`, reads `{prefix}LLM_{n}_LITELLMROUTER_CONFIG` /
`_VERTEXAI_SERVICE_ACCOUNT_KEY` in `_parse_llm_members`, threads both through
`_member_to_llm`, and lets `LLMProvider.__init__` take a per-instance Vertex SA
key (explicit wins, else global fallback). Single-LLM/global behavior unchanged.

Tests: parse (incl. per-op prefix + invalid-JSON), and build-path proving the
member's own values reach `litellm.Router` and the Vertex SDK client. Docs table
updated with the new per-member keys.
2026-06-25 15:00:45 +02:00
Nicolò Boschi 93100ed314 Remove Atlas Cloud section from README
Removed Atlas Cloud promotional content and related instructions from the README.
2026-06-25 14:50:08 +02:00
Nicolò Boschi 01eda51880 fix(llm-trace): keep provider token usage on parse/validation failures (#2387) (#2396)
* fix(llm-trace): keep provider token usage on parse/validation failures (#2387)

When an LLM call succeeds and returns usage but local JSON parsing or
structured-output validation then fails, the failure trace was recorded
with input_tokens=0/output_tokens=0 because response.usage was out of
scope by the time the exception reached the wrapper. Providers still
charge for those tokens, so error rows lost real cost data.

Providers now stash provider-reported usage (LLMResponseUsage) into a
contextvar as soon as a response is in hand, before parse/validate; the
wrapper attaches it to the error trace. Codex/Claude Code (no SDK token
counts) stash the same char/4 estimate their success path already traces.

* test(llm-trace): drive real provider parse/validation failure with mocked SDK

Add tests that exercise the actual OpenAICompatibleLLM structured-output
path through the LLMProvider wrapper with a mocked SDK client returning a
successful usage-bearing response but bad output: a non-JSON body (parse
failure) and schema-mismatched JSON (validation failure) both record the
provider usage on the status=error retain_extract_facts trace. A success
case asserts the same usage flows on the happy path.
2026-06-25 14:39:32 +02:00
Nicolò Boschi e63d028a5a test(openai): set usage.completion_tokens_details in tool-call mocks (#2378) (#2400)
PR #2378 added reasoning-token accounting in OpenAICompatibleLLM that
subtracts thoughts_tokens from output/total. Several tool-call tests build
their mock response with MagicMock() and set only prompt/completion/total
tokens, leaving usage.completion_tokens_details as a truthy auto-MagicMock.
The new code then does arithmetic on a MagicMock and raises TypeError,
failing all test-api shards. Set completion_tokens_details = None in the
affected mock helpers (matching the explicit-field convention already
documented in test_openrouter_null_content).
2026-06-25 13:49:18 +02:00
Nicolò Boschi 58b5677617 release(claude-code): v0.7.2 2026-06-25 13:32:25 +02:00
Nicolò Boschi b6608076ff fix(release): bump marketplace version on claude-code release (#2386) (#2398)
The Claude Code plugin ships via the marketplace manifest, not a package
registry. The integration release (release-integration.sh claude-code) already
bumps plugin.json, but the marketplace manifest carried no version and was
never bumped — so the published catalog never reflected new releases (e.g.
#2066 on Windows).

- add a "version" field to the root .claude-plugin/marketplace.json
- release-integration.sh now bumps it in lockstep with the plugin version when
  releasing claude-code, and commits it
- remove the redundant hindsight-integrations/.claude-plugin/marketplace.json:
  `claude plugin marketplace add vectorize-io/hindsight` only ever reads the
  root manifest (even with --sparse), so the second manifest was never consulted
- drop the stale --sparse install hint from the release-integration workflow

The claude-code release flow is otherwise unchanged — release it as before.
2026-06-25 13:31:00 +02:00
Chris Bartholomew 4fe477eaa3 feat(config): let indexed multi-LLM members configure Vertex AI project/region (#2384)
Indexed multi-LLM members previously carried only provider/api_key/model/
base_url, so a 'vertexai' member could not initialize (its client requires a
project id, and the region defaults to us-central1). That made vertexai
unusable as a member of a failover/round-robin chain.

Add optional vertexai_project_id / vertexai_region to LLMMemberConfig, parse
them from {prefix}LLM_{n}_VERTEXAI_PROJECT_ID / _VERTEXAI_REGION (global and
per-op prefixes), thread them through the member build path, and accept them on
LLMProvider so an explicit per-instance value wins while existing single-LLM
setups still fall back to the global config.
2026-06-25 13:28:39 +02:00
Sanderhoff-alt a7d1f26f98 fix(api): prevent PATCH bank from creating banks (#2391)
Treat PATCH /v1/default/banks/{bank_id} as update-only by using a
non-creating bank profile lookup and returning 404 when the bank is
missing.

Add a regression test proving the endpoint does not create a bank as a
side effect.
2026-06-25 12:31:11 +02:00
Sanderhoff-alt 0673131a80 fix(api): keep dry-run extract from creating banks (#2394)
Use the non-creating bank-profile lookup when dry-run extraction
resolves the optional narrator name. A preview endpoint promises no
persistence, so probing a missing bank must not insert a bank row.

Add a regression test that calls dry-run extraction against a missing
bank and verifies the bank still does not exist afterwards.
2026-06-25 12:30:13 +02:00
Sanderhoff-alt 6e02a0829f fix(hooks): keep uv lockfile frozen during lint (#2397)
Run the pre-commit uv sync and workspace uv run commands with
--frozen so linting uses the checked-in lockfile without rewriting it
during ordinary code changes.

This avoids local uv resolver freshness checks producing unrelated
uv.lock diffs while preserving explicit dependency update workflows.
2026-06-25 12:29:13 +02:00
EvoandNicolò Boschi bc813692c6 fix(openai): propagate reasoning_tokens into TokenUsage for OpenAI-compatible providers (#2378)
* fix(openai): propagate reasoning_tokens into TokenUsage for OpenAI-compatible providers

Follow-up to merged #2356, which shipped TokenUsage.thoughts_tokens but only
wired the gemini provider. The OpenAI-compatible backend (the most-used class:
OpenAI o-series/gpt-5, groq, deepseek-r1, plus NousLLM/FireworksLLM subclasses)
never read completion_tokens_details.reasoning_tokens and never passed
thoughts_tokens, so it reported 0 for every OpenAI-compatible reasoning model.

Extract reasoning_tokens with a 0-safe getattr chain (mirroring the existing
cached_tokens extraction and the gemini wiring) in both call() and
call_with_tools(), and pass thoughts_tokens (plus cached_tokens for
call_with_tools) into TokenUsage / LLMToolCallResult. Providers without
completion_tokens_details (non-reasoning models, Ollama native) keep 0.

Scoped to the OpenAI-compatible provider; anthropic_llm.py folds thinking into
output_tokens with no separate reasoning sub-count, left as optional follow-up.
Adds provider-level regression tests for call() and call_with_tools().

* fix(openai): make output_tokens visible-only so it doesn't double-count reasoning

OpenAI-compatible completion_tokens INCLUDES reasoning_tokens (verified live:
o4-mini completion=83, reasoning=64), but the TokenUsage contract and the
Gemini provider treat output_tokens/total_tokens as visible-only with
reasoning surfaced separately in thoughts_tokens. Subtract thoughts_tokens
from output_tokens (and total_tokens in call()) so cost attribution doesn't
double-count reasoning. Add a convention test pinning the invariant.

---------

Co-authored-by: Nicolò Boschi <[email protected]>
2026-06-25 11:33:16 +02:00
Nicolò Boschi 701de3293d test: eagerly import torch in conftest to fix shard flake (#2376)
test-api shard 2/3 intermittently failed collection of dozens of tests
with 'RuntimeError: function _has_torch_function already has a docstring'.

Root cause: the first import torch in a worker process happened lazily
from inside concurrent/async code (embeddings.initialize() ->
sentence_transformers -> transformers -> torch, and cross_encoder's
ThreadPoolExecutor). torch/overrides.py's C-level _add_docstr is not
re-entrancy-safe, so under concurrency torch/overrides.py could execute
twice and raise, failing collection of every test on the shard.

Fix: import torch once at conftest import time (single-threaded, before any
event loop or thread pool), so the registration happens exactly once per
xdist worker. Guarded for slim/no-torch environments.
2026-06-25 10:56:53 +02:00
Ben 9dafadc7eb release(eve): v0.1.0 2026-06-24 14:51:08 -04:00
Ben d0b77f5bee feat(eve): add Eve agent-framework MCP connection helper (#2280)
* feat(eve): add Eve agent-framework MCP connection helper

Add @vectorize-io/hindsight-eve: a thin helper that wraps Eve's
defineMcpClientConnection to wire an Eve agent into a Hindsight MCP
server in one line, pre-filling the endpoint, model-facing description,
and bearer auth with env-var defaults (HINDSIGHT_MCP_URL,
HINDSIGHT_API_KEY, HINDSIGHT_MCP_BANK_ID).
2026-06-24 14:48:38 -04:00
DK09876andClaude Opus 4.8 7194f98b19 feat(windsurf): add Windsurf (Codeium) integration via MCP (#2358)
* feat(windsurf): add Windsurf (Codeium) integration via MCP

Config-only CLI that wires the Hindsight MCP server into Windsurf's
~/.codeium/windsurf/mcp_config.json (mcpServers, remote serverUrl + auth
header) and writes an always-on recall/retain rule to
.windsurf/rules/hindsight.md (trigger: always_on). Cascade then has
recall/retain/reflect and uses them automatically.

- hindsight_windsurf: config, mcp_config (strict-JSON parse-or-print),
  rules (dedicated sentinel-marked file), cli (init/status/uninstall)
- 25 unit tests + gated live-MCP-endpoint E2E
- CI job, release + changelog registries, docs page, icon, README row

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

* style(windsurf): apply ruff format to cli.py

lint.sh runs 'ruff format'; collapse the --rules-path add_argument to one
line so verify-generated-files passes.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

* fix(windsurf): use official Windsurf logo for the integration icon

Replace the placeholder abstract mark with the official Windsurf logo
(simple-icons, CC0), matching the real-brand-logo convention used by the
other integration icons.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
2026-06-24 09:58:55 -07:00
Derek Bouius 34ba3c676e blog(retain): structuring chat logs for optimal ingestion (#2375)
* blog(retain): structuring chat logs for optimal ingestion

Add a concept guide on shaping conversation transcripts for Hindsight's
retain: one item per conversation (document_id upsert / append), speaker
labels, context-driven world-vs-experience attribution, timestamp
anchoring, and dropping system prompts / injected memories. Grounded in
the retain API docs and de-facto integration conventions.

* blog(retain): add length/latency, streaming, and links/attachments guidance

Incorporate real user Q&A: document length isn't the constraint (the tail
of long transcripts isn't dropped), segment by recall latency not size,
buffer a few turns when streaming (per-user ingest limit), and set
expectations on links (reference text, not fetched) and attachments
(no file ingest; store in S3 and link).
2026-06-24 09:18:04 -04:00
Evo 0379b4c823 fix(deps): raise hindsight-litellm LiteLLM floor (#2382)
* fix(deps): raise hindsight-litellm LiteLLM floor

* fix(deps): raise hindsight-litellm LiteLLM floor
2026-06-24 11:21:02 +02:00
Parafee41 422e0fd809 Warn for unstable standalone worker ids (#2383) 2026-06-24 11:20:35 +02:00
DK09876andClaude Opus 4.8 91bf32842e feat(github-copilot): add GitHub Copilot (VS Code) integration via MCP (#2299)
Adds hindsight-copilot: long-term memory for GitHub Copilot in VS Code, using
Copilot agent mode's native MCP support (HTTP servers) — no bridge.

`hindsight-copilot init`:
- merges a Hindsight HTTP MCP server into .vscode/mcp.json (servers.hindsight),
  JSON-safe (prints a snippet if the file is JSONC), and
- writes a recall/retain rule into .github/copilot-instructions.md, which
  Copilot applies to every chat in the workspace.

Resolves the ask in #1588. Mirrors the Zed/OpenHands MCP-config pattern.

- hindsight_copilot package: config, mcp_config (.vscode/mcp.json writer),
  instructions (copilot-instructions.md rule), cli (init/status/uninstall)
- 25 deterministic tests (mcp.json merge incl. preserving servers/inputs +
  JSONC fallback, instructions rule block) + gated requires_real_llm MCP
  handshake E2E
- CI job, release registration (VALID_INTEGRATIONS + changelog generator),
  docs page, registry entry, icon (octicons), README row

Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
2026-06-23 16:39:12 -07:00
Ben e4afa5a61b blog: Persistent Memory for the Vercel AI SDK in Five Tools (#2374)
* blog: Persistent Memory for the Vercel AI SDK in Five Tools

Add a dedicated integration post for @vectorize-io/hindsight-ai-sdk.
Covers the five memory tools (retain, recall, reflect, getMentalModel,
getDocument), the semantic-vs-infrastructure input split, setup, and
generateText/streamText/ToolLoopAgent/Next.js usage.
2026-06-23 14:37:27 -04:00
Nicolò Boschi 680305aea4 fix(worker): warn when worker_id unset inside a container (#2359) (#2366)
Default worker_id falls back to socket.gethostname(), which inside Docker/
Kubernetes is the random container hostname and changes on every container
recreation. recover_own_tasks() only reclaims tasks whose worker_id matches
the current worker, so tasks left in 'processing' under the old hostname are
never recovered — consolidation and other async ops can get stuck forever.

Add detect_container_runtime() and log a prominent warning at worker start
when HINDSIGHT_API_WORKER_ID is unset and a container runtime is detected,
pointing operators to set a stable worker id.
2026-06-23 17:36:14 +02:00
668 changed files with 40160 additions and 4842 deletions
+1
View File
@@ -1,6 +1,7 @@
{
"$schema": "https://anthropic.com/claude-code/marketplace.schema.json",
"name": "hindsight",
"version": "0.7.2",
"description": "Official Hindsight integrations for Claude Code",
"owner": {
"name": "vectorize-io"
+11
View File
@@ -10,6 +10,17 @@ HINDSIGHT_API_LLM_BASE_URL=https://api.openai.com/v1
# Reasoning effort for providers/models that support it. Examples: low, medium, high, xhigh.
# HINDSIGHT_API_LLM_REASONING_EFFORT=low
# Sampling temperature for internal LLM calls. Set a number in [0.0, 2.0], or `none`
# to omit the temperature parameter entirely (required for models that reject explicit
# temperatures, e.g. Azure gpt-5.5). The global override below applies to every operation;
# per-operation overrides (defaults: verification=0.0, retain=0.1, reflect=0.9,
# consolidation=0.0) take precedence.
# HINDSIGHT_API_LLM_TEMPERATURE=none
# HINDSIGHT_API_LLM_TEMPERATURE_VERIFICATION=0.0
# HINDSIGHT_API_LLM_TEMPERATURE_RETAIN=0.1
# HINDSIGHT_API_LLM_TEMPERATURE_REFLECT=0.9
# HINDSIGHT_API_LLM_TEMPERATURE_CONSOLIDATION=0.0
# Example: Anthropic Claude configuration
# HINDSIGHT_API_LLM_PROVIDER=anthropic
# HINDSIGHT_API_LLM_API_KEY=your-anthropic-api-key
+1 -1
View File
@@ -75,7 +75,7 @@ jobs:
if: steps.type.outputs.type == 'plugin'
run: |
echo "Plugin integration ${{ steps.info.outputs.integration }} v${{ steps.info.outputs.version }} — no package to publish."
echo "Users install via: claude plugin marketplace add vectorize-io/hindsight --sparse hindsight-integrations"
echo "Users install via: claude plugin marketplace add vectorize-io/hindsight"
# ── TypeScript integrations (ai-sdk, chat, openclaw) ────────────────────
+121
View File
@@ -38,6 +38,7 @@ jobs:
integrations-claude-code: ${{ steps.filter.outputs.integrations-claude-code }}
integrations-cline: ${{ steps.filter.outputs.integrations-cline }}
integrations-codex: ${{ steps.filter.outputs.integrations-codex }}
integrations-github-copilot: ${{ steps.filter.outputs.integrations-github-copilot }}
integrations-continue: ${{ steps.filter.outputs.integrations-continue }}
integrations-cursor-cli: ${{ steps.filter.outputs.integrations-cursor-cli }}
integrations-crewai: ${{ steps.filter.outputs.integrations-crewai }}
@@ -50,6 +51,7 @@ jobs:
integrations-llamaindex: ${{ steps.filter.outputs.integrations-llamaindex }}
integrations-paperclip: ${{ steps.filter.outputs.integrations-paperclip }}
integrations-opencode: ${{ steps.filter.outputs.integrations-opencode }}
integrations-eve: ${{ steps.filter.outputs.integrations-eve }}
integrations-cursor: ${{ steps.filter.outputs.integrations-cursor }}
integrations-zed: ${{ steps.filter.outputs.integrations-zed }}
integrations-n8n: ${{ steps.filter.outputs.integrations-n8n }}
@@ -59,6 +61,7 @@ jobs:
integrations-lockfiles: ${{ steps.filter.outputs.integrations-lockfiles }}
integrations-openai-agents: ${{ steps.filter.outputs.integrations-openai-agents }}
integrations-openhands: ${{ steps.filter.outputs.integrations-openhands }}
integrations-devin-desktop: ${{ steps.filter.outputs.integrations-devin-desktop }}
integrations-pipecat: ${{ steps.filter.outputs.integrations-pipecat }}
integrations-agentcore: ${{ steps.filter.outputs.integrations-agentcore }}
integrations-smolagents: ${{ steps.filter.outputs.integrations-smolagents }}
@@ -143,6 +146,8 @@ jobs:
- 'hindsight-integrations/cline/**'
integrations-codex:
- 'hindsight-integrations/codex/**'
integrations-github-copilot:
- 'hindsight-integrations/github-copilot/**'
integrations-continue:
- 'hindsight-integrations/continue/**'
integrations-cursor-cli:
@@ -169,6 +174,8 @@ jobs:
- 'hindsight-integrations/paperclip/**'
integrations-opencode:
- 'hindsight-integrations/opencode/**'
integrations-eve:
- 'hindsight-integrations/eve/**'
integrations-cursor:
- 'hindsight-integrations/cursor/**'
integrations-zed:
@@ -189,6 +196,8 @@ jobs:
- 'hindsight-integrations/openai-agents/**'
integrations-openhands:
- 'hindsight-integrations/openhands/**'
integrations-devin-desktop:
- 'hindsight-integrations/devin-desktop/**'
integrations-pipecat:
- 'hindsight-integrations/pipecat/**'
integrations-agentcore:
@@ -591,6 +600,45 @@ jobs:
working-directory: ./hindsight-integrations/cline
run: uv run pytest tests -v
test-github-copilot-integration:
needs: [detect-changes]
if: >-
(github.event_name == 'workflow_dispatch' ||
needs.detect-changes.outputs.integrations-github-copilot == 'true' ||
needs.detect-changes.outputs.ci == 'true')
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v6
with:
ref: ${{ github.event.pull_request.head.sha || '' }}
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
enable-cache: true
prune-cache: false
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version-file: ".python-version"
- name: Build github-copilot integration
working-directory: ./hindsight-integrations/github-copilot
run: uv build
- name: Install dependencies
working-directory: ./hindsight-integrations/github-copilot
run: uv sync --frozen
- name: Run tests
working-directory: ./hindsight-integrations/github-copilot
# PR CI runs only the deterministic bucket; the real-LLM E2E bucket
# (requires_real_llm) needs a live Hindsight server and runs separately.
run: uv run pytest tests -v -m "not requires_real_llm"
test-codex-integration:
needs: [detect-changes]
if: >-
@@ -748,6 +796,37 @@ jobs:
working-directory: ./hindsight-integrations/opencode
run: npm run build
test-eve-integration:
needs: [detect-changes]
if: >-
(github.event_name == 'workflow_dispatch' ||
needs.detect-changes.outputs.integrations-eve == 'true' ||
needs.detect-changes.outputs.ci == 'true')
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v6
with:
ref: ${{ github.event.pull_request.head.sha || '' }}
- name: Set up Node.js
uses: actions/setup-node@v6
with:
node-version: '24'
- name: Install dependencies
working-directory: ./hindsight-integrations/eve
run: npm ci
- name: Run tests
working-directory: ./hindsight-integrations/eve
run: npm test
- name: Build
working-directory: ./hindsight-integrations/eve
run: npm run build
test-n8n-integration:
needs: [detect-changes]
if: >-
@@ -3787,6 +3866,45 @@ jobs:
# (requires_real_llm) needs a live Hindsight server and runs separately.
run: uv run pytest tests -v -m "not requires_real_llm"
test-devin-desktop-integration:
needs: [detect-changes]
if: >-
(github.event_name == 'workflow_dispatch' ||
needs.detect-changes.outputs.integrations-devin-desktop == 'true' ||
needs.detect-changes.outputs.ci == 'true')
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v6
with:
ref: ${{ github.event.pull_request.head.sha || '' }}
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
enable-cache: true
prune-cache: false
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version-file: ".python-version"
- name: Build devin-desktop integration
working-directory: ./hindsight-integrations/devin-desktop
run: uv build
- name: Install dependencies
working-directory: ./hindsight-integrations/devin-desktop
run: uv sync --frozen
- name: Run tests
working-directory: ./hindsight-integrations/devin-desktop
# PR CI runs only the deterministic bucket; the real-LLM E2E bucket
# (requires_real_llm) needs a live Hindsight server and runs separately.
run: uv run pytest tests -v -m "not requires_real_llm"
test-claude-agent-sdk-integration:
needs: [detect-changes]
if: >-
@@ -4788,11 +4906,13 @@ jobs:
- test-claude-code-integration
- test-cursor-integration
- test-cline-integration
- test-github-copilot-integration
- test-codex-integration
- test-cursor-cli-integration
- build-ai-sdk-integration
- test-ai-sdk-integration-deno
- test-opencode-integration
- test-eve-integration
- test-omo-integration
- test-cloudflare-oauth-proxy-integration
- build-chat-integration
@@ -4837,6 +4957,7 @@ jobs:
- test-llamaindex-integration
- test-openai-agents-integration
- test-openhands-integration
- test-devin-desktop-integration
- test-agentcore-integration
- test-haystack-integration
- test-pip-slim
+1
View File
@@ -6,6 +6,7 @@ dist/
wheels/
*.egg-info
.mcp.json
.playwright-mcp/
.osgrep
# Virtual environments
.venv
+2 -38
View File
@@ -16,42 +16,6 @@
---
### Powered by Atlas Cloud (OpenAI-compatible)
<p align="center">
<a href="https://www.atlascloud.ai/?utm_source=github&utm_medium=link&utm_campaign=hindsight">
<img src="./hindsight-docs/static/img/atlas-cloud-logo.png" alt="Atlas Cloud" width="200">
</a>
</p>
> 🎁 **[Atlas Cloud](https://www.atlascloud.ai/?utm_source=github&utm_medium=link&utm_campaign=hindsight)** is a full-modal, OpenAI-compatible AI inference platform — plug it in as a drop-in LLM backend for Hindsight's fact extraction, reflection and consolidation, with one API for DeepSeek, Qwen, GLM, Kimi, MiniMax and more. No multi-vendor setup needed.
> Budget-friendly: [coding plan](https://www.atlascloud.ai/console/coding-plan)
```bash
export HINDSIGHT_API_LLM_PROVIDER=atlas
export HINDSIGHT_API_LLM_API_KEY=your-atlascloud-api-key # base_url defaults to https://api.atlascloud.ai/v1
export HINDSIGHT_API_LLM_MODEL=deepseek-ai/deepseek-v4-pro
```
`deepseek-ai/deepseek-v4-pro` is a reasoning model — give it enough `max_tokens` (>= 512).
<details>
<summary>All Atlas Cloud chat models (59)</summary>
- **Anthropic (Claude):** `anthropic/claude-haiku-4.5-20251001`, `anthropic/claude-opus-4.8`, `anthropic/claude-sonnet-4.6`
- **OpenAI (GPT):** `openai/gpt-5.4`, `openai/gpt-5.5`
- **Google (Gemini):** `google/gemini-3.1-flash-lite`, `google/gemini-3.1-pro-preview`, `google/gemini-3.5-flash`
- **Alibaba Qwen:** `qwen/qwen2.5-7b-instruct`, `Qwen/Qwen3-235B-A22B-Instruct-2507`, `qwen/qwen3-235b-a22b-thinking-2507`, `qwen/qwen3-30b-a3b`, `Qwen/Qwen3-30B-A3B-Instruct-2507`, `qwen/qwen3-30b-a3b-thinking-2507`, `qwen/qwen3-32b`, `qwen/qwen3-8b`, `Qwen/Qwen3-Coder`, `qwen/qwen3-coder-next`, `qwen/qwen3-max-2026-01-23`, `Qwen/Qwen3-Next-80B-A3B-Instruct`, `Qwen/Qwen3-Next-80B-A3B-Thinking`, `Qwen/Qwen3-VL-235B-A22B-Instruct`, `qwen/qwen3-vl-235b-a22b-thinking`, `qwen/qwen3-vl-30b-a3b-instruct`, `qwen/qwen3-vl-30b-a3b-thinking`, `qwen/qwen3-vl-8b-instruct`, `qwen/qwen3.5-122b-a10b`, `qwen/qwen3.5-27b`, `qwen/qwen3.5-35b-a3b`, `qwen/qwen3.5-397b-a17b`, `qwen/qwen3.6-35b-a3b`, `qwen/qwen3.6-plus`
- **DeepSeek:** `deepseek-ai/deepseek-ocr`, `deepseek-ai/deepseek-r1-0528`, `deepseek-ai/DeepSeek-V3-0324`, `deepseek-ai/DeepSeek-V3.1`, `deepseek-ai/DeepSeek-V3.1-Terminus`, `deepseek-ai/deepseek-v3.2`, `deepseek-ai/DeepSeek-V3.2-Exp`, `deepseek-ai/deepseek-v4-flash`, `deepseek-ai/deepseek-v4-pro`
- **Moonshot (Kimi):** `moonshotai/Kimi-K2-Instruct`, `moonshotai/Kimi-K2-Instruct-0905`, `moonshotai/Kimi-K2-Thinking`, `moonshotai/kimi-k2.5`, `moonshotai/kimi-k2.6`
- **Zhipu GLM:** `zai-org/GLM-4.6`, `zai-org/glm-4.7`, `zai-org/glm-5`, `zai-org/glm-5-turbo`, `zai-org/glm-5.1`, `zai-org/glm-5v-turbo`
- **MiniMax:** `MiniMaxAI/MiniMax-M2`, `minimaxai/minimax-m2.1`, `minimaxai/minimax-m2.5`, `minimaxai/minimax-m2.7`
- **xAI:** `xai/grok-4.3`
- **Kuaishou KAT:** `kwaipilot/kat-coder-pro-v2`
- **Other:** `owl`
</details>
## What is Hindsight?
Hindsight™ is an agent memory system built to create smarter agents that learn over time. Most agent memory systems focus on recalling conversation history. Hindsight is focused on making agents that learn, not just remember.
@@ -286,7 +250,7 @@ Recall performs 4 retrieval strategies in parallel:
- Graph: Entity/temporal/causal links
- Temporal: Time range filtering
![Retain Operation](hindsight-docs/static/img/recall-operation.webp)
![Recall Operation](hindsight-docs/static/img/recall-operation.webp)
The individual results from the retrievals are merged, then ordered by relevance using reciprocal rank fusion and a cross-encoder reranking model.
@@ -312,7 +276,7 @@ client = Hindsight(base_url="http://localhost:8888")
client.reflect(bank_id="my-bank", query="What should I know about Alice?")
```
![Retain Operation](hindsight-docs/static/img/reflect-operation.webp)
![Reflect Operation](hindsight-docs/static/img/reflect-operation.webp)
---
+2 -2
View File
@@ -2,8 +2,8 @@ apiVersion: v2
name: hindsight
description: Hindsight helm chart
type: application
version: 0.8.3
appVersion: "0.8.3"
version: 0.8.4
appVersion: "0.8.4"
keywords:
- ai
- memory
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@vectorize-io/hindsight-all",
"version": "0.8.3",
"version": "0.8.4",
"description": "Node.js programmatic lifecycle manager for Hindsight — embeds a local hindsight daemon in a Node application. Pair with @vectorize-io/hindsight-client for memory operations.",
"main": "dist/index.js",
"types": "dist/index.d.ts",
+2 -2
View File
@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
[project]
name = "hindsight-all-slim"
version = "0.8.3"
version = "0.8.4"
description = "Hindsight: Agent Memory That Works Like Human Memory - Slim All-in-One Bundle"
readme = "README.md"
requires-python = ">=3.11"
dependencies = [
"hindsight-api-slim==0.8.3",
"hindsight-api-slim==0.8.4",
"hindsight-client>=0.0.7",
"hindsight-embed>=0.1.0",
]
+3 -3
View File
@@ -4,12 +4,12 @@ build-backend = "hatchling.build"
[project]
name = "hindsight-all"
version = "0.8.3"
version = "0.8.4"
description = "Hindsight: Agent Memory That Works Like Human Memory - All-in-One Bundle"
readme = "README.md"
requires-python = ">=3.11"
dependencies = [
"hindsight-api-slim[all]==0.8.3",
"hindsight-api-slim[all]==0.8.4",
"hindsight-client>=0.0.7",
"hindsight-embed>=0.1.0",
]
@@ -21,7 +21,7 @@ hindsight-embed = { workspace = true }
[project.optional-dependencies]
local-llm = [
"hindsight-api-slim[local-llm]==0.8.3",
"hindsight-api-slim[local-llm]==0.8.4",
]
test = [
"pytest>=7.0.0",
+1 -1
View File
@@ -121,7 +121,7 @@ This runs a stdio-based MCP server that can be used directly with MCP-compatible
- **Entity Graph** — Automatic entity extraction and relationship tracking
- **Temporal Reasoning** — Native support for time-based queries
- **Disposition Traits** — Configurable skepticism, literalism, and empathy influence opinion formation
- **Three Memory Types** — World facts, bank actions, and formed opinions with confidence scores
- **Three Memory Types** — World facts, experience facts (the bank's own actions), and observations
## Documentation
+1 -1
View File
@@ -53,4 +53,4 @@ __all__ = [
"RemoteTEICrossEncoder",
"LLMConfig",
]
__version__ = "0.8.3"
__version__ = "0.8.4"
@@ -56,6 +56,7 @@ BACKUP_TABLES = [
"observation_history",
"mental_models",
"mental_model_history",
"knowledge_pages",
"directives",
"async_operations",
"webhooks",
@@ -0,0 +1,52 @@
"""Add managed flag to knowledge_pages.
The knowledge base is managed by clients (CRUD over folders/pages). ``managed``
lets a client tag a node as system-owned vs. hand-authored; it carries no
server-side behaviour.
Revision ID: a5b6c7d8e9f0
Revises: a9b8c7d6e5f4
Create Date: 2026-06-26
"""
from collections.abc import Sequence
from alembic import context, op
from hindsight_api.alembic._dialect import run_for_dialect
revision: str = "a5b6c7d8e9f0"
down_revision: str | Sequence[str] | None = "a9b8c7d6e5f4"
branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None
def _pg_schema_prefix() -> str:
schema = context.config.get_main_option("target_schema")
return f'"{schema}".' if schema else ""
def _pg_upgrade() -> None:
schema = _pg_schema_prefix()
op.execute(f"ALTER TABLE {schema}knowledge_pages ADD COLUMN IF NOT EXISTS managed BOOLEAN NOT NULL DEFAULT false")
def _pg_downgrade() -> None:
schema = _pg_schema_prefix()
op.execute(f"ALTER TABLE {schema}knowledge_pages DROP COLUMN IF EXISTS managed")
def _oracle_upgrade() -> None:
op.execute("ALTER TABLE knowledge_pages ADD (managed NUMBER(1) DEFAULT 0 NOT NULL)")
def _oracle_downgrade() -> None:
op.execute("ALTER TABLE knowledge_pages DROP COLUMN managed")
def upgrade() -> None:
run_for_dialect(pg=_pg_upgrade, oracle=_oracle_upgrade)
def downgrade() -> None:
run_for_dialect(pg=_pg_downgrade, oracle=_oracle_downgrade)
@@ -0,0 +1,110 @@
"""Add knowledge_pages table (knowledge-base hierarchy).
The knowledge base organizes synthesized mental models into a navigable tree of
**folders** and **pages**. A page references the mental model that holds its
content (``mental_model_id``); a folder is a pure container (``mental_model_id``
NULL). Hierarchy is a single self-referential ``parent_id`` so folders can nest
arbitrarily. Content stays in ``mental_models`` — this table is metadata + tree
structure only.
Revision ID: a9b8c7d6e5f4
Revises: b57a7c9e0d13
Create Date: 2026-06-25
"""
from collections.abc import Sequence
from alembic import context, op
from hindsight_api.alembic._dialect import run_for_dialect
revision: str = "a9b8c7d6e5f4"
down_revision: str | Sequence[str] | None = "b57a7c9e0d13"
branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None
def _pg_schema_prefix() -> str:
"""Schema-qualifier for raw SQL on PG (multi-tenant search_path)."""
schema = context.config.get_main_option("target_schema")
return f'"{schema}".' if schema else ""
def _pg_upgrade() -> None:
schema = _pg_schema_prefix()
# parent_id self-FK cascades so deleting a folder row removes its whole
# subtree of rows in one shot. The mental_model FK is composite (matches the
# mental_models (id, bank_id) PK) and cascades too, so deleting a page's
# mental model removes the page row — folders skip the FK because a NULL
# column in a composite FK is not enforced (MATCH SIMPLE).
op.execute(
f"""
CREATE TABLE IF NOT EXISTS {schema}knowledge_pages (
id VARCHAR(64) NOT NULL,
bank_id TEXT NOT NULL,
parent_id VARCHAR(64),
kind VARCHAR(16) NOT NULL,
name TEXT NOT NULL,
mental_model_id VARCHAR(64),
sort_order INTEGER NOT NULL DEFAULT 0,
created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(),
updated_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(),
CONSTRAINT pk_knowledge_pages PRIMARY KEY (id),
CONSTRAINT ck_knowledge_pages_kind CHECK (kind IN ('folder', 'page')),
CONSTRAINT fk_kp_bank FOREIGN KEY (bank_id)
REFERENCES {schema}banks(bank_id) ON DELETE CASCADE,
CONSTRAINT fk_kp_parent FOREIGN KEY (parent_id)
REFERENCES {schema}knowledge_pages(id) ON DELETE CASCADE,
CONSTRAINT fk_kp_mm FOREIGN KEY (mental_model_id, bank_id)
REFERENCES {schema}mental_models(id, bank_id) ON DELETE CASCADE
)
"""
)
op.execute(
f"CREATE INDEX IF NOT EXISTS idx_kp_bank_parent ON {schema}knowledge_pages (bank_id, parent_id, sort_order)"
)
def _pg_downgrade() -> None:
schema = _pg_schema_prefix()
op.execute(f"DROP INDEX IF EXISTS {schema}idx_kp_bank_parent")
op.execute(f"DROP TABLE IF EXISTS {schema}knowledge_pages")
def _oracle_upgrade() -> None:
op.execute(
"""
CREATE TABLE IF NOT EXISTS knowledge_pages (
id VARCHAR2(64) NOT NULL,
bank_id VARCHAR2(256) NOT NULL,
parent_id VARCHAR2(64),
kind VARCHAR2(16) NOT NULL,
name CLOB NOT NULL,
mental_model_id VARCHAR2(64),
sort_order NUMBER DEFAULT 0 NOT NULL,
created_at TIMESTAMP WITH TIME ZONE DEFAULT SYSTIMESTAMP NOT NULL,
updated_at TIMESTAMP WITH TIME ZONE DEFAULT SYSTIMESTAMP NOT NULL,
CONSTRAINT pk_knowledge_pages PRIMARY KEY (id),
CONSTRAINT ck_knowledge_pages_kind CHECK (kind IN ('folder', 'page')),
CONSTRAINT fk_kp_bank FOREIGN KEY (bank_id)
REFERENCES banks(bank_id) ON DELETE CASCADE,
CONSTRAINT fk_kp_parent FOREIGN KEY (parent_id)
REFERENCES knowledge_pages(id) ON DELETE CASCADE,
CONSTRAINT fk_kp_mm FOREIGN KEY (mental_model_id, bank_id)
REFERENCES mental_models(id, bank_id) ON DELETE CASCADE
)
"""
)
op.execute("CREATE INDEX idx_kp_bank_parent ON knowledge_pages (bank_id, parent_id, sort_order)")
def _oracle_downgrade() -> None:
op.execute("DROP TABLE knowledge_pages CASCADE CONSTRAINTS")
def upgrade() -> None:
run_for_dialect(pg=_pg_upgrade, oracle=_oracle_upgrade)
def downgrade() -> None:
run_for_dialect(pg=_pg_downgrade, oracle=_oracle_downgrade)
@@ -0,0 +1,61 @@
"""Add bank_stats_cache table for distributed get_bank_stats caching
Revision ID: b57a7c9e0d13
Revises: c3f7a1b9d2e4
Create Date: 2026-07-01
get_bank_stats aggregates over memory_links / unit_entities — a multi-second scan
on banks with millions of rows. The result was cached per-process (in-memory), so
every API worker recomputed it once per TTL and the first caller after expiry
stalled. This table backs a shared, cross-process TTL cache: one worker's compute
is written here and served to all the others.
PostgreSQL only. Oracle keeps the in-process cache (the runtime picks the backing
store by dialect), so the Oracle upgrade slot is intentionally absent.
"""
from collections.abc import Sequence
from alembic import context, op
from hindsight_api.alembic._dialect import run_for_dialect
revision: str = "b57a7c9e0d13"
down_revision: str | Sequence[str] | None = "c3f7a1b9d2e4"
branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None
def _get_schema_prefix() -> str:
"""Schema-qualifier for raw SQL on PG (multi-tenant search_path)."""
schema = context.config.get_main_option("target_schema")
return f'"{schema}".' if schema else ""
def _pg_upgrade() -> None:
schema = _get_schema_prefix()
# One row per bank: payload is the full get_bank_stats result, computed_at
# drives logical TTL expiry. Rows are overwritten in place (ON CONFLICT), so
# the table never grows beyond the number of banks and needs no purge job.
op.execute(
f"""
CREATE TABLE IF NOT EXISTS {schema}bank_stats_cache (
bank_id TEXT PRIMARY KEY,
payload JSONB NOT NULL,
computed_at TIMESTAMPTZ NOT NULL DEFAULT now()
)
"""
)
def _pg_downgrade() -> None:
schema = _get_schema_prefix()
op.execute(f"DROP TABLE IF EXISTS {schema}bank_stats_cache")
def upgrade() -> None:
run_for_dialect(pg=_pg_upgrade) # oracle slot intentionally absent → no-op
def downgrade() -> None:
run_for_dialect(pg=_pg_downgrade)
@@ -0,0 +1,71 @@
"""Unique page name per folder in knowledge_pages.
The folder curator can fire concurrently (folder-create trigger + the
post-consolidation sweep), and an in-process lock can't serialize runs that
execute in different threads/loops. A partial unique index on
(bank_id, parent, lower(name)) for pages makes duplicate-named pages in the same
folder impossible at the DB level — the second concurrent insert fails and the
curator treats it as "already exists".
PostgreSQL only: the Oracle ``name`` column is a CLOB and cannot back a
functional unique index; Oracle relies on the in-process serialization instead.
Revision ID: c3d4e5f6a7b8
Revises: a5b6c7d8e9f0
Create Date: 2026-06-26
"""
from collections.abc import Sequence
from alembic import context, op
from hindsight_api.alembic._dialect import run_for_dialect
revision: str = "c3d4e5f6a7b8"
down_revision: str | Sequence[str] | None = "a5b6c7d8e9f0"
branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None
def _pg_schema_prefix() -> str:
schema = context.config.get_main_option("target_schema")
return f'"{schema}".' if schema else ""
def _pg_upgrade() -> None:
schema = _pg_schema_prefix()
# First drop any pre-existing duplicate pages (created by the racy curator
# before this guard existed), keeping the earliest row of each duplicate set,
# so the unique index can be built. Their backing mental models are left in
# place (harmless orphans).
op.execute(
f"""
DELETE FROM {schema}knowledge_pages a
USING {schema}knowledge_pages b
WHERE a.kind = 'page' AND b.kind = 'page'
AND a.bank_id = b.bank_id
AND COALESCE(a.parent_id, '') = COALESCE(b.parent_id, '')
AND lower(a.name) = lower(b.name)
AND a.ctid > b.ctid
"""
)
# COALESCE(parent_id, '') so root-level pages (NULL parent) are also unique by
# name — NULLs would otherwise compare distinct and allow duplicates.
op.execute(
"CREATE UNIQUE INDEX IF NOT EXISTS uq_kp_folder_pagename "
f"ON {schema}knowledge_pages (bank_id, COALESCE(parent_id, ''), lower(name)) "
"WHERE kind = 'page'"
)
def _pg_downgrade() -> None:
schema = _pg_schema_prefix()
op.execute(f"DROP INDEX IF EXISTS {schema}uq_kp_folder_pagename")
def upgrade() -> None:
run_for_dialect(pg=_pg_upgrade) # oracle slot intentionally absent (CLOB name)
def downgrade() -> None:
run_for_dialect(pg=_pg_downgrade)
@@ -0,0 +1,144 @@
"""Backfill search_vector for native-backend observations.
Observations created or updated by the consolidator landed with a NULL
``search_vector`` under the ``native`` text-search backend: the
single-row INSERT/UPDATE paths in ``consolidator.py`` never populated the
tsvector (only the batch raw-fact path in ``ops_postgresql.insert_facts_batch``
did). Those observations were therefore invisible to the BM25 retrieval arm
until they were re-written by a later consolidation pass. The writer is fixed
in the same change set (all four consolidator sites now call
``to_tsvector($lang, COALESCE(text, ''))``); this migration repairs the
historical residue so existing observations become BM25-searchable without a
re-ingest.
Scope mirrors the writer fix exactly:
* Only the ``native`` backend is touched. The gate is the column *type*:
under ``native`` ``search_vector`` is a regular (non-generated) tsvector
column; under ``vchord`` it is a ``bm25vector`` and under
``pg_textsearch`` / ``pgroonga`` / ``pg_search`` it is a dummy ``text``
column. ``_is_regular_tsvector`` is true only for ``native``, so every
other backend is a no-op.
* The tsvector is built from the observation's own ``text`` only — matching
the consolidator INSERT/UPDATE paths (entity / source / temporal signals
are intentionally excluded; the other retrieval arms cover those).
* Only ``fact_type = 'observation'`` rows with a NULL ``search_vector`` are
rewritten. Raw facts already carry a populated tsvector, and the
``IS NULL`` predicate makes the migration idempotent and re-runnable.
The configured ``HINDSIGHT_API_TEXT_SEARCH_EXTENSION_NATIVE_LANGUAGE`` is used
so backfilled rows are lexically identical to newly-created observations. The
value is validated as a PG identifier (mirroring
``HindsightConfig.validate``) before being embedded as a SQL literal.
This is a single UPDATE per schema: it locks the targeted observation rows for
its duration. It is one-time and only touches unpopulated rows, so subsequent
online writes (which now carry the tsvector via the writer fix) are unaffected.
Oracle slot is intentionally absent: the consolidator INSERT/UPDATE paths that
this repairs are PostgreSQL-specific (``ops_postgresql``), and the native
tsvector ``search_vector`` column only exists on PostgreSQL. There is no Oracle
residue to repair.
Revision ID: c3f7a1b9d2e4
Revises: f4d1c2b3a5e6
Create Date: 2026-06-29
"""
import os
import re
from collections.abc import Sequence
from alembic import context, op
from sqlalchemy import Connection, text
from hindsight_api.alembic._dialect import run_for_dialect
from hindsight_api.config import (
DEFAULT_TEXT_SEARCH_EXTENSION_NATIVE_LANGUAGE,
ENV_TEXT_SEARCH_EXTENSION_NATIVE_LANGUAGE,
)
revision: str = "c3f7a1b9d2e4"
down_revision: str | Sequence[str] | None = "f4d1c2b3a5e6"
branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None
# Matches HindsightConfig.validate(): a tsvector regconfig name embedded as a
# SQL literal must be a bare PG identifier.
_PG_IDENTIFIER = re.compile(r"[a-zA-Z_][a-zA-Z0-9_]*")
def _schema_prefix() -> str:
schema = context.config.get_main_option("target_schema")
return f'"{schema}".' if schema else ""
def _schema_name() -> str:
return (context.config.get_main_option("target_schema") or "public").strip('"')
def _native_language() -> str:
"""Configured native tsvector language, validated as a PG identifier."""
lang = os.getenv(
ENV_TEXT_SEARCH_EXTENSION_NATIVE_LANGUAGE,
DEFAULT_TEXT_SEARCH_EXTENSION_NATIVE_LANGUAGE,
)
if not _PG_IDENTIFIER.fullmatch(lang):
return DEFAULT_TEXT_SEARCH_EXTENSION_NATIVE_LANGUAGE
return lang
def _is_regular_tsvector(conn: Connection, schema: str, table: str) -> bool:
"""True iff ``schema.table.search_vector`` is a non-generated tsvector column.
This is the ``native`` backend signature. ``vchord`` (bm25vector) and
``pg_textsearch`` / ``pgroonga`` / ``pg_search`` (dummy text column) all
fail this check, so the backfill is a no-op for them.
"""
row = conn.execute(
text(
"""
SELECT is_generated, udt_name
FROM information_schema.columns
WHERE table_schema = :schema
AND table_name = :table
AND column_name = 'search_vector'
"""
),
{"schema": schema, "table": table},
).fetchone()
if not row:
return False
is_generated, udt_name = row[0], row[1]
return udt_name == "tsvector" and is_generated != "ALWAYS"
def _pg_upgrade() -> None:
conn = op.get_bind()
schema_name = _schema_name()
if not _is_regular_tsvector(conn, schema_name, "memory_units"):
# Non-native backend (or column absent) — nothing to backfill.
return
schema_prefix = _schema_prefix()
lang = _native_language()
op.execute(
f"""
UPDATE {schema_prefix}memory_units
SET search_vector = to_tsvector('{lang}'::regconfig, COALESCE(text, ''))
WHERE fact_type = 'observation' AND search_vector IS NULL
"""
)
def _pg_downgrade() -> None:
# No-op: backfilled rows are indistinguishable from observations that were
# populated by the post-fix writer, and reverting either to NULL would
# re-break BM25 retrieval. The column simply stays populated.
pass
def upgrade() -> None:
run_for_dialect(pg=_pg_upgrade)
def downgrade() -> None:
run_for_dialect(pg=_pg_downgrade)
@@ -0,0 +1,110 @@
"""Add server-side routine for cron-scheduled mental model refresh.
Installs ``public.mental_models_with_cron()`` — a discovery routine that returns
every mental model carrying a non-empty ``trigger->>'refresh_cron'`` across all
tenant schemas in one round-trip (the same per-schema scan as the other
maintenance routines from ``e5f6a7b8c9d0``). The maintenance loop evaluates each
candidate's cron expression in Python (``croniter``) against ``last_refreshed_at``
to decide whether a scheduled refresh is due — cron arithmetic isn't expressible
in plain SQL — and only the cron *candidate set* is discovered here.
Models that already have a ``refresh_mental_model`` operation pending/processing
are excluded so a slow refresh isn't double-queued (mirrors the in-flight guard
in ``banks_needing_consolidation``). Each per-schema query runs in its own
``BEGIN ... EXCEPTION`` subtransaction so a schema dropped mid-scan (tenant
deletion / migration) is skipped, not fatal — same resilience as
``c7e9f1a3b5d2``.
Read-only (STABLE) discovery routine — the caller performs the refresh enqueue —
so installing it never mutates data. PostgreSQL only: the worker poller and the
maintenance loop are PG-only (Oracle slot intentionally absent, mirroring
``e5f6a7b8c9d0``). The routine lives in ``public`` and is CREATE OR REPLACE, so
it is installed exactly once (base / ``public`` run) to avoid the
``tuple concurrently updated`` race on concurrent per-tenant runs.
Revision ID: f4d1c2b3a5e6
Revises: c7e9f1a3b5d2
Create Date: 2026-06-23
"""
from collections.abc import Sequence
from alembic import context, op
from hindsight_api.alembic._dialect import run_for_dialect
revision: str = "f4d1c2b3a5e6"
down_revision: str | Sequence[str] | None = "c7e9f1a3b5d2"
branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None
def _should_install_public_routines(target_schema: str | None) -> bool:
"""True for the run that must (re)create the shared ``public.*`` routine.
The routine physically lives in ``public``, so it is installed exactly once —
on the base run (no ``target_schema``) or the run that explicitly targets
``public``. Mirrors ``c7e9f1a3b5d2``.
"""
return not target_schema or target_schema == "public"
def _pg_upgrade() -> None:
if not _should_install_public_routines(context.config.get_main_option("target_schema")):
return
op.execute(
"""
CREATE OR REPLACE FUNCTION public.mental_models_with_cron()
RETURNS TABLE(schema_name text, bank_id text, mental_model_id text,
refresh_cron text, last_refreshed_at timestamptz)
LANGUAGE plpgsql STABLE
AS $fn$
DECLARE
sch text;
BEGIN
FOR sch IN
SELECT n.nspname
FROM pg_class c
JOIN pg_namespace n ON n.oid = c.relnamespace
WHERE c.relname = 'mental_models' AND c.relkind = 'r'
LOOP
BEGIN
RETURN QUERY EXECUTE format($q$
SELECT %1$L::text, mm.bank_id::text, mm.id::text,
mm.trigger->>'refresh_cron', mm.last_refreshed_at
FROM %1$I.mental_models mm
WHERE COALESCE(mm.trigger->>'refresh_cron', '') <> ''
AND NOT EXISTS (
SELECT 1 FROM %1$I.async_operations o
WHERE o.bank_id = mm.bank_id
AND o.operation_type = 'refresh_mental_model'
AND o.status IN ('pending', 'processing')
AND o.task_payload->>'mental_model_id' = mm.id::text
)
$q$, sch);
EXCEPTION
-- Schema or its tables vanished between the pg_class
-- snapshot and this query (tenant dropped or migrating).
WHEN undefined_table OR invalid_schema_name OR undefined_column THEN
CONTINUE;
END;
END LOOP;
END;
$fn$;
"""
)
def _pg_downgrade() -> None:
if not _should_install_public_routines(context.config.get_main_option("target_schema")):
return
op.execute("DROP FUNCTION IF EXISTS public.mental_models_with_cron()")
def upgrade() -> None:
run_for_dialect(pg=_pg_upgrade)
def downgrade() -> None:
run_for_dialect(pg=_pg_downgrade)
+571 -20
View File
@@ -18,6 +18,7 @@ from typing import Any, Literal, TypeVar
from fastapi import Depends, FastAPI, File, Form, Header, HTTPException, Query, Request, UploadFile
from fastapi.middleware.gzip import GZipMiddleware
from hindsight_api.api import okf
from hindsight_api.api.disconnect import ClientDisconnectCancellationMiddleware, get_scope_cancellation_token
from hindsight_api.cancellation import OperationCancelledError
from hindsight_api.engine.audit import (
@@ -27,7 +28,7 @@ from hindsight_api.engine.audit import (
AuditLogStatsResponse,
)
from hindsight_api.engine.llm_trace import LLMRequestListResponse, LLMRequestStatsResponse
from hindsight_api.extensions import AuthenticationError
from hindsight_api.extensions import AuthenticationError, PrecheckOperation
def _parse_metadata(metadata: Any) -> dict[str, Any]:
@@ -154,6 +155,8 @@ from hindsight_api.engine.response_models import (
VALID_RECALL_FACT_TYPES,
DryRunExtractionResult,
MemoryFact,
MinScores,
RecallScores,
TokenUsage,
)
from hindsight_api.engine.search.tags import TagGroup, TagsMatch
@@ -312,6 +315,15 @@ class RecallRequest(BaseModel):
description="Compound tag filter using boolean groups. Groups in the list are AND-ed. "
"Each group is a leaf {tags, match} or compound {and: [...]}, {or: [...]}, {not: ...}.",
)
min_scores: MinScores | None = Field(
default=None,
description="Optional per-stage score floors (all inclusive, AND-ed). `semantic` and `keyword` are "
"retrieval-level cutoffs pushed into the SQL arms (overriding the global similarity/BM25 minimums for "
"this request); `reranker` and `final` are post-ranking filters on the scored results. Any field left "
"unset imposes no floor; omitting `min_scores` entirely (the default) applies no score filtering. Use "
"with care — the reranker's absolute scores are not calibrated across queries (a clearly-relevant match "
"may score ~0.001 even though it is ranked first).",
)
@field_validator("query")
@classmethod
@@ -367,6 +379,7 @@ class RecallResult(BaseModel):
source_fact_ids: list[str] | None = (
None # IDs of source facts (observation type only, when source_facts is enabled)
)
scores: RecallScores | None = None # Per-stage recall scores (final/reranker/semantic/text)
class EntityObservationResponse(BaseModel):
@@ -1967,6 +1980,17 @@ class MentalModelTrigger(BaseModel):
default=False,
description="If true, refresh this mental model after observations consolidation (real-time mode)",
)
refresh_cron: str | None = Field(
default=None,
description=(
"Cron expression (UTC, standard 5-field syntax, e.g. '0 3 * * *' for daily at 03:00 UTC) "
"for refreshing this mental model on a fixed schedule. Mutually exclusive with "
"refresh_after_consolidation — a model refreshes either after consolidation or on a cron "
"schedule, not both. A scheduled refresh only runs when the model is stale (new memories in "
"its scope since the last refresh); if nothing changed, the tick is skipped to avoid a "
"wasted LLM call. null = no schedule."
),
)
fact_types: list[Literal["world", "experience", "observation"]] | None = Field(
default=None,
description="Filter which fact types are retrieved during reflect. None means all types (world, experience, observation).",
@@ -2025,6 +2049,31 @@ class MentalModelTrigger(BaseModel):
raise ValueError("fact_types must not be empty. Use null to include all fact types.")
return v
@field_validator("refresh_cron")
@classmethod
def validate_refresh_cron(cls, v: str | None) -> str | None:
if v is None:
return v
v = v.strip()
if not v:
return None
from croniter import croniter
if not croniter.is_valid(v):
raise ValueError(f"refresh_cron is not a valid cron expression: {v!r}")
return v
@model_validator(mode="after")
def validate_refresh_exclusivity(self) -> "MentalModelTrigger":
# A mental model refreshes either after consolidation (real-time) or on a
# cron schedule, never both — the two triggers would race and double-refresh.
if self.refresh_after_consolidation and self.refresh_cron:
raise ValueError(
"refresh_after_consolidation and refresh_cron are mutually exclusive: "
"a mental model refreshes either after consolidation or on a cron schedule, not both."
)
return self
class MentalModelResponse(BaseModel):
"""Response model for a mental model (stored reflect response)."""
@@ -2062,6 +2111,150 @@ class MentalModelListResponse(BaseModel):
items: list[MentalModelResponse]
# =========================================================================
# KNOWLEDGE BASE (folders + pages over mental models, projected to OKF)
# =========================================================================
class KnowledgeNode(BaseModel):
"""A node in the knowledge-base tree — a folder or a page.
Pages carry ``description``/``tags`` from their backing mental model. The
knowledge base is client-managed (CRUD); ``managed`` lets a client tag a node
as system-owned vs. hand-authored.
"""
id: str
kind: Literal["folder", "page"]
name: str
parent_id: str | None = None
mental_model_id: str | None = Field(default=None, description="Backing mental model id (pages only).")
managed: bool = Field(default=False, description="Client-set flag: true = system-owned, false = hand-authored.")
description: str | None = Field(default=None, description="Page source query (OKF `description`).")
tags: list[str] = FieldWithDefault(list)
timestamp: str | None = Field(default=None, description="Last refresh (page) or last update (folder).")
children: list["KnowledgeNode"] = FieldWithDefault(list)
class KnowledgeTreeResponse(BaseModel):
"""The knowledge base as a nested folder/page tree."""
roots: list[KnowledgeNode]
class CreateFolderRequest(BaseModel):
"""Create a folder under an optional parent folder."""
name: str
parent_id: str | None = None
class CreatePageRequest(BaseModel):
"""Create a page (a mental model + tree node) under an optional parent folder."""
name: str
source_query: str
parent_id: str | None = None
tags: list[str] | None = None
max_tokens: int | None = None
trigger: MentalModelTrigger | None = None
class UpdateNodeRequest(BaseModel):
"""Rename and/or move a node. Each field applies only when present."""
name: str | None = None
parent_id: str | None = None
class CreateKnowledgePageResponse(BaseModel):
"""Result of creating a page: the node id, its mental model, and the refresh op."""
page_id: str
mental_model_id: str
operation_id: str | None = None
class KnowledgePageResponse(BaseModel):
"""A knowledge page rendered as an OKF document."""
id: str
name: str
type: str = Field(description="OKF document type — from a `type:<x>` tag, else 'knowledge-page'.")
description: str | None = Field(default=None, description="The source query that rebuilds the page.")
tags: list[str] = FieldWithDefault(list)
timestamp: str | None = Field(default=None, description="Last refresh time (falls back to creation).")
body: str | None = Field(default=None, description="The page's synthesized markdown body.")
markdown: str = Field(description="The full OKF document: YAML frontmatter + markdown body.")
class KnowledgePageGraphResponse(BaseModel):
"""Constellation graph of knowledge pages linked by shared tags."""
nodes: list[dict[str, Any]]
edges: list[dict[str, Any]]
total_pages: int
total_edges: int
class KnowledgePageBundleFile(BaseModel):
"""One file in a portable OKF bundle."""
path: str
content: str
class KnowledgePageBundleResponse(BaseModel):
"""A portable OKF bundle — a flat set of markdown files (index + pages + logs)."""
files: list[KnowledgePageBundleFile]
def _knowledge_node_model(node: dict[str, Any]) -> KnowledgeNode:
"""Project an engine node dict into a (childless) KnowledgeNode."""
is_page = node.get("kind") == "page"
return KnowledgeNode(
id=node["id"],
kind=node["kind"],
name=node["name"],
parent_id=node.get("parent_id"),
mental_model_id=node.get("mental_model_id"),
managed=bool(node.get("managed")),
description=node.get("source_query") if is_page else None,
tags=list(node.get("tags") or []) if is_page else [],
timestamp=(node.get("last_refreshed_at") if is_page else node.get("updated_at")),
)
def _build_knowledge_tree(nodes: list[dict[str, Any]]) -> list[KnowledgeNode]:
"""Assemble the flat node list into a nested tree of roots."""
models = {n["id"]: _knowledge_node_model(n) for n in nodes}
roots: list[KnowledgeNode] = []
for node in nodes:
model = models[node["id"]]
parent_id = node.get("parent_id")
if parent_id and parent_id in models:
models[parent_id].children.append(model)
else:
roots.append(model)
return roots
def _knowledge_page_response(node: dict[str, Any]) -> KnowledgePageResponse:
"""Project a page node (with merged mental-model content) into an OKF document."""
page = okf.page_type(node.get("tags"))
return KnowledgePageResponse(
id=node["id"],
name=node["name"],
type=page.type,
description=node.get("source_query"),
tags=page.display_tags,
timestamp=node.get("last_refreshed_at") or node.get("created_at"),
body=node.get("content"),
markdown=okf.render_document(node),
)
class CreateMentalModelRequest(BaseModel):
"""Request model for creating a mental model."""
@@ -2560,6 +2753,10 @@ class OperationResponse(BaseModel):
task_type: str
items_count: int
document_id: str | None = None
filename: str | None = Field(
default=None,
description="Original filename for file-conversion operations (file_convert_retain); null for other task types.",
)
created_at: str
updated_at: str | None = Field(
default=None,
@@ -3069,8 +3266,12 @@ def create_app(
# All current backends (PostgreSQL, Oracle) support async worker/poller.
if config.worker_enabled and memory._backend.supports_worker_poller:
from ..config import DEFAULT_DATABASE_SCHEMA
from ..utils import warn_if_container_default_worker_id
warn_if_container_default_worker_id(config.worker_id)
worker_id = config.worker_id or socket.gethostname()
worker_id_source = "HINDSIGHT_API_WORKER_ID" if config.worker_id else "hostname (default)"
logging.info(f"Worker id: {worker_id} (source: {worker_id_source})")
# Convert default schema to None for SQL compatibility (no schema prefix)
schema = None if config.database_schema == DEFAULT_DATABASE_SCHEMA else config.database_schema
poller = WorkerPoller(
@@ -3324,7 +3525,7 @@ def _register_routes(app: FastAPI):
api_key = authorization.strip()
return RequestContext(api_key=api_key)
def precheck_for(operation: str):
def precheck_for(operation: PrecheckOperation):
"""
Build a FastAPI dependency that runs ``OperationValidator.precheck``.
@@ -3575,7 +3776,7 @@ def _register_routes(app: FastAPI):
async def _require_dry_run_enabled() -> None:
"""Feature-flag gate for dry-run extraction.
Declared as a dependency BEFORE ``precheck_for("dry_run_extract")`` so a
Declared as a dependency BEFORE ``precheck_for(PrecheckOperation.DRY_RUN_EXTRACT)`` so a
disabled route returns 404 regardless of tenant/billing state FastAPI
resolves path-operation dependencies in signature order, so this runs
first and preserves the original "disabled → 404" contract.
@@ -3605,7 +3806,7 @@ def _register_routes(app: FastAPI):
body: DryRunExtractRequest,
request_context: RequestContext = Depends(get_request_context),
_enabled: None = Depends(_require_dry_run_enabled),
_precheck: None = Depends(precheck_for("dry_run_extract")),
_precheck: None = Depends(precheck_for(PrecheckOperation.DRY_RUN_EXTRACT)),
):
try:
override_fields = (
@@ -3773,7 +3974,7 @@ def _register_routes(app: FastAPI):
request: RecallRequest,
http_request: Request,
request_context: RequestContext = Depends(get_request_context),
_precheck: None = Depends(precheck_for("recall")),
_precheck: None = Depends(precheck_for(PrecheckOperation.RECALL)),
):
"""Run a recall and return results with trace."""
import time
@@ -3853,6 +4054,7 @@ def _register_routes(app: FastAPI):
tags=request.tags,
tags_match=request.tags_match,
tag_groups=request.tag_groups,
min_scores=request.min_scores,
),
operation="recall",
bank_id=bank_id,
@@ -3874,6 +4076,7 @@ def _register_routes(app: FastAPI):
chunk_id=fact.chunk_id,
tags=fact.tags,
source_fact_ids=fact.source_fact_ids,
scores=fact.scores,
)
recall_results = [_fact_to_result(fact) for fact in core_result.results]
@@ -3975,7 +4178,7 @@ def _register_routes(app: FastAPI):
request: ReflectRequest,
http_request: Request,
request_context: RequestContext = Depends(get_request_context),
_precheck: None = Depends(precheck_for("reflect")),
_precheck: None = Depends(precheck_for(PrecheckOperation.REFLECT)),
):
metrics = get_metrics_collector()
@@ -4133,11 +4336,17 @@ def _register_routes(app: FastAPI):
)
async def api_stats(
bank_id: str,
refresh: bool = Query(
default=False,
description="Force a fresh recompute, bypassing the cached value (and refreshing the cache).",
),
request_context: RequestContext = Depends(get_request_context),
):
"""Get statistics about memory nodes and links for a memory bank."""
try:
stats = await app.state.memory.get_bank_stats(bank_id, request_context=request_context)
stats = await app.state.memory.get_bank_stats(
bank_id, request_context=request_context, force_refresh=refresh
)
nodes_by_type = stats["node_counts"]
links_by_type = stats["link_counts"]
links_by_fact_type = stats["link_counts_by_fact_type"]
@@ -4522,7 +4731,7 @@ def _register_routes(app: FastAPI):
bank_id: str,
body: CreateMentalModelRequest,
request_context: RequestContext = Depends(get_request_context),
_precheck: None = Depends(precheck_for("mental_model_create")),
_precheck: None = Depends(precheck_for(PrecheckOperation.MENTAL_MODEL_CREATE)),
):
"""Create a mental model (async - returns operation_id)."""
try:
@@ -4571,7 +4780,7 @@ def _register_routes(app: FastAPI):
bank_id: str,
mental_model_id: str,
request_context: RequestContext = Depends(get_request_context),
_precheck: None = Depends(precheck_for("mental_model_refresh")),
_precheck: None = Depends(precheck_for(PrecheckOperation.MENTAL_MODEL_REFRESH)),
):
"""Refresh a mental model by re-running its source query (async)."""
try:
@@ -4717,6 +4926,333 @@ def _register_routes(app: FastAPI):
logger.error(f"Error in DELETE /v1/default/banks/{bank_id}/mental-models/{mental_model_id}: {error_detail}")
raise HTTPException(status_code=500, detail=str(e))
# =========================================================================
# KNOWLEDGE BASE ENDPOINTS (folders + pages, Open Knowledge Format)
# =========================================================================
# A hierarchy of folders and pages over mental models. Pages project to OKF
# documents (markdown body + YAML frontmatter); see api/okf.py. The static
# sub-paths (/tree, /folders, /pages, /graph, /export) are declared before
# the /pages/{id} and /nodes/{id} path-parameter routes so they win.
@app.get(
"/v1/default/banks/{bank_id}/knowledge-base/tree",
response_model=KnowledgeTreeResponse,
summary="Get the knowledge-base tree",
description="Return the knowledge base as a nested tree of folders and pages.",
operation_id="get_knowledge_base_tree",
tags=["Knowledge Base"],
)
async def api_knowledge_base_tree(
bank_id: str,
request_context: RequestContext = Depends(get_request_context),
):
"""Return the folder/page tree for a bank."""
try:
nodes = await app.state.memory.list_knowledge_nodes(bank_id=bank_id, request_context=request_context)
return KnowledgeTreeResponse(roots=_build_knowledge_tree(nodes))
except OperationValidationError as e:
raise HTTPException(status_code=e.status_code, detail=e.reason)
except (AuthenticationError, HTTPException):
raise
except Exception as e:
import traceback
error_detail = f"{str(e)}\n\nTraceback:\n{traceback.format_exc()}"
logger.error(f"Error in GET /v1/default/banks/{bank_id}/knowledge-base/tree: {error_detail}")
raise HTTPException(status_code=500, detail=str(e))
@app.post(
"/v1/default/banks/{bank_id}/knowledge-base/folders",
response_model=KnowledgeNode,
status_code=201,
summary="Create a knowledge-base folder",
description="Create a folder, optionally nested under a parent folder.",
operation_id="create_knowledge_folder",
tags=["Knowledge Base"],
)
async def api_create_knowledge_folder(
bank_id: str,
body: CreateFolderRequest,
request_context: RequestContext = Depends(get_request_context),
):
"""Create a folder node."""
try:
node = await app.state.memory.create_knowledge_folder(
bank_id=bank_id,
name=body.name,
parent_id=body.parent_id,
request_context=request_context,
)
return _knowledge_node_model(node)
except ValueError as e:
raise HTTPException(status_code=400, detail=str(e))
except OperationValidationError as e:
raise HTTPException(status_code=e.status_code, detail=e.reason)
except (AuthenticationError, HTTPException):
raise
except Exception as e:
import traceback
error_detail = f"{str(e)}\n\nTraceback:\n{traceback.format_exc()}"
logger.error(f"Error in POST /v1/default/banks/{bank_id}/knowledge-base/folders: {error_detail}")
raise HTTPException(status_code=500, detail=str(e))
@app.post(
"/v1/default/banks/{bank_id}/knowledge-base/pages",
response_model=CreateKnowledgePageResponse,
status_code=201,
summary="Create a knowledge-base page",
description="Create a page (a mental model + tree node). Content is generated asynchronously; "
"use the returned operation_id to track completion.",
operation_id="create_knowledge_page",
tags=["Knowledge Base"],
)
async def api_create_knowledge_page(
bank_id: str,
body: CreatePageRequest,
request_context: RequestContext = Depends(get_request_context),
):
"""Create a page node (async content generation)."""
try:
node = await app.state.memory.create_knowledge_page(
bank_id=bank_id,
name=body.name,
source_query=body.source_query,
content="Generating content...",
parent_id=body.parent_id,
tags=body.tags if body.tags else None,
max_tokens=body.max_tokens,
trigger=body.trigger.model_dump() if body.trigger else None,
request_context=request_context,
)
if node is None:
raise HTTPException(status_code=409, detail=f"A page named '{body.name}' already exists in this folder")
result = await app.state.memory.submit_async_refresh_mental_model(
bank_id=bank_id,
mental_model_id=node["mental_model_id"],
request_context=request_context,
)
return CreateKnowledgePageResponse(
page_id=node["id"],
mental_model_id=node["mental_model_id"],
operation_id=result["operation_id"],
)
except ValueError as e:
raise HTTPException(status_code=400, detail=str(e))
except OperationValidationError as e:
raise HTTPException(status_code=e.status_code, detail=e.reason)
except (AuthenticationError, HTTPException):
raise
except Exception as e:
import traceback
error_detail = f"{str(e)}\n\nTraceback:\n{traceback.format_exc()}"
logger.error(f"Error in POST /v1/default/banks/{bank_id}/knowledge-base/pages: {error_detail}")
raise HTTPException(status_code=500, detail=str(e))
@app.get(
"/v1/default/banks/{bank_id}/knowledge-base/graph",
response_model=KnowledgePageGraphResponse,
summary="Knowledge-base constellation graph",
description="Return pages as nodes linked by shared tags, for the constellation view.",
operation_id="get_knowledge_base_graph",
tags=["Knowledge Base"],
)
async def api_knowledge_base_graph(
bank_id: str,
request_context: RequestContext = Depends(get_request_context),
):
"""Return the shared-tag constellation graph for a bank's pages."""
try:
nodes = await app.state.memory.list_knowledge_nodes(bank_id=bank_id, request_context=request_context)
pages = [n for n in nodes if n.get("kind") == "page"]
# Cluster the constellation by parent folder (the knowledge base's own
# structure) rather than by the retired type: tag.
folder_names = {n["id"]: n["name"] for n in nodes if n.get("kind") == "folder"}
graph = okf.knowledge_graph(pages, cluster_for=lambda p: folder_names.get(p.get("parent_id"), "Ungrouped"))
return KnowledgePageGraphResponse(
nodes=graph.nodes,
edges=graph.edges,
total_pages=len(graph.nodes),
total_edges=len(graph.edges),
)
except OperationValidationError as e:
raise HTTPException(status_code=e.status_code, detail=e.reason)
except (AuthenticationError, HTTPException):
raise
except Exception as e:
import traceback
error_detail = f"{str(e)}\n\nTraceback:\n{traceback.format_exc()}"
logger.error(f"Error in GET /v1/default/banks/{bank_id}/knowledge-base/graph: {error_detail}")
raise HTTPException(status_code=500, detail=str(e))
@app.get(
"/v1/default/banks/{bank_id}/knowledge-base/export",
response_model=KnowledgePageBundleResponse,
summary="Export the knowledge base as an OKF bundle",
description="Return a portable OKF bundle: a nested index.md, one <id>.md per page, and history logs.",
operation_id="export_knowledge_base",
tags=["Knowledge Base"],
)
async def api_export_knowledge_base(
bank_id: str,
request_context: RequestContext = Depends(get_request_context),
):
"""Export a bank's knowledge base as a flat OKF markdown bundle."""
try:
nodes = await app.state.memory.list_knowledge_nodes(bank_id=bank_id, request_context=request_context)
files = [KnowledgePageBundleFile(path=okf.INDEX_FILENAME, content=okf.render_index(nodes))]
for node in nodes:
if node.get("kind") != "page":
continue
page = await app.state.memory.get_knowledge_page(
bank_id=bank_id, page_id=node["id"], request_context=request_context
)
if page is None:
continue
files.append(
KnowledgePageBundleFile(path=okf.page_filename(node["id"]), content=okf.render_document(page))
)
if node.get("mental_model_id"):
history = (
await app.state.memory.get_mental_model_history(
bank_id=bank_id,
mental_model_id=node["mental_model_id"],
request_context=request_context,
)
or []
)
if history:
files.append(
KnowledgePageBundleFile(
path=okf.log_filename(node["id"]), content=okf.render_log(page, history)
)
)
return KnowledgePageBundleResponse(files=files)
except OperationValidationError as e:
raise HTTPException(status_code=e.status_code, detail=e.reason)
except (AuthenticationError, HTTPException):
raise
except Exception as e:
import traceback
error_detail = f"{str(e)}\n\nTraceback:\n{traceback.format_exc()}"
logger.error(f"Error in GET /v1/default/banks/{bank_id}/knowledge-base/export: {error_detail}")
raise HTTPException(status_code=500, detail=str(e))
@app.get(
"/v1/default/banks/{bank_id}/knowledge-base/pages/{page_id}",
response_model=KnowledgePageResponse,
summary="Get a knowledge-base page",
description="Return a single page as an OKF document (frontmatter + markdown body).",
operation_id="get_knowledge_page",
tags=["Knowledge Base"],
)
async def api_get_knowledge_page(
bank_id: str,
page_id: str,
request_context: RequestContext = Depends(get_request_context),
):
"""Get a single page as an OKF document."""
try:
node = await app.state.memory.get_knowledge_page(
bank_id=bank_id, page_id=page_id, request_context=request_context
)
if node is None:
raise HTTPException(status_code=404, detail=f"Knowledge page '{page_id}' not found")
return _knowledge_page_response(node)
except (AuthenticationError, HTTPException):
raise
except OperationValidationError as e:
raise HTTPException(status_code=e.status_code, detail=e.reason)
except Exception as e:
import traceback
error_detail = f"{str(e)}\n\nTraceback:\n{traceback.format_exc()}"
logger.error(f"Error in GET /v1/default/banks/{bank_id}/knowledge-base/pages/{page_id}: {error_detail}")
raise HTTPException(status_code=500, detail=str(e))
@app.patch(
"/v1/default/banks/{bank_id}/knowledge-base/nodes/{node_id}",
response_model=KnowledgeNode,
summary="Rename or move a knowledge-base node",
description="Rename a node (set `name`) and/or move it under another folder (set `parent_id`, "
"null for the root).",
operation_id="update_knowledge_node",
tags=["Knowledge Base"],
)
async def api_update_knowledge_node(
bank_id: str,
node_id: str,
body: UpdateNodeRequest,
request_context: RequestContext = Depends(get_request_context),
):
"""Rename and/or move a node."""
try:
updated: dict[str, Any] | None = None
did_change = False
if body.name is not None:
did_change = True
updated = await app.state.memory.rename_knowledge_node(
bank_id=bank_id, node_id=node_id, name=body.name, request_context=request_context
)
# parent_id is applied only when present in the body, so passing null
# moves the node to the root (distinct from "not provided").
if "parent_id" in body.model_fields_set:
did_change = True
updated = await app.state.memory.move_knowledge_node(
bank_id=bank_id, node_id=node_id, new_parent_id=body.parent_id, request_context=request_context
)
if not did_change:
raise HTTPException(status_code=400, detail="Provide name and/or parent_id to update")
if updated is None:
raise HTTPException(status_code=404, detail=f"Knowledge node '{node_id}' not found")
return _knowledge_node_model(updated)
except ValueError as e:
raise HTTPException(status_code=400, detail=str(e))
except (AuthenticationError, HTTPException):
raise
except OperationValidationError as e:
raise HTTPException(status_code=e.status_code, detail=e.reason)
except Exception as e:
import traceback
error_detail = f"{str(e)}\n\nTraceback:\n{traceback.format_exc()}"
logger.error(f"Error in PATCH /v1/default/banks/{bank_id}/knowledge-base/nodes/{node_id}: {error_detail}")
raise HTTPException(status_code=500, detail=str(e))
@app.delete(
"/v1/default/banks/{bank_id}/knowledge-base/nodes/{node_id}",
summary="Delete a knowledge-base node",
description="Delete a folder or page and its whole subtree (pages' mental models are removed too).",
operation_id="delete_knowledge_node",
tags=["Knowledge Base"],
)
async def api_delete_knowledge_node(
bank_id: str,
node_id: str,
request_context: RequestContext = Depends(get_request_context),
):
"""Delete a node and its subtree."""
try:
deleted = await app.state.memory.delete_knowledge_node(
bank_id=bank_id, node_id=node_id, request_context=request_context
)
if not deleted:
raise HTTPException(status_code=404, detail=f"Knowledge node '{node_id}' not found")
return {"status": "deleted"}
except (AuthenticationError, HTTPException):
raise
except OperationValidationError as e:
raise HTTPException(status_code=e.status_code, detail=e.reason)
except Exception as e:
import traceback
error_detail = f"{str(e)}\n\nTraceback:\n{traceback.format_exc()}"
logger.error(f"Error in DELETE /v1/default/banks/{bank_id}/knowledge-base/nodes/{node_id}: {error_detail}")
raise HTTPException(status_code=500, detail=str(e))
# =========================================================================
# DIRECTIVES ENDPOINTS
# =========================================================================
@@ -5640,8 +6176,13 @@ def _register_routes(app: FastAPI):
):
"""Partially update an agent's profile (name, mission, disposition)."""
try:
# Ensure bank exists
await app.state.memory.get_bank_profile(bank_id, request_context=request_context)
# PATCH is update-only; missing banks must not be created as a
# side effect of reading the profile.
existing_profile = await app.state.memory.get_bank_profile(
bank_id, request_context=request_context, create_if_missing=False
)
if existing_profile is None:
raise HTTPException(status_code=404, detail=f"Bank '{bank_id}' not found")
# Update name if provided (stored in DB for display only, deprecated)
if request.name is not None:
@@ -5657,7 +6198,11 @@ def _register_routes(app: FastAPI):
await app.state.memory._config_resolver.update_bank_config(bank_id, config_updates, request_context)
# Get final profile
final_profile = await app.state.memory.get_bank_profile(bank_id, request_context=request_context)
final_profile = await app.state.memory.get_bank_profile(
bank_id, request_context=request_context, create_if_missing=False
)
if final_profile is None:
raise HTTPException(status_code=404, detail=f"Bank '{bank_id}' not found")
disposition_dict = (
final_profile["disposition"].model_dump()
if hasattr(final_profile["disposition"], "model_dump")
@@ -6148,9 +6693,11 @@ def _register_routes(app: FastAPI):
# Authenticate and set schema context for multi-tenant DB queries
await app.state.memory._authenticate_tenant(request_context)
if app.state.memory._operation_validator:
from hindsight_api.extensions import BankReadContext
from hindsight_api.extensions import BankReadContext, BankReadOperation
ctx = BankReadContext(bank_id=bank_id, operation="get_bank_config", request_context=request_context)
ctx = BankReadContext(
bank_id=bank_id, operation=BankReadOperation.GET_BANK_CONFIG, request_context=request_context
)
await app.state.memory._validate_operation(
app.state.memory._operation_validator.validate_bank_read(ctx)
)
@@ -6196,9 +6743,11 @@ def _register_routes(app: FastAPI):
# Authenticate and set schema context for multi-tenant DB queries
await app.state.memory._authenticate_tenant(request_context)
if app.state.memory._operation_validator:
from hindsight_api.extensions import BankWriteContext
from hindsight_api.extensions import BankWriteContext, BankWriteOperation
ctx = BankWriteContext(bank_id=bank_id, operation="update_bank_config", request_context=request_context)
ctx = BankWriteContext(
bank_id=bank_id, operation=BankWriteOperation.UPDATE_BANK_CONFIG, request_context=request_context
)
await app.state.memory._validate_operation(
app.state.memory._operation_validator.validate_bank_write(ctx)
)
@@ -6255,9 +6804,11 @@ def _register_routes(app: FastAPI):
# Authenticate and set schema context for multi-tenant DB queries
await app.state.memory._authenticate_tenant(request_context)
if app.state.memory._operation_validator:
from hindsight_api.extensions import BankWriteContext
from hindsight_api.extensions import BankWriteContext, BankWriteOperation
ctx = BankWriteContext(bank_id=bank_id, operation="reset_bank_config", request_context=request_context)
ctx = BankWriteContext(
bank_id=bank_id, operation=BankWriteOperation.RESET_BANK_CONFIG, request_context=request_context
)
await app.state.memory._validate_operation(
app.state.memory._operation_validator.validate_bank_write(ctx)
)
@@ -6628,7 +7179,7 @@ def _register_routes(app: FastAPI):
bank_id: str,
request: RetainRequest,
request_context: RequestContext = Depends(get_request_context),
_precheck: None = Depends(precheck_for("retain")),
_precheck: None = Depends(precheck_for(PrecheckOperation.RETAIN)),
):
"""Retain memories with optional async processing."""
metrics = get_metrics_collector()
@@ -6811,7 +7362,7 @@ def _register_routes(app: FastAPI):
files: list[UploadFile] = File(..., description="Files to upload and convert"),
request: str = Form(..., description="JSON string with FileRetainRequest model"),
request_context: RequestContext = Depends(get_request_context),
_precheck: None = Depends(precheck_for("files_retain")),
_precheck: None = Depends(precheck_for(PrecheckOperation.FILES_RETAIN)),
):
"""Upload and convert files to memories."""
from hindsight_api.config import get_config
+263
View File
@@ -0,0 +1,263 @@
"""Open Knowledge Format (OKF) projection for knowledge pages.
Knowledge pages are a *read-only* OKF view over the existing mental models: each
mental model is projected into an OKF document — a markdown body with YAML
frontmatter (``type`` required; ``title``/``description``/``tags``/``timestamp``
optional) — and pages are linked into a constellation graph via shared tags.
See the Open Knowledge Format spec:
https://github.com/GoogleCloudPlatform/knowledge-catalog/tree/main/okf
This module is intentionally pure: every function transforms the mental-model
dicts returned by ``MemoryEngine.list_mental_models`` / ``get_mental_model`` and
never touches the database. That keeps the OKF contract unit-testable without a
DB or LLM and lets the HTTP layer stay a thin wrapper.
"""
from __future__ import annotations
from collections.abc import Callable
from dataclasses import dataclass, field
from typing import Any
# OKF requires exactly one frontmatter field — ``type``. We default to this when
# a page does not declare one via a ``type:<x>`` tag.
DEFAULT_PAGE_TYPE = "knowledge-page"
# A page declares its OKF ``type`` through a tag of the form ``type:runbook``.
# This keeps the projection schema-free (no new mental_models column): the type
# is lifted from the existing tags array.
TYPE_TAG_PREFIX = "type:"
INDEX_FILENAME = "index.md"
# Deterministic, colour-blind-friendly palette. Type → colour is stable across
# requests so the constellation keeps the same colours between reloads.
_PALETTE = (
"#0074d9", # blue
"#2ecc40", # green
"#b10dc9", # purple
"#ff851b", # orange
"#39cccc", # teal
"#f012be", # magenta
"#3d9970", # olive
"#ff4136", # red
)
_EDGE_COLOR = "#9aa5b1"
@dataclass(frozen=True)
class PageType:
"""A page's OKF ``type`` and the tags that remain after the type tag is split off."""
type: str
display_tags: list[str]
@dataclass(frozen=True)
class KnowledgeGraph:
"""Cytoscape-style node/edge graph of knowledge pages linked by shared tags."""
nodes: list[dict[str, Any]] = field(default_factory=list)
edges: list[dict[str, Any]] = field(default_factory=list)
def _color_for(key: str) -> str:
"""Stable colour for a string key (FNV-ish hash into the fixed palette)."""
h = 0
for ch in key:
h = (h * 31 + ord(ch)) & 0xFFFFFFFF
return _PALETTE[h % len(_PALETTE)]
def _scalar(value: Any) -> str:
"""Emit a YAML-safe double-quoted scalar.
We always double-quote so arbitrary page names / source queries can't be
misread as YAML special forms (``true``, ``2026-01-01``, ``- x``, etc.).
"""
text = str(value)
escaped = text.replace("\\", "\\\\").replace('"', '\\"').replace("\n", "\\n").replace("\r", "")
return f'"{escaped}"'
def page_type(tags: list[str] | None) -> PageType:
"""Split an OKF ``type`` out of the tag list.
The first ``type:<x>`` tag wins; all ``type:`` tags are removed from the
returned ``display_tags`` so they don't pollute the constellation's
shared-tag edges. Falls back to :data:`DEFAULT_PAGE_TYPE`.
"""
resolved = DEFAULT_PAGE_TYPE
display: list[str] = []
for tag in tags or []:
if tag.startswith(TYPE_TAG_PREFIX):
suffix = tag[len(TYPE_TAG_PREFIX) :].strip()
if suffix and resolved == DEFAULT_PAGE_TYPE:
resolved = suffix
continue
display.append(tag)
return PageType(type=resolved, display_tags=display)
def _timestamp(mm: dict[str, Any]) -> str | None:
return mm.get("last_refreshed_at") or mm.get("created_at")
def frontmatter(mm: dict[str, Any]) -> dict[str, Any]:
"""Build the ordered OKF frontmatter mapping for a mental model.
``None``/empty values are dropped by :func:`render_frontmatter`.
"""
pt = page_type(mm.get("tags"))
return {
"id": mm.get("id"),
"type": pt.type,
"title": mm.get("name"),
"description": mm.get("source_query"),
"tags": pt.display_tags,
"timestamp": _timestamp(mm),
}
def render_frontmatter(fm: dict[str, Any]) -> str:
"""Render a frontmatter mapping into a ``---`` fenced YAML block."""
lines = ["---"]
for key, value in fm.items():
if value is None:
continue
if isinstance(value, list):
if not value:
continue
lines.append(f"{key}:")
lines.extend(f" - {_scalar(item)}" for item in value)
else:
lines.append(f"{key}: {_scalar(value)}")
lines.append("---")
return "\n".join(lines)
def render_document(mm: dict[str, Any]) -> str:
"""Render a full OKF document: frontmatter block + markdown body."""
body = (mm.get("content") or "").strip()
return f"{render_frontmatter(frontmatter(mm))}\n\n{body}\n" if body else f"{render_frontmatter(frontmatter(mm))}\n"
def page_filename(page_id: str) -> str:
"""OKF bundle filename for a page id."""
return f"{page_id}.md"
def log_filename(page_id: str) -> str:
"""OKF reserved per-page history filename."""
return f"{page_id}.log.md"
def render_index(nodes: list[dict[str, Any]]) -> str:
"""Render the reserved ``index.md`` — nested OKF navigation over the tree.
``nodes`` is the flat folder/page list (each with ``id``, ``kind``, ``name``,
``parent_id``); folders nest their children, pages link to their ``.md``.
"""
fm = render_frontmatter({"type": "index", "title": "Knowledge base"})
lines = [fm, "", "# Knowledge base", ""]
children: dict[Any, list[dict[str, Any]]] = {}
for node in nodes:
children.setdefault(node.get("parent_id"), []).append(node)
def walk(parent: Any, depth: int) -> None:
ordered = sorted(children.get(parent, []), key=lambda n: (n.get("sort_order", 0), n.get("name") or ""))
for node in ordered:
indent = " " * depth
if node.get("kind") == "folder":
lines.append(f"{indent}- **{node['name']}/**")
walk(node["id"], depth + 1)
else:
description = node.get("source_query") or node.get("description")
link = f"{indent}- [{node['name']}](./{page_filename(node['id'])})"
lines.append(f"{link}{description}" if description else link)
walk(None, 0)
if len(lines) == 4:
lines.append("_No knowledge pages yet._")
return "\n".join(lines) + "\n"
def render_log(mm: dict[str, Any], history: list[dict[str, Any]]) -> str:
"""Render the reserved per-page ``log.md`` from refresh history.
Each history entry is ``{previous_content, previous_reflect_response,
changed_at}`` (newest first), capturing the content *before* a refresh.
"""
name = mm.get("name") or mm.get("id")
fm = render_frontmatter({"type": "log", "title": f"{name} — history"})
lines = [fm, "", f"# {name} — history", ""]
if not history:
lines.append("_No refresh history._")
return "\n".join(lines) + "\n"
for entry in history:
changed_at = entry.get("changed_at") or "unknown"
previous = (entry.get("previous_content") or "").strip()
lines.append(f"## {changed_at}")
lines.append("")
lines.append(previous if previous else "_(empty)_")
lines.append("")
return "\n".join(lines).rstrip() + "\n"
def knowledge_graph(
pages: list[dict[str, Any]],
cluster_for: "Callable[[dict[str, Any]], str] | None" = None,
) -> KnowledgeGraph:
"""Derive the constellation graph: pages as nodes, shared tags as edges.
Two pages are linked when they share at least one (non-``type:``) tag; the
edge weight is the number of shared tags. Each node's cluster (``type`` field
+ colour) comes from ``cluster_for(page)`` — the knowledge base groups by
parent folder; the default groups by OKF ``type``.
"""
nodes: list[dict[str, Any]] = []
tag_sets: list[tuple[str, frozenset[str]]] = []
for mm in pages:
page_id = mm["id"]
pt = page_type(mm.get("tags"))
cluster = cluster_for(mm) if cluster_for else pt.type
tag_sets.append((page_id, frozenset(pt.display_tags)))
nodes.append(
{
"data": {
"id": page_id,
"label": mm.get("name") or page_id,
"type": cluster,
"tagCount": len(pt.display_tags),
"color": _color_for(cluster),
}
}
)
edges: list[dict[str, Any]] = []
for i in range(len(tag_sets)):
source_id, source_tags = tag_sets[i]
if not source_tags:
continue
for j in range(i + 1, len(tag_sets)):
target_id, target_tags = tag_sets[j]
shared = source_tags & target_tags
if not shared:
continue
edges.append(
{
"data": {
"id": f"{source_id}--{target_id}",
"source": source_id,
"target": target_id,
"sharedTags": sorted(shared),
"weight": len(shared),
"color": _EDGE_COLOR,
}
}
)
return KnowledgeGraph(nodes=nodes, edges=edges)
+118 -3
View File
@@ -148,6 +148,19 @@ ENV_LLM_DEFAULT_HEADERS = "HINDSIGHT_API_LLM_DEFAULT_HEADERS"
ENV_LLM_STRICT_SCHEMA = "HINDSIGHT_API_LLM_STRICT_SCHEMA"
ENV_LLM_SEND_BANK_AS_USER = "HINDSIGHT_API_LLM_SEND_BANK_AS_USER"
# Per-operation sampling temperature. Each internal LLM call uses a temperature
# tuned for its task (deterministic extraction vs. creative reflection). These
# expose those as overridable knobs. Resolution per operation:
# per-operation env -> global env (ENV_LLM_TEMPERATURE) -> built-in default.
# A value of "none"/"default"/"" (or "off") omits the temperature parameter
# entirely, for models that reject explicit temperatures (e.g. Azure GPT-5.5,
# which only accepts the default value) -- see issue #2459.
ENV_LLM_TEMPERATURE = "HINDSIGHT_API_LLM_TEMPERATURE"
ENV_LLM_TEMPERATURE_VERIFICATION = "HINDSIGHT_API_LLM_TEMPERATURE_VERIFICATION"
ENV_LLM_TEMPERATURE_RETAIN = "HINDSIGHT_API_LLM_TEMPERATURE_RETAIN"
ENV_LLM_TEMPERATURE_REFLECT = "HINDSIGHT_API_LLM_TEMPERATURE_REFLECT"
ENV_LLM_TEMPERATURE_CONSOLIDATION = "HINDSIGHT_API_LLM_TEMPERATURE_CONSOLIDATION"
# Multi-LLM strategy. Extra LLMs are configured by index alongside the unindexed
# primary (e.g. HINDSIGHT_API_LLM_1_PROVIDER, HINDSIGHT_API_LLM_2_PROVIDER, ...),
# and HINDSIGHT_API_LLM_STRATEGY (JSON) selects how to route across them — see
@@ -166,6 +179,12 @@ ENV_CONSOLIDATION_LLM_STRATEGY = "HINDSIGHT_API_CONSOLIDATION_LLM_STRATEGY"
# disambiguates from the embeddings/reranker LITELLM_* settings.
ENV_LLM_LITELLMROUTER_CONFIG = "HINDSIGHT_API_LLM_LITELLMROUTER_CONFIG"
# Per-operation temperature defaults (preserve historical hardcoded values).
DEFAULT_LLM_TEMPERATURE_VERIFICATION = 0.0 # connection check
DEFAULT_LLM_TEMPERATURE_RETAIN = 0.1 # fact extraction
DEFAULT_LLM_TEMPERATURE_REFLECT = 0.9 # reflect "thinking"
DEFAULT_LLM_TEMPERATURE_CONSOLIDATION = 0.0 # mental-model delta / dedup
# Defaults for service tiers
DEFAULT_LLM_GROQ_SERVICE_TIER = "auto" # "on_demand", "flex", or "auto"
DEFAULT_LLM_OPENAI_SERVICE_TIER = None # None (default) or "flex" (50% cheaper)
@@ -189,6 +208,46 @@ def parse_gemini_service_tier(value: str | None) -> str | None:
return tier
# Sentinel strings that, as a temperature value, mean "omit the temperature
# parameter entirely" rather than a numeric setting.
_TEMPERATURE_OMIT_VALUES = frozenset({"", "none", "default", "off", "unset"})
def _parse_temperature(raw: str) -> float | None:
"""Parse a raw temperature env value into a float, or None to omit it.
Returns None for the omit sentinels (so the temperature parameter is dropped
from the LLM call); otherwise parses a float and validates the 0.0-2.0 range.
"""
if raw.strip().lower() in _TEMPERATURE_OMIT_VALUES:
return None
try:
value = float(raw)
except ValueError as e:
raise ValueError(
f"Invalid LLM temperature {raw!r}: must be a number in [0.0, 2.0] "
f"or one of {sorted(_TEMPERATURE_OMIT_VALUES)} to omit it."
) from e
if not 0.0 <= value <= 2.0:
raise ValueError(f"Invalid LLM temperature {value}: must be in [0.0, 2.0].")
return value
def _resolve_operation_temperature(operation_env: str, default: float) -> float | None:
"""Resolve a per-operation temperature: per-op env -> global env -> default.
The omit sentinels resolve to None at any layer, so a single
``HINDSIGHT_API_LLM_TEMPERATURE=none`` drops temperature from every operation
that has no explicit per-operation override.
"""
raw = os.getenv(operation_env)
if raw is None:
raw = os.getenv(ENV_LLM_TEMPERATURE)
if raw is None:
return default
return _parse_temperature(raw)
# Per-operation LLM configuration (optional, falls back to global LLM config)
ENV_RETAIN_LLM_PROVIDER = "HINDSIGHT_API_RETAIN_LLM_PROVIDER"
ENV_RETAIN_LLM_API_KEY = "HINDSIGHT_API_RETAIN_LLM_API_KEY"
@@ -282,6 +341,11 @@ ENV_RERANKER_OPENROUTER_API_KEY = "HINDSIGHT_API_RERANKER_OPENROUTER_API_KEY"
ENV_RERANKER_OPENROUTER_MODEL = "HINDSIGHT_API_RERANKER_OPENROUTER_MODEL"
ENV_RERANKER_OPENROUTER_BASE_URL = "HINDSIGHT_API_RERANKER_OPENROUTER_BASE_URL"
# Requesty configuration (OpenAI-compatible gateway; embeddings)
ENV_REQUESTY_API_KEY = "HINDSIGHT_API_REQUESTY_API_KEY"
ENV_EMBEDDINGS_REQUESTY_API_KEY = "HINDSIGHT_API_EMBEDDINGS_REQUESTY_API_KEY"
ENV_EMBEDDINGS_REQUESTY_MODEL = "HINDSIGHT_API_EMBEDDINGS_REQUESTY_MODEL"
# ZeroEntropy configuration (embeddings)
ENV_EMBEDDINGS_ZEROENTROPY_API_KEY = "HINDSIGHT_API_EMBEDDINGS_ZEROENTROPY_API_KEY"
ENV_EMBEDDINGS_ZEROENTROPY_MODEL = "HINDSIGHT_API_EMBEDDINGS_ZEROENTROPY_MODEL"
@@ -509,7 +573,6 @@ ENV_LLAMACPP_EXTRA_ARGS = "HINDSIGHT_API_LLAMACPP_EXTRA_ARGS"
# Optimization flags
ENV_SKIP_LLM_VERIFICATION = "HINDSIGHT_API_SKIP_LLM_VERIFICATION"
ENV_LAZY_RERANKER = "HINDSIGHT_API_LAZY_RERANKER"
# Database migrations
ENV_RUN_MIGRATIONS_ON_STARTUP = "HINDSIGHT_API_RUN_MIGRATIONS_ON_STARTUP"
@@ -606,6 +669,7 @@ ENV_LLM_TRACE_MAX_CHARS = "HINDSIGHT_API_LLM_TRACE_MAX_CHARS"
# Background maintenance settings
ENV_CONSOLIDATION_RECONCILE_INTERVAL_SECONDS = "HINDSIGHT_API_CONSOLIDATION_RECONCILE_INTERVAL_SECONDS"
ENV_MENTAL_MODEL_REFRESH_TICK_SECONDS = "HINDSIGHT_API_MENTAL_MODEL_REFRESH_TICK_SECONDS"
# Disposition settings
ENV_DISPOSITION_SKEPTICISM = "HINDSIGHT_API_DISPOSITION_SKEPTICISM"
@@ -642,6 +706,7 @@ PROVIDER_DEFAULT_MODELS = {
"bedrock": "us.amazon.nova-2-lite-v1:0",
"volcano": "doubao-pro-32k",
"openrouter": "qwen/qwen3.5-9b",
"requesty": "openai/gpt-4o-mini",
"fireworks": "accounts/fireworks/models/llama-v3p1-8b-instruct",
"nous": "deepseek/deepseek-v4-flash",
}
@@ -798,6 +863,9 @@ DEFAULT_EMBEDDINGS_OPENROUTER_MODEL = "perplexity/pplx-embed-v1-0.6b"
DEFAULT_RERANKER_OPENROUTER_MODEL = "cohere/rerank-v3.5"
DEFAULT_RERANKER_OPENROUTER_BASE_URL = "https://openrouter.ai/api/v1/rerank"
# Requesty defaults
DEFAULT_EMBEDDINGS_REQUESTY_MODEL = "openai/text-embedding-3-small"
# ZeroEntropy defaults
DEFAULT_EMBEDDINGS_ZEROENTROPY_MODEL = "zembed-1"
# Shared between embeddings (zembed-1) and reranker (zerank-*) — the host is the same.
@@ -1038,6 +1106,11 @@ DEFAULT_LLM_TRACE_MAX_CHARS = 50000 # Truncate stored input/output beyond this
# 0 disables the reconcile sweep.
DEFAULT_CONSOLIDATION_RECONCILE_INTERVAL_SECONDS = 300
# How often the maintenance loop checks for cron-scheduled mental models that are
# due for a refresh. This is the *check* cadence; the actual schedule is the
# per-model cron expression in the mental model's trigger. 0 disables the sweep.
DEFAULT_MENTAL_MODEL_REFRESH_TICK_SECONDS = 60
# Default MCP tool descriptions (can be customized via env vars)
DEFAULT_MCP_RETAIN_DESCRIPTION = """Store important information to long-term memory.
@@ -1320,6 +1393,10 @@ class LLMMemberConfig:
default_headers: dict | None
bedrock_service_tier: str | None
gemini_service_tier: str | None
vertexai_project_id: str | None = None
vertexai_region: str | None = None
vertexai_service_account_key: str | None = None
litellmrouter_config: dict | None = None
# Valid multi-LLM strategy modes.
@@ -1413,6 +1490,10 @@ def _parse_llm_members(prefix: str) -> list[LLMMemberConfig]:
gemini_service_tier=(
parse_gemini_service_tier(gemini_service_tier) if provider.lower() == "gemini" else None
),
vertexai_project_id=os.getenv(base + "VERTEXAI_PROJECT_ID") or None,
vertexai_region=os.getenv(base + "VERTEXAI_REGION") or None,
vertexai_service_account_key=os.getenv(base + "VERTEXAI_SERVICE_ACCOUNT_KEY") or None,
litellmrouter_config=_parse_llm_router_config(base + "LITELLMROUTER_CONFIG"),
)
)
index += 1
@@ -1497,6 +1578,14 @@ class HindsightConfig:
# overrides a `user` the caller already set.
llm_send_bank_as_user: bool
# Per-operation sampling temperature. None means the temperature parameter is
# omitted from the call (for models that reject explicit temperatures). See
# ENV_LLM_TEMPERATURE and _resolve_operation_temperature.
llm_temperature_verification: float | None
llm_temperature_retain: float | None
llm_temperature_reflect: float | None
llm_temperature_consolidation: float | None
# LiteLLM Router chain (provider-specific; consumed by the "litellmrouter" provider).
# List of deployment dicts evaluated in order with fallback on transient errors.
# Each entry: {"provider": str, "model": str, "api_key": str | None, "base_url": str | None}.
@@ -1586,6 +1675,8 @@ class HindsightConfig:
embeddings_cohere_output_dimensions: int | None
embeddings_openrouter_api_key: str | None
embeddings_openrouter_model: str
embeddings_requesty_api_key: str | None
embeddings_requesty_model: str
embeddings_litellm_api_base: str
embeddings_litellm_api_key: str | None
embeddings_litellm_model: str
@@ -1794,7 +1885,6 @@ class HindsightConfig:
# Optimization flags
skip_llm_verification: bool
lazy_reranker: bool
# Database migrations
run_migrations_on_startup: bool
@@ -1849,6 +1939,9 @@ class HindsightConfig:
# Interval for the periodic sweep that re-schedules consolidation for banks with
# eligible-but-unscheduled facts. 0 = disabled.
consolidation_reconcile_interval_seconds: int
# How often the maintenance loop checks for cron-scheduled mental models due for
# refresh (the per-model schedule lives in the mental model trigger). 0 = disabled.
mental_model_refresh_tick_seconds: int
# Webhook configuration (static - server-level only, not per-bank)
webhook_url: str | None # Global webhook URL (None = disabled)
@@ -2226,6 +2319,18 @@ class HindsightConfig:
llm_strict_schema=os.getenv(ENV_LLM_STRICT_SCHEMA, str(DEFAULT_LLM_STRICT_SCHEMA)).lower() in ("true", "1"),
llm_send_bank_as_user=os.getenv(ENV_LLM_SEND_BANK_AS_USER, str(DEFAULT_LLM_SEND_BANK_AS_USER)).lower()
in ("true", "1"),
llm_temperature_verification=_resolve_operation_temperature(
ENV_LLM_TEMPERATURE_VERIFICATION, DEFAULT_LLM_TEMPERATURE_VERIFICATION
),
llm_temperature_retain=_resolve_operation_temperature(
ENV_LLM_TEMPERATURE_RETAIN, DEFAULT_LLM_TEMPERATURE_RETAIN
),
llm_temperature_reflect=_resolve_operation_temperature(
ENV_LLM_TEMPERATURE_REFLECT, DEFAULT_LLM_TEMPERATURE_REFLECT
),
llm_temperature_consolidation=_resolve_operation_temperature(
ENV_LLM_TEMPERATURE_CONSOLIDATION, DEFAULT_LLM_TEMPERATURE_CONSOLIDATION
),
llm_litellmrouter_config=_parse_llm_router_config(ENV_LLM_LITELLMROUTER_CONFIG),
# Vertex AI
llm_vertexai_project_id=os.getenv(ENV_LLM_VERTEXAI_PROJECT_ID) or DEFAULT_LLM_VERTEXAI_PROJECT_ID,
@@ -2398,6 +2503,11 @@ class HindsightConfig:
or os.getenv(ENV_OPENROUTER_API_KEY)
or os.getenv(ENV_LLM_API_KEY),
embeddings_openrouter_model=os.getenv(ENV_EMBEDDINGS_OPENROUTER_MODEL, DEFAULT_EMBEDDINGS_OPENROUTER_MODEL),
# Requesty embeddings (with fallback to shared Requesty key, then LLM key)
embeddings_requesty_api_key=os.getenv(ENV_EMBEDDINGS_REQUESTY_API_KEY)
or os.getenv(ENV_REQUESTY_API_KEY)
or os.getenv(ENV_LLM_API_KEY),
embeddings_requesty_model=os.getenv(ENV_EMBEDDINGS_REQUESTY_MODEL, DEFAULT_EMBEDDINGS_REQUESTY_MODEL),
# ZeroEntropy embeddings
embeddings_zeroentropy_api_key=os.getenv(ENV_EMBEDDINGS_ZEROENTROPY_API_KEY)
or os.getenv("ZEROENTROPY_API_KEY"),
@@ -2618,7 +2728,6 @@ class HindsightConfig:
),
# Optimization flags
skip_llm_verification=os.getenv(ENV_SKIP_LLM_VERIFICATION, "false").lower() == "true",
lazy_reranker=os.getenv(ENV_LAZY_RERANKER, "false").lower() == "true",
# Retain settings
retain_max_completion_tokens=int(
os.getenv(ENV_RETAIN_MAX_COMPLETION_TOKENS, str(DEFAULT_RETAIN_MAX_COMPLETION_TOKENS))
@@ -2896,6 +3005,12 @@ class HindsightConfig:
str(DEFAULT_CONSOLIDATION_RECONCILE_INTERVAL_SECONDS),
)
),
mental_model_refresh_tick_seconds=int(
os.getenv(
ENV_MENTAL_MODEL_REFRESH_TICK_SECONDS,
str(DEFAULT_MENTAL_MODEL_REFRESH_TICK_SECONDS),
)
),
# Webhook configuration (static, server-level only)
webhook_url=os.getenv(ENV_WEBHOOK_URL) or DEFAULT_WEBHOOK_URL,
webhook_secret=os.getenv(ENV_WEBHOOK_SECRET) or DEFAULT_WEBHOOK_SECRET,
@@ -13,9 +13,18 @@ in-flight task so that N concurrent callers produce one query rather than N.
from __future__ import annotations
import asyncio
import json
import logging
import time
from collections import OrderedDict
from typing import Any, Awaitable, Callable
from typing import TYPE_CHECKING, Any, Awaitable, Callable
from .db_utils import acquire_with_retry
if TYPE_CHECKING:
from .db.base import DatabaseBackend
logger = logging.getLogger(__name__)
class BankStatsCache:
@@ -66,17 +75,28 @@ class BankStatsCache:
schema: str,
bank_id: str,
loader: Callable[[], Awaitable[dict[str, Any]]],
*,
force_refresh: bool = False,
) -> dict[str, Any]:
"""Return cached stats for `(schema, bank_id)` or call `loader()`.
Concurrent misses on the same key are coalesced onto a single
in-flight loader.
in-flight loader. When ``force_refresh`` is set the cached value is
ignored: the loader runs and its result replaces the cached entry.
"""
if not self.enabled:
return await loader()
key = (schema, bank_id)
if force_refresh:
value = await loader()
async with self._lock:
self._store_unlocked(key, value)
# Supersede any loader that was in flight for this key.
self._in_flight.pop(key, None)
return value
async with self._lock:
cached = self._get_fresh_unlocked(key)
if cached is not None:
@@ -132,3 +152,103 @@ class BankStatsCache:
async with self._lock:
self._entries.clear()
self._in_flight.clear()
class DistributedBankStatsCache:
"""Table-backed (cross-process) TTL cache for `get_bank_stats`.
Same ``get_or_load`` / ``invalidate`` / ``clear`` contract as
:class:`BankStatsCache`, but the store is the per-schema ``bank_stats_cache``
table instead of a per-process dict — so one worker's computation is shared
with every other worker, and no caller recomputes while a fresh row exists.
On a hit, a call is a single primary-key ``SELECT`` (sub-millisecond); only a
miss runs the (expensive) ``loader`` and writes the row back. Concurrent
misses are *not* coalesced across processes (that would need a lock): they
each compute and ``UPSERT``, last write wins — all results are correct, at the
cost of a brief redundant compute at expiry.
Every DB touch is best-effort: if the cache table is unreachable or missing
(e.g. a schema mid-migration), the call degrades to computing without caching
rather than failing ``get_bank_stats``. PostgreSQL only — the engine keeps the
in-process :class:`BankStatsCache` for Oracle.
"""
def __init__(self, *, backend: "DatabaseBackend", ttl_seconds: float) -> None:
self._backend = backend
self._ttl = float(ttl_seconds)
@property
def enabled(self) -> bool:
return self._ttl > 0
@staticmethod
def _qualified(schema: str) -> str:
return f'"{schema}".bank_stats_cache' if schema else "bank_stats_cache"
async def get_or_load(
self,
schema: str,
bank_id: str,
loader: Callable[[], Awaitable[dict[str, Any]]],
*,
force_refresh: bool = False,
) -> dict[str, Any]:
if not self.enabled:
return await loader()
table = self._qualified(schema)
# 1. Fresh row? Single PK lookup; ``payload::text`` sidesteps any
# jsonb->object codec so we always decode the same way. Skipped when
# the caller forces a refresh — then we recompute and overwrite below.
if not force_refresh:
try:
async with acquire_with_retry(self._backend) as conn:
row = await conn.fetchrow(
f"SELECT payload::text AS payload FROM {table} "
f"WHERE bank_id = $1 AND computed_at > now() - make_interval(secs => $2::double precision)",
bank_id,
self._ttl,
)
if row is not None:
return json.loads(row["payload"])
except Exception as exc: # noqa: BLE001 — cache read must never break the endpoint
logger.debug("bank_stats_cache read failed for %s.%s (%s); computing uncached", schema, bank_id, exc)
return await loader()
# 2. Miss — compute, then write the row back (best-effort).
value = await loader()
try:
async with acquire_with_retry(self._backend) as conn:
await conn.execute(
f"INSERT INTO {table} (bank_id, payload, computed_at) VALUES ($1, $2::jsonb, now()) "
f"ON CONFLICT (bank_id) DO UPDATE SET payload = EXCLUDED.payload, computed_at = now()",
bank_id,
json.dumps(value),
)
except Exception as exc: # noqa: BLE001 — a failed write just means no caching this round
logger.warning("bank_stats_cache write failed for %s.%s (%s)", schema, bank_id, exc)
return value
async def invalidate(self, schema: str, bank_id: str) -> None:
"""Drop the cached row so the next read recomputes."""
if not self.enabled:
return
try:
async with acquire_with_retry(self._backend) as conn:
await conn.execute(f"DELETE FROM {self._qualified(schema)} WHERE bank_id = $1", bank_id)
except Exception as exc: # noqa: BLE001 — invalidation must never break the write path
logger.debug("bank_stats_cache invalidate failed for %s.%s (%s)", schema, bank_id, exc)
async def clear(self) -> None:
"""Drop all cached rows in the current schema (best-effort)."""
if not self.enabled:
return
from .memory_engine import get_current_schema
try:
async with acquire_with_retry(self._backend) as conn:
await conn.execute(f"DELETE FROM {self._qualified(get_current_schema())}")
except Exception as exc: # noqa: BLE001
logger.debug("bank_stats_cache clear failed (%s)", exc)
@@ -98,7 +98,7 @@ _DEDUP_TOP_K = 5
class _DedupDecision(BaseModel):
"""Focused 1-by-1 verdict for whether a new observation duplicates an existing one."""
action: Literal["merge", "keep"]
action: Literal["merge", "keep"] = "keep"
text: str = "" # the synthesized merged observation (when action == "merge")
reason: str = ""
@@ -224,13 +224,18 @@ async def _dedup_reconcile_create(
# Fold the new source facts into the twin and persist the merged text. We keep the twin's
# existing embedding: the merged text is >= threshold similar, so the stored vector stays
# representative and we avoid a re-embed + a dialect-specific vector UPDATE.
search_vector_clause = (
f",\n search_vector = to_tsvector('{config.text_search_extension_native_language}'::regconfig, COALESCE($1, ''))"
if config.text_search_extension == "native"
else ""
)
await conn.execute(
f"""
UPDATE {fq_table("memory_units")}
SET text = $1,
source_memory_ids = (SELECT array_agg(DISTINCT e) FROM unnest(source_memory_ids || $2::uuid[]) e),
proof_count = (SELECT count(DISTINCT e) FROM unnest(source_memory_ids || $2::uuid[]) e),
updated_at = now()
updated_at = now(){search_vector_clause}
WHERE id = $3::uuid
""",
outcome.merged_text,
@@ -279,6 +284,11 @@ async def _dedup_reconcile_update(
# the create path) then delete the now-redundant updated row. The all_strict/any tag match
# guarantees twin and updated share scope, so dropping the updated row's tags loses no
# visibility. Temporal fields follow the surviving twin (minimal scope; matches create).
search_vector_clause = (
f",\n search_vector = to_tsvector('{config.text_search_extension_native_language}'::regconfig, COALESCE($1, ''))"
if config.text_search_extension == "native"
else ""
)
await conn.execute(
f"""
UPDATE {fq_table("memory_units")} t
@@ -289,7 +299,7 @@ async def _dedup_reconcile_update(
proof_count = (
SELECT count(DISTINCT e) FROM unnest(t.source_memory_ids || u.source_memory_ids) e
),
updated_at = now()
updated_at = now(){search_vector_clause}
FROM {fq_table("memory_units")} u
WHERE t.id = $2::uuid AND u.id = $3::uuid
""",
@@ -1845,6 +1855,12 @@ async def _execute_update_action(
config = get_config()
search_vector_clause = (
f",\n search_vector = to_tsvector('{config.text_search_extension_native_language}'::regconfig, COALESCE($1, ''))"
if config.text_search_extension == "native"
else ""
)
t0 = time.time()
await conn.execute(
f"""
@@ -1857,7 +1873,7 @@ async def _execute_update_action(
updated_at = now(),
occurred_start = LEAST(occurred_start, COALESCE($6, occurred_start)),
occurred_end = GREATEST(occurred_end, COALESCE($7, occurred_end)),
mentioned_at = GREATEST(mentioned_at, COALESCE($8, mentioned_at))
mentioned_at = GREATEST(mentioned_at, COALESCE($8, mentioned_at)){search_vector_clause}
WHERE id = $5
""",
new_text,
@@ -2333,16 +2349,20 @@ async def _create_observation_directly(
tokenize($3, 'llmlingua2')::bm25_catalog.bm25vector)
RETURNING id
"""
else: # native, pg_textsearch, pgroonga, or pg_search
# pg_textsearch / pgroonga / pg_search: indexes operate on base text
# columns directly, so the dummy search_vector column is left NULL.
# Native: the migration p4q5r6s7t8u9 dropped the GENERATED expression on
# search_vector to allow per-deployment language configuration; the
# batch insert path in ops_postgresql.insert_facts_batch now populates
# it via to_tsvector($lang, ...). This single-observation INSERT does
# not, so observations under the native backend currently land with
# NULL search_vector and are not BM25-searchable until reflected/
# re-ingested. Tracking a separate fix for that gap.
elif config.text_search_extension == "native":
# Native: search_vector is populated with to_tsvector() using the
# configured native language dictionary, matching the batch insert
# path in ops_postgresql.insert_facts_batch.
query = f"""
INSERT INTO {fq_table("memory_units")} (
id, bank_id, text, fact_type, embedding, proof_count, source_memory_ids,
tags, event_date, occurred_start, occurred_end, mentioned_at, search_vector
)
VALUES ($1, $2, $3, 'observation', $4::vector, 1, $5, $6, $7, $8, $9, $10,
to_tsvector('{config.text_search_extension_native_language}'::regconfig, COALESCE($3, '')))
RETURNING id
"""
else: # pg_textsearch, pgroonga, pg_search: indexes operate on base text columns directly
query = f"""
INSERT INTO {fq_table("memory_units")} (
id, bank_id, text, fact_type, embedding, proof_count, source_memory_ids,
@@ -1638,6 +1638,20 @@ def create_embeddings_from_env() -> Embeddings:
batch_size=config.embeddings_openai_batch_size,
dimensions=config.embeddings_openai_dimensions,
)
elif provider == "requesty":
api_key = config.embeddings_requesty_api_key
if not api_key:
raise ValueError(
"HINDSIGHT_API_EMBEDDINGS_REQUESTY_API_KEY, HINDSIGHT_API_REQUESTY_API_KEY, "
f"or {ENV_LLM_API_KEY} is required when {ENV_EMBEDDINGS_PROVIDER} is 'requesty'"
)
return OpenAIEmbeddings(
api_key=api_key,
model=config.embeddings_requesty_model,
base_url="https://router.requesty.ai/v1",
batch_size=config.embeddings_openai_batch_size,
dimensions=config.embeddings_openai_dimensions,
)
elif provider == "zeroentropy":
api_key = config.embeddings_zeroentropy_api_key
if not api_key:
@@ -1701,6 +1715,6 @@ def create_embeddings_from_env() -> Embeddings:
else:
raise ValueError(
f"Unknown embeddings provider: {provider}. "
f"Supported: 'local', 'onnx', 'tei', 'openai', 'openai-codex', 'openrouter', 'cohere', 'google', "
f"Supported: 'local', 'onnx', 'tei', 'openai', 'openai-codex', 'openrouter', 'requesty', 'cohere', 'google', "
f"'zeroentropy', 'litellm', 'litellm-sdk'"
)
@@ -449,6 +449,7 @@ class MemoryEngineInterface(ABC):
bank_id: str,
*,
request_context: "RequestContext",
force_refresh: bool = False,
) -> dict[str, Any]:
"""
Get statistics about memory nodes and links for a bank.
@@ -456,6 +457,8 @@ class MemoryEngineInterface(ABC):
Args:
bank_id: The memory bank ID.
request_context: Request context for authentication.
force_refresh: Bypass the cached value and recompute (also refreshes
the cache for subsequent callers).
Returns:
Dict with node_counts, link_counts, link_counts_by_fact_type
@@ -76,6 +76,51 @@ _request_ctx: ContextVar[dict[str, Any] | None] = ContextVar("hindsight_llm_requ
_call_metadata_ctx: ContextVar[dict[str, Any] | None] = ContextVar("hindsight_llm_call_metadata_ctx", default=None)
@dataclass
class LLMResponseUsage:
"""Provider-reported token usage for the in-flight LLM call.
Stashed by provider implementations as soon as a response is received —
*before* local JSON parsing / schema validation, which may still fail. The
wrapper reads it to attach real token counts to an error trace when the
provider call itself succeeded but the structured output couldn't be parsed
or validated (providers charge for those tokens regardless). See #2387.
"""
input_tokens: int = 0
output_tokens: int = 0
cached_tokens: int = 0
# Per-call provider usage, set by providers right after a response is received.
_response_usage_ctx: ContextVar[LLMResponseUsage | None] = ContextVar("hindsight_llm_response_usage_ctx", default=None)
def set_response_usage(usage: LLMResponseUsage | None) -> Token:
"""Bind provider-reported usage for the current call. Returns a reset token."""
return _response_usage_ctx.set(usage)
def stash_response_usage(usage: LLMResponseUsage | None) -> None:
"""Record provider-reported usage so an error trace can attach it later.
Called by provider implementations once a response (with usage) is in hand,
before parsing/validation that may raise. Overwrites any prior value from an
earlier retry attempt so the last attempt's usage wins.
"""
_response_usage_ctx.set(usage)
def reset_response_usage(token: Token) -> None:
"""Unwind a binding made by :func:`set_response_usage`."""
_response_usage_ctx.reset(token)
def current_response_usage() -> LLMResponseUsage | None:
"""Return the active call's provider-reported usage, or None."""
return _response_usage_ctx.get()
def set_trace_context(ctx: LLMTraceContext | None) -> Token:
"""Bind trace attribution to the current context. Returns a reset token."""
return _trace_ctx.set(ctx)
@@ -253,6 +253,7 @@ def create_llm_provider(
prompt_cache_enabled: bool = False,
litellmrouter_config: dict[str, Any] | None = None,
gemini_service_tier: str | None = None,
timeout: float | None = None,
) -> Any: # Returns LLMInterface
"""
Factory function to create the appropriate LLM provider implementation.
@@ -272,12 +273,20 @@ def create_llm_provider(
VertexAI and LiteLLM providers (each merges them in its own parameter
space). Keys must use each provider's native names (e.g. ``max_tokens``
for OpenAI/Anthropic vs ``max_output_tokens`` for Gemini).
default_headers: Custom headers passed as ``default_headers`` to provider SDK clients
(used by operators routing through proxies / request-tracing middleware). Currently
wired into the Anthropic provider; other providers may opt in as needed.
default_headers: Custom headers passed to provider SDK clients (used by operators
routing through proxies / request-tracing middleware). Wired into the Anthropic
provider (SDK ``default_headers``) and the LiteLLM-backed providers — ``litellm``,
``litellmrouter`` and ``bedrock`` — as the LiteLLM ``extra_headers`` completion
kwarg; other providers may opt in as needed.
vertexai_project_id: Vertex AI project ID (for VertexAI provider).
vertexai_region: Vertex AI region (for VertexAI provider).
vertexai_credentials: Vertex AI credentials object (for VertexAI provider).
timeout: Per-request LLM timeout in seconds (resolved by the caller from the
per-operation/global config). Threaded into the providers that honour a
configurable request timeout (LiteLLM, LiteLLM Router, OpenAI-compatible,
Nous). ``None`` lets each provider fall back to its own default
(``HINDSIGHT_API_LLM_TIMEOUT`` / ``DEFAULT_LLM_TIMEOUT`` for those four;
Anthropic and Gemini keep their provider-specific defaults).
Returns:
LLMInterface implementation for the specified provider.
@@ -375,6 +384,8 @@ def create_llm_provider(
model=model,
reasoning_effort=reasoning_effort,
extra_body=extra_body,
default_headers=default_headers,
timeout=timeout,
)
elif provider_lower == "litellmrouter":
@@ -393,6 +404,8 @@ def create_llm_provider(
config=litellmrouter_config,
reasoning_effort=reasoning_effort,
extra_body=extra_body,
default_headers=default_headers,
timeout=timeout,
)
elif provider_lower == "bedrock":
@@ -405,7 +418,9 @@ def create_llm_provider(
model=bedrock_model,
reasoning_effort=reasoning_effort,
extra_body=extra_body,
default_headers=default_headers,
bedrock_service_tier=bedrock_service_tier,
timeout=timeout,
)
elif provider_lower == "llamacpp":
@@ -452,6 +467,7 @@ def create_llm_provider(
model=model,
reasoning_effort=reasoning_effort,
extra_body=extra_body,
timeout=timeout,
)
elif provider_lower in (
@@ -464,6 +480,7 @@ def create_llm_provider(
"deepseek",
"volcano",
"openrouter",
"requesty",
"zai",
"opencode-go",
"atlas",
@@ -477,6 +494,7 @@ def create_llm_provider(
groq_service_tier=groq_service_tier,
openai_service_tier=openai_service_tier,
extra_body=extra_body,
timeout=timeout,
)
else:
@@ -506,6 +524,13 @@ class LLMProvider:
default_headers: dict[str, str] | None = None,
litellmrouter_config: dict[str, Any] | None = None,
gemini_service_tier: str | None = None,
vertexai_project_id: str | None = None,
vertexai_region: str | None = None,
vertexai_service_account_key: str | None = None,
timeout: float | None = None,
max_retries: int | None = None,
initial_backoff: float | None = None,
max_backoff: float | None = None,
):
"""
Initialize LLM provider.
@@ -524,20 +549,49 @@ class LLMProvider:
extra_body: Extra request-body params merged into the provider's native call
(OpenAI-compatible, Fireworks, Anthropic, Gemini/VertexAI, LiteLLM).
default_headers: Custom headers passed as ``default_headers`` to provider SDK clients.
Used by operators routing through proxies / request-tracing middleware. Falls
back to ``HindsightConfig.llm_default_headers`` (env: ``HINDSIGHT_API_LLM_DEFAULT_HEADERS``)
when ``None``.
Used by operators routing through proxies / request-tracing middleware.
litellmrouter_config: Provider-specific config for ``provider="litellmrouter"``.
JSON object passed verbatim to ``litellm.Router(**config)`` — see
https://docs.litellm.ai/docs/routing. Ignored unless ``provider == "litellmrouter"``.
When None and the provider is ``litellmrouter``, falls back to
``HindsightConfig.llm_litellmrouter_config``.
vertexai_project_id: Vertex AI project ID for ``provider="vertexai"`` (required for
that provider).
vertexai_region: Vertex AI region for ``provider="vertexai"`` (defaults to
``"us-central1"`` when ``None``).
vertexai_service_account_key: Path to a Vertex AI service-account key file for
``provider="vertexai"`` (uses ADC when ``None``).
timeout: Per-request LLM timeout in seconds. Resolved by the caller from the
per-operation/global config (``retain_llm_timeout`` falling back to
``llm_timeout``, etc.). ``None`` lets each provider apply its own default.
max_retries: Default retry-attempt budget for ``call`` / ``call_with_tools``
when the per-call argument is omitted. Resolved by the caller from the
per-operation/global config (``reflect_llm_max_retries`` falling back to
``llm_max_retries``, etc.). ``None`` keeps each method's own fallback.
initial_backoff: Default initial retry backoff (seconds), same resolution as
``max_retries``. ``None`` keeps each method's own fallback.
max_backoff: Default maximum retry backoff (seconds), same resolution as
``max_retries``. ``None`` keeps each method's own fallback.
This constructor uses every argument as passed and does not read global
``HindsightConfig``: resolving the server-level default for a ``None`` argument is the
caller's responsibility (see ``MemoryEngine``'s per-op builds, ``_member_to_llm``, and
``LLMProvider.from_env``). Keeping it config-free makes a provider's effective settings a
pure function of its arguments — which is what lets each member of a multi-LLM chain be
configured independently.
"""
self.provider = provider.lower()
self.api_key = api_key
self.base_url = base_url
self.model = model
self.reasoning_effort = reasoning_effort
# Per-request timeout (seconds). Used verbatim — the caller resolves the
# per-operation/global fallback. ``None`` defers to the provider default.
self.timeout = timeout
# Default retry policy for call()/call_with_tools(). The caller resolves the
# per-operation/global fallback; ``None`` keeps each method's own fallback so
# providers built without a resolved config (from_env, tests) are unchanged.
self.max_retries = max_retries
self.initial_backoff = initial_backoff
self.max_backoff = max_backoff
self.litellmrouter_config = litellmrouter_config
# Service tiers from hierarchical config (not env vars)
self.groq_service_tier = groq_service_tier
@@ -554,16 +608,9 @@ class LLMProvider:
# Extra body params for OpenAI-compatible providers (e.g. chat_template_kwargs)
self.extra_body = extra_body
# Default headers passed to provider SDK clients (e.g. proxy auth, request tracing).
# Same pattern as ``gemini_safety_settings``: explicit override wins; otherwise read
# the static server-level default from ``HindsightConfig`` via ``_get_raw_config()``.
# Used verbatim — callers resolve the global fallback (see _member_to_llm /
# the per-op builds in MemoryEngine, and LLMProvider.from_env).
self.default_headers = default_headers
if self.default_headers is None:
from ..config import _get_raw_config
try:
self.default_headers = _get_raw_config().llm_default_headers
except Exception:
pass # Config may not be initialized in test environments
# Validate provider
valid_providers = [
@@ -587,6 +634,7 @@ class LLMProvider:
"bedrock",
"volcano",
"openrouter",
"requesty",
"zai",
"opencode-go",
"atlas",
@@ -612,6 +660,8 @@ class LLMProvider:
self.base_url = "https://api.deepseek.com"
elif self.provider == "openrouter":
self.base_url = "https://openrouter.ai/api/v1"
elif self.provider == "requesty":
self.base_url = "https://router.requesty.ai/v1"
elif self.provider == "zai":
self.base_url = "https://api.z.ai/api/coding/paas/v4"
elif self.provider == "opencode-go":
@@ -621,25 +671,20 @@ class LLMProvider:
elif self.provider == "nous":
self.base_url = "https://inference-api.nousresearch.com/v1"
# Prepare Vertex AI config (if applicable)
vertexai_project_id = None
vertexai_region = None
# Prepare Vertex AI config (if applicable). Values are used as passed; the
# caller resolves the global-config fallback (MemoryEngine builds /
# _member_to_llm / from_env). The region keeps a constant default here.
vertexai_credentials = None
if self.provider == "vertexai":
from ..config import get_config
config = get_config()
vertexai_project_id = config.llm_vertexai_project_id
if not vertexai_project_id:
raise ValueError(
"HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID is required for Vertex AI provider. "
"Set it to your GCP project ID."
)
vertexai_region = config.llm_vertexai_region or "us-central1"
service_account_key = config.llm_vertexai_service_account_key
vertexai_region = vertexai_region or "us-central1"
service_account_key = vertexai_service_account_key
# Load explicit service account credentials if provided
if service_account_key:
@@ -663,61 +708,20 @@ class LLMProvider:
f"model={self.model}, auth={'service_account' if service_account_key else 'ADC'}"
)
# For Gemini/VertexAI providers: read safety settings from global config if not explicitly provided
# Use _get_raw_config() to bypass StaticConfigProxy (which blocks configurable fields),
# since LLMProvider initialization legitimately needs the server-level default.
if self.provider in ("gemini", "vertexai") and self.gemini_safety_settings is None:
from ..config import _get_raw_config
try:
raw_config = _get_raw_config()
self.gemini_safety_settings = raw_config.llm_gemini_safety_settings
except Exception:
pass # Config may not be initialized in test environments
# Normalize the Gemini service tier (pure: maps/validates the passed value,
# no global config read). Non-Gemini providers never carry a tier. The
# server-level default is resolved by the caller, like the other fields.
if self.provider == "gemini":
from ..config import parse_gemini_service_tier
self.gemini_service_tier = parse_gemini_service_tier(self.gemini_service_tier)
if self.provider == "gemini" and self.gemini_service_tier is None:
from ..config import _get_raw_config
try:
raw_config = _get_raw_config()
self.gemini_service_tier = raw_config.llm_gemini_service_tier
except Exception:
pass # Config may not be initialized in test environments
elif self.provider != "gemini":
else:
self.gemini_service_tier = None
# Prompt-prefix caching is a provider-agnostic toggle (default on): resolve
# it from the static server config for every provider when the caller didn't
# pass an explicit override. Providers that don't support caching ignore the
# value; only those that implement get_or_create_cached_prefix act on it.
if not self.prompt_cache_enabled:
from ..config import DEFAULT_LLM_PROMPT_CACHE_ENABLED, _get_raw_config
try:
raw_config = _get_raw_config()
self.prompt_cache_enabled = bool(
getattr(raw_config, "llm_prompt_cache_enabled", DEFAULT_LLM_PROMPT_CACHE_ENABLED)
)
except Exception:
pass # Config may not be initialized in test environments
# For litellmrouter: prefer an explicit chain from the caller (per-op
# construction in MemoryEngine threads the right chain through). If the caller
# didn't supply one, fall back to the global ``llm_litellmrouter_config`` so
# ad-hoc constructions (e.g. ``LLMProvider.from_env()``) keep working.
# gemini_safety_settings / prompt_cache_enabled / litellmrouter_config are
# used as passed — the caller resolves the global-config fallback. Providers
# that don't support prompt caching ignore the flag.
router_config: dict[str, Any] | None = self.litellmrouter_config
if self.provider == "litellmrouter" and router_config is None:
from ..config import _get_raw_config
try:
router_config = _get_raw_config().llm_litellmrouter_config
except Exception:
router_config = None
# Create provider implementation using factory
self._provider_impl = create_llm_provider(
@@ -738,6 +742,7 @@ class LLMProvider:
gemini_safety_settings=self.gemini_safety_settings,
prompt_cache_enabled=self.prompt_cache_enabled,
litellmrouter_config=router_config,
timeout=self.timeout,
)
# Backward compatibility: Keep mock provider properties
@@ -794,9 +799,9 @@ class LLMProvider:
max_completion_tokens: int | None = None,
temperature: float | None = None,
scope: str = "memory",
max_retries: int = 10,
initial_backoff: float = 1.0,
max_backoff: float = 60.0,
max_retries: int | None = None,
initial_backoff: float | None = None,
max_backoff: float | None = None,
skip_validation: bool = False,
strict_schema: bool = False,
return_usage: bool = False,
@@ -811,9 +816,12 @@ class LLMProvider:
max_completion_tokens: Maximum tokens in response.
temperature: Sampling temperature (0.0-2.0).
scope: Scope identifier for tracking.
max_retries: Maximum retry attempts.
initial_backoff: Initial backoff time in seconds.
max_backoff: Maximum backoff time in seconds.
max_retries: Maximum retry attempts. ``None`` uses the provider's configured
default (per-operation/global ``llm_max_retries``), else 10.
initial_backoff: Initial backoff time in seconds. ``None`` uses the provider's
configured default (``llm_initial_backoff``), else 1.0.
max_backoff: Maximum backoff time in seconds. ``None`` uses the provider's
configured default (``llm_max_backoff``), else 60.0.
skip_validation: Return raw JSON without Pydantic validation.
strict_schema: Per-call override requesting grammar-enforced (json_schema strict)
structured output instead of the soft json_object path. The server-level
@@ -838,6 +846,20 @@ class LLMProvider:
structured = "+structured" if response_format is not None else ""
set_stage(f"llm.{self.provider}.{scope}{structured}")
# Resolve the retry policy: explicit per-call arg wins, else the provider's
# configured per-operation/global default, else this method's own fallback.
max_retries = (
max_retries if max_retries is not None else (self.max_retries if self.max_retries is not None else 10)
)
initial_backoff = (
initial_backoff
if initial_backoff is not None
else (self.initial_backoff if self.initial_backoff is not None else 1.0)
)
max_backoff = (
max_backoff if max_backoff is not None else (self.max_backoff if self.max_backoff is not None else 60.0)
)
# Resolve strict-schema once, here, rather than in each provider: the
# per-call argument OR the server-level HINDSIGHT_API_LLM_STRICT_SCHEMA
# flag. Providers with a json_schema response_format (OpenAI-compatible,
@@ -854,7 +876,13 @@ class LLMProvider:
# The requested params are stashed in a contextvar (only what the caller
# actually set) so the recorder can attach them to either path.
from ..tracing import get_span_recorder
from .llm_trace import reset_request_context, set_request_context
from .llm_trace import (
current_response_usage,
reset_request_context,
reset_response_usage,
set_request_context,
set_response_usage,
)
call_start = time.monotonic()
request_token = set_request_context(
@@ -865,6 +893,9 @@ class LLMProvider:
response_format=response_format,
)
)
# Cleared per call; the provider stashes real usage once a response is in
# hand so the error path below can attach it if parsing/validation fails.
usage_token = set_response_usage(None)
try:
async with AsyncExitStack() as stack:
for sem in _semaphores_for_scope(scope):
@@ -892,14 +923,19 @@ class LLMProvider:
**cache_kwarg,
)
except Exception as e:
# The provider call may have succeeded (and incurred token
# cost) before local parsing/validation raised; attach the
# provider-reported usage to the error trace when available.
usage = current_response_usage()
get_span_recorder().record_llm_call(
provider=self.provider,
model=self.model,
scope=scope,
messages=messages,
response_content=None,
input_tokens=0,
output_tokens=0,
input_tokens=usage.input_tokens if usage else 0,
output_tokens=usage.output_tokens if usage else 0,
cached_tokens=usage.cached_tokens if usage else 0,
duration=time.monotonic() - call_start,
error=e,
)
@@ -915,6 +951,7 @@ class LLMProvider:
self._mock_calls = self._provider_impl.get_mock_calls()
finally:
reset_request_context(request_token)
reset_response_usage(usage_token)
return result
@@ -925,9 +962,9 @@ class LLMProvider:
max_completion_tokens: int | None = None,
temperature: float | None = None,
scope: str = "tools",
max_retries: int = 5,
initial_backoff: float = 1.0,
max_backoff: float = 30.0,
max_retries: int | None = None,
initial_backoff: float | None = None,
max_backoff: float | None = None,
tool_choice: str | dict[str, Any] = "auto",
cached_prefix: str | None = None,
) -> "LLMToolCallResult":
@@ -940,9 +977,12 @@ class LLMProvider:
max_completion_tokens: Maximum tokens in response.
temperature: Sampling temperature (0.0-2.0).
scope: Scope identifier for tracking.
max_retries: Maximum retry attempts.
initial_backoff: Initial backoff time in seconds.
max_backoff: Maximum backoff time in seconds.
max_retries: Maximum retry attempts. ``None`` uses the provider's configured
default (per-operation/global ``llm_max_retries``), else 5.
initial_backoff: Initial backoff time in seconds. ``None`` uses the provider's
configured default (``llm_initial_backoff``), else 1.0.
max_backoff: Maximum backoff time in seconds. ``None`` uses the provider's
configured default (``llm_max_backoff``), else 30.0.
tool_choice: How to choose tools - "auto", "none", "required", or {"type": "function", "function": {"name": "..."}}
Returns:
@@ -952,9 +992,29 @@ class LLMProvider:
set_stage(f"llm.{self.provider}.{scope}+tools")
# Resolve the retry policy: explicit per-call arg wins, else the provider's
# configured per-operation/global default, else this method's own fallback.
max_retries = (
max_retries if max_retries is not None else (self.max_retries if self.max_retries is not None else 5)
)
initial_backoff = (
initial_backoff
if initial_backoff is not None
else (self.initial_backoff if self.initial_backoff is not None else 1.0)
)
max_backoff = (
max_backoff if max_backoff is not None else (self.max_backoff if self.max_backoff is not None else 30.0)
)
# Failures forwarded to the GenAI recorder; successes recorded by providers.
from ..tracing import get_span_recorder
from .llm_trace import reset_request_context, set_request_context
from .llm_trace import (
current_response_usage,
reset_request_context,
reset_response_usage,
set_request_context,
set_response_usage,
)
call_start = time.monotonic()
request_token = set_request_context(
@@ -965,6 +1025,9 @@ class LLMProvider:
tool_choice=tool_choice,
)
)
# Cleared per call; the provider stashes real usage once a response is in
# hand so the error path below can attach it if parsing/validation fails.
usage_token = set_response_usage(None)
try:
async with AsyncExitStack() as stack:
for sem in _semaphores_for_scope(scope):
@@ -989,14 +1052,19 @@ class LLMProvider:
**cache_kwarg,
)
except Exception as e:
# The provider call may have succeeded (and incurred token
# cost) before local parsing/validation raised; attach the
# provider-reported usage to the error trace when available.
usage = current_response_usage()
get_span_recorder().record_llm_call(
provider=self.provider,
model=self.model,
scope=scope,
messages=messages,
response_content=None,
input_tokens=0,
output_tokens=0,
input_tokens=usage.input_tokens if usage else 0,
output_tokens=usage.output_tokens if usage else 0,
cached_tokens=usage.cached_tokens if usage else 0,
duration=time.monotonic() - call_start,
error=e,
)
@@ -1012,6 +1080,7 @@ class LLMProvider:
self._mock_calls = self._provider_impl.get_mock_calls()
finally:
reset_request_context(request_token)
reset_response_usage(usage_token)
return result
@@ -1170,19 +1239,37 @@ class LLMProvider:
@classmethod
def from_env(cls) -> "LLMProvider":
"""Create provider from environment variables using config.py constants."""
# Read every field straight from the environment. The constructor no longer
# resolves global-config fallbacks, so this factory must supply them — and it
# does so without building the full HindsightConfig, keeping from_env() a
# lightweight env-only loader (see test_llm_provider_from_env_keeps_lightweight_loader).
from ..config import (
DEFAULT_LLM_GROQ_SERVICE_TIER,
DEFAULT_LLM_OPENAI_SERVICE_TIER,
DEFAULT_LLM_PROMPT_CACHE_ENABLED,
DEFAULT_LLM_PROVIDER,
DEFAULT_LLM_REASONING_EFFORT,
DEFAULT_LLM_TIMEOUT,
ENV_LLM_API_KEY,
ENV_LLM_BASE_URL,
ENV_LLM_BEDROCK_SERVICE_TIER,
ENV_LLM_DEFAULT_HEADERS,
ENV_LLM_EXTRA_BODY,
ENV_LLM_GEMINI_SAFETY_SETTINGS,
ENV_LLM_GEMINI_SERVICE_TIER,
ENV_LLM_GROQ_SERVICE_TIER,
ENV_LLM_LITELLMROUTER_CONFIG,
ENV_LLM_MODEL,
ENV_LLM_OPENAI_SERVICE_TIER,
ENV_LLM_PROMPT_CACHE_ENABLED,
ENV_LLM_PROVIDER,
ENV_LLM_REASONING_EFFORT,
ENV_LLM_TIMEOUT,
ENV_LLM_VERTEXAI_PROJECT_ID,
ENV_LLM_VERTEXAI_REGION,
ENV_LLM_VERTEXAI_SERVICE_ACCOUNT_KEY,
_get_default_model_for_provider,
_parse_llm_router_config,
parse_gemini_service_tier,
)
@@ -1200,6 +1287,14 @@ class LLMProvider:
model = os.getenv(ENV_LLM_MODEL) or _get_default_model_for_provider(provider)
extra_body = json.loads(os.getenv(ENV_LLM_EXTRA_BODY, "null"))
default_headers = json.loads(os.getenv(ENV_LLM_DEFAULT_HEADERS, "null"))
prompt_cache_enabled = os.getenv(
ENV_LLM_PROMPT_CACHE_ENABLED, str(DEFAULT_LLM_PROMPT_CACHE_ENABLED)
).lower() in (
"1",
"true",
"yes",
"on",
)
return cls(
provider=provider,
@@ -1209,12 +1304,21 @@ class LLMProvider:
reasoning_effort=os.getenv(ENV_LLM_REASONING_EFFORT, DEFAULT_LLM_REASONING_EFFORT),
extra_body=extra_body,
default_headers=default_headers,
groq_service_tier=os.getenv(ENV_LLM_GROQ_SERVICE_TIER, DEFAULT_LLM_GROQ_SERVICE_TIER),
openai_service_tier=os.getenv(ENV_LLM_OPENAI_SERVICE_TIER, DEFAULT_LLM_OPENAI_SERVICE_TIER),
bedrock_service_tier=os.getenv(ENV_LLM_BEDROCK_SERVICE_TIER) or None,
gemini_service_tier=(
parse_gemini_service_tier(os.getenv(ENV_LLM_GEMINI_SERVICE_TIER))
if provider.lower() == "gemini"
else None
),
gemini_safety_settings=json.loads(os.getenv(ENV_LLM_GEMINI_SAFETY_SETTINGS, "null")),
prompt_cache_enabled=prompt_cache_enabled,
litellmrouter_config=_parse_llm_router_config(ENV_LLM_LITELLMROUTER_CONFIG),
vertexai_project_id=os.getenv(ENV_LLM_VERTEXAI_PROJECT_ID) or None,
vertexai_region=os.getenv(ENV_LLM_VERTEXAI_REGION) or None,
vertexai_service_account_key=os.getenv(ENV_LLM_VERTEXAI_SERVICE_ACCOUNT_KEY) or None,
timeout=float(os.getenv(ENV_LLM_TIMEOUT, str(DEFAULT_LLM_TIMEOUT))),
)
@@ -11,6 +11,12 @@ from one place, so we don't spawn a separate ``asyncio`` task per concern:
consolidation operation failed terminally and left them with
``consolidated_at IS NULL AND consolidation_failed_at IS NULL`` and nothing to
re-trigger them.
- **Scheduled mental model refresh** (configurable check cadence, default 60s):
refresh mental models whose ``trigger.refresh_cron`` schedule is due, but only
when the model is stale (new memories in its scope since its last refresh), so
a scheduled tick never burns an LLM call to regenerate identical content. The
per-model schedule lives in the cron expression; this loop only decides when to
*check*.
The loop wakes on a short fixed tick and runs each job when its own
``last_run + interval`` is due (run-at-start, then on interval), so adding jobs
@@ -25,12 +31,14 @@ from __future__ import annotations
import asyncio
import logging
import time
from typing import TYPE_CHECKING
from collections.abc import Coroutine
from datetime import datetime, timezone
from typing import TYPE_CHECKING, Any
from ..config import HindsightConfig, get_config
from ..models import RequestContext
from .db_utils import acquire_with_retry
from .schema import _is_oracle
from .schema import _is_oracle, fq_table
if TYPE_CHECKING:
from .memory_engine import MemoryEngine
@@ -91,7 +99,8 @@ class MaintenanceLoop:
reconcile_on = cfg.consolidation_reconcile_interval_seconds > 0
audit_on = cfg.audit_log_enabled and cfg.audit_log_retention_days > 0
llm_on = cfg.llm_trace_enabled and cfg.llm_trace_retention_days > 0
return reconcile_on or audit_on or llm_on
mm_refresh_on = cfg.mental_model_refresh_tick_seconds > 0
return reconcile_on or audit_on or llm_on or mm_refresh_on
# ── loop ───────────────────────────────────────────────────────────────
@@ -118,10 +127,25 @@ class MaintenanceLoop:
async def _tick(self) -> None:
cfg = get_config()
if self._is_due("retention", _RETENTION_INTERVAL_SECONDS):
await self._run_retention(cfg)
await self._run_timed("retention", self._run_retention(cfg))
interval = cfg.consolidation_reconcile_interval_seconds
if interval > 0 and self._is_due("reconcile", interval):
await self._run_reconcile()
await self._run_timed("consolidation reconcile", self._run_reconcile())
mm_interval = cfg.mental_model_refresh_tick_seconds
if mm_interval > 0 and self._is_due("mm_refresh", mm_interval):
await self._run_timed("scheduled mental model refresh", self._run_scheduled_mm_refresh())
async def _run_timed(self, name: str, coro: Coroutine[Any, Any, None]) -> None:
"""Run a maintenance job and emit one timing line for it.
Each job keeps its own summary log (counts of work done); this adds a
single, uniform line per run so the cost of every sweep is observable.
"""
start = time.monotonic()
try:
await coro
finally:
logger.info(f"Maintenance: {name} took {time.monotonic() - start:.3f}s")
# ── retention ──────────────────────────────────────────────────────────
@@ -212,3 +236,112 @@ class MaintenanceLoop:
f"Consolidation reconcile: scheduled {submitted} bank(s)"
+ (f", skipped {skipped_unknown} in unrecognized schema(s)" if skipped_unknown else "")
)
# ── scheduled mental model refresh ───────────────────────────────────────
async def _run_scheduled_mm_refresh(self) -> None:
"""Refresh mental models whose ``trigger.refresh_cron`` is due.
Discovery (the set of cron-scheduled models, minus any with an in-flight
refresh) is one cross-tenant round-trip via
``public.mental_models_with_cron()``. Cron *due-ness* is evaluated here in
Python — a scheduled fire has elapsed when the most recent cron boundary at
or before now is later than ``last_refreshed_at`` — because cron arithmetic
isn't expressible in plain SQL. Each due model is refreshed only when it is
actually stale, so a schedule that fires while nothing changed costs a
cheap staleness query, not an LLM call.
"""
engine = self._engine
try:
async with acquire_with_retry(engine._backend, max_retries=1) as conn:
rows = await conn.fetch(
"SELECT schema_name, bank_id, mental_model_id, refresh_cron, last_refreshed_at "
"FROM public.mental_models_with_cron()"
)
except Exception as e:
logger.warning(f"Scheduled mental model refresh discovery failed: {e}")
return
if not rows:
return
from croniter import croniter
now = datetime.now(timezone.utc)
due = []
for row in rows:
cron = row["refresh_cron"]
last = row["last_refreshed_at"]
try:
prev_fire = croniter(cron, now).get_prev(datetime)
except (ValueError, KeyError) as e:
logger.warning(
f"Scheduled mental model refresh: skipping invalid cron {cron!r} for "
f"{row['schema_name']}/{row['mental_model_id']}: {e}"
)
continue
if last is None or prev_fire > last:
due.append(row)
if not due:
return
# Only enqueue into schemas the worker actually polls (tenant discovery),
# otherwise the op would never be claimed. The tenant_id (when provided)
# lets config resolution honor tenant-level overrides.
try:
tenants = await engine._tenant_extension.list_tenants()
except Exception as e:
logger.warning(f"Scheduled mental model refresh tenant discovery failed: {e}")
return
tenant_by_schema = {t.schema: t for t in tenants}
default_schema = get_config().database_schema
from .memory_engine import _current_schema
submitted = 0
skipped_unknown = 0
skipped_fresh = 0
for row in due:
schema = row["schema_name"]
bank_id = row["bank_id"]
mm_id = row["mental_model_id"]
tenant = tenant_by_schema.get(schema)
if tenant is None and schema != default_schema:
skipped_unknown += 1
continue
tenant_id = tenant.tenant_id if tenant else None
token = _current_schema.set(schema)
try:
context = RequestContext(internal=True, tenant_id=tenant_id)
# Skip if nothing in the model's scope changed since its last
# refresh — a scheduled refresh must not regenerate identical
# content. compute_mental_model_is_stale needs the model's tags +
# trigger, which the discovery routine doesn't return, so re-read
# the row under the bank's schema context.
async with acquire_with_retry(engine._backend, max_retries=1) as conn:
mm_row = await conn.fetchrow(
f"SELECT id, tags, trigger, last_refreshed_at FROM {fq_table('mental_models')} "
"WHERE bank_id = $1 AND id = $2",
bank_id,
mm_id,
)
if mm_row is None:
continue
is_stale = await engine.compute_mental_model_is_stale(conn, bank_id, mm_row)
if not is_stale:
skipped_fresh += 1
continue
await engine.submit_async_refresh_mental_model(
bank_id=bank_id, mental_model_id=mm_id, request_context=context
)
submitted += 1
except Exception as e:
logger.warning(f"Scheduled mental model refresh failed for {mm_id} in {schema}: {e}")
finally:
_current_schema.reset(token)
if submitted or skipped_unknown or skipped_fresh:
logger.info(
f"Scheduled mental model refresh: scheduled {submitted} model(s)"
+ (f", {skipped_fresh} up-to-date" if skipped_fresh else "")
+ (f", skipped {skipped_unknown} in unrecognized schema(s)" if skipped_unknown else "")
)
File diff suppressed because it is too large Load Diff
@@ -5,13 +5,35 @@ import logging
import tempfile
from dataclasses import dataclass
from pathlib import Path
from typing import TYPE_CHECKING
from hindsight_api.config import DEFAULT_FILE_PARSER_MARKITDOWN_OCR_PROMPT
from .base import FileParser
if TYPE_CHECKING:
from markitdown import StreamInfo
logger = logging.getLogger(__name__)
# Extensions whose markitdown converters decode the raw bytes as text. markitdown
# samples only the first chunk for charset detection, so a UTF-8 file with a long
# ASCII-only prefix is mis-detected as ASCII; the JSON/ipynb converter then crashes
# decoding the first multibyte byte. Passing an explicit UTF-8 hint when the bytes
# are valid UTF-8 sidesteps the faulty detection without affecting other encodings.
_TEXT_EXTENSIONS = {
".json",
".jsonl",
".ipynb",
".txt",
".text",
".md",
".markdown",
".csv",
".html",
".htm",
}
@dataclass(frozen=True)
class MarkitdownOcrOptions:
@@ -134,8 +156,9 @@ class MarkitdownParser(FileParser):
tmp_path = tmp.name
try:
# Parse using markitdown
result = self._markitdown.convert(tmp_path)
# Parse using markitdown, passing an explicit charset hint for text
# files to avoid markitdown's sample-based (and crash-prone) detection.
result = self._markitdown.convert(tmp_path, stream_info=self._utf8_stream_info(file_data, filename))
if not result or not result.text_content:
raise RuntimeError(f"No content extracted from '{filename}'")
@@ -153,6 +176,23 @@ class MarkitdownParser(FileParser):
except Exception:
pass
@staticmethod
def _utf8_stream_info(file_data: bytes, filename: str) -> "StreamInfo | None":
"""Return a UTF-8 charset hint for text files that decode cleanly as UTF-8.
Returns None for binary files or non-UTF-8 text so markitdown falls back
to its own detection.
"""
if Path(filename).suffix.lower() not in _TEXT_EXTENSIONS:
return None
try:
file_data.decode("utf-8")
except UnicodeDecodeError:
return None
from markitdown import StreamInfo
return StreamInfo(charset="utf-8")
@staticmethod
def _is_image_file(filename: str) -> bool:
"""Return whether the file type needs OCR to extract useful text."""
@@ -15,12 +15,25 @@ import time
from typing import Any
from hindsight_api.engine.llm_interface import LLMInterface
from hindsight_api.engine.llm_trace import LLMResponseUsage, stash_response_usage
from hindsight_api.engine.response_models import LLMToolCall, LLMToolCallResult, TokenUsage
from hindsight_api.metrics import get_metrics_collector
logger = logging.getLogger(__name__)
def _usage_from_anthropic_response(response: Any) -> LLMResponseUsage:
"""Extract input/output/cached token counts from an Anthropic usage block."""
usage = getattr(response, "usage", None)
if not usage:
return LLMResponseUsage()
return LLMResponseUsage(
input_tokens=usage.input_tokens or 0,
output_tokens=usage.output_tokens or 0,
cached_tokens=getattr(usage, "cache_read_input_tokens", 0) or 0,
)
class AnthropicLLM(LLMInterface):
"""
LLM provider using Anthropic's Claude models.
@@ -211,6 +224,9 @@ class AnthropicLLM(LLMInterface):
for attempt in range(max_retries + 1):
try:
response = await self._client.messages.create(**call_params)
# Stash usage before parse/validate, which may raise locally
# even though the provider charged for these tokens (#2387).
stash_response_usage(_usage_from_anthropic_response(response))
if use_forced_tool:
# Forced tool_use → the validated args are already a dict; no parsing,
@@ -258,10 +274,11 @@ class AnthropicLLM(LLMInterface):
# Record metrics and log slow calls
duration = time.time() - start_time
input_tokens = response.usage.input_tokens or 0 if response.usage else 0
output_tokens = response.usage.output_tokens or 0 if response.usage else 0
response_usage = _usage_from_anthropic_response(response)
input_tokens = response_usage.input_tokens
output_tokens = response_usage.output_tokens
total_tokens = input_tokens + output_tokens
cached_tokens = getattr(response.usage, "cache_read_input_tokens", 0) or 0 if response.usage else 0
cached_tokens = response_usage.cached_tokens
# Record LLM metrics
metrics = get_metrics_collector()
@@ -449,6 +466,7 @@ class AnthropicLLM(LLMInterface):
for attempt in range(max_retries + 1):
try:
response = await self._client.messages.create(**call_params)
stash_response_usage(_usage_from_anthropic_response(response))
# Extract content and tool calls
content_parts = []
@@ -16,6 +16,7 @@ from typing import Any
from pydantic import ValidationError
from hindsight_api.engine.llm_interface import LLMInterface
from hindsight_api.engine.llm_trace import LLMResponseUsage, stash_response_usage
from hindsight_api.engine.response_models import LLMToolCall, LLMToolCallResult, TokenUsage
from hindsight_api.metrics import get_metrics_collector
@@ -118,12 +119,14 @@ class ClaudeCodeLLM(LLMInterface):
Raises:
RuntimeError: If the connection test fails.
"""
from ...config import get_config
try:
test_messages = [{"role": "user", "content": "test"}]
await self.call(
messages=test_messages,
max_completion_tokens=10,
temperature=0.0,
temperature=get_config().llm_temperature_verification,
scope="verification",
max_retries=0,
)
@@ -226,6 +229,16 @@ class ClaudeCodeLLM(LLMInterface):
if isinstance(block, TextBlock):
full_text += block.text
# The Claude Agent SDK doesn't report exact counts; stash the same
# char/4 estimate the success path traces so a later parse/validate
# failure records consistent (estimated) tokens, not zero (#2387).
stash_response_usage(
LLMResponseUsage(
input_tokens=sum(len(m.get("content", "")) for m in messages) // 4,
output_tokens=len(full_text) // 4,
)
)
# Handle structured output
if response_format is not None:
# Models may wrap JSON in markdown
@@ -26,6 +26,7 @@ from typing import Any
import httpx
from hindsight_api.engine.llm_interface import LLMInterface
from hindsight_api.engine.llm_trace import LLMResponseUsage, stash_response_usage
from hindsight_api.engine.response_models import LLMToolCall, LLMToolCallResult, TokenUsage
from hindsight_api.metrics import get_metrics_collector
@@ -414,6 +415,16 @@ class CodexLLM(LLMInterface):
# Parse SSE stream
content = await self._parse_sse_stream(response)
# Codex SSE carries no usage block; stash the same char/4 estimate
# the success path traces so a later parse/validate failure records
# consistent (estimated) token counts rather than zero (#2387).
stash_response_usage(
LLMResponseUsage(
input_tokens=sum(len(m.get("content", "")) for m in messages) // 4,
output_tokens=len(content) // 4,
)
)
# Handle structured output
if response_format is not None:
# Models may wrap JSON in markdown
@@ -20,6 +20,7 @@ from google.genai import errors as genai_errors
from google.genai import types as genai_types
from hindsight_api.engine.llm_interface import LLMInterface
from hindsight_api.engine.llm_trace import LLMResponseUsage, stash_response_usage
from hindsight_api.engine.llm_wrapper import parse_llm_json
from hindsight_api.engine.response_models import LLMToolCall, LLMToolCallResult, TokenUsage
from hindsight_api.metrics import get_metrics_collector
@@ -50,6 +51,18 @@ def _to_int(value: Any) -> int:
return 0
def _usage_from_gemini_response(response: Any) -> LLMResponseUsage:
"""Extract prompt/candidate/cached token counts from a Gemini usage_metadata block."""
usage = getattr(response, "usage_metadata", None)
if not usage:
return LLMResponseUsage()
return LLMResponseUsage(
input_tokens=usage.prompt_token_count or 0,
output_tokens=usage.candidates_token_count or 0,
cached_tokens=getattr(usage, "cached_content_token_count", 0) or 0,
)
class GeminiLLM(LLMInterface):
"""
LLM provider for Google Gemini and Vertex AI.
@@ -327,6 +340,9 @@ class GeminiLLM(LLMInterface):
),
timeout=90.0, # Safety net for network hangs; valid slow responses are <90s
)
# Stash usage before parse/validate, which may raise locally
# even though the provider charged for these tokens (#2387).
stash_response_usage(_usage_from_gemini_response(response))
content = response.text
@@ -693,6 +709,7 @@ class GeminiLLM(LLMInterface):
),
timeout=90.0, # Safety net for network hangs; valid slow responses are <90s
)
stash_response_usage(_usage_from_gemini_response(response))
# Extract content and tool calls
content = None
@@ -23,6 +23,7 @@ from litellm.exceptions import Timeout as LiteLLMTimeout
from hindsight_api.config import DEFAULT_LLM_TIMEOUT, ENV_LLM_TIMEOUT
from hindsight_api.engine.llm_interface import LLMInterface, OutputTooLongError
from hindsight_api.engine.llm_trace import LLMResponseUsage, stash_response_usage
from hindsight_api.engine.response_models import LLMToolCall, LLMToolCallResult, TokenUsage
from hindsight_api.metrics import get_metrics_collector
from hindsight_api.worker.stage import set_stage
@@ -30,6 +31,22 @@ from hindsight_api.worker.stage import set_stage
logger = logging.getLogger(__name__)
def _usage_from_litellm_response(response: Any) -> LLMResponseUsage:
"""Extract prompt/completion/cached token counts from a LiteLLM (OpenAI-shaped) usage block."""
usage = getattr(response, "usage", None)
if not usage:
return LLMResponseUsage()
cached_tokens = 0
details = getattr(usage, "prompt_tokens_details", None)
if details:
cached_tokens = getattr(details, "cached_tokens", 0) or 0
return LLMResponseUsage(
input_tokens=getattr(usage, "prompt_tokens", 0) or 0,
output_tokens=getattr(usage, "completion_tokens", 0) or 0,
cached_tokens=cached_tokens,
)
class LiteLLMLLM(LLMInterface):
"""
LLM provider using the LiteLLM SDK for universal model support.
@@ -54,6 +71,7 @@ class LiteLLMLLM(LLMInterface):
timeout: float | None = None,
extra_body: dict[str, Any] | None = None,
bedrock_service_tier: str | None = None,
default_headers: dict[str, Any] | None = None,
**kwargs: Any,
):
super().__init__(provider, api_key, base_url, model, reasoning_effort, **kwargs)
@@ -67,6 +85,13 @@ class LiteLLMLLM(LLMInterface):
# drops any the target model rejects (litellm.drop_params=True below).
# Sourced from llm_extra_body (env: HINDSIGHT_API_LLM_EXTRA_BODY).
self._extra_body: dict[str, Any] = extra_body or {}
# Operator-configured default headers forwarded to litellm.acompletion as
# ``extra_headers`` (used by deployments routing through proxies / request-
# tracing middleware). Mirrors the Anthropic provider's default_headers
# wiring. Sourced from llm_default_headers (env: HINDSIGHT_API_LLM_DEFAULT_HEADERS).
# Copied so a caller-owned dict can't be mutated through us, and a fresh
# copy is handed to each call below to avoid cross-request contamination.
self._default_headers: dict[str, Any] = dict(default_headers or {})
self.bedrock_service_tier = bedrock_service_tier
try:
@@ -83,12 +108,14 @@ class LiteLLMLLM(LLMInterface):
raise RuntimeError("LiteLLM SDK not installed. Run: uv add litellm or pip install litellm") from e
async def verify_connection(self) -> None:
from ...config import get_config
try:
test_messages = [{"role": "user", "content": "test"}]
await self.call(
messages=test_messages,
max_completion_tokens=50,
temperature=0.0,
temperature=get_config().llm_temperature_verification,
scope="verification",
max_retries=0,
)
@@ -127,6 +154,13 @@ class LiteLLMLLM(LLMInterface):
for key, value in self._extra_body.items():
kwargs.setdefault(key, value)
# Forward operator-configured default headers as ``extra_headers`` so they
# reach the provider behind LiteLLM (proxies / request-tracing middleware).
# ``setdefault`` keeps any explicit per-call ``extra_headers`` authoritative;
# a per-call copy prevents LiteLLM/downstream from mutating the stored dict.
if self._default_headers:
kwargs.setdefault("extra_headers", dict(self._default_headers))
# Bedrock service tier: flex (50% cheaper), priority, or reserved
if self.model.startswith("bedrock/") and self.bedrock_service_tier is not None:
kwargs["service_tier"] = self.bedrock_service_tier
@@ -219,6 +253,10 @@ class LiteLLMLLM(LLMInterface):
self._acompletion(**call_kwargs),
timeout=self.timeout,
)
# Stash usage before the length check and parse/validate below,
# which may raise locally even though the provider charged for
# these tokens (#2387).
stash_response_usage(_usage_from_litellm_response(response))
content = response.choices[0].message.content or ""
finish_reason = response.choices[0].finish_reason
@@ -249,8 +287,9 @@ class LiteLLMLLM(LLMInterface):
result = content
# Extract usage
input_tokens = getattr(response.usage, "prompt_tokens", 0) or 0
output_tokens = getattr(response.usage, "completion_tokens", 0) or 0
response_usage = _usage_from_litellm_response(response)
input_tokens = response_usage.input_tokens
output_tokens = response_usage.output_tokens
total_tokens = input_tokens + output_tokens
# Record metrics
@@ -386,6 +425,14 @@ class LiteLLMLLM(LLMInterface):
self._acompletion(**call_kwargs),
timeout=self.timeout,
)
# Stash usage before the tool-call argument parse below, which
# can raise json.JSONDecodeError locally even though the provider
# already billed for these tokens; without this the error trace
# records 0/0 tokens (#2387). Mirrors call() and the anthropic/
# gemini call_with_tools paths so the litellm tool path (and the
# LiteLLMRouterLLM subclass that inherits this method) completes
# the #2396 usage-on-error coverage.
stash_response_usage(_usage_from_litellm_response(response))
message = response.choices[0].message
content = message.content
@@ -146,16 +146,28 @@ class LiteLLMRouterLLM(LiteLLMLLM):
kwargs["max_completion_tokens"] = self._cap_max_completion_tokens(max_completion_tokens)
if temperature is not None:
kwargs["temperature"] = temperature
# Forward operator-configured default headers as ``extra_headers`` so they
# reach the provider behind the Router (proxies / request-tracing middleware).
# This override deliberately omits api_key/base_url/extra_body (those live in
# the per-deployment Router config), but headers are a cross-cutting operator
# concern, so we inject them here too — mirroring the base provider.
# ``setdefault`` keeps any explicit per-call ``extra_headers`` authoritative;
# a per-call copy prevents LiteLLM/downstream from mutating the stored dict.
if self._default_headers:
kwargs.setdefault("extra_headers", dict(self._default_headers))
return kwargs
async def verify_connection(self) -> None:
from hindsight_api.engine.llm_interface import OutputTooLongError
from ...config import get_config
try:
await self.call(
messages=[{"role": "user", "content": "test"}],
max_completion_tokens=50,
temperature=0.0,
temperature=get_config().llm_temperature_verification,
scope="verification",
max_retries=0,
)
@@ -101,7 +101,7 @@ class MockLLM(LLMInterface):
messages: List of message dicts with 'role' and 'content'.
response_format: Optional Pydantic model for structured output.
max_completion_tokens: Not used in mock.
temperature: Not used in mock.
temperature: Recorded on the call record for test assertions.
scope: Scope identifier for tracking.
max_retries: Not used in mock.
initial_backoff: Not used in mock.
@@ -123,6 +123,9 @@ class MockLLM(LLMInterface):
if response_format and hasattr(response_format, "__name__")
else str(response_format),
"scope": scope,
# Record the temperature so tests can assert per-operation temperature
# wiring (None means the parameter was omitted from the call).
"temperature": temperature,
}
self._mock_calls.append(call_record)
logger.debug(f"Mock LLM call recorded: scope={scope}, model={self.model}")
@@ -208,7 +211,7 @@ class MockLLM(LLMInterface):
messages: List of message dicts. Can include tool results with role='tool'.
tools: List of tool definitions in OpenAI format.
max_completion_tokens: Not used in mock.
temperature: Not used in mock.
temperature: Recorded on the call record for test assertions.
scope: Scope identifier for tracking.
max_retries: Not used in mock.
initial_backoff: Not used in mock.
@@ -225,6 +228,9 @@ class MockLLM(LLMInterface):
"messages": messages,
"tools": [t.get("function", {}).get("name") for t in tools],
"scope": scope,
# Record the temperature so tests can assert per-operation temperature
# wiring (None means the parameter was omitted from the call).
"temperature": temperature,
}
self._mock_calls.append(call_record)
@@ -37,6 +37,7 @@ from openai import APIConnectionError, APIStatusError, AsyncOpenAI, LengthFinish
from hindsight_api.config import DEFAULT_LLM_TIMEOUT, ENV_LLM_TIMEOUT
from hindsight_api.engine.bank_attribution import apply_bank_attribution
from hindsight_api.engine.llm_interface import LLMInterface, OutputTooLongError, ProviderRateLimitResetError
from hindsight_api.engine.llm_trace import LLMResponseUsage, stash_response_usage
from hindsight_api.engine.response_models import LLMToolCall, LLMToolCallResult, TokenUsage
from hindsight_api.metrics import get_metrics_collector
from hindsight_api.worker.stage import set_stage
@@ -232,6 +233,21 @@ def _content_or_error(response: Any, *, provider: str, model: str, scope: str) -
return content, choice
def _usage_from_openai_response(response: Any) -> LLMResponseUsage:
"""Extract prompt/completion/cached token counts from an OpenAI-shaped usage block."""
usage = getattr(response, "usage", None)
input_tokens = (usage.prompt_tokens or 0) if usage else 0
output_tokens = (usage.completion_tokens or 0) if usage else 0
cached_tokens = 0
if usage and getattr(usage, "prompt_tokens_details", None):
cached_tokens = getattr(usage.prompt_tokens_details, "cached_tokens", 0) or 0
return LLMResponseUsage(
input_tokens=input_tokens,
output_tokens=output_tokens,
cached_tokens=cached_tokens,
)
def _ensure_json_word_in_user_message(messages: list[dict[str, Any]]) -> list[dict[str, Any]]:
"""Some OpenAI-compatible gateways require 'json' in a user message for json_object mode."""
@@ -449,6 +465,7 @@ class OpenAICompatibleLLM(LLMInterface):
"deepseek",
"volcano",
"openrouter",
"requesty",
"zai",
"opencode-go",
"atlas",
@@ -473,6 +490,8 @@ class OpenAICompatibleLLM(LLMInterface):
self.base_url = "https://api.deepseek.com"
elif self.provider == "openrouter":
self.base_url = "https://openrouter.ai/api/v1"
elif self.provider == "requesty":
self.base_url = "https://router.requesty.ai/v1"
elif self.provider == "zai":
self.base_url = "https://api.z.ai/api/coding/paas/v4"
elif self.provider == "opencode-go":
@@ -497,6 +516,7 @@ class OpenAICompatibleLLM(LLMInterface):
"minimax",
"deepseek",
"openrouter",
"requesty",
"zai",
"opencode-go",
"atlas",
@@ -774,6 +794,9 @@ class OpenAICompatibleLLM(LLMInterface):
try:
if response_format is not None:
response = await self._client.chat.completions.create(**call_params)
# Stash usage before parse/validate, which may raise locally
# even though the provider charged for these tokens (#2387).
stash_response_usage(_usage_from_openai_response(response))
content, first_choice = _content_or_error(
response,
@@ -827,6 +850,7 @@ class OpenAICompatibleLLM(LLMInterface):
result = response_format.model_validate(json_data)
else:
response = await self._client.chat.completions.create(**call_params)
stash_response_usage(_usage_from_openai_response(response))
result, first_choice = _content_or_error(
response,
provider=self.provider,
@@ -844,12 +868,23 @@ class OpenAICompatibleLLM(LLMInterface):
# Record token usage metrics
duration = time.time() - start_time
usage = response.usage
input_tokens = usage.prompt_tokens or 0 if usage else 0
output_tokens = usage.completion_tokens or 0 if usage else 0
response_usage = _usage_from_openai_response(response)
input_tokens = response_usage.input_tokens
output_tokens = response_usage.output_tokens
total_tokens = usage.total_tokens or 0 if usage else 0
cached_tokens = 0
if usage and getattr(usage, "prompt_tokens_details", None):
cached_tokens = getattr(usage.prompt_tokens_details, "cached_tokens", 0) or 0
cached_tokens = response_usage.cached_tokens
thoughts_tokens = 0
if usage and getattr(usage, "completion_tokens_details", None):
thoughts_tokens = getattr(usage.completion_tokens_details, "reasoning_tokens", 0) or 0
# OpenAI-compatible providers fold reasoning tokens into
# ``completion_tokens`` (and thus ``total_tokens``), but the
# TokenUsage contract — and the Gemini provider — treat
# ``output_tokens``/``total_tokens`` as visible-only, surfacing
# reasoning separately in ``thoughts_tokens``. Subtract so the
# two fields don't double-count reasoning (cost over-attribution).
if thoughts_tokens:
output_tokens = max(0, output_tokens - thoughts_tokens)
total_tokens = max(0, total_tokens - thoughts_tokens)
# Record LLM metrics
metrics = get_metrics_collector()
@@ -898,6 +933,7 @@ class OpenAICompatibleLLM(LLMInterface):
output_tokens=output_tokens,
total_tokens=total_tokens,
cached_tokens=cached_tokens,
thoughts_tokens=thoughts_tokens,
)
return result, token_usage
return result
@@ -1148,6 +1184,17 @@ class OpenAICompatibleLLM(LLMInterface):
usage = response.usage
input_tokens = usage.prompt_tokens or 0 if usage else 0
output_tokens = usage.completion_tokens or 0 if usage else 0
cached_tokens = 0
if usage and getattr(usage, "prompt_tokens_details", None):
cached_tokens = getattr(usage.prompt_tokens_details, "cached_tokens", 0) or 0
thoughts_tokens = 0
if usage and getattr(usage, "completion_tokens_details", None):
thoughts_tokens = getattr(usage.completion_tokens_details, "reasoning_tokens", 0) or 0
# See ``call()``: OpenAI-compatible ``completion_tokens`` includes
# reasoning, so make ``output_tokens`` visible-only to avoid
# double-counting it against ``thoughts_tokens``.
if thoughts_tokens:
output_tokens = max(0, output_tokens - thoughts_tokens)
metrics = get_metrics_collector()
metrics.record_llm_call(
@@ -1190,6 +1237,8 @@ class OpenAICompatibleLLM(LLMInterface):
finish_reason=finish_reason,
input_tokens=input_tokens,
output_tokens=output_tokens,
cached_tokens=cached_tokens,
thoughts_tokens=thoughts_tokens,
)
except APIConnectionError as e:
@@ -90,12 +90,87 @@ _LEAKED_JSON_SUFFIX = re.compile(
r'\s*```(?:json)?\s*\{[^}]*(?:"(?:observation_ids|memory_ids|mental_model_ids)"|\})\s*```\s*$',
re.DOTALL | re.IGNORECASE,
)
_LEAKED_JSON_OBJECT = re.compile(
r'\s*\{[^{]*"(?:observation_ids|memory_ids|mental_model_ids|answer)"[^}]*\}\s*$', re.DOTALL
)
_TRAILING_IDS_PATTERN = re.compile(
r"\s*(?:observation_ids|memory_ids|mental_model_ids)\s*[=:]\s*\[.*?\]\s*$", re.DOTALL | re.IGNORECASE
)
_JSON_CODE_FENCE_PATTERN = re.compile(r"^\s*```(?:json)?\s*(\{.*\})\s*```\s*$", re.DOTALL | re.IGNORECASE)
_DONE_ARGUMENT_KEYS = frozenset(
{
"answer",
"directive_compliance",
"memory_ids",
"mental_model_ids",
"observation_ids",
"model_ids",
}
)
_DONE_ARGUMENT_MARKER_KEYS = _DONE_ARGUMENT_KEYS - {"answer"}
_LEAKED_JSON_ID_KEYS = frozenset({"memory_ids", "mental_model_ids", "observation_ids", "model_ids"})
def _unwrap_leaked_done_arguments(text: str) -> str | None:
"""Return the answer when a done tool call was rendered as JSON text.
Some providers leak the done tool's argument object instead of surfacing it
as a native tool call, e.g. {"answer": "...", "memory_ids": [...]}. Only
unwrap objects that match the done argument shape so normal JSON answers
stay intact.
"""
candidate = text.strip()
if not candidate:
return None
fenced = _JSON_CODE_FENCE_PATTERN.match(candidate)
if fenced:
candidate = fenced.group(1).strip()
try:
payload = json.loads(candidate)
except json.JSONDecodeError:
return None
if not isinstance(payload, dict):
return None
answer = payload.get("answer")
if not isinstance(answer, str) or not answer.strip():
return None
keys = set(payload)
if not keys.intersection(_DONE_ARGUMENT_MARKER_KEYS):
return None
if not keys.issubset(_DONE_ARGUMENT_KEYS):
return None
for key in ("memory_ids", "mental_model_ids", "observation_ids", "model_ids"):
value = payload.get(key)
if value is not None and not isinstance(value, list):
return None
return answer.strip()
def _strip_trailing_id_json_object(text: str) -> str:
stripped = text.rstrip()
if not stripped.endswith("}"):
return text.strip()
start = stripped.rfind("{")
if start < 0:
return text.strip()
try:
payload = json.loads(stripped[start:])
except json.JSONDecodeError:
return text.strip()
if not isinstance(payload, dict) or not payload:
return text.strip()
keys = set(payload)
if not keys.issubset(_LEAKED_JSON_ID_KEYS):
return text.strip()
return stripped[:start].strip()
def _clean_answer_text(text: str) -> str:
@@ -104,6 +179,10 @@ def _clean_answer_text(text: str) -> str:
Some LLMs output the done() call as text instead of a proper tool call.
This strips out patterns like: done({"answer": "...", ...})
"""
unwrapped = _unwrap_leaked_done_arguments(text)
if unwrapped is not None:
return unwrapped
# Remove done() call pattern from the end of the text
cleaned = _DONE_CALL_PATTERN.sub("", text).strip()
return cleaned if cleaned else text
@@ -122,13 +201,17 @@ def _clean_done_answer(text: str) -> str:
if not text:
return text
unwrapped = _unwrap_leaked_done_arguments(text)
if unwrapped is not None:
return unwrapped
cleaned = text
# Remove leaked JSON in code blocks at the end
cleaned = _LEAKED_JSON_SUFFIX.sub("", cleaned).strip()
# Remove leaked raw JSON objects at the end
cleaned = _LEAKED_JSON_OBJECT.sub("", cleaned).strip()
cleaned = _strip_trailing_id_json_object(cleaned)
# Remove trailing ID patterns
cleaned = _TRAILING_IDS_PATTERN.sub("", cleaned).strip()
@@ -239,6 +322,9 @@ OUTPUT:"""
],
response_format=DynamicModel,
scope="reflect_structured",
max_retries=1,
initial_backoff=0.25,
max_backoff=1.0,
skip_validation=True, # We'll handle the dict ourselves
return_usage=True,
)
@@ -172,6 +172,47 @@ class DispositionTraits(BaseModel):
model_config = ConfigDict(json_schema_extra={"example": {"skepticism": 3, "literalism": 3, "empathy": 3}})
class RecallScores(BaseModel):
"""Per-result recall scores from different stages of the pipeline.
``final`` is the value results are ranked by. The others are diagnostic and
can be filtered on via the recall ``min_scores`` request parameter. ``semantic``
and ``keyword`` are the raw per-strategy retrieval scores (``None`` when that
strategy did not surface this result); ``reranker`` is the cross-encoder's
normalized relevance.
"""
final: float = Field(description="Final ranking score (combined reranker + recency/temporal/proof boosts)")
reranker: float | None = Field(
default=None,
description="Cross-encoder relevance, normalized 0-1. None when the reranker is a passthrough (rrf/interleave modes).",
)
semantic: float | None = Field(
default=None, description="Vector cosine similarity (0-1). None if this result was not surfaced semantically."
)
keyword: float | None = Field(
default=None,
description="Keyword/full-text (BM25) score (>= 0, unbounded). None if this result was not surfaced by keyword search.",
)
class MinScores(BaseModel):
"""Optional per-stage score floors for recall (all inclusive, AND-ed).
``semantic`` and ``keyword`` are **retrieval-level** cutoffs pushed into the SQL
arms (overriding the global ``semantic_min_similarity`` / ``bm25_min_score``
config for this request), so they prune weak matches before fusion. ``reranker``
and ``final`` are **post-query** filters applied to the scored results after
reranking. Any field left None imposes no floor; all-None (the default) means
no score filtering.
"""
semantic: float | None = Field(default=None, description="Retrieval-level: minimum vector similarity (0-1).")
keyword: float | None = Field(default=None, description="Retrieval-level: minimum keyword/full-text (BM25) score.")
reranker: float | None = Field(default=None, description="Post-query: minimum normalized reranker score (0-1).")
final: float | None = Field(default=None, description="Post-query: minimum final ranking score.")
class MemoryFact(BaseModel):
"""
A single memory fact returned by search or think operations.
@@ -202,7 +243,7 @@ class MemoryFact(BaseModel):
id: str = Field(description="Unique identifier for the memory fact")
text: str = Field(description="The actual text content of the memory")
fact_type: str = Field(description="Type of fact: 'world', 'experience', 'opinion', or 'observation'")
fact_type: str = Field(description="Type of fact: 'world', 'experience', or 'observation'")
entities: list[str] | None = Field(None, description="Entity names mentioned in this fact")
context: str | None = Field(None, description="Additional context for the memory")
occurred_start: str | None = Field(None, description="ISO format date when the event started occurring")
@@ -231,6 +272,10 @@ class MemoryFact(BaseModel):
None,
description="IDs of source facts this observation was derived from (observation type only, when source_facts is enabled)",
)
scores: RecallScores | None = Field(
None,
description="Recall scores from each pipeline stage (final/reranker/semantic/keyword). Not returned for source facts.",
)
class ChunkInfo(BaseModel):
@@ -193,7 +193,7 @@ class ExtractedFact(BaseModel):
occurred_start: str | None = Field(default=None, description="ISO timestamp for events")
occurred_end: str | None = Field(default=None, description="ISO timestamp for event end")
fact_type: Literal["world", "assistant"] = Field(
description="'world' = objective/external facts. 'assistant' = first-person actions, experiences, or observations by the speaker."
description="'world' = objective/external facts, including user preferences, rules, corrections, and constraints even when stated during a conversation. 'assistant' = actions, experiences, or observations the assistant/agent actually performed."
)
entities: list[Entity] | None = Field(default=None, description="People, places, concepts")
causal_relations: list[FactCausalRelation] | None = Field(
@@ -296,7 +296,7 @@ class ExtractedFactVerbose(BaseModel):
)
fact_type: Literal["world", "assistant"] = Field(
description="'world' = objective/external facts about other people, events, general knowledge. 'assistant' = first-person actions, experiences, or observations by the speaker (e.g., 'I changed X', 'I discovered Y')."
description="'world' = objective/external facts about the user, other people, events, general knowledge, preferences, rules, corrections, or constraints. 'assistant' = actions, experiences, or observations the assistant/agent actually performed (e.g., 'I changed X', 'I discovered Y')."
)
entities: list[Entity] | None = Field(
@@ -346,7 +346,7 @@ class ExtractedFactNoCausal(BaseModel):
occurred_start: str | None = Field(default=None, description="WHEN the event happened (ISO timestamp).")
occurred_end: str | None = Field(default=None, description="WHEN the event ended (ISO timestamp).")
fact_type: Literal["world", "assistant"] = Field(
description="'world' = about the user/others. 'assistant' = experience with assistant."
description="'world' = about the user/others, including user preferences, rules, corrections, and constraints. 'assistant' = actions or experiences the assistant/agent actually performed."
)
entities: list[Entity] | None = Field(
default=None,
@@ -663,8 +663,8 @@ fact_kind:
- "conversation": Ongoing state, preference, trait (no dates)
fact_type:
- "world": About other people, external events, general knowledge, objective facts
- "assistant": First-person actions, experiences, or observations by the speaker/author (e.g., "I changed X", "I discovered Y", "I debugged Z"). Also includes interactions with the user (requests, recommendations). If the narrator describes something they did, tried, learned, or decided — use "assistant".
- "world": Objective/external facts, including the user's preferences, rules, corrections, constraints, plans, traits, or context. These stay "world" even when the user states them during an assistant interaction (e.g., "User prefers browser_navigate over web_search", "User corrected the project deadline").
- "assistant": Actions, experiences, or observations the assistant/agent actually performed (e.g., "I changed X", "I discovered Y", "I debugged Z"). Use this for the assistant/agent doing, trying, learning, deciding, recommending, or responding — not merely for user facts mentioned in conversation.
══════════════════════════════════════════════════════════════════════════
TEMPORAL HANDLING
@@ -766,7 +766,7 @@ RULES:
- Extract all entities (people, places, organizations, objects, concepts).
- Extract temporal information (occurred_start, occurred_end, fact_kind, when).
- Extract location (where) and people (who).
- fact_type: use "world" unless the content is clearly an interaction with the assistant."""
- fact_type: use "world" for user preferences, rules, corrections, constraints, traits, and other objective facts, even when stated during an assistant interaction. Use "assistant" only for actions or experiences the assistant/agent actually performed."""
VERBATIM_FACT_EXTRACTION_PROMPT = _BASE_FACT_EXTRACTION_PROMPT.format(
retain_mission_section="{retain_mission_section}",
@@ -867,8 +867,8 @@ For CONVERSATIONS (fact_kind="conversation"):
FACT TYPE
══════════════════════════════════════════════════════════════════════════
- **world**: User's life, other people, events (would exist without this conversation)
- **assistant**: Interactions with assistant (requests, recommendations, help)
- **world**: User's life, preferences, rules, corrections, constraints, other people, and events (facts that would exist without this conversation)
- **assistant**: Actions or experiences the assistant/agent actually performed while helping the user (requests, recommendations, help)
⚠️ CRITICAL for assistant facts: ALWAYS capture the user's request/question in the fact!
Include: what the user asked, what problem they wanted solved, what context they provided
@@ -1203,9 +1203,17 @@ def _build_request_body(llm_config, config, prompt: str, user_message: str, resp
request_body = {
"model": llm_config.model,
"messages": [{"role": "system", "content": prompt}, {"role": "user", "content": user_message}],
"temperature": 0.1,
}
# Honour the configured retain temperature. ``None`` omits the parameter
# entirely (for models like Azure GPT-5.5 that reject explicit temperatures),
# mirroring LLMProvider.call, which drops temperature when it is None. The
# batch path builds the request body directly instead of going through
# LLMProvider.call (#2469 only de-hardcoded the streaming path), so it must
# apply the same rule here.
if config.llm_temperature_retain is not None:
request_body["temperature"] = config.llm_temperature_retain
# Add max_completion_tokens if configured
if config.retain_max_completion_tokens:
request_body["max_completion_tokens"] = config.retain_max_completion_tokens
@@ -1314,7 +1322,7 @@ async def _extract_facts_from_chunk(
messages=[{"role": "system", "content": prompt}, {"role": "user", "content": user_message}],
response_format=response_schema,
scope="retain_extract_facts",
temperature=0.1,
temperature=config.llm_temperature_retain,
max_completion_tokens=config.retain_max_completion_tokens,
max_retries=llm_max_retries,
initial_backoff=initial_backoff,
@@ -1814,7 +1822,14 @@ async def extract_facts_from_text(
total_usage = total_usage + chunk_usage
if failed_chunks:
failed_summary = ", ".join(f"chunk {idx}: {type(err).__name__}" for idx, err in failed_chunks[:5])
# Include the exception message — not just the type — so operators
# can tell a structured-JSON parse failure apart from a rate limit
# apart from a network 5xx, all of which can surface as the same
# exception types. The error_message we propagate to the
# async_operations row is the only inspection surface a worker-side
# failure leaves behind, and a bare "chunk 0: RuntimeError" is not
# actionable.
failed_summary = ", ".join(f"chunk {idx}: {type(err).__name__}: {err}" for idx, err in failed_chunks[:5])
quota_errors = [err for _, err in failed_chunks if isinstance(err, ProviderRateLimitResetError)]
if quota_errors and len(quota_errors) == len(failed_chunks):
retry_at = max(err.retry_at for err in quota_errors)
@@ -834,6 +834,28 @@ async def retain_batch(
if first.get("tags"):
existing_content["tags"] = first["tags"]
contents_dicts = [existing_content, *contents_dicts]
# Merge JSON arrays to keep original_text valid (#2409).
# Without this, combined_content joins items with "\n", producing
# "[...]\n[...]" which is not valid JSON. On the next append cycle
# chunk_text() fails to parse it and falls through to sentence-
# boundary text splitting, breaking speaker attribution.
try:
_merged = []
for _item in contents_dicts:
_parsed = json.loads(_item.get("content", ""))
if isinstance(_parsed, list) and all(isinstance(_e, dict) for _e in _parsed):
_merged.extend(_parsed)
else:
_merged = None
break
if _merged is not None:
contents_dicts = [{"content": json.dumps(_merged, ensure_ascii=False)}]
if first.get("context"):
contents_dicts[0]["context"] = first["context"]
if first.get("tags"):
contents_dicts[0]["tags"] = first["tags"]
except (json.JSONDecodeError, ValueError, TypeError):
pass
# Rebuild contents list to match
contents = _build_contents(contents_dicts, document_tags)
log_buffer.append(
@@ -2,7 +2,7 @@
Helper functions for hybrid search (semantic + BM25 + graph).
"""
from .types import MergedCandidate, RetrievalResult
from .types import ArmScores, MergedCandidate, RetrievalResult
def cap_per_source(results: list[RetrievalResult], cap: int) -> list[RetrievalResult]:
@@ -51,6 +51,7 @@ def reciprocal_rank_fusion(result_lists: list[list[RetrievalResult]], k: int = 6
rrf_scores = {}
source_ranks = {} # Track rank from each source for each doc_id
all_retrievals = {} # Store the actual RetrievalResult (use first occurrence)
arm_scores: dict[str, ArmScores] = {} # doc_id -> raw per-strategy scores across arms
source_names = ["semantic", "bm25", "graph", "temporal"]
@@ -79,17 +80,29 @@ def reciprocal_rank_fusion(result_lists: list[list[RetrievalResult]], k: int = 6
if doc_id not in rrf_scores:
rrf_scores[doc_id] = 0.0
source_ranks[doc_id] = {}
arm_scores[doc_id] = ArmScores()
rrf_scores[doc_id] += 1.0 / (k + rank)
source_ranks[doc_id][f"{source_name}_rank"] = rank
# Capture this arm's raw score for the doc (the merged RetrievalResult
# below keeps only the first arm's score, so record each arm here).
if source_name == "semantic" and retrieval.similarity is not None:
arm_scores[doc_id].semantic = retrieval.similarity
elif source_name == "bm25" and retrieval.bm25_score is not None:
arm_scores[doc_id].keyword = retrieval.bm25_score
# Combine into final results with metadata
merged_results = []
for rrf_rank, (doc_id, rrf_score) in enumerate(
sorted(rrf_scores.items(), key=lambda x: x[1], reverse=True), start=1
):
merged_candidate = MergedCandidate(
retrieval=all_retrievals[doc_id], rrf_score=rrf_score, rrf_rank=rrf_rank, source_ranks=source_ranks[doc_id]
retrieval=all_retrievals[doc_id],
rrf_score=rrf_score,
rrf_rank=rrf_rank,
source_ranks=source_ranks[doc_id],
arm_scores=arm_scores[doc_id],
)
merged_results.append(merged_candidate)
@@ -118,6 +131,7 @@ def interleave_fusion(result_lists: list[list[RetrievalResult]]) -> list[MergedC
source_names = ["semantic", "bm25", "graph", "temporal"]
source_ranks: dict[str, dict[str, int]] = {}
all_retrievals: dict[str, RetrievalResult] = {}
arm_scores: dict[str, ArmScores] = {}
for source_idx, results in enumerate(result_lists):
source_name = source_names[source_idx] if source_idx < len(source_names) else f"source_{source_idx}"
@@ -129,6 +143,11 @@ def interleave_fusion(result_lists: list[list[RetrievalResult]]) -> list[MergedC
doc_id = retrieval.id
all_retrievals.setdefault(doc_id, retrieval)
source_ranks.setdefault(doc_id, {})[f"{source_name}_rank"] = rank
arm = arm_scores.setdefault(doc_id, ArmScores())
if source_name == "semantic" and retrieval.similarity is not None:
arm.semantic = retrieval.similarity
elif source_name == "bm25" and retrieval.bm25_score is not None:
arm.keyword = retrieval.bm25_score
# Round-robin pick across arms in priority order: all #1s, then all #2s, ...
ordered_ids: list[str] = []
@@ -151,6 +170,7 @@ def interleave_fusion(result_lists: list[list[RetrievalResult]]) -> list[MergedC
rrf_score=float(n - pos),
rrf_rank=pos + 1,
source_ranks=source_ranks[doc_id],
arm_scores=arm_scores[doc_id],
)
for pos, doc_id in enumerate(ordered_ids)
]
@@ -177,6 +177,9 @@ def apply_combined_scoring(
else:
# Neutral baseline is precisely 0.5, ensuring neutral multiplier (1.0)
proof_norm = 0.5
# Surface the proof signal so the trace can show the proof_count_boost
# factor (otherwise the reranked breakdown can't reconcile CE × boosts).
sr.proof_norm = proof_norm
# RRF: kept at 0.0 for trace continuity but excluded from scoring.
# RRF is batch-relative (min-max normalised) and redundant after reranking.
@@ -104,6 +104,8 @@ async def retrieve_semantic_bm25_combined(
tag_groups: list[TagGroup] | None = None,
created_after: datetime | None = None,
created_before: datetime | None = None,
min_semantic: float | None = None,
min_keyword: float | None = None,
) -> dict[str, tuple[list[RetrievalResult], list[RetrievalResult]]]:
"""
Combined semantic + BM25 retrieval for multiple fact types in a single query.
@@ -143,6 +145,12 @@ async def retrieve_semantic_bm25_combined(
config = get_config()
tokens = tokenize_query(query_text)
# Per-request retrieval-level score floors (recall min_scores.semantic / .keyword)
# override the global config defaults for this query, pruning weak matches in
# the SQL arms before fusion.
sem_min = min_semantic if min_semantic is not None else config.semantic_min_similarity
bm25_min = min_keyword if min_keyword is not None else config.bm25_min_score
# Over-fetch for HNSW approximation; semantic results trimmed to limit in Python.
hnsw_fetch = max(limit * 5, 100)
@@ -203,7 +211,7 @@ async def retrieve_semantic_bm25_combined(
embedding_param="$1",
bank_id_param="$2",
fetch_limit=hnsw_fetch,
min_similarity=config.semantic_min_similarity,
min_similarity=sem_min,
tags_clause=tags_clause,
groups_clause=groups_clause,
extra_where=created_range_clause,
@@ -229,7 +237,7 @@ async def retrieve_semantic_bm25_combined(
arm_index=i,
text_search_extension=text_ext,
bm25_language=config.text_search_extension_native_language,
bm25_min_score=config.bm25_min_score,
bm25_min_score=bm25_min,
extra_where=created_range_clause,
)
)
@@ -277,7 +285,7 @@ async def retrieve_semantic_bm25_combined(
embedding_param="$1",
bank_id_param="$2",
fetch_limit=hnsw_fetch,
min_similarity=config.semantic_min_similarity,
min_similarity=sem_min,
tags_clause=fb_tags_clause,
groups_clause=fb_groups_clause,
extra_where=fb_created_clause,
@@ -706,6 +714,8 @@ async def retrieve_all_fact_types_parallel(
tag_groups: list[TagGroup] | None = None,
created_after: datetime | None = None,
created_before: datetime | None = None,
min_semantic: float | None = None,
min_keyword: float | None = None,
) -> MultiFactTypeRetrievalResult:
"""
Optimized retrieval for multiple fact types using batched queries.
@@ -766,6 +776,8 @@ async def retrieve_all_fact_types_parallel(
tag_groups=tag_groups,
created_after=created_after,
created_before=created_before,
min_semantic=min_semantic,
min_keyword=min_keyword,
)
semantic_bm25_time = time.time() - semantic_bm25_start
@@ -781,7 +793,7 @@ async def retrieve_all_fact_types_parallel(
tc_start,
tc_end,
budget=thinking_budget,
semantic_threshold=0.1,
semantic_threshold=min_semantic if min_semantic is not None else 0.1,
tags=tags,
tags_match=tags_match,
tag_groups=tag_groups,
@@ -5,6 +5,7 @@ Think operation utilities for formulating answers based on agent and world facts
import logging
from datetime import datetime
from ...config import get_config
from ..response_models import DispositionTraits, MemoryFact
logger = logging.getLogger(__name__)
@@ -251,7 +252,7 @@ async def reflect(
answer_text = await llm_config.call(
messages=[{"role": "system", "content": system_message}, {"role": "user", "content": prompt}],
scope="memory_think",
temperature=0.9,
temperature=get_config().llm_temperature_reflect,
max_completion_tokens=1000,
)
@@ -392,7 +392,7 @@ class SearchTracer:
# Extract score components (only include non-None values)
# Keys from ScoredResult.to_dict(): cross_encoder_score, cross_encoder_score_normalized,
# rrf_normalized, temporal, recency, combined_score, weight
# rrf_normalized, temporal, recency, proof_norm, combined_score, weight
score_components = {}
for key in [
"cross_encoder_score",
@@ -401,6 +401,7 @@ class SearchTracer:
"rrf_normalized",
"temporal",
"recency",
"proof_norm",
"combined_score",
]:
if key in result and result[key] is not None:
@@ -82,6 +82,20 @@ class RetrievalResult:
)
@dataclass
class ArmScores:
"""Raw per-strategy retrieval scores for a single doc, aggregated across arms.
Fusion keeps only the first-seen RetrievalResult per doc, so its per-arm score
fields reflect just one arm. This captures each arm's raw score for the same doc
so the recall response can report them (and ``min_scores`` can filter on them).
``None`` means the doc was not surfaced by that arm.
"""
semantic: float | None = None # cosine similarity from the semantic arm
keyword: float | None = None # BM25 / full-text score from the keyword arm
@dataclass
class MergedCandidate:
"""
@@ -97,6 +111,7 @@ class MergedCandidate:
rrf_score: float
rrf_rank: int = 0
source_ranks: dict[str, int] = field(default_factory=dict) # method_name -> rank
arm_scores: "ArmScores" = field(default_factory=lambda: ArmScores()) # raw per-strategy scores
@property
def id(self) -> str:
@@ -123,6 +138,7 @@ class ScoredResult:
rrf_normalized: float = 0.0
recency: float = 0.5
temporal: float = 0.5
proof_norm: float = 0.5 # log-normalized proof count (neutral 0.5); drives proof_count_boost
# Final combined score
combined_score: float = 0.0
@@ -179,6 +195,7 @@ class ScoredResult:
result["rrf_normalized"] = self.rrf_normalized
result["temporal"] = self.temporal
result["recency"] = self.recency
result["proof_norm"] = self.proof_norm
result["combined_score"] = self.combined_score
result["weight"] = self.weight
result["activation"] = self.weight # Legacy field
@@ -39,7 +39,9 @@ from hindsight_api.extensions.operation_validator import (
BankListContext,
BankListResult,
BankReadContext,
BankReadOperation,
BankWriteContext,
BankWriteOperation,
# Consolidation operation
ConsolidateContext,
ConsolidateResult,
@@ -54,6 +56,7 @@ from hindsight_api.extensions.operation_validator import (
OperationValidationError,
OperationValidatorExtension,
PrecheckContext,
PrecheckOperation,
RecallContext,
RecallResult,
ReflectContext,
@@ -87,6 +90,7 @@ __all__ = [
"OperationValidationError",
"OperationValidatorExtension",
"PrecheckContext",
"PrecheckOperation",
"RecallContext",
"RecallResult",
"ReflectContext",
@@ -98,7 +102,9 @@ __all__ = [
"BankListContext",
"BankListResult",
"BankReadContext",
"BankReadOperation",
"BankWriteContext",
"BankWriteOperation",
# Operation Validator - Consolidation
"ConsolidateContext",
"ConsolidateResult",
@@ -3,6 +3,7 @@
from abc import ABC, abstractmethod
from dataclasses import dataclass, field
from datetime import datetime
from enum import StrEnum
from typing import TYPE_CHECKING
from hindsight_api.extensions.base import Extension
@@ -82,6 +83,18 @@ class ValidationResult:
# =============================================================================
class PrecheckOperation(StrEnum):
"""Route operation names passed to the pre-body-parse precheck hook."""
DRY_RUN_EXTRACT = "dry_run_extract"
FILES_RETAIN = "files_retain"
MENTAL_MODEL_CREATE = "mental_model_create"
MENTAL_MODEL_REFRESH = "mental_model_refresh"
RECALL = "recall"
REFLECT = "reflect"
RETAIN = "retain"
@dataclass
class PrecheckContext:
"""Context for a pre-body-parse precheck on an operation.
@@ -91,9 +104,7 @@ class PrecheckContext:
therefore intentionally carries only the cheap, already-resolved
pieces of request state:
- ``operation``: a short string identifying the route, e.g. ``"retain"``,
``"recall"``, ``"reflect"``, ``"files_retain"``, ``"mental_model_create"``,
``"mental_model_refresh"``.
- ``operation``: a short string-compatible enum identifying the route.
- ``bank_id``: parsed from the URL path.
- ``request_context``: the authenticated :class:`RequestContext` (tenant
already resolved by the tenant extension).
@@ -108,7 +119,7 @@ class PrecheckContext:
the source of truth for the precise per-call cost / quota arithmetic.
"""
operation: str
operation: PrecheckOperation
bank_id: str
request_context: "RequestContext"
content_length: int | None = None
@@ -303,12 +314,77 @@ class ConsolidateResult:
# =============================================================================
class BankReadOperation(StrEnum):
"""Bank-scoped read operation names passed to validate_bank_read."""
GET_BANK_CONFIG = "get_bank_config"
GET_BANK_PROFILE = "get_bank_profile"
GET_BANK_STATS = "get_bank_stats"
GET_CHUNK = "get_chunk"
GET_DIRECTIVE = "get_directive"
GET_DOCUMENT = "get_document"
GET_ENTITY = "get_entity"
GET_ENTITY_GRAPH = "get_entity_graph"
GET_ENTITY_STATE = "get_entity_state"
GET_GRAPH_DATA = "get_graph_data"
GET_MEMORIES_TIMESERIES = "get_memories_timeseries"
GET_MEMORY_UNIT = "get_memory_unit"
GET_OBSERVATION_HISTORY = "get_observation_history"
GET_OPERATION_STATUS = "get_operation_status"
LIST_DIRECTIVES = "list_directives"
LIST_DOCUMENT_CHUNKS = "list_document_chunks"
LIST_DOCUMENTS = "list_documents"
LIST_ENTITIES = "list_entities"
LIST_MEMORY_UNITS = "list_memory_units"
LIST_MENTAL_MODEL_TAGS = "list_mental_model_tags"
LIST_MENTAL_MODELS = "list_mental_models"
LIST_OBSERVATION_SCOPES = "list_observation_scopes"
LIST_OPERATIONS = "list_operations"
LIST_TAGS = "list_tags"
LIST_WEBHOOK_DELIVERIES = "list_webhook_deliveries"
LIST_WEBHOOKS = "list_webhooks"
class BankWriteOperation(StrEnum):
"""Bank-scoped write operation names passed to validate_bank_write."""
CANCEL_OPERATION = "cancel_operation"
CLEAR_MENTAL_MODEL = "clear_mental_model"
CLEAR_OBSERVATIONS = "clear_observations"
CLEAR_OBSERVATIONS_FOR_MEMORY = "clear_observations_for_memory"
CREATE_DIRECTIVE = "create_directive"
CREATE_MENTAL_MODEL = "create_mental_model"
CREATE_WEBHOOK = "create_webhook"
DELETE_BANK = "delete_bank"
DELETE_DIRECTIVE = "delete_directive"
DELETE_DOCUMENT = "delete_document"
DELETE_MENTAL_MODEL = "delete_mental_model"
DELETE_WEBHOOK = "delete_webhook"
MERGE_BANK_MISSION = "merge_bank_mission"
REPROCESS_DOCUMENT = "reprocess_document"
RESET_BANK_CONFIG = "reset_bank_config"
RETRY_FAILED_CONSOLIDATION = "retry_failed_consolidation"
RETRY_OPERATION = "retry_operation"
RUN_CONSOLIDATION = "run_consolidation"
SET_BANK_MISSION = "set_bank_mission"
SUBMIT_ASYNC_CONSOLIDATION = "submit_async_consolidation"
SUBMIT_ASYNC_GRAPH_MAINTENANCE = "submit_async_graph_maintenance"
UPDATE_BANK = "update_bank"
UPDATE_BANK_CONFIG = "update_bank_config"
UPDATE_BANK_DISPOSITION = "update_bank_disposition"
UPDATE_DIRECTIVE = "update_directive"
UPDATE_DOCUMENT = "update_document"
UPDATE_MEMORY_UNIT = "update_memory_unit"
UPDATE_MENTAL_MODEL = "update_mental_model"
UPDATE_WEBHOOK = "update_webhook"
@dataclass
class BankReadContext:
"""Context for a bank read operation validation (pre-operation)."""
bank_id: str
operation: str # "get_bank_profile", "get_bank_stats"
operation: BankReadOperation
request_context: "RequestContext"
@@ -317,7 +393,7 @@ class BankWriteContext:
"""Context for a bank write operation validation (pre-operation)."""
bank_id: str
operation: str # "delete_bank", "update_bank", "update_bank_disposition", "set_bank_mission", "merge_bank_mission", "clear_observations", "clear_observations_for_memory"
operation: BankWriteOperation
request_context: "RequestContext"
+17 -1
View File
@@ -22,7 +22,7 @@ from hindsight_api.config import (
)
from hindsight_api.engine.audit import AuditEntry, AuditLogger
from hindsight_api.engine.memory_engine import Budget
from hindsight_api.engine.response_models import VALID_RECALL_FACT_TYPES
from hindsight_api.engine.response_models import VALID_RECALL_FACT_TYPES, MinScores
from hindsight_api.engine.search.tags import TagGroup
from hindsight_api.extensions import OperationValidationError
from hindsight_api.models import RequestContext
@@ -838,6 +838,7 @@ def _register_recall(mcp: FastMCP, memory: MemoryEngine, config: MCPToolsConfig)
tags_match: str = "any",
tag_groups: list[dict] | None = None,
query_timestamp: str | None = None,
min_scores: dict | None = None,
bank_id: str | None = None,
) -> str | dict:
"""
@@ -858,6 +859,11 @@ def _register_recall(mcp: FastMCP, memory: MemoryEngine, config: MCPToolsConfig)
Mutually exclusive with tags.
query_timestamp: Temporal context for the query (ISO format, e.g., '2024-01-15T10:30:00Z').
Anchors relative temporal expressions and recency scoring.
min_scores: Optional per-stage score floors as an object with any of: "semantic", "keyword"
(retrieval-level cutoffs), "reranker", "final" (post-ranking). E.g. {"reranker": 0.5}.
All inclusive and AND-ed; omit for no score filtering. The reranker's absolute scores are
not calibrated across queries, so only threshold against scores you've calibrated for your
own data.
bank_id: Optional bank to search in (defaults to session bank). Use for cross-bank operations.
"""
try:
@@ -890,6 +896,8 @@ def _register_recall(mcp: FastMCP, memory: MemoryEngine, config: MCPToolsConfig)
recall_kwargs["tag_groups"] = _TAG_GROUP_LIST_ADAPTER.validate_python(tag_groups)
if query_timestamp is not None:
recall_kwargs["question_date"] = parse_timestamp(query_timestamp)
if min_scores is not None:
recall_kwargs["min_scores"] = MinScores.model_validate(min_scores)
recall_result = await memory.recall_async(**recall_kwargs)
@@ -916,6 +924,7 @@ def _register_recall(mcp: FastMCP, memory: MemoryEngine, config: MCPToolsConfig)
tags_match: str = "any",
tag_groups: list[dict] | None = None,
query_timestamp: str | None = None,
min_scores: dict | None = None,
) -> dict:
"""
Args:
@@ -935,6 +944,11 @@ def _register_recall(mcp: FastMCP, memory: MemoryEngine, config: MCPToolsConfig)
Mutually exclusive with tags.
query_timestamp: Temporal context for the query (ISO format, e.g., '2024-01-15T10:30:00Z').
Anchors relative temporal expressions and recency scoring.
min_scores: Optional per-stage score floors as an object with any of: "semantic", "keyword"
(retrieval-level cutoffs), "reranker", "final" (post-ranking). E.g. {"reranker": 0.5}.
All inclusive and AND-ed; omit for no score filtering. The reranker's absolute scores are
not calibrated across queries, so only threshold against scores you've calibrated for your
own data.
"""
try:
target_bank = config.bank_id_resolver()
@@ -966,6 +980,8 @@ def _register_recall(mcp: FastMCP, memory: MemoryEngine, config: MCPToolsConfig)
recall_kwargs["tag_groups"] = _TAG_GROUP_LIST_ADAPTER.validate_python(tag_groups)
if query_timestamp is not None:
recall_kwargs["question_date"] = parse_timestamp(query_timestamp)
if min_scores is not None:
recall_kwargs["min_scores"] = MinScores.model_validate(min_scores)
recall_result = await memory.recall_async(**recall_kwargs)
+83 -77
View File
@@ -32,6 +32,7 @@ from sqlalchemy.pool import NullPool
from ._pg_search import normalize_pg_search_tokenizer, pg_search_bm25_columns
from ._vector_index import (
bootstrap_extension,
configured_vector_extension,
detect_vector_extension,
index_type_keyword,
index_using_clause,
@@ -60,6 +61,86 @@ def _detect_vector_extension(conn, vector_extension: str = "pgvector") -> str:
return detect_vector_extension(conn, vector_extension)
def _ensure_pgvector_extension_in_public(conn: Connection) -> None:
"""Ensure pgvector is installed before pgvector-backed migrations run."""
logger.debug("Checking pgvector extension availability...")
# First, check if extension already exists
ext_check = conn.execute(
text(
"SELECT extname, nspname FROM pg_extension e "
"JOIN pg_namespace n ON e.extnamespace = n.oid "
"WHERE extname = 'vector'"
)
).fetchone()
if ext_check:
# Extension exists - check if in correct schema
ext_schema = ext_check[1]
if ext_schema == "public":
logger.info("pgvector extension found in public schema - ready to use")
else:
# Extension in wrong schema - try to fix if we have permissions
logger.warning(
f"pgvector extension found in schema '{ext_schema}' instead of 'public'. Attempting to relocate..."
)
try:
conn.execute(text("DROP EXTENSION vector CASCADE"))
conn.execute(text("SET search_path TO public"))
conn.execute(text("CREATE EXTENSION vector"))
conn.commit()
logger.info("pgvector extension relocated to public schema")
except Exception as e:
# Failed to relocate - log but don't fail if extension exists somewhere
logger.warning(
f"Could not relocate pgvector extension to public schema: {e}. "
f"Continuing with extension in '{ext_schema}' schema."
)
conn.rollback()
else:
# Extension doesn't exist - try to install
logger.info("pgvector extension not found, attempting to install...")
try:
conn.execute(text("SET search_path TO public"))
conn.execute(text("CREATE EXTENSION vector"))
conn.commit()
logger.info("pgvector extension installed in public schema")
except Exception as e:
# Installation failed - this is only fatal if extension truly doesn't exist
# Check one more time in case another process installed it
conn.rollback()
ext_recheck = conn.execute(
text(
"SELECT nspname FROM pg_extension e "
"JOIN pg_namespace n ON e.extnamespace = n.oid "
"WHERE extname = 'vector'"
)
).fetchone()
if ext_recheck:
logger.warning(
f"Could not install pgvector extension (permission denied?), "
f"but extension exists in '{ext_recheck[0]}' schema. Continuing..."
)
else:
# Extension truly doesn't exist and we can't install it
logger.error(
f"pgvector extension is not installed and cannot be installed: {e}. "
f"Please ensure pgvector is installed by a database administrator. "
f"See: https://github.com/pgvector/pgvector#installation"
)
raise RuntimeError(
"pgvector extension is required but not installed. Please install it with: CREATE EXTENSION vector;"
) from e
def _bootstrap_vector_extension_for_migrations(conn: Connection, vector_extension: str) -> None:
"""Bootstrap the configured vector backend before schema migrations run."""
if vector_extension == "pgvector":
_ensure_pgvector_extension_in_public(conn)
bootstrap_extension(conn, vector_extension)
def _drop_per_bank_vector_indexes(conn: Connection, schema_name: str) -> None:
"""Drop per-bank partial memory_units vector indexes after global ScaNN is ready."""
rows = conn.execute(
@@ -275,83 +356,8 @@ def run_migrations(
logger.debug("Migration advisory lock acquired")
try:
# Ensure pgvector extension is installed globally BEFORE schema migrations
# This is critical: the extension must exist database-wide before any schema
# migrations run, otherwise custom schemas won't have access to vector types
logger.debug("Checking pgvector extension availability...")
# First, check if extension already exists
ext_check = conn.execute(
text(
"SELECT extname, nspname FROM pg_extension e "
"JOIN pg_namespace n ON e.extnamespace = n.oid "
"WHERE extname = 'vector'"
)
).fetchone()
if ext_check:
# Extension exists - check if in correct schema
ext_schema = ext_check[1]
if ext_schema == "public":
logger.info("pgvector extension found in public schema - ready to use")
else:
# Extension in wrong schema - try to fix if we have permissions
logger.warning(
f"pgvector extension found in schema '{ext_schema}' instead of 'public'. "
f"Attempting to relocate..."
)
try:
conn.execute(text("DROP EXTENSION vector CASCADE"))
conn.execute(text("SET search_path TO public"))
conn.execute(text("CREATE EXTENSION vector"))
conn.commit()
logger.info("pgvector extension relocated to public schema")
except Exception as e:
# Failed to relocate - log but don't fail if extension exists somewhere
logger.warning(
f"Could not relocate pgvector extension to public schema: {e}. "
f"Continuing with extension in '{ext_schema}' schema."
)
conn.rollback()
else:
# Extension doesn't exist - try to install
logger.info("pgvector extension not found, attempting to install...")
try:
conn.execute(text("SET search_path TO public"))
conn.execute(text("CREATE EXTENSION vector"))
conn.commit()
logger.info("pgvector extension installed in public schema")
except Exception as e:
# Installation failed - this is only fatal if extension truly doesn't exist
# Check one more time in case another process installed it
conn.rollback()
ext_recheck = conn.execute(
text(
"SELECT nspname FROM pg_extension e "
"JOIN pg_namespace n ON e.extnamespace = n.oid "
"WHERE extname = 'vector'"
)
).fetchone()
if ext_recheck:
logger.warning(
f"Could not install pgvector extension (permission denied?), "
f"but extension exists in '{ext_recheck[0]}' schema. Continuing..."
)
else:
# Extension truly doesn't exist and we can't install it
logger.error(
f"pgvector extension is not installed and cannot be installed: {e}. "
f"Please ensure pgvector is installed by a database administrator. "
f"See: https://github.com/pgvector/pgvector#installation"
)
raise RuntimeError(
"pgvector extension is required but not installed. "
"Please install it with: CREATE EXTENSION vector;"
) from e
vector_extension = os.getenv("HINDSIGHT_API_VECTOR_EXTENSION", "pgvector").lower()
bootstrap_extension(conn, vector_extension)
vector_extension = configured_vector_extension()
_bootstrap_vector_extension_for_migrations(conn, vector_extension)
# Commit any pending transaction on the advisory-lock connection
# before running migrations. Some code paths above (e.g., the
+52
View File
@@ -1,6 +1,58 @@
import logging
import os
from urllib.parse import urlparse, urlunparse
def detect_container_runtime() -> str | None:
"""Detect whether the process is running inside a container.
Returns "kubernetes", "docker", or None. Used to warn operators that the
default ``socket.gethostname()`` worker id is unstable across container
recreation (the random container id changes on restart, so tasks stuck in
'processing' under the old id are never recovered).
"""
if os.getenv("KUBERNETES_SERVICE_HOST"):
return "kubernetes"
# Docker (and most OCI runtimes) create this marker file in every container.
if os.path.exists("/.dockerenv"):
return "docker"
# cgroup v1 fallback for runtimes that don't write /.dockerenv.
try:
with open("/proc/1/cgroup", encoding="utf-8") as f:
if any(token in f.read() for token in ("docker", "containerd", "kubepods")):
return "docker"
except OSError:
pass
return None
def warn_if_container_default_worker_id(worker_id: str | None) -> None:
"""Warn when worker id will fall back to an unstable container hostname."""
if worker_id:
return
runtime = detect_container_runtime()
if not runtime:
return
logging.warning(
"\n"
"============================================================\n"
" WARNING: HINDSIGHT_API_WORKER_ID is not set and Hindsight\n"
f" appears to be running inside {runtime}.\n"
"\n"
" The worker id is defaulting to the container hostname,\n"
" which CHANGES every time the container is recreated.\n"
" When that happens, tasks left in 'processing' under the\n"
" old hostname are never recovered — consolidation and other\n"
" async operations can get stuck indefinitely.\n"
"\n"
" Set HINDSIGHT_API_WORKER_ID to a STABLE value (e.g. the\n"
" compose service name or StatefulSet pod name) to avoid this.\n"
"============================================================"
)
def mask_network_location(url):
if not url:
return url
@@ -136,7 +136,7 @@ def main():
# Worker options
parser.add_argument(
"--worker-id",
default=config.worker_id or socket.gethostname(),
default=config.worker_id,
help="Worker identifier (default: hostname, env: HINDSIGHT_API_WORKER_ID)",
)
parser.add_argument(
@@ -178,10 +178,17 @@ def main():
# Configure logging
config.configure_logging()
from ..utils import warn_if_container_default_worker_id
warn_if_container_default_worker_id(args.worker_id)
worker_id = args.worker_id or socket.gethostname()
worker_id_source = "HINDSIGHT_API_WORKER_ID/--worker-id" if args.worker_id else "hostname (default)"
logger.info(f"Worker id: {worker_id} (source: {worker_id_source})")
# Import MemoryEngine here to avoid circular imports
from .. import MemoryEngine
print(f"Starting Hindsight Worker: {args.worker_id}")
print(f"Starting Hindsight Worker: {worker_id}")
print(f" Poll interval: {args.poll_interval}ms")
print(f" Max retries: {args.max_retries}")
print(f" Max slots: {config.worker_max_slots}")
@@ -249,7 +256,7 @@ def main():
schema = None if config.database_schema == DEFAULT_DATABASE_SCHEMA else config.database_schema
poller = WorkerPoller(
backend=memory._backend,
worker_id=args.worker_id,
worker_id=worker_id,
executor=memory.execute_task,
poll_interval_ms=args.poll_interval,
schema=schema,
+2 -1
View File
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
[project]
name = "hindsight-api-slim"
version = "0.8.3"
version = "0.8.4"
description = "Hindsight: Agent Memory That Works Like Human Memory"
readme = "README.md"
requires-python = ">=3.11"
@@ -74,6 +74,7 @@ dependencies = [
"pygments>=2.20.0", # ReDoS via inefficient GUID regex fix
"claude-agent-sdk>=0.2.82",
"boto3>=1.42.74",
"croniter>=2.0.0", # Cron parsing for scheduled mental model refresh
]
[project.optional-dependencies]
+45 -4
View File
@@ -11,6 +11,22 @@ import pytest
import pytest_asyncio
from dotenv import load_dotenv
# Force torch to initialize exactly once, in the main thread, at conftest import
# time — before any fixture spins up an event loop or sentence-transformers'
# thread pools. torch's C-level `_add_docstr(_has_torch_function, ...)` in
# torch/overrides.py is not re-entrancy-safe: when the first `import torch`
# happens lazily from inside concurrent/async code (e.g.
# embeddings.initialize() -> sentence_transformers -> transformers -> torch, or
# cross_encoder's ThreadPoolExecutor), torch/overrides.py can execute twice and
# raise "RuntimeError: function '_has_torch_function' already has a docstring",
# failing collection of every test on the pytest-xdist shard. Importing it here
# (single-threaded, before any concurrency) makes that registration happen once
# per worker process. Guarded so slim/no-torch environments still collect.
try:
import torch # noqa: F401 # eager one-time init; see comment above
except ImportError:
pass
from hindsight_api import LLMConfig, LocalSTEmbeddings, MemoryEngine, RequestContext
from hindsight_api.engine.cross_encoder import LocalSTCrossEncoder
from hindsight_api.engine.query_analyzer import DateparserQueryAnalyzer
@@ -38,6 +54,29 @@ async def _teardown_memory_engine(mem: MemoryEngine) -> None:
unregister_span_recorder(mem._llm_recorder)
@pytest.fixture(autouse=True)
def _cleanup_leaked_span_recorders():
"""Fail-safe for the process-global LLM-trace recorder registry (#2229).
``MemoryEngine.__init__`` registers its recorder in the shared registry, and
only ``close()`` removes it. Tests that construct an engine directly (without
``_teardown_memory_engine``/``close()``) leak an *enabled* recorder; a later
test's LLM calls then get recorded into the shared DB, flaking
``test_llm_trace::test_disabled_writes_no_rows`` (it observes rows for its
bank even though its own recorder is disabled). ``_teardown_memory_engine``
guards the fixtures; this guards everything else by dropping any recorder a
test added to the registry.
"""
from hindsight_api.tracing import get_span_recorder
recorders = get_span_recorder()._recorders
before = {id(r) for r in recorders}
yield
for recorder in list(recorders):
if id(recorder) not in before:
recorders.remove(recorder)
# Default pg0 instance configuration for tests
DEFAULT_PG0_INSTANCE_NAME = "hindsight-test"
DEFAULT_PG0_PORT = int(os.environ.get("HINDSIGHT_TEST_PG_PORT", "5556"))
@@ -45,11 +84,13 @@ DEFAULT_PG0_PORT = int(os.environ.get("HINDSIGHT_TEST_PG_PORT", "5556"))
# Keep the background MaintenanceLoop from auto-starting during tests. In
# production it sweeps retention and re-schedules consolidation, but its timers
# would race shared-pg0 test data (e.g. delete llm_requests/audit_log rows a test
# just inserted). Disabling the reconcile interval and llm-trace retention — with
# audit retention already off by default — leaves no job enabled, so the loop
# never starts. Tests that exercise it call MaintenanceLoop methods
# (_run_reconcile / _purge_expired) directly.
# just inserted). Disabling the reconcile interval, the mental-model refresh tick
# and llm-trace retention — with audit retention already off by default — leaves
# no job enabled, so the loop never starts. Tests that exercise it call
# MaintenanceLoop methods (_run_reconcile / _run_scheduled_mm_refresh /
# _purge_expired) directly.
os.environ.setdefault("HINDSIGHT_API_CONSOLIDATION_RECONCILE_INTERVAL_SECONDS", "0")
os.environ.setdefault("HINDSIGHT_API_MENTAL_MODEL_REFRESH_TICK_SECONDS", "0")
os.environ.setdefault("HINDSIGHT_API_LLM_TRACE_RETENTION_DAYS", "-1")
@@ -88,7 +88,10 @@ async def test_backup_tables_covers_entire_schema(backup_test_schema):
await conn.close()
# alembic_version is migration bookkeeping, not data — never backed up.
schema_tables = {r["table_name"] for r in rows} - {"alembic_version"}
# bank_stats_cache is a derived TTL cache of get_bank_stats results: it has no
# FK to banks (so the restore cascade never touches it) and repopulates itself
# on demand, so it is deliberately not backed up — a restore starts it cold.
schema_tables = {r["table_name"] for r in rows} - {"alembic_version", "bank_stats_cache"}
backup_tables = set(BACKUP_TABLES)
missing = schema_tables - backup_tables
@@ -0,0 +1,148 @@
"""Tests for the table-backed (cross-process) get_bank_stats cache.
On PostgreSQL the engine backs `get_bank_stats` with the `bank_stats_cache`
table (`DistributedBankStatsCache`) instead of a per-process dict, so one
worker's computation is shared with every other worker. These tests verify:
* the PG engine actually selects the distributed cache,
* a computed result is written to the table and served from it on the next call,
* invalidation deletes the row so the next call recomputes, and
* an unreachable cache table degrades to computing without caching rather than
failing the endpoint.
"""
import uuid
import pytest
from hindsight_api import RequestContext
from hindsight_api.engine.bank_stats_cache import DistributedBankStatsCache
from hindsight_api.engine.memory_engine import MemoryEngine, get_current_schema
_PINNED_TTL_SECONDS = 300.0
async def _insert_memory(conn, bank_id: str, text: str, fact_type: str = "experience") -> uuid.UUID:
mem_id = uuid.uuid4()
await conn.execute(
"""
INSERT INTO memory_units (id, bank_id, text, fact_type, event_date, created_at, updated_at, consolidated_at)
VALUES ($1, $2, $3, $4, NOW(), NOW(), NOW(), NOW())
""",
mem_id,
bank_id,
text,
fact_type,
)
return mem_id
async def _ensure_bank(memory: MemoryEngine, bank_id: str, request_context: RequestContext) -> None:
await memory.get_bank_profile(bank_id=bank_id, request_context=request_context)
def _pin_distributed_cache(memory: MemoryEngine) -> DistributedBankStatsCache:
cache = DistributedBankStatsCache(backend=memory._backend, ttl_seconds=_PINNED_TTL_SECONDS)
memory._bank_stats_cache = cache
return cache
class TestDistributedBankStatsCache:
@pytest.mark.asyncio
async def test_pg_engine_selects_distributed_cache(self, memory: MemoryEngine):
if memory._database_backend_type != "postgresql":
pytest.skip("distributed cache is PostgreSQL-only")
assert isinstance(memory._bank_stats_cache, DistributedBankStatsCache)
@pytest.mark.asyncio
async def test_result_is_written_and_served_from_table(self, memory: MemoryEngine, request_context: RequestContext):
if memory._database_backend_type != "postgresql":
pytest.skip("distributed cache is PostgreSQL-only")
bank_id = f"test-dist-stats-{uuid.uuid4().hex[:8]}"
await _ensure_bank(memory, bank_id, request_context)
pool = await memory._get_pool()
async with pool.acquire() as conn:
await _insert_memory(conn, bank_id, "Alice loves hiking.")
_pin_distributed_cache(memory)
try:
first = await memory.get_bank_stats(bank_id, request_context=request_context)
assert first["node_counts"].get("experience") == 1
# The computed result was persisted to the shared table.
async with pool.acquire() as conn:
rows = await conn.fetchval("SELECT count(*) FROM bank_stats_cache WHERE bank_id = $1", bank_id)
assert rows == 1
# Mutate the underlying data WITHOUT going through an invalidating
# engine method — the long-TTL cache must serve the stale row.
async with pool.acquire() as conn:
await _insert_memory(conn, bank_id, "Bob enjoys cycling.")
served = await memory.get_bank_stats(bank_id, request_context=request_context)
assert served["node_counts"].get("experience") == 1 # still cached
# Invalidating drops the row → next call recomputes the true count.
await memory._bank_stats_cache.invalidate(get_current_schema(), bank_id)
async with pool.acquire() as conn:
rows = await conn.fetchval("SELECT count(*) FROM bank_stats_cache WHERE bank_id = $1", bank_id)
assert rows == 0
fresh = await memory.get_bank_stats(bank_id, request_context=request_context)
assert fresh["node_counts"].get("experience") == 2
finally:
await memory.delete_bank(bank_id, request_context=request_context)
@pytest.mark.asyncio
async def test_force_refresh_bypasses_and_updates_cache(
self, memory: MemoryEngine, request_context: RequestContext
):
if memory._database_backend_type != "postgresql":
pytest.skip("distributed cache is PostgreSQL-only")
bank_id = f"test-dist-stats-fresh-{uuid.uuid4().hex[:8]}"
await _ensure_bank(memory, bank_id, request_context)
pool = await memory._get_pool()
async with pool.acquire() as conn:
await _insert_memory(conn, bank_id, "Alice loves hiking.")
_pin_distributed_cache(memory)
try:
# Warm the cache, then mutate the data without invalidation.
assert (await memory.get_bank_stats(bank_id, request_context=request_context))["node_counts"][
"experience"
] == 1
async with pool.acquire() as conn:
await _insert_memory(conn, bank_id, "Bob enjoys cycling.")
# A normal read is served the stale cached count...
stale = await memory.get_bank_stats(bank_id, request_context=request_context)
assert stale["node_counts"]["experience"] == 1
# ...but force_refresh recomputes the true count.
fresh = await memory.get_bank_stats(bank_id, request_context=request_context, force_refresh=True)
assert fresh["node_counts"]["experience"] == 2
# The forced result also refreshed the cache for the next caller.
served = await memory.get_bank_stats(bank_id, request_context=request_context)
assert served["node_counts"]["experience"] == 2
finally:
await memory.delete_bank(bank_id, request_context=request_context)
@pytest.mark.asyncio
async def test_degrades_when_cache_table_unreachable(self, memory: MemoryEngine, request_context: RequestContext):
if memory._database_backend_type != "postgresql":
pytest.skip("distributed cache is PostgreSQL-only")
bank_id = f"test-dist-stats-degrade-{uuid.uuid4().hex[:8]}"
await _ensure_bank(memory, bank_id, request_context)
pool = await memory._get_pool()
async with pool.acquire() as conn:
await _insert_memory(conn, bank_id, "Alice loves hiking.")
# Point the cache at a table that does not exist: reads and writes fail,
# so it must fall back to computing the real result (no real table touched).
cache = _pin_distributed_cache(memory)
cache._qualified = lambda schema: '"public".bank_stats_cache_does_not_exist' # type: ignore[method-assign]
try:
stats = await memory.get_bank_stats(bank_id, request_context=request_context)
assert stats["node_counts"].get("experience") == 1
finally:
await memory.delete_bank(bank_id, request_context=request_context)
+60
View File
@@ -395,3 +395,63 @@ def test_rechunk_preserves_one_chunk_id_per_pre_chunk():
chunk_ids.append(f"bank_doc_{global_idx}")
assert len(chunk_ids) == len(set(chunk_ids)), f"duplicate chunk_ids in one batch: {chunk_ids}"
# ---------------------------------------------------------------------------
# Append-mode JSON array merge simulation (issue #2409)
# ---------------------------------------------------------------------------
def test_newline_joined_json_arrays_bypass_conversation_chunking():
"""Newline-joined JSON arrays (the pre-fix append-mode storage format)
fail both the conversation and JSONL detection paths and fall through
to sentence-boundary text splitting.
This test documents the broken state that issue #2409 fixes at the
orchestrator level. chunk_text() itself is not changed; the fix
merges the arrays before they reach chunk_text().
"""
turn1 = json.dumps([{"role": "user", "content": "Hello"}, {"role": "assistant", "content": "Hi there"}])
turn2 = json.dumps([{"role": "user", "content": "How are you"}, {"role": "assistant", "content": "Fine"}])
corrupted = turn1 + "\n" + turn2
chunks = chunk_text(corrupted, max_chars=80)
# The corrupted format does NOT route through _chunk_conversation.
# At least one chunk will not be a valid JSON array of dicts.
has_non_json_chunk = False
for chunk in chunks:
try:
parsed = json.loads(chunk)
if not (isinstance(parsed, list) and all(isinstance(e, dict) for e in parsed)):
has_non_json_chunk = True
except json.JSONDecodeError:
has_non_json_chunk = True
assert has_non_json_chunk, (
"Newline-joined JSON arrays should NOT produce valid conversation chunks. "
"If this fails, chunk_text() learned to handle the format and the "
"orchestrator-level merge in #2409 may be redundant."
)
def test_merged_json_array_routes_to_conversation_chunking():
"""A properly merged flat JSON array (the post-fix format) routes
through _chunk_conversation and produces chunks that are each valid
JSON arrays of complete message dicts.
"""
messages = [
{"role": "user", "content": "Hello"},
{"role": "assistant", "content": "Hi there"},
{"role": "user", "content": "How are you"},
{"role": "assistant", "content": "Fine, thanks for asking"},
]
text = json.dumps(messages)
chunks = chunk_text(text, max_chars=120)
assert len(chunks) > 1, "Should produce multiple chunks at this budget"
for chunk in chunks:
parsed = json.loads(chunk)
assert isinstance(parsed, list), f"Chunk must be a JSON array: {chunk[:60]}"
assert all(isinstance(e, dict) for e in parsed), f"Every element must be a dict: {chunk[:60]}"
assert all("role" in e for e in parsed), f"Every element must have a role key: {chunk[:60]}"
@@ -3619,3 +3619,39 @@ def test_consolidation_prompt_split_is_cacheable_and_complete():
)
assert "OBSERVATION LIMIT REACHED" in capped
assert "OBSERVATION LIMIT REACHED" not in sys_prompt
@pytest.mark.asyncio
async def test_create_observation_populates_search_vector_native(memory, request_context):
"""Observations created via consolidation must have search_vector populated
when text_search_extension == 'native', so BM25 retrieval finds them."""
from hindsight_api.config import get_config
config = get_config()
if config.text_search_extension != "native":
pytest.skip("Only applies to native text search backend")
bank_id = f"test-search-vector-{uuid.uuid4().hex[:8]}"
await memory.get_bank_profile(bank_id=bank_id, request_context=request_context)
await memory.retain_async(
bank_id=bank_id,
content="Django uses middleware for request processing.",
request_context=request_context,
)
async with memory._pool.acquire() as conn:
row = await conn.fetchrow(
"""
SELECT search_vector
FROM memory_units
WHERE bank_id = $1 AND fact_type = 'observation'
LIMIT 1
""",
bank_id,
)
assert row is not None, "Consolidation should have created an observation"
assert row["search_vector"] is not None, "search_vector must be populated for BM25 retrieval under native backend"
await memory.delete_bank(bank_id, request_context=request_context)
@@ -84,7 +84,13 @@ def _ctx(threshold: float = 0.97):
conn=conn,
memory_engine=types.SimpleNamespace(embeddings=object()),
bank_id="bank1",
config=types.SimpleNamespace(consolidation_dedup_threshold=threshold),
# The merge path builds a search_vector UPDATE clause from the text-search
# config, so these must be present (production defaults: native/english).
config=types.SimpleNamespace(
consolidation_dedup_threshold=threshold,
text_search_extension="native",
text_search_extension_native_language="english",
),
dedup_llm_config=llm,
create_text="YouTube content in Uzbek is very rich.",
create_source_ids=[uuid.uuid4()],
@@ -126,6 +132,16 @@ async def test_dedup_llm_keep_does_not_merge() -> None:
conn.execute.assert_not_called() # kept distinct → no merge
async def test_dedup_llm_missing_action_defaults_to_keep() -> None:
kwargs, conn, llm = _ctx()
llm.call.return_value = _DedupDecision(reason="underfilled structured response")
with _patch_embed(), _patch_probe([_obs("Uzbek content on YouTube is described as very rich.", 0.98)]):
result = await _dedup_reconcile_create(**kwargs)
assert result is None
llm.call.assert_awaited_once()
conn.execute.assert_not_called() # missing action is a conservative no-merge
async def test_dedup_llm_merge_folds_into_twin() -> None:
kwargs, conn, llm = _ctx()
kwargs["create_source_ids"] = [uuid.uuid4(), uuid.uuid4()]
@@ -169,7 +185,13 @@ def _update_ctx(threshold: float = 0.97):
conn=conn,
memory_engine=types.SimpleNamespace(embeddings=object()),
bank_id="bank1",
config=types.SimpleNamespace(consolidation_dedup_threshold=threshold),
# The merge path builds a search_vector UPDATE clause from the text-search
# config, so these must be present (production defaults: native/english).
config=types.SimpleNamespace(
consolidation_dedup_threshold=threshold,
text_search_extension="native",
text_search_extension_native_language="english",
),
dedup_llm_config=llm,
updated_id=_UPDATED_ID,
updated_text="Uzbek content on YouTube is very rich and growing.",
@@ -0,0 +1,69 @@
"""Tests for container-runtime detection used to warn about unstable worker ids."""
import builtins
from hindsight_api.utils import detect_container_runtime, warn_if_container_default_worker_id
def test_detects_kubernetes_via_env(monkeypatch):
monkeypatch.setenv("KUBERNETES_SERVICE_HOST", "10.0.0.1")
assert detect_container_runtime() == "kubernetes"
def test_detects_docker_via_dockerenv(monkeypatch):
monkeypatch.delenv("KUBERNETES_SERVICE_HOST", raising=False)
monkeypatch.setattr("os.path.exists", lambda p: p == "/.dockerenv")
assert detect_container_runtime() == "docker"
def test_detects_docker_via_cgroup(monkeypatch):
monkeypatch.delenv("KUBERNETES_SERVICE_HOST", raising=False)
monkeypatch.setattr("os.path.exists", lambda p: False)
real_open = builtins.open
def fake_open(path, *args, **kwargs):
if path == "/proc/1/cgroup":
import io
return io.StringIO("12:devices:/docker/abcdef123456\n")
return real_open(path, *args, **kwargs)
monkeypatch.setattr("builtins.open", fake_open)
assert detect_container_runtime() == "docker"
def test_returns_none_when_not_containerized(monkeypatch):
monkeypatch.delenv("KUBERNETES_SERVICE_HOST", raising=False)
monkeypatch.setattr("os.path.exists", lambda p: False)
def fake_open(path, *args, **kwargs):
raise OSError("no such file")
monkeypatch.setattr("builtins.open", fake_open)
assert detect_container_runtime() is None
def test_warns_when_default_worker_id_is_used_in_container(monkeypatch, caplog):
monkeypatch.setattr("hindsight_api.utils.detect_container_runtime", lambda: "docker")
warn_if_container_default_worker_id(None)
assert "HINDSIGHT_API_WORKER_ID is not set" in caplog.text
assert "appears to be running inside docker" in caplog.text
def test_skips_warning_when_worker_id_is_explicit(monkeypatch, caplog):
monkeypatch.setattr("hindsight_api.utils.detect_container_runtime", lambda: "docker")
warn_if_container_default_worker_id("worker-1")
assert caplog.text == ""
def test_skips_warning_outside_containers(monkeypatch, caplog):
monkeypatch.setattr("hindsight_api.utils.detect_container_runtime", lambda: None)
warn_if_container_default_worker_id(None)
assert caplog.text == ""
@@ -77,6 +77,9 @@ def _make_tool_call_response(tool_name: str = "search_observations") -> MagicMoc
mock_response.usage.prompt_tokens = 100
mock_response.usage.completion_tokens = 20
mock_response.usage.total_tokens = 120
# Explicit None: an auto-MagicMock here is truthy, so the reasoning-token
# accounting (#2378) would do arithmetic on a MagicMock and crash.
mock_response.usage.completion_tokens_details = None
mock_response.choices[0].finish_reason = "tool_calls"
mock_response.choices[0].message.content = None
mock_response.choices[0].message.tool_calls = [mock_tc]
+46 -12
View File
@@ -9,11 +9,19 @@ from fastapi.testclient import TestClient
from hindsight_api.extensions import (
ApiKeyTenantExtension,
AuthenticationError,
BankReadContext,
BankReadOperation,
BankWriteContext,
BankWriteOperation,
# Consolidation operation
ConsolidateContext,
ConsolidateResult,
Extension,
HttpExtension,
OperationValidationError,
OperationValidatorExtension,
PrecheckContext,
PrecheckOperation,
RecallContext,
RecallResult,
ReflectContext,
@@ -21,13 +29,8 @@ from hindsight_api.extensions import (
RequestContext,
RetainContext,
RetainResult,
TenantContext,
TenantExtension,
ValidationResult,
load_extension,
# Consolidation operation
ConsolidateContext,
ConsolidateResult,
)
@@ -68,6 +71,36 @@ class TestExtensionLoader:
await ext.on_shutdown()
assert ext.stopped
def test_operation_enums_remain_string_compatible(self):
"""Operation enums centralize names without breaking string comparisons."""
request_context = RequestContext(tenant_id="tenant-1")
precheck_ctx = PrecheckContext(
bank_id="bank-1",
operation=PrecheckOperation.RETAIN,
request_context=request_context,
)
read_ctx = BankReadContext(
bank_id="bank-1",
operation=BankReadOperation.GET_BANK_STATS,
request_context=request_context,
)
write_ctx = BankWriteContext(
bank_id="bank-1",
operation=BankWriteOperation.UPDATE_BANK_CONFIG,
request_context=request_context,
)
assert precheck_ctx.operation is PrecheckOperation.RETAIN
assert read_ctx.operation is BankReadOperation.GET_BANK_STATS
assert write_ctx.operation is BankWriteOperation.UPDATE_BANK_CONFIG
assert precheck_ctx.operation == "retain"
assert read_ctx.operation == "get_bank_stats"
assert write_ctx.operation == "update_bank_config"
assert isinstance(precheck_ctx.operation, str)
assert isinstance(read_ctx.operation, str)
assert isinstance(write_ctx.operation, str)
class LifecycleTestExtension(Extension):
"""Test extension for config and lifecycle tests."""
@@ -356,6 +389,7 @@ class TestOperationHooksParameters:
async def test_recall_pre_hook_receives_all_parameters(self, memory_with_tracking_validator):
"""Pre-recall hook receives all user-provided parameters."""
from datetime import datetime, timezone
from hindsight_api.engine.memory_engine import Budget
memory, validator = memory_with_tracking_validator
@@ -882,7 +916,7 @@ class TestPrecheckDefault:
validator = RecordingPrecheckValidator(reject=False)
# Bypass our override by calling the base implementation directly.
ctx = PrecheckContext(
operation="retain",
operation=PrecheckOperation.RETAIN,
bank_id="bank-x",
request_context=RequestContext(),
)
@@ -914,7 +948,7 @@ class TestPrecheckHttpWiring:
from fastapi import Depends, FastAPI, HTTPException, Request
from pydantic import BaseModel, model_validator
from hindsight_api.extensions import PrecheckContext
from hindsight_api.extensions import PrecheckContext, PrecheckOperation
from hindsight_api.models import RequestContext
body_parses: list[str] = []
@@ -949,7 +983,7 @@ class TestPrecheckHttpWiring:
async def _request_context() -> RequestContext:
return RequestContext()
def _precheck_for(operation: str):
def _precheck_for(operation: PrecheckOperation):
async def _dep(
bank_id: str,
request: Request,
@@ -985,7 +1019,7 @@ class TestPrecheckHttpWiring:
async def retain(
bank_id: str,
body: _RetainBody,
_: None = Depends(_precheck_for("retain")),
_: None = Depends(_precheck_for(PrecheckOperation.RETAIN)),
):
return {"ok": True, "bank_id": bank_id, "n": len(body.items)}
@@ -993,7 +1027,7 @@ class TestPrecheckHttpWiring:
async def recall(
bank_id: str,
body: _RecallBody,
_: None = Depends(_precheck_for("recall")),
_: None = Depends(_precheck_for(PrecheckOperation.RECALL)),
):
return {"ok": True}
@@ -1001,7 +1035,7 @@ class TestPrecheckHttpWiring:
async def reflect(
bank_id: str,
body: _ReflectBody,
_: None = Depends(_precheck_for("reflect")),
_: None = Depends(_precheck_for(PrecheckOperation.REFLECT)),
):
return {"ok": True}
@@ -1168,7 +1202,7 @@ class TestPrecheckHttpWiring:
content_length = parsed
ctx = PrecheckContext(
operation="retain",
operation=PrecheckOperation.RETAIN,
bank_id="bank-x",
request_context=RequestContext(),
content_length=content_length,
@@ -77,6 +77,37 @@ async def test_dry_run_extracts_without_persisting(api_client, memory):
assert after["total"] == before["total"]
@pytest.mark.asyncio
async def test_dry_run_does_not_create_missing_bank(api_client, memory):
bank_id = f"dryrun-missing-{uuid.uuid4().hex[:8]}"
request_context = RequestContext()
assert (
await memory.get_bank_profile(
bank_id=bank_id,
request_context=request_context,
create_if_missing=False,
)
is None
)
resp = await api_client.post(
f"/v1/default/banks/{bank_id}/memories/dry-run-extract",
json={"content": "Alice moved to Berlin in 2021."},
)
assert resp.status_code == 200, resp.text
assert resp.json()["facts"]
assert (
await memory.get_bank_profile(
bank_id=bank_id,
request_context=request_context,
create_if_missing=False,
)
is None
)
@pytest.mark.asyncio
async def test_dry_run_rejects_empty_content(api_client, memory):
"""Empty/whitespace-only content is rejected by request validation (422) before the
@@ -27,6 +27,13 @@ def llm_config():
api_key=config.retain_llm_api_key or config.llm_api_key,
model=config.retain_llm_model or config.llm_model,
base_url=config.retain_llm_base_url or config.llm_base_url,
# LLMConfig uses these as-passed and no longer reads them from global config,
# so the caller must forward the Vertex AI settings (mirrors MemoryEngine's
# own LLMConfig construction). Without this, provider=vertexai raises
# "HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID is required" even when it is set.
vertexai_project_id=config.llm_vertexai_project_id,
vertexai_region=config.llm_vertexai_region,
vertexai_service_account_key=config.llm_vertexai_service_account_key,
)
@@ -0,0 +1,41 @@
from unittest.mock import MagicMock
from hindsight_api.engine.retain.fact_extraction import (
ExtractedFact,
ExtractedFactNoCausal,
ExtractedFactVerbose,
_build_extraction_prompt_and_schema,
)
def _baseline_config() -> MagicMock:
config = MagicMock()
config.entity_labels = None
config.entities_allow_free_form = True
config.retain_extraction_mode = "concise"
config.retain_extract_causal_links = False
config.retain_mission = None
config.retain_custom_instructions = None
config.llm_output_language = None
return config
def test_concise_prompt_keeps_user_preferences_rules_and_corrections_world():
prompt, _ = _build_extraction_prompt_and_schema(_baseline_config())
assert '"world": Objective/external facts' in prompt
assert "user's preferences, rules, corrections, constraints" in prompt
assert 'These stay "world" even when the user states them during an assistant interaction' in prompt
assert "Use this for the assistant/agent doing" in prompt
assert "not merely for user facts mentioned in conversation" in prompt
def test_fact_type_schema_descriptions_distinguish_user_facts_from_agent_actions():
for model in (ExtractedFact, ExtractedFactVerbose, ExtractedFactNoCausal):
description = model.model_fields["fact_type"].description
assert description is not None
assert "preferences" in description
assert "rules" in description
assert "corrections" in description
assert "assistant/agent actually performed" in description
@@ -30,6 +30,7 @@ def _make_config(llm_max_retries: int = 3, retain_llm_max_retries: int | None =
cfg.retain_extraction_mode = "concise"
cfg.retain_extract_causal_links = False
cfg.retain_mission = None
cfg.llm_temperature_retain = 0.1
return cfg
@@ -216,3 +217,43 @@ async def test_none_event_date_with_valid_facts_no_crash():
assert len(facts) == 1
assert "Alice visited Paris" in facts[0].fact
def _make_batch_temp_config(temperature):
"""Minimal config for _build_request_body temperature tests."""
from hindsight_api.config import HindsightConfig
cfg = MagicMock(spec=HindsightConfig)
cfg.llm_temperature_retain = temperature
cfg.retain_max_completion_tokens = None
cfg.llm_strict_schema = False
return cfg
def _make_batch_llm_config():
"""Minimal LLMProvider mock for _build_request_body (non-openai skips service_tier)."""
from hindsight_api.engine.llm_wrapper import LLMProvider
llm = MagicMock(spec=LLMProvider)
llm.model = "gpt-test"
llm.provider = "mock"
return llm
def test_build_request_body_forwards_configured_temperature():
"""Batch retain path must send the configured retain temperature."""
from hindsight_api.engine.retain.fact_extraction import _build_request_body
body = _build_request_body(_make_batch_llm_config(), _make_batch_temp_config(0.7), "sys", "user", dict)
assert body["temperature"] == 0.7
def test_build_request_body_omits_temperature_when_none():
"""HINDSIGHT_API_LLM_TEMPERATURE=none must drop temperature from the batch
request body too (Azure GPT-5.5 rejects explicit temperatures). Follow-up to
#2469, which only de-hardcoded the streaming path and left the batch
_build_request_body hardcoding temperature=0.1."""
from hindsight_api.engine.retain.fact_extraction import _build_request_body
body = _build_request_body(_make_batch_llm_config(), _make_batch_temp_config(None), "sys", "user", dict)
assert "temperature" not in body
@@ -617,6 +617,59 @@ async def test_file_conversion_creates_separate_retain_operation(memory_no_llm_v
assert len(doc["original_text"]) > 0
@pytest.mark.asyncio
async def test_list_operations_surfaces_file_document_id_and_filename(memory_no_llm_verify, sample_txt_content):
"""list_operations must expose document_id + filename for file_convert_retain ops.
The control plane derives its pending-upload rows from these fields (it
matches an in-flight operation to the real document via document_id and
labels the row with the original filename), so both must round-trip from
the operation's result_metadata into the list response.
"""
from hindsight_api.models import RequestContext
bank_id = "test_file_op_fields_bank"
context = RequestContext(internal=True)
await memory_no_llm_verify.get_bank_profile(bank_id, request_context=context)
class MockFile:
def __init__(self, content, filename, content_type):
self.content = content
self.filename = filename
self.content_type = content_type
async def read(self):
return self.content
file_items = [
{
"file": MockFile(sample_txt_content, "report.txt", "text/plain"),
"document_id": "doc_op_fields",
"context": None,
"metadata": {},
"tags": [],
"timestamp": None,
"parser": ["markitdown"],
}
]
await memory_no_llm_verify.submit_async_file_retain(
bank_id=bank_id,
file_items=file_items,
document_tags=None,
request_context=context,
)
result = await memory_no_llm_verify.list_operations(
bank_id, task_type="file_convert_retain", request_context=context
)
file_ops = [op for op in result["operations"] if op["task_type"] == "file_convert_retain"]
assert len(file_ops) == 1
assert file_ops[0]["document_id"] == "doc_op_fields"
assert file_ops[0]["filename"] == "report.txt"
@pytest.mark.asyncio
async def test_async_file_retain_serializes_datetime_timestamp(memory_no_llm_verify, sample_txt_content):
"""Async file retain should accept Python datetimes in task payloads."""
@@ -106,8 +106,6 @@ def test_gemini_llm_no_safety_settings_is_none():
@pytest.mark.asyncio
async def test_call_applies_safety_settings():
"""call() includes safety_settings in GenerateContentConfig when configured."""
from google.genai import types as genai_types
provider = _make_gemini_provider(safety_settings=SAMPLE_SAFETY_SETTINGS)
# Build a fake successful response
@@ -319,8 +317,12 @@ async def test_with_config_resets_after_call():
# ─── LLMProvider reads safety settings from config ────────────────────────────
def test_llm_provider_reads_safety_settings_from_config():
"""LLMProvider reads llm_gemini_safety_settings from global config for Gemini provider."""
def test_llm_provider_from_env_reads_safety_settings():
"""from_env() resolves llm_gemini_safety_settings from the environment.
The constructor itself is config-free; the env-reading factory supplies the
server default (the engine builds do the same from config).
"""
import json
from hindsight_api.config import ENV_LLM_GEMINI_SAFETY_SETTINGS, clear_config_cache
@@ -338,12 +340,7 @@ def test_llm_provider_reads_safety_settings_from_config():
mock_client_cls.return_value = MagicMock()
from hindsight_api.engine.llm_wrapper import LLMProvider
provider = LLMProvider(
provider="gemini",
api_key="fake-key",
base_url="",
model="gemini-2.5-flash",
)
provider = LLMProvider.from_env()
assert provider.gemini_safety_settings == SAMPLE_SAFETY_SETTINGS
@@ -165,6 +165,12 @@ async def test_full_api_workflow(api_client, test_bank_id):
assert "total_nodes" in stats
assert stats["total_nodes"] > 0
# ?refresh=true forces a fresh recompute, bypassing the cache; same shape.
response = await api_client.get(f"/v1/default/banks/{test_bank_id}/stats?refresh=true")
assert response.status_code == 200
fresh_stats = response.json()
assert fresh_stats["total_nodes"] == stats["total_nodes"]
# Verify bank list returns stats (fact_count, last_document_at)
response = await api_client.get("/v1/default/banks")
assert response.status_code == 200
@@ -1354,6 +1360,26 @@ async def test_patch_config_persists_override_for_uncreated_bank(api_client, fie
assert response.json()["name"] == test_bank_id
@pytest.mark.asyncio
async def test_patch_bank_does_not_create_missing_bank(api_client):
"""PATCH /banks/{bank_id} updates existing banks only."""
test_bank_id = f"patch_missing_bank_{datetime.now().timestamp()}"
response = await api_client.patch(
f"/v1/default/banks/{test_bank_id}",
json={"name": "Should Not Exist"},
)
assert response.status_code == 404, response.text
assert response.json()["detail"] == f"Bank '{test_bank_id}' not found"
profile = await api_client.get(f"/v1/default/banks/{test_bank_id}/profile")
assert profile.status_code == 404, profile.text
banks = await api_client.get("/v1/default/banks")
assert banks.status_code == 200, banks.text
assert test_bank_id not in {bank["bank_id"] for bank in banks.json()["banks"]}
@pytest.mark.hs_llm_core
@pytest.mark.asyncio
async def test_full_api_workflow_llm_quality(api_client_real_llm):
@@ -0,0 +1,241 @@
"""HTTP + engine integration tests for the knowledge base (folders + pages).
Pages are seeded directly via the engine (deterministic content, no LLM) so the
tree, OKF projection, move/rename, and cascade-delete behaviour can be asserted
without consolidation.
"""
import urllib.parse
import uuid
import pytest_asyncio
from hindsight_api.engine.memory_engine import MemoryEngine
def _enc(bank_id: str) -> str:
return urllib.parse.quote(bank_id, safe="")
class _Seed:
"""Holds the ids created by the seed fixture for assertions."""
def __init__(self, **ids):
self.__dict__.update(ids)
@pytest_asyncio.fixture
async def kb_bank(memory: MemoryEngine, request_context):
"""A bank with folders, nested folders, and pages."""
bank_id = f"test-kb-{uuid.uuid4().hex[:8]}"
runbooks = await memory.create_knowledge_folder(bank_id, "Runbooks", request_context=request_context)
policies = await memory.create_knowledge_folder(bank_id, "Policies", request_context=request_context)
sub = await memory.create_knowledge_folder(
bank_id, "Sub", parent_id=runbooks["id"], request_context=request_context
)
orders = await memory.create_knowledge_page(
bank_id,
"Orders",
"What are the order facts?",
"# Orders\n\nOne row per order.",
parent_id=runbooks["id"],
tags=["type:runbook", "sales", "revenue"],
request_context=request_context,
)
billing = await memory.create_knowledge_page(
bank_id,
"Billing",
"What is the billing policy?",
"# Billing\n\nNet-30.",
parent_id=policies["id"],
tags=["type:policy", "revenue"],
request_context=request_context,
)
loose = await memory.create_knowledge_page(
bank_id,
"Loose",
"A root page.",
"# Loose\n\nNo folder, no tags.",
tags=[],
request_context=request_context,
)
yield (
bank_id,
_Seed(
runbooks=runbooks["id"],
policies=policies["id"],
sub=sub["id"],
orders=orders["id"],
billing=billing["id"],
loose=loose["id"],
orders_mm=orders["mental_model_id"],
),
)
await memory.delete_bank(bank_id, request_context=request_context)
class TestTree:
async def test_nested_tree(self, api_client, kb_bank):
bank_id, ids = kb_bank
resp = await api_client.get(f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/tree")
assert resp.status_code == 200, resp.text
roots = {r["name"]: r for r in resp.json()["roots"]}
assert set(roots) == {"Runbooks", "Policies", "Loose"}
runbooks = roots["Runbooks"]
assert runbooks["kind"] == "folder"
child_names = {c["name"] for c in runbooks["children"]}
assert child_names == {"Sub", "Orders"}
orders = next(c for c in runbooks["children"] if c["name"] == "Orders")
assert orders["kind"] == "page"
# Human-created pages are pinned (not curator-managed).
assert orders["managed"] is False
assert "sales" in orders["tags"]
assert roots["Loose"]["kind"] == "page"
class TestPageDefaults:
"""A knowledge page is a living document by default: observation-only, delta,
auto-refreshing, with a larger token budget than a plain mental model."""
async def test_default_trigger_and_max_tokens(self, memory: MemoryEngine, request_context):
bank_id = f"test-kb-def-{uuid.uuid4().hex[:8]}"
page = await memory.create_knowledge_page(
bank_id, "P", "What is P?", "seed", request_context=request_context
)
mm = await memory.get_mental_model(bank_id, page["mental_model_id"], request_context=request_context)
assert mm["trigger"] == {
"mode": "delta",
"fact_types": ["observation"],
"exclude_mental_models": True,
"refresh_after_consolidation": True,
}
assert mm["max_tokens"] == 4096
await memory.delete_bank(bank_id, request_context=request_context)
async def test_client_trigger_and_max_tokens_override_defaults(self, memory: MemoryEngine, request_context):
bank_id = f"test-kb-ovr-{uuid.uuid4().hex[:8]}"
page = await memory.create_knowledge_page(
bank_id,
"P",
"What is P?",
"seed",
trigger={"mode": "full", "refresh_after_consolidation": False},
max_tokens=1024,
request_context=request_context,
)
mm = await memory.get_mental_model(bank_id, page["mental_model_id"], request_context=request_context)
assert mm["trigger"]["mode"] == "full"
assert mm["trigger"].get("refresh_after_consolidation") is False
assert mm["max_tokens"] == 1024
await memory.delete_bank(bank_id, request_context=request_context)
class TestGetPage:
async def test_okf_document(self, api_client, kb_bank):
bank_id, ids = kb_bank
resp = await api_client.get(f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/pages/{ids.orders}")
assert resp.status_code == 200, resp.text
page = resp.json()
assert page["type"] == "runbook"
assert page["body"].startswith("# Orders")
assert page["markdown"].startswith("---\n")
assert 'type: "runbook"' in page["markdown"]
async def test_missing_page_404(self, api_client, kb_bank):
bank_id, ids = kb_bank
resp = await api_client.get(f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/pages/nope")
assert resp.status_code == 404
class TestCreate:
async def test_create_folder(self, api_client, kb_bank):
bank_id, ids = kb_bank
resp = await api_client.post(
f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/folders",
json={"name": "Guides", "parent_id": None},
)
assert resp.status_code == 201, resp.text
assert resp.json()["kind"] == "folder"
assert resp.json()["name"] == "Guides"
async def test_create_folder_bad_parent(self, api_client, kb_bank):
bank_id, ids = kb_bank
# parent that is a page, not a folder → 400
resp = await api_client.post(
f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/folders",
json={"name": "Nope", "parent_id": ids.orders},
)
assert resp.status_code == 400
class TestGraphAndExport:
async def test_graph_shared_tag_edge(self, api_client, kb_bank):
bank_id, ids = kb_bank
resp = await api_client.get(f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/graph")
assert resp.status_code == 200, resp.text
data = resp.json()
assert data["total_pages"] == 3
# orders & billing share "revenue"; loose has no tags
assert data["total_edges"] == 1
edge = data["edges"][0]["data"]
assert {edge["source"], edge["target"]} == {ids.orders, ids.billing}
assert edge["sharedTags"] == ["revenue"]
async def test_export_bundle_nested_index(self, api_client, kb_bank):
bank_id, ids = kb_bank
resp = await api_client.get(f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/export")
assert resp.status_code == 200, resp.text
files = {f["path"]: f["content"] for f in resp.json()["files"]}
assert "index.md" in files
assert f"{ids.orders}.md" in files
# index reflects the folder hierarchy
assert "**Runbooks/**" in files["index.md"]
assert "One row per order." in files[f"{ids.orders}.md"]
class TestMoveRenameDelete:
async def test_rename(self, api_client, kb_bank):
bank_id, ids = kb_bank
resp = await api_client.patch(
f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/nodes/{ids.policies}",
json={"name": "Compliance"},
)
assert resp.status_code == 200, resp.text
assert resp.json()["name"] == "Compliance"
async def test_move_into_folder(self, api_client, kb_bank):
bank_id, ids = kb_bank
# move the Loose root page under Policies
resp = await api_client.patch(
f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/nodes/{ids.loose}",
json={"parent_id": ids.policies},
)
assert resp.status_code == 200, resp.text
assert resp.json()["parent_id"] == ids.policies
async def test_move_cycle_rejected(self, api_client, kb_bank):
bank_id, ids = kb_bank
# moving Runbooks under its own descendant Sub must fail
resp = await api_client.patch(
f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/nodes/{ids.runbooks}",
json={"parent_id": ids.sub},
)
assert resp.status_code == 400
async def test_delete_folder_cascades(self, api_client, kb_bank, memory, request_context):
bank_id, ids = kb_bank
# deleting Runbooks removes Sub + Orders (and Orders' mental model)
resp = await api_client.delete(f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/nodes/{ids.runbooks}")
assert resp.status_code == 200, resp.text
tree = (await api_client.get(f"/v1/default/banks/{_enc(bank_id)}/knowledge-base/tree")).json()
root_names = {r["name"] for r in tree["roots"]}
assert "Runbooks" not in root_names
# the backing mental model is gone too
mm = await memory.get_mental_model(bank_id, ids.orders_mm, request_context=request_context)
assert mm is None
+107 -1
View File
@@ -22,6 +22,7 @@ from unittest.mock import AsyncMock, MagicMock, patch
import pytest
EXTRA_BODY = {"temperature": 0.2, "top_p": 0.9}
DEFAULT_HEADERS = {"X-Component-Id": "hindsight", "X-Trace": "abc"}
# ─── config / env parsing ─────────────────────────────────────────────────────
@@ -348,7 +349,7 @@ async def test_gemini_cached_parse_retry_keeps_cached_native_schema():
# ─── LiteLLM ──────────────────────────────────────────────────────────────────
def _make_litellm_provider(extra_body=None):
def _make_litellm_provider(extra_body=None, default_headers=None):
pytest.importorskip("litellm")
from hindsight_api.engine.providers.litellm_llm import LiteLLMLLM
@@ -358,6 +359,7 @@ def _make_litellm_provider(extra_body=None):
base_url="",
model="gpt-4o",
extra_body=extra_body,
default_headers=default_headers,
)
@@ -419,3 +421,107 @@ def test_litellm_router_forwards_extra_body():
extra_body=EXTRA_BODY,
)
assert provider._extra_body == EXTRA_BODY
def test_litellm_stores_default_headers():
provider = _make_litellm_provider(default_headers=DEFAULT_HEADERS)
assert provider._default_headers == DEFAULT_HEADERS
def test_litellm_empty_default_headers_defaults_to_dict():
provider = _make_litellm_provider(default_headers=None)
assert provider._default_headers == {}
@pytest.mark.asyncio
async def test_litellm_call_passes_default_headers_as_extra_headers():
"""``call()`` forwards default_headers to acompletion via ``extra_headers``."""
provider = _make_litellm_provider(default_headers=DEFAULT_HEADERS)
provider._acompletion = AsyncMock(return_value=_fake_litellm_response())
with patch("hindsight_api.engine.providers.litellm_llm.get_metrics_collector"):
await provider.call(messages=[{"role": "user", "content": "hi"}], scope="test", max_retries=0)
assert provider._acompletion.call_args.kwargs.get("extra_headers") == DEFAULT_HEADERS
@pytest.mark.asyncio
async def test_litellm_no_default_headers_omits_extra_headers():
"""``call()`` does not pass ``extra_headers`` when none are configured."""
provider = _make_litellm_provider(default_headers=None)
provider._acompletion = AsyncMock(return_value=_fake_litellm_response())
with patch("hindsight_api.engine.providers.litellm_llm.get_metrics_collector"):
await provider.call(messages=[{"role": "user", "content": "hi"}], scope="test", max_retries=0)
assert "extra_headers" not in provider._acompletion.call_args.kwargs
@pytest.mark.asyncio
async def test_litellm_default_headers_passed_as_fresh_copy():
"""Each call gets its own ``extra_headers`` copy so downstream mutation can't
contaminate the stored headers or other requests."""
provider = _make_litellm_provider(default_headers=DEFAULT_HEADERS)
provider._acompletion = AsyncMock(return_value=_fake_litellm_response())
with patch("hindsight_api.engine.providers.litellm_llm.get_metrics_collector"):
await provider.call(messages=[{"role": "user", "content": "hi"}], scope="test", max_retries=0)
passed = provider._acompletion.call_args.kwargs["extra_headers"]
assert passed == DEFAULT_HEADERS
assert passed is not provider._default_headers
passed["X-Injected"] = "1"
assert "X-Injected" not in provider._default_headers
def test_litellm_default_headers_copied_from_caller_dict():
"""A caller-owned dict cannot be mutated through the provider."""
caller_dict = {"X-Component-Id": "hindsight"}
provider = _make_litellm_provider(default_headers=caller_dict)
caller_dict["X-Mutated"] = "1"
assert "X-Mutated" not in provider._default_headers
def _make_litellm_router_provider(default_headers=None):
pytest.importorskip("litellm")
from hindsight_api.engine.providers.litellm_router_llm import LiteLLMRouterLLM
config = {"model_list": [{"model_name": "default", "litellm_params": {"model": "gpt-4o", "api_key": "x"}}]}
return LiteLLMRouterLLM(
provider="litellmrouter",
api_key="",
base_url="",
model="default",
config=config,
default_headers=default_headers,
)
def test_litellm_router_stores_default_headers():
provider = _make_litellm_router_provider(default_headers=DEFAULT_HEADERS)
assert provider._default_headers == DEFAULT_HEADERS
@pytest.mark.asyncio
async def test_litellm_router_call_passes_default_headers_as_extra_headers():
"""The Router's ``_build_common_kwargs`` override must also forward default_headers
as ``extra_headers`` storage alone doesn't reach the provider behind the Router."""
provider = _make_litellm_router_provider(default_headers=DEFAULT_HEADERS)
provider._acompletion = AsyncMock(return_value=_fake_litellm_response())
with patch("hindsight_api.engine.providers.litellm_llm.get_metrics_collector"):
await provider.call(messages=[{"role": "user", "content": "hi"}], scope="test", max_retries=0)
assert provider._acompletion.call_args.kwargs.get("extra_headers") == DEFAULT_HEADERS
@pytest.mark.asyncio
async def test_litellm_router_no_default_headers_omits_extra_headers():
"""The Router omits ``extra_headers`` entirely when none are configured."""
provider = _make_litellm_router_provider(default_headers=None)
provider._acompletion = AsyncMock(return_value=_fake_litellm_response())
with patch("hindsight_api.engine.providers.litellm_llm.get_metrics_collector"):
await provider.call(messages=[{"role": "user", "content": "hi"}], scope="test", max_retries=0)
assert "extra_headers" not in provider._acompletion.call_args.kwargs
@@ -45,11 +45,22 @@ def _get_api_key() -> str:
def _make_llm() -> LLMProvider:
# LLMProvider uses provider-specific settings as-passed (it does not resolve
# them from global config), so forward the ones whose providers require them:
# Vertex AI needs project/region, and litellmrouter needs its router config.
# Without these, provider=vertexai/litellmrouter raise at construction.
from hindsight_api.config import get_config
config = get_config()
return LLMProvider(
provider=_PROVIDER,
api_key=_get_api_key(),
base_url=os.environ.get("HINDSIGHT_API_LLM_BASE_URL", ""),
model=_MODEL,
vertexai_project_id=config.llm_vertexai_project_id,
vertexai_region=config.llm_vertexai_region,
vertexai_service_account_key=config.llm_vertexai_service_account_key,
litellmrouter_config=config.llm_litellmrouter_config,
)
@@ -194,6 +194,7 @@ def _make_router_provider(config: dict[str, Any], mock_router: Any) -> LiteLLMRo
provider.model = "unused"
provider.reasoning_effort = "low"
provider.timeout = 300.0
provider._default_headers = {}
provider.config = config
provider._litellm = fake_litellm
provider._router = mock_router
@@ -0,0 +1,73 @@
"""Tests for per-operation LLM temperature configuration from environment variables.
Covers the resolution order (per-operation env -> global env -> built-in default)
and the "omit" sentinels that drop the temperature parameter for models that reject
explicit temperatures (e.g. Azure gpt-5.5 -- see issue #2459).
"""
import pytest
from hindsight_api.config import HindsightConfig, _parse_temperature
_OP_FIELDS = {
"HINDSIGHT_API_LLM_TEMPERATURE_VERIFICATION": ("llm_temperature_verification", 0.0),
"HINDSIGHT_API_LLM_TEMPERATURE_RETAIN": ("llm_temperature_retain", 0.1),
"HINDSIGHT_API_LLM_TEMPERATURE_REFLECT": ("llm_temperature_reflect", 0.9),
"HINDSIGHT_API_LLM_TEMPERATURE_CONSOLIDATION": ("llm_temperature_consolidation", 0.0),
}
def _clear_temperature_env(monkeypatch) -> None:
monkeypatch.delenv("HINDSIGHT_API_LLM_TEMPERATURE", raising=False)
for env_name in _OP_FIELDS:
monkeypatch.delenv(env_name, raising=False)
def test_defaults_preserve_historical_values(monkeypatch):
_clear_temperature_env(monkeypatch)
config = HindsightConfig.from_env()
for _, (field, default) in _OP_FIELDS.items():
assert getattr(config, field) == default
def test_global_override_applies_to_all_operations(monkeypatch):
_clear_temperature_env(monkeypatch)
monkeypatch.setenv("HINDSIGHT_API_LLM_TEMPERATURE", "0.2")
config = HindsightConfig.from_env()
for _, (field, _default) in _OP_FIELDS.items():
assert getattr(config, field) == 0.2
def test_global_none_omits_temperature_everywhere(monkeypatch):
_clear_temperature_env(monkeypatch)
monkeypatch.setenv("HINDSIGHT_API_LLM_TEMPERATURE", "none")
config = HindsightConfig.from_env()
for _, (field, _default) in _OP_FIELDS.items():
assert getattr(config, field) is None
def test_per_operation_override_beats_global(monkeypatch):
_clear_temperature_env(monkeypatch)
monkeypatch.setenv("HINDSIGHT_API_LLM_TEMPERATURE", "none")
monkeypatch.setenv("HINDSIGHT_API_LLM_TEMPERATURE_RETAIN", "0.5")
config = HindsightConfig.from_env()
assert config.llm_temperature_retain == 0.5
# Other operations still follow the global "none" (omit).
assert config.llm_temperature_reflect is None
@pytest.mark.parametrize("sentinel", ["none", "NONE", "default", "off", "unset", "", " "])
def test_omit_sentinels(sentinel):
assert _parse_temperature(sentinel) is None
def test_parse_temperature_rejects_out_of_range():
with pytest.raises(ValueError):
_parse_temperature("2.5")
with pytest.raises(ValueError):
_parse_temperature("-0.1")
def test_parse_temperature_rejects_non_numeric():
with pytest.raises(ValueError):
_parse_temperature("warm")
@@ -0,0 +1,99 @@
"""End-to-end checks that per-operation temperature reaches the LLM call.
These drive the real pipeline with the mock LLM provider (which records the
``temperature`` it receives) and assert that each operation forwards the
configured value -- including ``None``, which omits the parameter for models
that reject explicit temperatures (issue #2459).
Config resolution itself is unit-tested in ``test_llm_temperature_env.py``;
here we verify the value is actually threaded through to ``provider.call()``.
"""
from datetime import datetime, timezone
import pytest
from hindsight_api.config import clear_config_cache
from hindsight_api.engine.search import think_utils
def _calls_for_scope(memory, scope: str) -> list[dict]:
"""Collect mock call records for a scope across the engine's LLM configs.
retain/reflect/consolidation each wrap a distinct provider instance, so a
given scope only lands on one of them; gather from all and filter.
"""
seen_impls: dict[int, object] = {}
for config in (
memory._llm_config,
memory._retain_llm_config,
memory._reflect_llm_config,
memory._consolidation_llm_config,
):
impl = config._provider_impl
seen_impls[id(impl)] = impl
calls: list[dict] = []
for impl in seen_impls.values():
calls.extend(impl.get_mock_calls())
return [c for c in calls if c.get("scope") == scope]
@pytest.mark.asyncio
async def test_retain_forwards_configured_temperature(memory, request_context):
"""Retain's fact extraction must call the LLM with the retain temperature (0.1 default)."""
bank_id = f"test_temp_retain_{datetime.now(timezone.utc).timestamp()}"
try:
await memory.retain_async(
bank_id=bank_id,
content="Alice is a senior engineer at TechCorp. She works on distributed systems.",
context="team overview",
event_date=datetime(2024, 1, 15, tzinfo=timezone.utc),
request_context=request_context,
)
extract_calls = _calls_for_scope(memory, "retain_extract_facts")
assert extract_calls, "retain should have made a fact-extraction LLM call"
assert all(c["temperature"] == 0.1 for c in extract_calls)
finally:
await memory.delete_bank(bank_id, request_context=request_context)
@pytest.mark.asyncio
async def test_reflect_think_forwards_configured_temperature(memory):
"""The reflect 'thinking' path must call the LLM with the reflect temperature (0.9 default)."""
reflect_config = memory._reflect_llm_config
reflect_config._provider_impl.clear_mock_calls()
await think_utils.reflect(
llm_config=reflect_config,
query="What does Alice work on?",
world_facts=["Alice works on distributed systems."],
)
think_calls = [c for c in reflect_config._provider_impl.get_mock_calls() if c["scope"] == "memory_think"]
assert think_calls, "reflect should have made a memory_think LLM call"
assert all(c["temperature"] == 0.9 for c in think_calls)
@pytest.mark.asyncio
async def test_global_none_omits_temperature_on_real_call(memory, monkeypatch):
"""HINDSIGHT_API_LLM_TEMPERATURE=none must omit (None) the temperature on a live call."""
monkeypatch.setenv("HINDSIGHT_API_LLM_TEMPERATURE", "none")
clear_config_cache()
try:
reflect_config = memory._reflect_llm_config
reflect_config._provider_impl.clear_mock_calls()
await think_utils.reflect(
llm_config=reflect_config,
query="What does Alice work on?",
world_facts=["Alice works on distributed systems."],
)
think_calls = [c for c in reflect_config._provider_impl.get_mock_calls() if c["scope"] == "memory_think"]
assert think_calls, "reflect should have made a memory_think LLM call"
assert all(c["temperature"] is None for c in think_calls), "temperature should be omitted"
finally:
# Restore the cached config so later tests see default temperatures.
clear_config_cache()
@@ -0,0 +1,179 @@
"""Plumbing tests for the per-operation / global LLM request defaults (issue #2452).
These assert the *wiring* that a resolved timeout / retry policy actually reaches
the provider that uses it not just that the env var parses into config (covered by
test_config_validation.py).
The values are threaded
``config -> MemoryEngine per-op resolve -> LLMProvider -> (create_llm_provider /
call())``. Before the fix the per-operation ``*_llm_timeout`` / ``*_llm_max_retries`` /
``*_llm_initial_backoff`` / ``*_llm_max_backoff`` fields (and even the global ``llm_*``)
were resolved into ``HindsightConfig`` but never reached the provider, so a configured
``HINDSIGHT_API_RETAIN_LLM_TIMEOUT`` silently used the global default
(``LiteLLM call exceeded timeout=120.0s``) and the per-op retry knobs were inert.
"""
import pytest
from hindsight_api.config import DEFAULT_LLM_TIMEOUT
from hindsight_api.engine.llm_wrapper import LLMConfig
def _mock_llm(**kwargs) -> LLMConfig:
return LLMConfig(provider="mock", api_key="", base_url="", model="m", **kwargs)
def _spy_provider_call(monkeypatch, llm: LLMConfig) -> dict:
"""Replace the provider impl's call() with a kwargs-capturing stub."""
captured: dict = {}
async def fake_call(**kwargs):
captured.update(kwargs)
return "ok"
monkeypatch.setattr(llm._provider_impl, "call", fake_call)
return captured
def test_litellm_provider_impl_receives_timeout():
"""LLMConfig -> create_llm_provider -> LiteLLMLLM carries the resolved timeout."""
llm = LLMConfig(provider="litellm", api_key="k", base_url="", model="gpt-4o-mini", timeout=300.0)
assert llm.timeout == 300.0
assert llm._provider_impl.timeout == 300.0
def test_openai_compatible_provider_impl_receives_timeout():
"""The OpenAI-compatible path (openai/groq/ollama/...) carries the timeout too."""
llm = LLMConfig(provider="openai", api_key="k", base_url="", model="gpt-4o-mini", timeout=250.0)
assert llm._provider_impl.timeout == 250.0
def test_timeout_none_falls_back_to_provider_default():
"""No timeout passed -> provider falls back to its env/DEFAULT_LLM_TIMEOUT default.
Guards against a regression where threading the value would override the
long-standing default for callers that never configured a timeout.
"""
llm = LLMConfig(provider="litellm", api_key="k", base_url="", model="gpt-4o-mini")
assert llm._provider_impl.timeout == DEFAULT_LLM_TIMEOUT
@pytest.fixture
def _clean_timeout_env(monkeypatch):
"""Mock provider + verification off, with all timeout env vars cleared."""
from hindsight_api.config import clear_config_cache
monkeypatch.setenv("HINDSIGHT_API_SKIP_LLM_VERIFICATION", "true")
monkeypatch.setenv("HINDSIGHT_API_LLM_PROVIDER", "mock")
monkeypatch.setenv("HINDSIGHT_API_LLM_MODEL", "default-model")
for op in ("LLM", "RETAIN_LLM", "REFLECT_LLM", "CONSOLIDATION_LLM"):
for knob in ("TIMEOUT", "MAX_RETRIES", "INITIAL_BACKOFF", "MAX_BACKOFF"):
monkeypatch.delenv(f"HINDSIGHT_API_{op}_{knob}", raising=False)
clear_config_cache()
yield
clear_config_cache()
async def test_call_uses_instance_retry_defaults(monkeypatch):
"""call() falls back to the provider's configured retry policy when no per-call
arg is given this is what makes a per-op ``*_llm_max_retries`` take effect."""
llm = _mock_llm(max_retries=7, initial_backoff=2.0, max_backoff=9.0)
captured = _spy_provider_call(monkeypatch, llm)
await llm.call(messages=[{"role": "user", "content": "hi"}], scope="x")
assert captured["max_retries"] == 7
assert captured["initial_backoff"] == 2.0
assert captured["max_backoff"] == 9.0
async def test_call_explicit_arg_overrides_instance_default(monkeypatch):
"""An explicit per-call value still wins over the configured default."""
llm = _mock_llm(max_retries=7)
captured = _spy_provider_call(monkeypatch, llm)
await llm.call(messages=[{"role": "user", "content": "hi"}], scope="x", max_retries=2)
assert captured["max_retries"] == 2
async def test_call_falls_back_to_method_default_when_unconfigured(monkeypatch):
"""No instance config and no per-call arg -> the method's own fallback (10),
so providers built outside MemoryEngine (from_env, tests) are unchanged."""
llm = _mock_llm()
captured = _spy_provider_call(monkeypatch, llm)
await llm.call(messages=[{"role": "user", "content": "hi"}], scope="x")
assert captured["max_retries"] == 10
assert captured["initial_backoff"] == 1.0
assert captured["max_backoff"] == 60.0
def test_memory_engine_threads_per_operation_timeout(monkeypatch, _clean_timeout_env):
"""Each per-operation override reaches its own LLM config; the rest fall back
to the global ``llm_timeout``."""
from hindsight_api import MemoryEngine
from hindsight_api.config import clear_config_cache
monkeypatch.setenv("HINDSIGHT_API_LLM_TIMEOUT", "100")
monkeypatch.setenv("HINDSIGHT_API_RETAIN_LLM_TIMEOUT", "300")
monkeypatch.setenv("HINDSIGHT_API_CONSOLIDATION_LLM_TIMEOUT", "450")
# reflect intentionally unset -> inherits the global 100
clear_config_cache()
engine = MemoryEngine(skip_llm_verification=True)
assert engine._llm_config.timeout == 100.0
assert engine._retain_llm_config.timeout == 300.0
assert engine._reflect_llm_config.timeout == 100.0
assert engine._consolidation_llm_config.timeout == 450.0
def test_memory_engine_threads_per_operation_retry_policy(monkeypatch, _clean_timeout_env):
"""Per-op retry/backoff overrides reach their own config; unset ops fall back
to the global ``llm_max_retries`` / ``llm_initial_backoff`` / ``llm_max_backoff``."""
from hindsight_api import MemoryEngine
from hindsight_api.config import clear_config_cache
monkeypatch.setenv("HINDSIGHT_API_LLM_MAX_RETRIES", "4")
monkeypatch.setenv("HINDSIGHT_API_LLM_INITIAL_BACKOFF", "0.5")
monkeypatch.setenv("HINDSIGHT_API_LLM_MAX_BACKOFF", "20")
monkeypatch.setenv("HINDSIGHT_API_REFLECT_LLM_MAX_RETRIES", "2")
monkeypatch.setenv("HINDSIGHT_API_CONSOLIDATION_LLM_MAX_BACKOFF", "99")
clear_config_cache()
engine = MemoryEngine(skip_llm_verification=True)
# Global applies everywhere unless overridden.
assert engine._llm_config.max_retries == 4
assert engine._retain_llm_config.max_retries == 4
# reflect overrides only max_retries; backoff inherits global.
assert engine._reflect_llm_config.max_retries == 2
assert engine._reflect_llm_config.initial_backoff == 0.5
# consolidation overrides only max_backoff; retries inherit global.
assert engine._consolidation_llm_config.max_retries == 4
assert engine._consolidation_llm_config.max_backoff == 99.0
def test_memory_engine_per_op_defaults_to_global_default(_clean_timeout_env):
"""With nothing configured, every operation uses the documented global defaults."""
from hindsight_api import MemoryEngine
from hindsight_api.config import (
DEFAULT_LLM_INITIAL_BACKOFF,
DEFAULT_LLM_MAX_BACKOFF,
DEFAULT_LLM_MAX_RETRIES,
)
engine = MemoryEngine(skip_llm_verification=True)
for cfg in (
engine._llm_config,
engine._retain_llm_config,
engine._reflect_llm_config,
engine._consolidation_llm_config,
):
assert cfg.timeout == DEFAULT_LLM_TIMEOUT
assert cfg.max_retries == DEFAULT_LLM_MAX_RETRIES
assert cfg.initial_backoff == DEFAULT_LLM_INITIAL_BACKOFF
assert cfg.max_backoff == DEFAULT_LLM_MAX_BACKOFF
+231 -2
View File
@@ -10,11 +10,13 @@ success/error paths, and the HTTP read API (list / stats / tokens).
import asyncio
import json
from datetime import datetime, timezone
from types import SimpleNamespace
from unittest.mock import AsyncMock
import httpx
import pytest
import pytest_asyncio
from pydantic import BaseModel
from pydantic import BaseModel, ValidationError
from hindsight_api import tracing
from hindsight_api.api import create_app
@@ -206,6 +208,234 @@ async def test_wrapper_error_forwarded_and_reraised(registered_recorder):
assert "kaboom" in r.error
class _StashThenRaiseProvider:
"""Provider impl that mimics a successful call whose response carries usage,
then fails locally during parsing/validation (#2387)."""
def __init__(self, usage: llm_trace.LLMResponseUsage | None, exc: Exception):
self._usage = usage
self._exc = exc
async def call(self, **_kwargs):
if self._usage is not None:
llm_trace.stash_response_usage(self._usage)
raise self._exc
async def call_with_tools(self, **_kwargs):
if self._usage is not None:
llm_trace.stash_response_usage(self._usage)
raise self._exc
@pytest.mark.asyncio
async def test_wrapper_error_attaches_provider_usage_on_parse_failure(registered_recorder):
"""When the provider call succeeds (and reports usage) but local parsing/
validation raises, the error trace keeps the provider-reported tokens."""
llm = LLMProvider(provider="mock", api_key="", base_url="", model="mock")
llm._provider_impl = _StashThenRaiseProvider(
usage=llm_trace.LLMResponseUsage(input_tokens=321, output_tokens=12, cached_tokens=64),
exc=ValueError("invalid structured output"),
)
with pytest.raises(ValueError, match="invalid structured output"):
await llm.call(messages=[{"role": "user", "content": "x"}], scope="memory")
assert len(registered_recorder.records) == 1
r = registered_recorder.records[0]
assert r.status == "error"
assert r.input_tokens == 321
assert r.output_tokens == 12
assert r.cached_tokens == 64
assert r.total_tokens == 333
# contextvar is unwound after the call so the next call starts clean
assert llm_trace.current_response_usage() is None
@pytest.mark.asyncio
async def test_wrapper_error_without_provider_usage_records_zero(registered_recorder):
"""A failure before any response (no usage stashed) still records 0 tokens."""
llm = LLMProvider(provider="mock", api_key="", base_url="", model="mock")
llm._provider_impl = _StashThenRaiseProvider(usage=None, exc=RuntimeError("connection reset"))
with pytest.raises(RuntimeError, match="connection reset"):
await llm.call(messages=[{"role": "user", "content": "x"}], scope="memory")
r = registered_recorder.records[0]
assert r.status == "error"
assert r.input_tokens is None
assert r.output_tokens is None
assert r.cached_tokens is None
@pytest.mark.asyncio
async def test_wrapper_tools_error_attaches_provider_usage(registered_recorder):
"""The tool-calling path forwards provider usage onto error traces too."""
llm = LLMProvider(provider="mock", api_key="", base_url="", model="mock")
llm._provider_impl = _StashThenRaiseProvider(
usage=llm_trace.LLMResponseUsage(input_tokens=50, output_tokens=5),
exc=ValueError("bad tool args"),
)
with pytest.raises(ValueError, match="bad tool args"):
await llm.call_with_tools(
messages=[{"role": "user", "content": "x"}],
tools=[],
scope="tools",
)
r = registered_recorder.records[0]
assert r.status == "error"
assert r.input_tokens == 50
assert r.output_tokens == 5
# ── real provider: structured-output failure keeps provider usage (#2387) ─────
class _Extracted(BaseModel):
"""Stand-in for a retain fact-extraction schema."""
fact: str
def _openai_response_with_usage(content: str):
"""A successful OpenAI-shaped response carrying usage, like the provider sees
right before it parses/validates ``content``."""
message = SimpleNamespace(content=content, tool_calls=None, refusal=None)
choice = SimpleNamespace(finish_reason="stop", message=message)
usage = SimpleNamespace(
prompt_tokens=140,
completion_tokens=18,
total_tokens=158,
prompt_tokens_details=SimpleNamespace(cached_tokens=20),
)
return SimpleNamespace(error=None, usage=usage, choices=[choice])
@pytest.mark.asyncio
async def test_retain_extract_json_parse_failure_keeps_usage(registered_recorder):
"""The provider call succeeds (and reports usage) but returns non-JSON for a
structured request; the retain-extraction error trace keeps the tokens."""
llm = LLMProvider(provider="openai", api_key="test-key", base_url="https://example.test/v1", model="gpt-4o-mini")
llm._provider_impl._client.chat.completions.create = AsyncMock(
return_value=_openai_response_with_usage("not valid json at all")
)
with pytest.raises(json.JSONDecodeError):
await llm.call(
messages=[{"role": "user", "content": "extract facts"}],
response_format=_Extracted,
scope="retain_extract_facts",
max_retries=0,
)
assert len(registered_recorder.records) == 1
r = registered_recorder.records[0]
assert r.status == "error"
assert r.scope == "retain_extract_facts"
assert r.input_tokens == 140
assert r.output_tokens == 18
assert r.cached_tokens == 20
assert r.total_tokens == 158
@pytest.mark.asyncio
async def test_retain_extract_validation_failure_keeps_usage(registered_recorder):
"""Valid JSON that doesn't match the schema fails ``model_validate`` locally
after a successful (billed) provider call; usage must survive."""
llm = LLMProvider(provider="openai", api_key="test-key", base_url="https://example.test/v1", model="gpt-4o-mini")
# Parses fine, but ``fact`` is missing → pydantic ValidationError.
llm._provider_impl._client.chat.completions.create = AsyncMock(
return_value=_openai_response_with_usage('{"wrong_field": 1}')
)
with pytest.raises(ValidationError):
await llm.call(
messages=[{"role": "user", "content": "extract facts"}],
response_format=_Extracted,
scope="retain_extract_facts",
max_retries=0,
)
r = registered_recorder.records[0]
assert r.status == "error"
assert r.input_tokens == 140
assert r.output_tokens == 18
assert r.cached_tokens == 20
@pytest.mark.asyncio
async def test_retain_extract_success_records_usage_once(registered_recorder):
"""Sanity check the happy path the failure tests are contrasted against:
valid structured output records a single success trace with the same usage."""
llm = LLMProvider(provider="openai", api_key="test-key", base_url="https://example.test/v1", model="gpt-4o-mini")
llm._provider_impl._client.chat.completions.create = AsyncMock(
return_value=_openai_response_with_usage('{"fact": "the sky is blue"}')
)
result = await llm.call(
messages=[{"role": "user", "content": "extract facts"}],
response_format=_Extracted,
scope="retain_extract_facts",
max_retries=0,
)
assert isinstance(result, _Extracted)
assert len(registered_recorder.records) == 1
r = registered_recorder.records[0]
assert r.status == "success"
assert r.input_tokens == 140
assert r.output_tokens == 18
assert r.cached_tokens == 20
# ── real provider: litellm tool-call arg-parse failure keeps usage (#2387) ────
def _litellm_tool_response_with_usage(arguments: str):
"""A successful LiteLLM (OpenAI-shaped) tool-call response carrying usage,
like ``call_with_tools`` sees right before it ``json.loads`` the tool
arguments."""
function = SimpleNamespace(name="extract", arguments=arguments)
tool_call = SimpleNamespace(id="call_1", function=function)
message = SimpleNamespace(content=None, tool_calls=[tool_call])
choice = SimpleNamespace(finish_reason="tool_calls", message=message)
usage = SimpleNamespace(
prompt_tokens=140,
completion_tokens=18,
total_tokens=158,
prompt_tokens_details=SimpleNamespace(cached_tokens=20),
)
return SimpleNamespace(error=None, usage=usage, choices=[choice])
@pytest.mark.asyncio
async def test_litellm_tool_call_arg_parse_failure_keeps_usage(registered_recorder):
"""The litellm tool path bills the provider response, then ``json.loads`` the
tool-call arguments locally; malformed args raise after billing, so the error
trace must keep the provider-reported tokens. Exercises the real
``LiteLLMLLM.call_with_tools`` stash that ``LiteLLMRouterLLM`` also inherits
(the wrapper-level tools test uses a provider that already stashes)."""
llm = LLMProvider(provider="litellm", api_key="test-key", base_url="https://example.test/v1", model="gpt-4o-mini")
# Valid response + usage, but the tool arguments are not valid JSON.
llm._provider_impl._acompletion = AsyncMock(return_value=_litellm_tool_response_with_usage("{not valid json"))
with pytest.raises(json.JSONDecodeError):
await llm.call_with_tools(
messages=[{"role": "user", "content": "x"}],
tools=[],
scope="tools",
max_retries=0,
)
assert len(registered_recorder.records) == 1
r = registered_recorder.records[0]
assert r.status == "error"
assert r.input_tokens == 140
assert r.output_tokens == 18
assert r.cached_tokens == 20
@pytest.mark.asyncio
async def test_configured_provider_binds_bank_context(registered_recorder):
llm = LLMProvider(provider="mock", api_key="", base_url="", model="mock")
@@ -235,7 +465,6 @@ async def test_engine_teardown_unregisters_recorder_even_when_close_skipped():
leave the registry exactly as it found it.
"""
from hindsight_api import tracing
from tests.conftest import _teardown_memory_engine
sentinel = object()
@@ -35,3 +35,56 @@ from hindsight_api.engine.llm_wrapper import sanitize_llm_output
)
def test_sanitize_llm_output(input_text, expected):
assert sanitize_llm_output(input_text) == expected
def test_llm_provider_constructor_ignores_global_config(monkeypatch):
"""The constructor uses only its arguments — it never reads global config.
Resolving the server-level default for an omitted field is the caller's job
(MemoryEngine's per-op builds, _member_to_llm, and from_env). Keeping the
constructor config-free makes a provider's effective settings a pure function
of its arguments, which is what lets each member of a multi-LLM chain be
configured independently.
"""
import json
from hindsight_api.config import (
ENV_LLM_DEFAULT_HEADERS,
ENV_LLM_PROMPT_CACHE_ENABLED,
clear_config_cache,
)
from hindsight_api.engine.llm_wrapper import LLMProvider
# Global config sets a non-default header map and enables prompt caching...
monkeypatch.setenv(ENV_LLM_DEFAULT_HEADERS, json.dumps({"x-from": "global"}))
monkeypatch.setenv(ENV_LLM_PROMPT_CACHE_ENABLED, "true") # also the global default
clear_config_cache()
# ...but a directly-constructed provider that omits them does NOT inherit them.
provider = LLMProvider(provider="mock", api_key="", base_url="", model="m")
assert provider.default_headers is None
assert provider.prompt_cache_enabled is False # constructor default, not the global True
clear_config_cache()
def test_llm_provider_constructor_ignores_global_safety_settings(monkeypatch):
"""A Gemini provider built directly does not pull safety settings from config."""
import json
from unittest.mock import MagicMock, patch
from hindsight_api.config import ENV_LLM_GEMINI_SAFETY_SETTINGS, clear_config_cache
from hindsight_api.engine.llm_wrapper import LLMProvider
monkeypatch.setenv(
ENV_LLM_GEMINI_SAFETY_SETTINGS,
json.dumps([{"category": "HARM_CATEGORY_HARASSMENT", "threshold": "BLOCK_NONE"}]),
)
clear_config_cache()
with patch("google.genai.Client", return_value=MagicMock()):
provider = LLMProvider(provider="gemini", api_key="k", base_url="", model="gemini-2.5-flash")
assert provider.gemini_safety_settings is None # not inherited from global config
clear_config_cache()
@@ -106,6 +106,9 @@ def _make_tool_call_response(tool_name: str, arguments: dict) -> MagicMock:
mock_response.usage.prompt_tokens = 120
mock_response.usage.completion_tokens = 40
mock_response.usage.total_tokens = 160
# Explicit None: an auto-MagicMock here is truthy, so the reasoning-token
# accounting (#2378) would do arithmetic on a MagicMock and crash.
mock_response.usage.completion_tokens_details = None
mock_response.choices[0].finish_reason = "tool_calls"
mock_response.choices[0].message.content = None
mock_response.choices[0].message.tool_calls = [mock_tc]
@@ -0,0 +1,65 @@
"""Unit tests for the markitdown file parser."""
import json
import pytest
from hindsight_api.engine.parsers.markitdown import MarkitdownParser
@pytest.fixture
def parser() -> MarkitdownParser:
return MarkitdownParser()
def _utf8_json_with_ascii_prefix() -> bytes:
"""A JSON file whose first chunk is ASCII but contains multibyte UTF-8 later.
markitdown samples only the first chunk for charset detection, so this layout
used to be mis-detected as ASCII and crash the JSON/ipynb converter on the
first multibyte byte (0xc3).
"""
payload = {"messages": [{"role": "user", "text": "x" * 6400 + " café à la crème naïve über"}]}
raw = json.dumps(payload, ensure_ascii=False).encode("utf-8")
assert any(b > 127 for b in raw[6000:]), "fixture must have non-ASCII bytes past the sample window"
return raw
async def test_convert_utf8_json_transcript(parser: MarkitdownParser):
"""A UTF-8 JSON transcript with an ASCII prefix parses without a decode error."""
file_data = _utf8_json_with_ascii_prefix()
content = await parser.convert(file_data, "transcript.json")
assert "café" in content
assert "crème" in content
async def test_convert_plain_utf8_text(parser: MarkitdownParser):
"""A plain UTF-8 text file with non-ASCII content round-trips."""
file_data = ("über résumé\n" + "a" * 7000 + "\nfin: naïveté").encode("utf-8")
content = await parser.convert(file_data, "notes.txt")
assert "über" in content
assert "naïveté" in content
def test_utf8_stream_info_for_text_extension():
"""Text files that are valid UTF-8 get an explicit UTF-8 charset hint."""
info = MarkitdownParser._utf8_stream_info("über".encode("utf-8"), "a.json")
assert info is not None
assert info.charset == "utf-8"
def test_utf8_stream_info_skips_binary_extension():
"""Binary files are left to markitdown's own detection (no hint)."""
assert MarkitdownParser._utf8_stream_info(b"%PDF-1.4 ...", "a.pdf") is None
def test_utf8_stream_info_skips_non_utf8_text():
"""Non-UTF-8 text falls back to markitdown's detection (no hint)."""
latin1 = "café".encode("latin-1") # 0xe9, invalid as standalone UTF-8
assert MarkitdownParser._utf8_stream_info(latin1, "a.txt") is None
@@ -0,0 +1,175 @@
"""Tests for cron-scheduled mental model refresh.
Covers the discovery routine ``public.mental_models_with_cron()`` and the
maintenance-loop job ``MaintenanceLoop._run_scheduled_mm_refresh``: a model is
refreshed only when its cron schedule is *due* AND it is *stale* (new memories in
its scope since the last refresh). Deterministic no LLM, refresh submission is
monkeypatched.
"""
import json
import uuid
import pytest
from hindsight_api.api.http import MentalModelTrigger
from hindsight_api.engine.maintenance import MaintenanceLoop
from hindsight_api.engine.memory_engine import MemoryEngine
def test_refresh_cron_and_auto_refresh_are_mutually_exclusive():
"""A trigger cannot set both refresh_after_consolidation and refresh_cron."""
# Either alone is fine.
MentalModelTrigger(refresh_after_consolidation=True)
MentalModelTrigger(refresh_cron="0 3 * * *")
# Both together is rejected.
with pytest.raises(ValueError, match="mutually exclusive"):
MentalModelTrigger(refresh_after_consolidation=True, refresh_cron="0 3 * * *")
async def _make_bank(memory: MemoryEngine, request_context) -> str:
bank_id = f"mmcron-{uuid.uuid4().hex[:8]}"
await memory.get_bank_profile(bank_id=bank_id, request_context=request_context)
return bank_id
async def _insert_mm(
conn,
bank_id: str,
*,
refresh_cron: str | None,
last_refreshed_offset: str,
tags: list[str] | None = None,
) -> str:
"""Insert a pinned mental model. ``last_refreshed_offset`` is an interval
string applied as ``now() - INTERVAL <offset>`` (e.g. '1 day', '0 seconds')."""
mm_id = f"mm-{uuid.uuid4().hex}"
trigger = {"refresh_after_consolidation": False}
if refresh_cron is not None:
trigger["refresh_cron"] = refresh_cron
await conn.execute(
f"""
INSERT INTO mental_models
(id, bank_id, subtype, name, source_query, content, tags, trigger, last_refreshed_at)
VALUES ($1, $2, 'pinned', 'sched model', 'what changed', 'body', $3, $4::jsonb,
now() - INTERVAL '{last_refreshed_offset}')
""",
mm_id,
bank_id,
tags or [],
json.dumps(trigger),
)
return mm_id
async def _insert_fact(conn, bank_id: str, tags: list[str] | None = None) -> None:
await conn.execute(
"INSERT INTO memory_units (id, bank_id, text, fact_type, tags, created_at, updated_at) "
"VALUES ($1, $2, 'a fresh fact', 'experience', $3, now(), now())",
uuid.uuid4(),
bank_id,
tags or [],
)
def _patch_submit(memory: MemoryEngine, monkeypatch) -> list[str]:
submitted: list[str] = []
async def _record(*, bank_id, mental_model_id, request_context):
submitted.append(mental_model_id)
return {"operation_id": str(uuid.uuid4())}
monkeypatch.setattr(memory, "submit_async_refresh_mental_model", _record)
return submitted
@pytest.mark.asyncio
async def test_refresh_cron_round_trips_through_create_and_get(memory: MemoryEngine, request_context):
"""refresh_cron set on a mental model's trigger persists and reads back."""
bank = await _make_bank(memory, request_context)
created = await memory.create_mental_model(
bank_id=bank,
name="scheduled model",
source_query="what changed",
content="body",
trigger={"refresh_after_consolidation": False, "refresh_cron": "0 3 * * *"},
request_context=request_context,
)
fetched = await memory.get_mental_model(bank, created["id"], request_context=request_context)
assert fetched["trigger"]["refresh_cron"] == "0 3 * * *"
@pytest.mark.asyncio
async def test_routine_returns_cron_models_excludes_plain_and_in_flight(memory: MemoryEngine, request_context):
"""The discovery routine returns models with a cron schedule and excludes both
cron-less models and models with an in-flight refresh operation."""
bank = await _make_bank(memory, request_context)
async with memory._pool.acquire() as conn:
cron_mm = await _insert_mm(conn, bank, refresh_cron="*/5 * * * *", last_refreshed_offset="1 day")
plain_mm = await _insert_mm(conn, bank, refresh_cron=None, last_refreshed_offset="1 day")
in_flight_mm = await _insert_mm(conn, bank, refresh_cron="*/5 * * * *", last_refreshed_offset="1 day")
await conn.execute(
"""
INSERT INTO async_operations (operation_id, bank_id, operation_type, status, task_payload)
VALUES ($1, $2, 'refresh_mental_model', 'processing', $3::jsonb)
""",
uuid.uuid4(),
bank,
json.dumps({"mental_model_id": in_flight_mm}),
)
rows = await conn.fetch(
"SELECT mental_model_id FROM public.mental_models_with_cron() WHERE bank_id = $1",
bank,
)
returned = {r["mental_model_id"] for r in rows}
assert cron_mm in returned
assert plain_mm not in returned # no cron -> not a candidate
assert in_flight_mm not in returned # already being refreshed -> excluded
@pytest.mark.asyncio
async def test_due_and_stale_model_is_refreshed(memory: MemoryEngine, request_context, monkeypatch):
"""A model whose cron is due and that has new memories in scope is refreshed."""
bank = await _make_bank(memory, request_context)
async with memory._pool.acquire() as conn:
mm_id = await _insert_mm(conn, bank, refresh_cron="*/5 * * * *", last_refreshed_offset="1 day")
await _insert_fact(conn, bank) # newer than last_refreshed_at -> stale
submitted = _patch_submit(memory, monkeypatch)
await MaintenanceLoop(memory)._run_scheduled_mm_refresh()
assert mm_id in submitted
@pytest.mark.asyncio
async def test_due_but_not_stale_model_is_skipped(memory: MemoryEngine, request_context, monkeypatch):
"""A model whose cron is due but whose scope has no new memories is skipped —
a scheduled refresh must not burn an LLM call to regenerate identical content."""
bank = await _make_bank(memory, request_context)
async with memory._pool.acquire() as conn:
# Cron is due (last refresh a day ago), but no memory_units in this fresh
# bank are newer than last_refreshed_at, so the model is not stale.
mm_id = await _insert_mm(conn, bank, refresh_cron="*/5 * * * *", last_refreshed_offset="1 day")
submitted = _patch_submit(memory, monkeypatch)
await MaintenanceLoop(memory)._run_scheduled_mm_refresh()
assert mm_id not in submitted
@pytest.mark.asyncio
async def test_not_due_model_is_skipped_even_when_stale(memory: MemoryEngine, request_context, monkeypatch):
"""A model whose cron has not elapsed since the last refresh is not refreshed,
even when new memories exist the cron gate, not just staleness, must hold."""
bank = await _make_bank(memory, request_context)
async with memory._pool.acquire() as conn:
# Yearly cron (Jan 1); last refresh seconds ago -> the most recent fire is
# well before last_refreshed_at, so it is not due.
mm_id = await _insert_mm(conn, bank, refresh_cron="0 0 1 1 *", last_refreshed_offset="5 seconds")
await _insert_fact(conn, bank) # stale, but cron not due
submitted = _patch_submit(memory, monkeypatch)
await MaintenanceLoop(memory)._run_scheduled_mm_refresh()
assert mm_id not in submitted
@@ -0,0 +1,155 @@
"""Regression for the consolidator search_vector gap (PR #2425).
Observations written by the consolidator under the ``native`` text-search
backend landed with a NULL ``search_vector`` and were invisible to BM25. The
writer is fixed to populate the tsvector; migration
``c3f7a1b9d2e4`` backfills the historical NULL observations.
This test seeds an observation with a NULL ``search_vector`` at the revision
just before the backfill, runs the migration to head, and asserts the row is
populated with a valid tsvector and that already-populated rows are left
untouched. Uses a dedicated pg0 instance (mirrors test_migration_backsweep) so
it controls exactly which migrations have run and never stamps the shared test
instance.
"""
import asyncio
import uuid
from pathlib import Path
import pytest
from alembic import command
from alembic.config import Config
from sqlalchemy import create_engine, text
_SCRIPT_LOCATION = str(Path(__file__).parent.parent / "hindsight_api" / "alembic")
# Revision immediately before the backfill migration.
_PRE_BACKFILL_REVISION = "f4d1c2b3a5e6"
_BACKFILL_REVISION = "c3f7a1b9d2e4"
def _alembic_cfg(db_url: str) -> Config:
cfg = Config()
cfg.set_main_option("script_location", _SCRIPT_LOCATION)
cfg.set_main_option("sqlalchemy.url", db_url)
cfg.set_main_option("prepend_sys_path", ".")
cfg.set_main_option("path_separator", "os")
return cfg
@pytest.fixture(scope="module")
def pre_backfill_db_url():
"""pg0 instance brought to the revision just before the backfill so the
migration's UPDATE runs against seeded NULL-search_vector observations."""
from hindsight_api.pg0 import EmbeddedPostgres
pg0 = EmbeddedPostgres(name="hindsight-obs-sv-backfill-test", port=5568)
loop = asyncio.new_event_loop()
try:
url = loop.run_until_complete(pg0.ensure_running())
finally:
loop.close()
# pg0 data dirs persist across runs, so normalise: go to head, then down to
# just before the backfill.
command.upgrade(_alembic_cfg(url), "heads")
command.downgrade(_alembic_cfg(url), _PRE_BACKFILL_REVISION)
return url
def test_backfill_populates_null_observation_search_vector(pre_backfill_db_url):
db_url = pre_backfill_db_url
bank_id = f"obs-sv-{uuid.uuid4().hex[:12]}"
null_obs_id = uuid.uuid4()
populated_obs_id = uuid.uuid4()
world_id = uuid.uuid4()
engine = create_engine(db_url)
with engine.connect() as conn:
# Sanity: under the default native backend search_vector is a regular
# tsvector column; otherwise this test wouldn't exercise the gate.
udt = conn.execute(
text(
"""
SELECT udt_name FROM information_schema.columns
WHERE table_name = 'memory_units' AND column_name = 'search_vector'
"""
)
).scalar()
assert udt == "tsvector", f"expected native tsvector backend, got {udt!r}"
conn.execute(text("INSERT INTO banks (bank_id) VALUES (:b)"), {"b": bank_id})
# The bug shape: an observation with NULL search_vector.
conn.execute(
text(
"""
INSERT INTO memory_units (id, bank_id, text, fact_type, search_vector)
VALUES (:id, :b, 'Django uses middleware for request processing', 'observation', NULL)
"""
),
{"id": null_obs_id, "b": bank_id},
)
# An observation already populated — must be left byte-for-byte intact.
conn.execute(
text(
"""
INSERT INTO memory_units (id, bank_id, text, fact_type, search_vector)
VALUES (:id, :b, 'Already indexed observation', 'observation',
to_tsvector('english', 'Already indexed observation'))
"""
),
{"id": populated_obs_id, "b": bank_id},
)
# A non-observation row with NULL search_vector — must NOT be touched
# (the migration is scoped to fact_type = 'observation').
conn.execute(
text(
"""
INSERT INTO memory_units (id, bank_id, text, fact_type, search_vector)
VALUES (:id, :b, 'A world fact', 'world', NULL)
"""
),
{"id": world_id, "b": bank_id},
)
conn.commit()
# Run the backfill.
command.upgrade(_alembic_cfg(db_url), _BACKFILL_REVISION)
with engine.connect() as conn:
null_obs_sv, null_obs_match = conn.execute(
text(
"""
SELECT search_vector IS NOT NULL,
search_vector @@ plainto_tsquery('english', 'middleware')
FROM memory_units WHERE id = :id
"""
),
{"id": null_obs_id},
).fetchone()
assert null_obs_sv, "backfill must populate the NULL observation's search_vector"
assert null_obs_match, "backfilled tsvector must be BM25-searchable on its own text"
populated_match = conn.execute(
text("SELECT search_vector @@ plainto_tsquery('english', 'indexed') FROM memory_units WHERE id = :id"),
{"id": populated_obs_id},
).scalar()
assert populated_match, "pre-populated observation must remain searchable"
world_null = conn.execute(
text("SELECT search_vector IS NULL FROM memory_units WHERE id = :id"),
{"id": world_id},
).scalar()
assert world_null, "non-observation rows must be left untouched by the backfill"
# Idempotency: re-running touches nothing and stays at head.
command.upgrade(_alembic_cfg(db_url), "heads")
with engine.connect() as conn:
still_populated = conn.execute(
text("SELECT search_vector IS NOT NULL FROM memory_units WHERE id = :id"),
{"id": null_obs_id},
).scalar()
assert still_populated
@@ -1,5 +1,5 @@
"""
Startup/lazy model-init must fail fast instead of hanging forever.
Startup model-init must fail fast instead of hanging forever.
Covers issue #1897: if a model load blocks (e.g. an offline HuggingFace
download or an unreachable provider), initialization is capped by a wall-clock
@@ -68,7 +68,7 @@ def test_default_model_init_timeout_is_300s():
@pytest.mark.asyncio
async def test_lazy_reranker_init_fails_fast_on_hang():
async def test_reranker_ensure_initialized_fails_fast_on_hang():
"""A stuck cross-encoder load raises RuntimeError within the timeout, not forever."""
reranker = CrossEncoderReranker(cross_encoder=_HangingCrossEncoder())
config = _make_config(model_init_timeout=0.1)
@@ -81,7 +81,7 @@ async def test_lazy_reranker_init_fails_fast_on_hang():
@pytest.mark.asyncio
async def test_lazy_reranker_init_succeeds_within_timeout():
async def test_reranker_ensure_initialized_succeeds_within_timeout():
"""A fast init completes normally and marks the reranker initialized."""
encoder = _FastCrossEncoder()
reranker = CrossEncoderReranker(cross_encoder=encoder)
@@ -70,7 +70,6 @@ async def test_global_default_dtype_restored_to_float32_after_init():
query_analyzer=_NoopQueryAnalyzer(),
run_migrations=False,
skip_llm_verification=True,
lazy_reranker=False, # load the cross-encoder eagerly, in the gather
task_backend=SyncTaskBackend(),
)
@@ -15,9 +15,13 @@ from hindsight_api.config import (
_parse_llm_strategy,
)
from hindsight_api.engine.llm_wrapper import LLMProvider
from hindsight_api.engine.memory_engine import _build_llm
from hindsight_api.engine.memory_engine import _build_llm, _LLMCallDefaults
from hindsight_api.engine.multi_llm import MultiLLMProvider
# No per-request overrides — exercises the chain-resolution logic without
# touching timeout/retry defaults (those have their own tests).
_NO_CALL_DEFAULTS = _LLMCallDefaults(timeout=None, max_retries=None, initial_backoff=None, max_backoff=None)
@pytest.fixture
def clean_llm_env(monkeypatch):
@@ -83,6 +87,81 @@ def test_parse_members_no_key_provider_ok(clean_llm_env):
assert members[0].api_key is None
def test_parse_members_vertexai_project_and_region(clean_llm_env):
# A vertexai member can carry its own project/region so it can be used as a
# member of a failover/round-robin chain.
clean_llm_env.setenv("HINDSIGHT_API_LLM_1_PROVIDER", "vertexai")
clean_llm_env.setenv("HINDSIGHT_API_LLM_1_VERTEXAI_PROJECT_ID", "p")
clean_llm_env.setenv("HINDSIGHT_API_LLM_1_VERTEXAI_REGION", "us-central1")
members = _parse_llm_members("")
assert members[0].provider == "vertexai"
assert members[0].vertexai_project_id == "p"
assert members[0].vertexai_region == "us-central1"
def test_parse_members_vertexai_per_op_prefix(clean_llm_env):
clean_llm_env.setenv("HINDSIGHT_API_REFLECT_LLM_1_PROVIDER", "vertexai")
clean_llm_env.setenv("HINDSIGHT_API_REFLECT_LLM_1_VERTEXAI_PROJECT_ID", "reflect-proj")
clean_llm_env.setenv("HINDSIGHT_API_REFLECT_LLM_1_VERTEXAI_REGION", "europe-west1")
reflect = _parse_llm_members("REFLECT_")
assert reflect[0].vertexai_project_id == "reflect-proj"
assert reflect[0].vertexai_region == "europe-west1"
# The vertex fields are scoped to the prefix; the global chain is unaffected.
assert _parse_llm_members("") == []
def test_parse_members_without_vertexai_fields_default_none(clean_llm_env):
# Non-vertex members (and members that omit the vars) leave the fields None —
# no regression for existing providers.
clean_llm_env.setenv("HINDSIGHT_API_LLM_1_PROVIDER", "ollama")
members = _parse_llm_members("")
assert members[0].vertexai_project_id is None
assert members[0].vertexai_region is None
assert members[0].vertexai_service_account_key is None
assert members[0].litellmrouter_config is None
def test_parse_members_vertexai_service_account_key(clean_llm_env):
# A vertexai member can carry its own service-account key for cross-project
# failover (credentials are otherwise global).
clean_llm_env.setenv("HINDSIGHT_API_LLM_1_PROVIDER", "vertexai")
clean_llm_env.setenv("HINDSIGHT_API_LLM_1_VERTEXAI_PROJECT_ID", "p")
clean_llm_env.setenv("HINDSIGHT_API_LLM_1_VERTEXAI_SERVICE_ACCOUNT_KEY", "/keys/sa.json")
members = _parse_llm_members("")
assert members[0].vertexai_service_account_key == "/keys/sa.json"
def test_parse_members_litellmrouter_config(clean_llm_env):
# A litellmrouter member can carry its own router config so a chain can fail
# over between differently-routed LiteLLM routers.
clean_llm_env.setenv("HINDSIGHT_API_LLM_1_PROVIDER", "litellmrouter")
clean_llm_env.setenv(
"HINDSIGHT_API_LLM_1_LITELLMROUTER_CONFIG",
'{"model_list": [{"model_name": "m"}]}',
)
members = _parse_llm_members("")
assert members[0].litellmrouter_config == {"model_list": [{"model_name": "m"}]}
def test_parse_members_litellmrouter_config_per_op_prefix(clean_llm_env):
clean_llm_env.setenv("HINDSIGHT_API_REFLECT_LLM_1_PROVIDER", "litellmrouter")
clean_llm_env.setenv(
"HINDSIGHT_API_REFLECT_LLM_1_LITELLMROUTER_CONFIG",
'{"model_list": [{"model_name": "reflect-m"}]}',
)
reflect = _parse_llm_members("REFLECT_")
assert reflect[0].litellmrouter_config == {"model_list": [{"model_name": "reflect-m"}]}
# Scoped to the prefix; the global chain is unaffected.
assert _parse_llm_members("") == []
def test_parse_members_litellmrouter_config_invalid_json_raises(clean_llm_env):
clean_llm_env.setenv("HINDSIGHT_API_LLM_1_PROVIDER", "litellmrouter")
clean_llm_env.setenv("HINDSIGHT_API_LLM_1_LITELLMROUTER_CONFIG", "{not json")
with pytest.raises(ValueError, match="invalid JSON"):
_parse_llm_members("")
# ── strategy parsing ───────────────────────────────────────────────────────────
@@ -173,7 +252,7 @@ def _base_llm() -> LLMProvider:
def test_build_llm_no_chain_returns_plain_provider(clean_llm_env):
base = _base_llm()
result = _build_llm(base, _empty_config(), "")
result = _build_llm(base, _empty_config(), "", _NO_CALL_DEFAULTS)
assert result is base
assert not isinstance(result, MultiLLMProvider)
@@ -184,7 +263,7 @@ def test_build_llm_global_chain_wraps(clean_llm_env):
llm_strategy=LLMStrategyConfig(mode="failover"),
)
base = _base_llm()
result = _build_llm(base, config, "")
result = _build_llm(base, config, "", _NO_CALL_DEFAULTS)
assert isinstance(result, MultiLLMProvider)
assert result.members[0] is base # primary stays index 0
assert result.members[1].provider == "ollama"
@@ -197,7 +276,7 @@ def test_build_llm_per_op_inherits_global(clean_llm_env):
retain_llm_members=[],
retain_llm_strategy=None,
)
result = _build_llm(_base_llm(), config, "retain_")
result = _build_llm(_base_llm(), config, "retain_", _NO_CALL_DEFAULTS)
assert isinstance(result, MultiLLMProvider)
assert [m.provider for m in result.members[1:]] == ["ollama"] # inherited
@@ -209,7 +288,7 @@ def test_build_llm_per_op_overrides_global(clean_llm_env):
retain_llm_members=[_member("lmstudio")],
retain_llm_strategy=LLMStrategyConfig(mode="round-robin"),
)
result = _build_llm(_base_llm(), config, "retain_")
result = _build_llm(_base_llm(), config, "retain_", _NO_CALL_DEFAULTS)
assert isinstance(result, MultiLLMProvider)
assert [m.provider for m in result.members[1:]] == ["lmstudio"]
assert result._strategy.mode == "round-robin"
@@ -219,4 +298,146 @@ def test_build_llm_members_without_strategy_stays_plain(clean_llm_env):
# Members configured but no strategy → no wrapping (strategy is required).
config = _empty_config(llm_members=[_member("ollama")], llm_strategy=None)
base = _base_llm()
assert _build_llm(base, config, "") is base
assert _build_llm(base, config, "", _NO_CALL_DEFAULTS) is base
# ── vertexai member build path (_member_to_llm) ─────────────────────────────────
def test_member_to_llm_passes_vertexai_project_and_region(clean_llm_env, monkeypatch):
"""A vertexai member's own project/region reach the provider build.
The global config has no Vertex project, so this also proves the member's
values are used (no "VERTEXAI_PROJECT_ID is required") instead of the global
fallback. The Vertex SDK client is patched so no live LLM/network call runs.
"""
import hindsight_api.engine.providers.gemini_llm as gemini_llm
from hindsight_api.config import clear_config_cache
from hindsight_api.engine.memory_engine import _member_to_llm
captured: dict = {}
class _FakeClient:
def __init__(self, **kwargs):
captured.update(kwargs)
monkeypatch.setattr(gemini_llm.genai, "Client", _FakeClient)
clear_config_cache() # rebuild from the (vertex-less) test env
member = LLMMemberConfig(
provider="vertexai",
api_key=None,
model="gemini-2.0-flash",
base_url=None,
reasoning_effort=None,
extra_body=None,
default_headers=None,
bedrock_service_tier=None,
gemini_service_tier=None,
vertexai_project_id="member-proj",
vertexai_region="europe-west1",
)
provider = _member_to_llm(member, _empty_config(), _NO_CALL_DEFAULTS)
assert provider.provider == "vertexai"
# Project/region flowed all the way to the Vertex AI SDK client.
assert captured["project"] == "member-proj"
assert captured["location"] == "europe-west1"
def test_member_to_llm_passes_vertexai_service_account_key(clean_llm_env, monkeypatch):
"""A vertexai member's own service-account key reaches credential loading.
The key path flows to ``service_account.Credentials.from_service_account_file``
and the resulting credentials reach the Vertex AI SDK client proving the
member value is used rather than the (unset) global one. Both the credential
loader and the SDK client are patched so no file or network is touched.
"""
import hindsight_api.engine.llm_wrapper as llm_wrapper
import hindsight_api.engine.providers.gemini_llm as gemini_llm
from hindsight_api.config import clear_config_cache
from hindsight_api.engine.memory_engine import _member_to_llm
captured: dict = {}
sentinel_creds = object()
class _FakeServiceAccount:
class Credentials:
@staticmethod
def from_service_account_file(path, scopes=None):
captured["key_path"] = path
return sentinel_creds
class _FakeClient:
def __init__(self, **kwargs):
captured.update(kwargs)
monkeypatch.setattr(llm_wrapper, "VERTEXAI_AVAILABLE", True)
monkeypatch.setattr(llm_wrapper, "service_account", _FakeServiceAccount)
monkeypatch.setattr(gemini_llm.genai, "Client", _FakeClient)
clear_config_cache()
member = LLMMemberConfig(
provider="vertexai",
api_key=None,
model="gemini-2.0-flash",
base_url=None,
reasoning_effort=None,
extra_body=None,
default_headers=None,
bedrock_service_tier=None,
gemini_service_tier=None,
vertexai_project_id="member-proj",
vertexai_service_account_key="/keys/member-sa.json",
)
provider = _member_to_llm(member, _empty_config(), _NO_CALL_DEFAULTS)
assert provider.provider == "vertexai"
# The member's key path was loaded, and the credentials reached the SDK client.
assert captured["key_path"] == "/keys/member-sa.json"
assert captured["credentials"] is sentinel_creds
# ── litellmrouter member build path (_member_to_llm) ─────────────────────────────
def test_member_to_llm_passes_litellmrouter_config(clean_llm_env, monkeypatch):
"""A litellmrouter member's own router config reaches the LiteLLM router build.
The global config has no router config, so this also proves the member's
config is used (no "requires a config object" error) instead of the global
fallback. The LiteLLM router provider is patched so no router is constructed.
"""
import hindsight_api.engine.providers as providers
from hindsight_api.config import clear_config_cache
from hindsight_api.engine.memory_engine import _member_to_llm
captured: dict = {}
class _FakeRouterLLM:
provider = "litellmrouter"
def __init__(self, **kwargs):
captured.update(kwargs)
monkeypatch.setattr(providers, "LiteLLMRouterLLM", _FakeRouterLLM)
clear_config_cache()
router_cfg = {"model_list": [{"model_name": "m"}]}
member = LLMMemberConfig(
provider="litellmrouter",
api_key=None,
model="m",
base_url=None,
reasoning_effort=None,
extra_body=None,
default_headers=None,
bedrock_service_tier=None,
gemini_service_tier=None,
litellmrouter_config=router_cfg,
)
provider = _member_to_llm(member, _empty_config(), _NO_CALL_DEFAULTS)
assert provider.provider == "litellmrouter"
# The member's own router config flowed to the LiteLLM router build.
assert captured["config"] == router_cfg
+166
View File
@@ -0,0 +1,166 @@
"""Pure unit tests for the OKF (Open Knowledge Format) serializer.
These exercise hindsight_api/api/okf.py with plain dicts no DB, no LLM so
they pin the OKF contract (frontmatter projection, type-from-tag, shared-tag
graph) deterministically and fast.
"""
from hindsight_api.api import okf
def _mm(**overrides):
base = {
"id": "orders",
"name": "Orders",
"source_query": "What are the order facts?",
"content": "# Orders\n\nOne row per order.",
"tags": ["type:runbook", "sales", "revenue"],
"last_refreshed_at": "2026-01-02T00:00:00Z",
"created_at": "2026-01-01T00:00:00Z",
}
base.update(overrides)
return base
class TestPageType:
def test_lifts_type_from_tag_and_drops_it(self):
pt = okf.page_type(["type:runbook", "sales", "revenue"])
assert pt.type == "runbook"
assert pt.display_tags == ["sales", "revenue"]
def test_defaults_when_no_type_tag(self):
pt = okf.page_type(["sales"])
assert pt.type == okf.DEFAULT_PAGE_TYPE
assert pt.display_tags == ["sales"]
def test_handles_none_and_empty(self):
assert okf.page_type(None).type == okf.DEFAULT_PAGE_TYPE
assert okf.page_type(None).display_tags == []
def test_blank_type_suffix_falls_back(self):
pt = okf.page_type(["type:", "sales"])
assert pt.type == okf.DEFAULT_PAGE_TYPE
# the (blank) type tag is still stripped from display tags
assert pt.display_tags == ["sales"]
def test_first_type_tag_wins(self):
pt = okf.page_type(["type:runbook", "type:guide"])
assert pt.type == "runbook"
assert pt.display_tags == []
class TestFrontmatter:
def test_projects_expected_fields(self):
fm = okf.frontmatter(_mm())
assert fm["id"] == "orders"
assert fm["type"] == "runbook"
assert fm["title"] == "Orders"
assert fm["description"] == "What are the order facts?"
assert fm["tags"] == ["sales", "revenue"]
assert fm["timestamp"] == "2026-01-02T00:00:00Z"
def test_timestamp_falls_back_to_created_at(self):
fm = okf.frontmatter(_mm(last_refreshed_at=None))
assert fm["timestamp"] == "2026-01-01T00:00:00Z"
def test_render_omits_none_and_empty(self):
rendered = okf.render_frontmatter({"type": "x", "title": None, "tags": []})
assert "title" not in rendered
assert "tags" not in rendered
assert 'type: "x"' in rendered
def test_render_quotes_and_escapes(self):
# A name that looks like a YAML bool / contains a quote must stay a string.
rendered = okf.render_frontmatter({"title": 'true "x"'})
assert 'title: "true \\"x\\""' in rendered
class TestRenderDocument:
def test_includes_frontmatter_and_body(self):
doc = okf.render_document(_mm())
assert doc.startswith("---\n")
assert 'type: "runbook"' in doc
assert "One row per order." in doc
def test_empty_body(self):
doc = okf.render_document(_mm(content=""))
assert doc.count("---") == 2
assert doc.rstrip().endswith("---")
class TestKnowledgeGraph:
def test_edge_from_shared_tag(self):
pages = [
_mm(id="orders", tags=["type:runbook", "sales", "revenue"]),
_mm(id="customers", tags=["sales", "crm"]),
_mm(id="lonely", tags=[]),
]
graph = okf.knowledge_graph(pages)
assert len(graph.nodes) == 3
assert len(graph.edges) == 1
edge = graph.edges[0]["data"]
assert {edge["source"], edge["target"]} == {"orders", "customers"}
assert edge["sharedTags"] == ["sales"]
assert edge["weight"] == 1
def test_type_tag_does_not_create_edges(self):
# Two pages sharing only a type: tag must NOT be linked.
pages = [
_mm(id="a", tags=["type:runbook"]),
_mm(id="b", tags=["type:runbook"]),
]
graph = okf.knowledge_graph(pages)
assert graph.edges == []
def test_node_carries_type_and_color(self):
graph = okf.knowledge_graph([_mm(id="orders", tags=["type:runbook", "sales"])])
node = graph.nodes[0]["data"]
assert node["type"] == "runbook"
assert node["label"] == "Orders"
assert node["tagCount"] == 1
assert node["color"].startswith("#")
def test_weight_counts_shared_tags(self):
pages = [
_mm(id="a", tags=["sales", "revenue", "x"]),
_mm(id="b", tags=["sales", "revenue", "y"]),
]
graph = okf.knowledge_graph(pages)
assert graph.edges[0]["data"]["weight"] == 2
assert graph.edges[0]["data"]["sharedTags"] == ["revenue", "sales"]
class TestReservedFiles:
def test_index_links_each_page(self):
index = okf.render_index([_mm(id="orders", name="Orders", source_query="q?")])
assert "[Orders](./orders.md)" in index
assert "q?" in index
assert 'type: "index"' in index
def test_index_empty(self):
assert "No knowledge pages yet" in okf.render_index([])
def test_index_nests_folders(self):
nodes = [
{"id": "f1", "kind": "folder", "name": "Runbooks", "parent_id": None},
{"id": "p1", "kind": "page", "name": "Orders", "parent_id": "f1", "source_query": "q?"},
{"id": "p2", "kind": "page", "name": "Loose", "parent_id": None},
]
idx = okf.render_index(nodes)
assert "**Runbooks/**" in idx
# the page nested in the folder is indented and links to its file
assert " - [Orders](./p1.md) — q?" in idx
assert "- [Loose](./p2.md)" in idx
def test_log_renders_history_newest_first(self):
history = [
{"previous_content": "v2", "changed_at": "2026-01-02T00:00:00Z"},
{"previous_content": "v1", "changed_at": "2026-01-01T00:00:00Z"},
]
log = okf.render_log(_mm(), history)
assert 'type: "log"' in log
assert log.index("2026-01-02") < log.index("2026-01-01")
assert "v2" in log and "v1" in log
def test_log_empty(self):
assert "No refresh history" in okf.render_log(_mm(), [])
@@ -38,6 +38,7 @@ def _make_chat_response(content: str | None) -> MagicMock:
- response.error = None (otherwise truthy MagicMock triggers error path)
- response.model_dump() (returns dict without 'error' key)
- choice.message.tool_calls/refusal (otherwise truthy MagicMock in error msg)
- usage.completion_tokens_details (otherwise reasoning-token math crashes, #2378)
"""
choice = MagicMock()
choice.finish_reason = "stop"
@@ -51,6 +52,7 @@ def _make_chat_response(content: str | None) -> MagicMock:
response.usage.prompt_tokens = 10
response.usage.completion_tokens = 0 if content is None else 5
response.usage.total_tokens = 10 if content is None else 15
response.usage.completion_tokens_details = None
response.choices = [choice]
return response
@@ -17,7 +17,6 @@ def setup_test_env():
# Save original environment values
env_vars_to_set = {
"HINDSIGHT_API_SKIP_LLM_VERIFICATION": "true",
"HINDSIGHT_API_LAZY_RERANKER": "true",
"HINDSIGHT_API_LLM_PROVIDER": "mock",
"HINDSIGHT_API_LLM_MODEL": "default-model",
"HINDSIGHT_API_RETAIN_LLM_PROVIDER": "mock",
@@ -76,7 +75,6 @@ class TestPerOperationLLMConfig:
engine = MemoryEngine(
skip_llm_verification=True,
lazy_reranker=True,
)
# Verify default config
@@ -91,6 +89,33 @@ class TestPerOperationLLMConfig:
assert engine._reflect_llm_config.provider == "mock"
assert engine._reflect_llm_config.model == "reflect-model"
def test_groq_openai_service_tier_threaded_into_per_operation_configs(self, monkeypatch):
"""The groq/openai service-tier config knobs must reach every per-operation
LLM config, like bedrock/gemini already do. Previously they were parsed into
HindsightConfig but never threaded into the constructed providers, so setting
them was a silent no-op (groq is the default provider)."""
from hindsight_api import MemoryEngine
from hindsight_api.config import clear_config_cache
monkeypatch.setenv("HINDSIGHT_API_LLM_GROQ_SERVICE_TIER", "flex")
monkeypatch.setenv("HINDSIGHT_API_LLM_OPENAI_SERVICE_TIER", "flex")
clear_config_cache()
engine = MemoryEngine(
skip_llm_verification=True,
)
for cfg in (
engine._llm_config,
engine._retain_llm_config,
engine._reflect_llm_config,
engine._consolidation_llm_config,
):
assert cfg.groq_service_tier == "flex"
assert cfg.openai_service_tier == "flex"
clear_config_cache()
def test_memory_engine_with_explicit_params(self):
"""Test that explicit params override env config."""
from hindsight_api import MemoryEngine
@@ -103,7 +128,6 @@ class TestPerOperationLLMConfig:
reflect_llm_provider="mock",
reflect_llm_model="explicit-reflect",
skip_llm_verification=True,
lazy_reranker=True,
)
assert engine._llm_config.model == "explicit-default"
@@ -126,7 +150,6 @@ class TestPerOperationLLMConfig:
engine = MemoryEngine(
skip_llm_verification=True,
lazy_reranker=True,
)
# All should fall back to default
@@ -240,7 +263,6 @@ class TestRetainUsesRetainLLMConfig:
reflect_llm_provider="mock",
reflect_llm_model="reflect-specific-model",
skip_llm_verification=True,
lazy_reranker=True,
)
# Verify the retain LLM config is set correctly
@@ -266,7 +288,6 @@ class TestReflectUsesReflectLLMConfig:
reflect_llm_provider="mock",
reflect_llm_model="reflect-specific-model",
skip_llm_verification=True,
lazy_reranker=True,
)
# Verify the reflect LLM config is set correctly
@@ -292,7 +313,6 @@ class TestReflectUsesReflectLLMConfig:
reflect_llm_provider="mock",
reflect_llm_model="reflect-specific-model",
skip_llm_verification=True,
lazy_reranker=True,
)
engine._authenticate_tenant = AsyncMock() # type: ignore[method-assign]
@@ -0,0 +1,182 @@
"""Tests for the recall `scores` object and the `min_scores` filters.
Inserts memory_units with known content + real embeddings directly via SQL, then
verifies that recall_async:
- returns a `scores` object (final/reranker/semantic/keyword) on every result,
- applies the post-query floors (`reranker`, `final`) to the scored results,
- applies the retrieval-level floors (`semantic`, `keyword`) inside the SQL arms,
- is unchanged by the default (`min_scores=None`).
Filtering is deterministic post/pre-processing, so these assertions are direct
no LLM and no LLM-as-judge required (uses the mock provider).
"""
import uuid
import pytest
import pytest_asyncio
from hindsight_api import MemoryEngine, RequestContext
from hindsight_api.engine.response_models import MinScores
from hindsight_api.engine.retain import embedding_utils
# Shared hardcoded UUIDs (memory_units.id is a global PK) → serialize xdist workers
# onto one group to avoid pk conflicts, same as test_recall_time_range.py.
pytestmark = pytest.mark.xdist_group("recall_min_score")
ID_A = "00000000-0000-0000-0000-0000000000a1"
ID_B = "00000000-0000-0000-0000-0000000000a2"
ID_C = "00000000-0000-0000-0000-0000000000a3"
ALL_IDS = (ID_A, ID_B, ID_C)
RC = RequestContext(tenant_id="default")
async def _insert_fact(conn, *, fact_id: str, text: str, bank_id: str, embedding_str: str) -> None:
await conn.execute(
"""
INSERT INTO memory_units (id, bank_id, text, fact_type, embedding)
VALUES ($1, $2, $3, 'world', $4::vector)
""",
fact_id,
bank_id,
text,
embedding_str,
)
@pytest_asyncio.fixture
async def seeded_memory(memory_no_llm_verify: MemoryEngine):
"""Insert three facts with real embeddings and return (engine, bank_id)."""
engine = memory_no_llm_verify
bank_id = f"test-min-score-{uuid.uuid4().hex[:8]}"
await engine.get_bank_profile(bank_id, request_context=RC)
embeddings = await embedding_utils.generate_embeddings_batch(
engine.embeddings,
["the cat sat on the mat", "dogs are loyal animals", "birds can fly in the sky"],
)
def _to_str(emb: list[float]) -> str:
return "[" + ",".join(str(v) for v in emb) + "]"
pool = await engine._get_pool()
async with pool.acquire() as conn:
await conn.execute("DELETE FROM memory_units WHERE id IN ($1, $2, $3)", *ALL_IDS)
await _insert_fact(
conn, fact_id=ID_A, text="the cat sat on the mat", bank_id=bank_id, embedding_str=_to_str(embeddings[0])
)
await _insert_fact(
conn, fact_id=ID_B, text="dogs are loyal animals", bank_id=bank_id, embedding_str=_to_str(embeddings[1])
)
await _insert_fact(
conn, fact_id=ID_C, text="birds can fly in the sky", bank_id=bank_id, embedding_str=_to_str(embeddings[2])
)
yield engine, bank_id
await engine.delete_bank(bank_id, request_context=RC)
def _ids(result) -> set[str]:
return {str(r.id) for r in result.results}
async def _recall(engine, bank_id, *, query="animals and nature", **kwargs):
return await engine.recall_async(
bank_id=bank_id,
query=query,
request_context=RC,
max_tokens=10000,
**kwargs,
)
class TestRecallScores:
async def test_every_result_has_scores(self, seeded_memory):
engine, bank_id = seeded_memory
result = await _recall(engine, bank_id)
assert result.results, "expected the seeded facts to be recalled"
for r in result.results:
assert r.scores is not None, f"result {r.id} is missing scores"
assert isinstance(r.scores.final, float)
# semantic surfaced these (vector arm) — should be populated and 0..1
assert r.scores.semantic is not None
assert 0.0 <= r.scores.semantic <= 1.0
async def test_results_ordered_by_descending_final(self, seeded_memory):
engine, bank_id = seeded_memory
result = await _recall(engine, bank_id)
finals = [r.scores.final for r in result.results]
assert finals == sorted(finals, reverse=True), f"results not ordered by final score: {finals}"
class TestPostQueryFilters:
async def test_none_is_no_op(self, seeded_memory):
engine, bank_id = seeded_memory
baseline = await _recall(engine, bank_id)
explicit = await _recall(engine, bank_id, min_scores=None)
assert _ids(baseline) == _ids(explicit)
async def test_final_floor_filters_and_is_a_subset(self, seeded_memory):
engine, bank_id = seeded_memory
baseline = await _recall(engine, bank_id)
finals = sorted((r.scores.final for r in baseline.results), reverse=True)
assert len(finals) >= 2, "need at least two results to exercise a mid threshold"
threshold = finals[-1] + (finals[-2] - finals[-1]) / 2
filtered = await _recall(engine, bank_id, min_scores=MinScores(final=threshold))
assert _ids(filtered), "threshold should still keep the top result(s)"
assert _ids(filtered) < _ids(baseline), "threshold must drop at least one result"
for r in filtered.results:
assert r.scores.final >= threshold
async def test_final_floor_above_all_returns_empty(self, seeded_memory):
engine, bank_id = seeded_memory
baseline = await _recall(engine, bank_id)
max_final = max(r.scores.final for r in baseline.results)
filtered = await _recall(engine, bank_id, min_scores=MinScores(final=max_final + 1.0))
assert filtered.results == [], f"expected nothing above all final scores, got {_ids(filtered)}"
async def test_reranker_floor_filters(self, seeded_memory):
engine, bank_id = seeded_memory
baseline = await _recall(engine, bank_id)
rerankers = sorted((r.scores.reranker for r in baseline.results if r.scores.reranker is not None))
if len(rerankers) < 2:
pytest.skip("reranker scores unavailable (passthrough reranker)")
threshold = rerankers[-1] # keep only the top reranker score(s)
filtered = await _recall(engine, bank_id, min_scores=MinScores(reranker=threshold))
assert len(filtered.results) < len(baseline.results)
for r in filtered.results:
assert r.scores.reranker is not None and r.scores.reranker >= threshold
class TestRetrievalLevelFilters:
async def test_semantic_floor_prunes_in_retrieval(self, seeded_memory):
"""min_scores.semantic is a SQL-arm cutoff: every returned result has a
semantic score >= the floor, and a high floor returns nothing."""
engine, bank_id = seeded_memory
baseline = await _recall(engine, bank_id)
sems = sorted(r.scores.semantic for r in baseline.results if r.scores.semantic is not None)
assert sems, "semantic arm should have surfaced these facts"
# A floor just above the lowest semantic score must drop that weakest result.
floor = sems[-1]
filtered = await _recall(engine, bank_id, min_scores=MinScores(semantic=floor))
assert len(filtered.results) <= len(baseline.results)
for r in filtered.results:
assert r.scores.semantic is not None and r.scores.semantic >= floor
async def test_semantic_floor_above_one_returns_empty(self, seeded_memory):
engine, bank_id = seeded_memory
filtered = await _recall(engine, bank_id, min_scores=MinScores(semantic=1.1))
assert filtered.results == []
class TestRecallRequestDefault:
"""min_scores is opt-in: the HTTP recall defaults to None (no filtering)."""
def test_http_request_defaults_to_none(self):
from hindsight_api.api.http import RecallRequest
assert RecallRequest(query="hi").min_scores is None
+81 -1
View File
@@ -18,6 +18,7 @@ from hindsight_api.engine.reflect.agent import (
_clean_answer_text,
_clean_done_answer,
_count_messages_tokens,
_generate_structured_output,
_is_context_overflow_error,
_is_done_tool,
_normalize_tool_name,
@@ -68,6 +69,25 @@ class TestCleanAnswerText:
cleaned = _clean_answer_text(text)
assert cleaned == "Summary of findings."
def test_clean_text_recovers_leaked_done_arguments(self):
"""A done tool-call argument object rendered as text should keep only answer."""
text = """{
"answer": "Use the inbound table for API consumers.",
"directive_compliance": "Directive 1 followed.",
"memory_ids": ["mem-1"],
"mental_model_ids": [],
"observation_ids": []
}"""
cleaned = _clean_answer_text(text)
assert cleaned == "Use the inbound table for API consumers."
assert "directive_compliance" not in cleaned
def test_clean_text_leaves_non_done_json_answer_unchanged(self):
"""Plain JSON answers are valid user-visible content."""
text = '{"status": "ok", "items": [1, 2]}'
cleaned = _clean_answer_text(text)
assert cleaned == text
class TestCleanDoneAnswer:
"""Test cleanup of answer field from done() tool call that leaks structured output."""
@@ -141,6 +161,37 @@ class TestCleanDoneAnswer:
assert "Point 2" in cleaned
assert "mental_model_ids" not in cleaned
def test_clean_answer_recovers_leaked_done_arguments(self):
"""A done answer that contains leaked done arguments should keep answer content."""
text = """{
"answer": "Render two markdown tables: inbound and outbound.",
"directive_compliance": "All directives followed.",
"memory_ids": ["mem-1", "mem-2"],
"mental_model_ids": [],
"observation_ids": ["obs-1"]
}"""
cleaned = _clean_done_answer(text)
assert cleaned == "Render two markdown tables: inbound and outbound."
def test_clean_answer_recovers_fenced_leaked_done_arguments(self):
"""Some providers put leaked done arguments in a JSON code fence."""
text = """```json
{
"answer": "The current interface is HTTP only.",
"memory_ids": [],
"mental_model_ids": [],
"observation_ids": []
}
```"""
cleaned = _clean_done_answer(text)
assert cleaned == "The current interface is HTTP only."
def test_clean_answer_rejects_done_arguments_with_unexpected_keys(self):
"""Avoid rewriting user-requested JSON that happens to contain answer."""
text = '{"answer": "yes", "payload": {"format": "json"}, "memory_ids": []}'
cleaned = _clean_done_answer(text)
assert cleaned == text
class TestToolNameNormalization:
"""Test tool name normalization for various LLM output formats."""
@@ -234,6 +285,36 @@ class TestMentalModelFreshnessHelper:
assert _all_mental_models_are_usable_and_fresh({}) is True
class TestReflectStructuredOutput:
"""Tests for the second-pass structured-output extraction."""
@pytest.mark.asyncio
async def test_structured_output_uses_short_retry_budget(self):
"""A provider-specific structured-output failure must not consume the full reflect timeout."""
llm = MagicMock()
llm.call = AsyncMock(side_effect=RuntimeError("empty message content: finish_reason=length"))
result = await _generate_structured_output(
answer="Alice prefers concise engineering updates.",
response_schema={
"type": "object",
"properties": {
"summary": {"type": "string"},
},
"required": ["summary"],
},
llm_config=llm,
reflect_id="test-reflect",
)
assert result.structured_output is None
call_kwargs = llm.call.await_args.kwargs
assert call_kwargs["scope"] == "reflect_structured"
assert call_kwargs["max_retries"] == 1
assert call_kwargs["initial_backoff"] == 0.25
assert call_kwargs["max_backoff"] == 1.0
class TestReflectAgentMocked:
"""Test reflect agent with mocked LLM outputs."""
@@ -1022,7 +1103,6 @@ class TestContextOverflowIntegration:
# Patch get_config where memory_engine uses it, injecting a tiny
# max_context_tokens. Everything else delegates to the real config.
real_config = memory._get_raw_config() if hasattr(memory, "_get_raw_config") else None
from hindsight_api.config import get_config as _real_get_config
class _TinyContextProxy:
@@ -2,6 +2,7 @@
Tests for retain update_mode='append' appends new content to existing documents.
"""
import json
import logging
from datetime import datetime, timezone
@@ -42,7 +43,7 @@ async def test_append_mode_concatenates_content(memory, request_context):
assert "Alice works at Google" in v1_text
# Second retain with append — add new content
v2_units = await memory.retain_batch_async(
await memory.retain_batch_async(
bank_id=bank_id,
contents=[
{
@@ -238,3 +239,99 @@ async def test_replace_mode_is_default(memory, request_context):
finally:
await memory.delete_bank(bank_id, request_context=request_context)
@pytest.mark.asyncio
async def test_append_mode_conversation_arrays_produce_valid_json(memory, request_context):
"""When conversation-format JSON arrays are appended, original_text
must remain a valid flat JSON array after multiple append cycles.
Regression test for #2409: without the merge fix, original_text
becomes newline-joined arrays which breaks conversation-aware chunking.
"""
bank_id = f"test_append_conv_{_ts()}"
document_id = "conversation-json-append"
try:
# First retain - JSON conversation array
turn1 = json.dumps(
[
{"role": "user", "content": "Hello"},
{"role": "assistant", "content": "Hi there"},
]
)
await memory.retain_batch_async(
bank_id=bank_id,
contents=[
{
"content": turn1,
"context": "conversation",
"document_id": document_id,
}
],
request_context=request_context,
)
# Second retain - append more turns
turn2 = json.dumps(
[
{"role": "user", "content": "How are you"},
{"role": "assistant", "content": "Doing well"},
]
)
await memory.retain_batch_async(
bank_id=bank_id,
contents=[
{
"content": turn2,
"context": "conversation",
"document_id": document_id,
"update_mode": "append",
}
],
request_context=request_context,
)
# Verify original_text is valid JSON (not newline-joined arrays)
doc = await memory.get_document(document_id, bank_id, request_context=request_context)
text = doc["original_text"]
parsed = json.loads(text)
assert isinstance(parsed, list), "original_text must be a JSON array"
assert all(isinstance(e, dict) for e in parsed), (
"original_text must be a flat array of dicts, not nested arrays"
)
assert len(parsed) == 4, "Should contain all 4 messages from both retains"
# Third retain - append again, verify no degradation
turn3 = json.dumps(
[
{"role": "user", "content": "What is new"},
{"role": "assistant", "content": "Not much"},
]
)
await memory.retain_batch_async(
bank_id=bank_id,
contents=[
{
"content": turn3,
"context": "conversation",
"document_id": document_id,
"update_mode": "append",
}
],
request_context=request_context,
)
doc = await memory.get_document(document_id, bank_id, request_context=request_context)
text = doc["original_text"]
parsed = json.loads(text)
assert isinstance(parsed, list), "original_text must remain a JSON array after 3rd append"
assert all(isinstance(e, dict) for e in parsed), (
"original_text must remain a flat array of dicts after 3rd append"
)
assert len(parsed) == 6, "Should contain all 6 messages from three retains"
finally:
await memory.delete_bank(bank_id, request_context=request_context)
@@ -53,7 +53,7 @@ async def _count_memory_units(memory, bank_id: str) -> int:
)
async def _run_retain_through_worker(memory, extraction_error: Exception):
async def _run_retain_through_worker(memory, extraction_error: Exception, *, retry_count: int = 0):
"""Enqueue a one-item retain and run it through the real poller + executor.
``extraction_error`` is raised by the mock LLM on the ``retain_extract_facts``
@@ -90,16 +90,18 @@ async def _run_retain_through_worker(memory, extraction_error: Exception):
"operation_id": str(operation_id),
"bank_id": bank_id,
"contents": [{"content": "Alice moved to Berlin in March 2024 and joined Acme as a staff engineer."}],
"_retry_count": retry_count,
}
await pool.execute(
"""
INSERT INTO async_operations
(operation_id, bank_id, operation_type, status, task_payload, worker_id, claimed_at)
VALUES ($1, $2, 'retain', 'processing', $3::jsonb, 'test-worker-1', now())
(operation_id, bank_id, operation_type, status, task_payload, retry_count, worker_id, claimed_at)
VALUES ($1, $2, 'retain', 'processing', $3::jsonb, $4, 'test-worker-1', now())
""",
operation_id,
bank_id,
json.dumps(task_payload),
retry_count,
)
poller = WorkerPoller(
@@ -150,3 +152,26 @@ async def test_extraction_failure_is_retried_never_silently_completed(memory, ex
)
assert final["status"] == "pending", f"expected task reset to 'pending' for retry, got {final['status']!r}"
assert final["retry_count"] == 1, f"expected retry_count bumped to 1, got {final['retry_count']}"
@pytest.mark.asyncio
async def test_extraction_failure_at_retry_cap_fails_terminally(memory):
"""Once the worker retry cap is reached, extraction failures must fail terminally.
This guards the recovered-worker path seen in vectorize-io/hindsight#2413:
repeated structured-output parse failures should eventually release the
worker slot and leave an inspectable failed operation, not remain pending or
processing indefinitely.
"""
final, bank_id = await _run_retain_through_worker(
memory,
RuntimeError("structured JSON parse failed after all retain_extract_facts attempts"),
retry_count=3,
)
unit_count = await _count_memory_units(memory, bank_id)
assert final["status"] == "failed", f"expected retry-capped task to fail, got {final['status']!r}"
assert final["retry_count"] == 3
assert final["error_message"] is not None
assert "structured JSON parse failed" in final["error_message"]
assert unit_count == 0
@@ -16,14 +16,32 @@ the value through unchanged.
from __future__ import annotations
import pytest
from types import SimpleNamespace
from unittest.mock import AsyncMock, patch
import pytest
from pydantic import BaseModel
from hindsight_api.engine.providers.openai_compatible_llm import OpenAICompatibleLLM
from hindsight_api.engine.reflect.agent import _generate_structured_output
from hindsight_api.engine.reflect.models import StructuredOutputResult, TokenUsageSummary
from hindsight_api.engine.response_models import LLMToolCallResult, TokenUsage
from hindsight_api.extensions.operation_validator import RetainResult
class _OkModel(BaseModel):
ok: bool
def _openai_llm() -> OpenAICompatibleLLM:
return OpenAICompatibleLLM(
provider="openai",
api_key="test-key",
base_url="https://example.test/v1",
model="gpt-4o-mini",
)
def test_token_usage_carries_cached_and_thoughts():
"""TokenUsage defaults both new fields to 0 and accepts non-zero values."""
u = TokenUsage(input_tokens=1500, output_tokens=500, total_tokens=2000)
@@ -160,3 +178,118 @@ async def test_generate_structured_output_returns_dataclass_on_no_fields():
assert result.output_tokens == 0
assert result.cached_tokens == 0
assert result.thoughts_tokens == 0
# --- Provider-level extraction (follow-up to #2356) -------------------------
# The model-level tests above pin that the types CARRY the new fields. These
# pin that the OpenAI-compatible backend (the most-used provider: OpenAI
# o-series/gpt-5, groq, deepseek-r1, plus NousLLM/FireworksLLM subclasses)
# actually READS usage.completion_tokens_details.reasoning_tokens and surfaces
# it. Before this fix it never did, so thoughts_tokens was silently 0 for every
# OpenAI-compatible reasoning model and the #2356 cost-attribution field was
# wrong on the dominant code path.
def _usage(*, cached=0, reasoning=0, prompt=1500, completion=500, total=2000):
return SimpleNamespace(
prompt_tokens=prompt,
completion_tokens=completion,
total_tokens=total,
prompt_tokens_details=SimpleNamespace(cached_tokens=cached) if cached is not None else None,
completion_tokens_details=SimpleNamespace(reasoning_tokens=reasoning) if reasoning is not None else None,
)
def _response(*, usage, content='{"ok": true}', tool_calls=None):
choice = SimpleNamespace(
finish_reason="stop",
message=SimpleNamespace(content=content, tool_calls=tool_calls, refusal=None),
)
return SimpleNamespace(error=None, usage=usage, choices=[choice])
@pytest.mark.asyncio
async def test_openai_compatible_call_extracts_reasoning_into_thoughts_tokens():
llm = _openai_llm()
llm._client.chat.completions.create = AsyncMock(return_value=_response(usage=_usage(cached=200, reasoning=80)))
with patch("hindsight_api.engine.providers.openai_compatible_llm.get_metrics_collector"):
_, token_usage = await llm.call(
messages=[{"role": "user", "content": "Return whether this worked."}],
response_format=_OkModel,
max_retries=0,
return_usage=True,
)
# reasoning_tokens must flow into thoughts_tokens (was dropped -> 0 before).
assert token_usage.thoughts_tokens == 80
assert token_usage.cached_tokens == 200
# OpenAI folds reasoning into completion_tokens; output_tokens/total_tokens
# must stay visible-only so they don't double-count thoughts_tokens.
assert token_usage.output_tokens == 500 - 80
assert token_usage.total_tokens == 2000 - 80
@pytest.mark.asyncio
async def test_openai_compatible_call_with_tools_extracts_reasoning_and_cached():
llm = _openai_llm()
llm._client.chat.completions.create = AsyncMock(
return_value=_response(usage=_usage(cached=64, reasoning=33), content="done")
)
with patch("hindsight_api.engine.providers.openai_compatible_llm.get_metrics_collector"):
result = await llm.call_with_tools(
messages=[{"role": "user", "content": "hi"}],
tools=[],
max_retries=0,
)
# call_with_tools previously set neither field -> both defaulted to 0.
assert result.thoughts_tokens == 33
assert result.cached_tokens == 64
# output_tokens is visible-only (completion_tokens minus reasoning).
assert result.output_tokens == 500 - 33
@pytest.mark.asyncio
async def test_openai_compatible_call_no_token_details_keeps_thoughts_zero():
"""Non-reasoning models / Ollama report no *_details — the 0-safe getattr
chain must leave thoughts_tokens (and cached_tokens) at 0, not raise."""
llm = _openai_llm()
llm._client.chat.completions.create = AsyncMock(
return_value=_response(usage=_usage(cached=None, reasoning=None, prompt=10, completion=5, total=15))
)
with patch("hindsight_api.engine.providers.openai_compatible_llm.get_metrics_collector"):
_, token_usage = await llm.call(
messages=[{"role": "user", "content": "x"}],
response_format=_OkModel,
max_retries=0,
return_usage=True,
)
assert token_usage.thoughts_tokens == 0
assert token_usage.cached_tokens == 0
@pytest.mark.asyncio
async def test_openai_compatible_output_tokens_exclude_thoughts_like_gemini():
"""Convention invariant: for an OpenAI-compatible reasoning model, the
provider's ``completion_tokens`` already INCLUDES ``reasoning_tokens`` (real
o4-mini sample: completion_tokens=83, reasoning_tokens=64). The TokenUsage
contract matching the Gemini provider treats ``output_tokens`` as
visible-only and surfaces reasoning separately in ``thoughts_tokens``, with
``total_tokens == input_tokens + output_tokens``. Pin that the two fields do
not double-count: visible = completion - reasoning, and the three token
counts reconcile."""
llm = _openai_llm()
llm._client.chat.completions.create = AsyncMock(
return_value=_response(usage=_usage(reasoning=64, prompt=20, completion=83, total=103))
)
with patch("hindsight_api.engine.providers.openai_compatible_llm.get_metrics_collector"):
_, token_usage = await llm.call(
messages=[{"role": "user", "content": "17*23?"}],
response_format=_OkModel,
max_retries=0,
return_usage=True,
)
assert token_usage.thoughts_tokens == 64
assert token_usage.output_tokens == 83 - 64 # visible-only, no reasoning
assert token_usage.input_tokens == 20
assert token_usage.total_tokens == token_usage.input_tokens + token_usage.output_tokens
# The reasoning tokens live in exactly one field, not both.
assert token_usage.output_tokens + token_usage.thoughts_tokens == 83
@@ -73,6 +73,9 @@ def _tool_call_response() -> MagicMock:
resp.usage.prompt_tokens = 10
resp.usage.completion_tokens = 5
resp.usage.total_tokens = 15
# Explicit None: an auto-MagicMock here is truthy, so the reasoning-token
# accounting (#2378) would do arithmetic on a MagicMock and crash.
resp.usage.completion_tokens_details = None
resp.choices[0].finish_reason = "tool_calls"
resp.choices[0].message.content = None
resp.choices[0].message.tool_calls = [tc]
@@ -13,6 +13,7 @@ from hindsight_api._vector_index import (
validate_extension,
)
from hindsight_api.engine.retain import bank_utils
from hindsight_api.migrations import _bootstrap_vector_extension_for_migrations
class RecordingConn:
@@ -69,6 +70,25 @@ def test_bootstrap_extension_scann_installs_vector_before_alloydb_scann():
]
def test_migration_bootstrap_vchord_skips_pgvector_preflight():
conn = RecordingConn()
_bootstrap_vector_extension_for_migrations(conn, "vchord")
assert conn.statements == ["CREATE EXTENSION IF NOT EXISTS vchord CASCADE"]
def test_migration_bootstrap_scann_uses_dispatcher_without_legacy_pgvector_check():
conn = RecordingConn()
_bootstrap_vector_extension_for_migrations(conn, "scann")
assert conn.statements == [
"CREATE EXTENSION IF NOT EXISTS vector",
"CREATE EXTENSION IF NOT EXISTS alloydb_scann CASCADE",
]
def test_scann_index_creation_defers_until_table_is_large_enough():
assert should_defer_index_creation("scann", 0)
assert should_defer_index_creation("scann", SCANN_MIN_ROWS_FOR_AUTO_INDEX - 1)
@@ -20,41 +20,7 @@ def test_llm_wrapper_vertexai_missing_dependency():
try:
llm_wrapper.VERTEXAI_AVAILABLE = False
with patch.dict(
os.environ,
{
"HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID": "test-project",
"HINDSIGHT_API_LLM_VERTEXAI_SERVICE_ACCOUNT_KEY": "/path/to/key.json",
},
clear=False,
):
from hindsight_api.config import clear_config_cache
clear_config_cache()
with pytest.raises(ValueError, match="google-auth"):
from hindsight_api.engine.llm_wrapper import LLMProvider
LLMProvider(
provider="vertexai",
api_key="",
base_url="",
model="google/gemini-2.0-flash-001",
)
clear_config_cache()
finally:
llm_wrapper.VERTEXAI_AVAILABLE = original_available
def test_llm_wrapper_vertexai_missing_project_id():
"""Test error when project ID is not configured."""
with patch.dict(os.environ, {"HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID": ""}, clear=False):
from hindsight_api.config import clear_config_cache
clear_config_cache()
with pytest.raises(ValueError, match="HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID"):
with pytest.raises(ValueError, match="google-auth"):
from hindsight_api.engine.llm_wrapper import LLMProvider
LLMProvider(
@@ -62,49 +28,52 @@ def test_llm_wrapper_vertexai_missing_project_id():
api_key="",
base_url="",
model="google/gemini-2.0-flash-001",
vertexai_project_id="test-project",
vertexai_service_account_key="/path/to/key.json",
)
finally:
llm_wrapper.VERTEXAI_AVAILABLE = original_available
clear_config_cache()
def test_llm_wrapper_vertexai_missing_project_id():
"""Test error when no project ID is provided."""
from hindsight_api.engine.llm_wrapper import LLMProvider
with pytest.raises(ValueError, match="HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID"):
LLMProvider(
provider="vertexai",
api_key="",
base_url="",
model="google/gemini-2.0-flash-001",
)
def test_llm_wrapper_vertexai_adc_auth():
"""Test Vertex AI with ADC authentication creates native genai client."""
from hindsight_api.engine.llm_wrapper import LLMProvider
with patch.dict(
os.environ,
{
"HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID": "test-project",
"HINDSIGHT_API_LLM_VERTEXAI_SERVICE_ACCOUNT_KEY": "", # Clear SA key to test ADC path
},
clear=False,
):
from hindsight_api.config import clear_config_cache
# No service account key → ADC path. genai.Client handles ADC internally —
# just verify it creates the client with the project/region passed in.
with patch("google.genai.Client") as mock_client_cls:
mock_client_cls.return_value = MagicMock()
clear_config_cache()
provider = LLMProvider(
provider="vertexai",
api_key="",
base_url="",
model="google/gemini-2.0-flash-001",
vertexai_project_id="test-project",
)
# genai.Client handles ADC internally — just verify it creates the client
with patch("google.genai.Client") as mock_client_cls:
mock_client_cls.return_value = MagicMock()
assert provider.provider == "vertexai"
assert provider.model == "gemini-2.0-flash-001" # google/ prefix stripped
assert provider._gemini_client is not None
provider = LLMProvider(
provider="vertexai",
api_key="",
base_url="",
model="google/gemini-2.0-flash-001",
)
assert provider.provider == "vertexai"
assert provider.model == "gemini-2.0-flash-001" # google/ prefix stripped
assert provider._gemini_client is not None
# Verify genai.Client was called with vertexai=True
call_kwargs = mock_client_cls.call_args.kwargs
assert call_kwargs["vertexai"] is True
assert call_kwargs["project"] == "test-project"
assert call_kwargs["location"] == "us-central1"
clear_config_cache()
# Verify genai.Client was called with vertexai=True
call_kwargs = mock_client_cls.call_args.kwargs
assert call_kwargs["vertexai"] is True
assert call_kwargs["project"] == "test-project"
assert call_kwargs["location"] == "us-central1"
def test_llm_wrapper_vertexai_sa_auth():
@@ -113,99 +82,67 @@ def test_llm_wrapper_vertexai_sa_auth():
mock_credentials = MagicMock()
with patch.dict(
os.environ,
{
"HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID": "test-project",
"HINDSIGHT_API_LLM_VERTEXAI_SERVICE_ACCOUNT_KEY": "/path/to/key.json",
},
clear=False,
with patch(
"google.oauth2.service_account.Credentials.from_service_account_file",
return_value=mock_credentials,
):
from hindsight_api.config import clear_config_cache
with patch("google.genai.Client") as mock_client_cls:
mock_client_cls.return_value = MagicMock()
clear_config_cache()
provider = LLMProvider(
provider="vertexai",
api_key="",
base_url="",
model="google/gemini-2.0-flash-001",
vertexai_project_id="test-project",
vertexai_service_account_key="/path/to/key.json",
)
with patch(
"google.oauth2.service_account.Credentials.from_service_account_file",
return_value=mock_credentials,
):
with patch("google.genai.Client") as mock_client_cls:
mock_client_cls.return_value = MagicMock()
assert provider.provider == "vertexai"
assert provider._gemini_client is not None
provider = LLMProvider(
provider="vertexai",
api_key="",
base_url="",
model="google/gemini-2.0-flash-001",
)
assert provider.provider == "vertexai"
assert provider._gemini_client is not None
# Verify credentials were passed to genai.Client
call_kwargs = mock_client_cls.call_args.kwargs
assert call_kwargs["vertexai"] is True
assert call_kwargs["project"] == "test-project"
assert call_kwargs["location"] == "us-central1"
assert call_kwargs["credentials"] is mock_credentials
clear_config_cache()
# Verify credentials were passed to genai.Client
call_kwargs = mock_client_cls.call_args.kwargs
assert call_kwargs["vertexai"] is True
assert call_kwargs["project"] == "test-project"
assert call_kwargs["location"] == "us-central1"
assert call_kwargs["credentials"] is mock_credentials
def test_llm_wrapper_vertexai_strips_google_prefix():
"""Test that google/ prefix is stripped from model name for native SDK."""
from hindsight_api.engine.llm_wrapper import LLMProvider
with patch.dict(
os.environ,
{"HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID": "test-project"},
clear=False,
):
from hindsight_api.config import clear_config_cache
with patch("google.genai.Client") as mock_client_cls:
mock_client_cls.return_value = MagicMock()
clear_config_cache()
provider = LLMProvider(
provider="vertexai",
api_key="",
base_url="",
model="google/gemini-2.0-flash-lite-001",
vertexai_project_id="test-project",
)
with patch("google.genai.Client") as mock_client_cls:
mock_client_cls.return_value = MagicMock()
provider = LLMProvider(
provider="vertexai",
api_key="",
base_url="",
model="google/gemini-2.0-flash-lite-001",
)
assert provider.model == "gemini-2.0-flash-lite-001"
clear_config_cache()
assert provider.model == "gemini-2.0-flash-lite-001"
def test_llm_wrapper_vertexai_no_prefix_model():
"""Test that model without google/ prefix is unchanged."""
from hindsight_api.engine.llm_wrapper import LLMProvider
with patch.dict(
os.environ,
{"HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID": "test-project"},
clear=False,
):
from hindsight_api.config import clear_config_cache
with patch("google.genai.Client") as mock_client_cls:
mock_client_cls.return_value = MagicMock()
clear_config_cache()
provider = LLMProvider(
provider="vertexai",
api_key="",
base_url="",
model="gemini-2.0-flash-001",
vertexai_project_id="test-project",
)
with patch("google.genai.Client") as mock_client_cls:
mock_client_cls.return_value = MagicMock()
provider = LLMProvider(
provider="vertexai",
api_key="",
base_url="",
model="gemini-2.0-flash-001",
)
assert provider.model == "gemini-2.0-flash-001"
clear_config_cache()
assert provider.model == "gemini-2.0-flash-001"
@pytest.mark.asyncio
@@ -228,6 +165,8 @@ async def test_vertexai_integration_actual_api():
api_key="",
base_url="",
model="google/gemini-2.5-flash-lite",
vertexai_project_id=os.getenv("HINDSIGHT_API_LLM_VERTEXAI_PROJECT_ID"),
vertexai_service_account_key=os.getenv("HINDSIGHT_API_LLM_VERTEXAI_SERVICE_ACCOUNT_KEY") or None,
)
try:
+1 -1
View File
@@ -121,7 +121,7 @@ This runs a stdio-based MCP server that can be used directly with MCP-compatible
- **Entity Graph** — Automatic entity extraction and relationship tracking
- **Temporal Reasoning** — Native support for time-based queries
- **Disposition Traits** — Configurable skepticism, literalism, and empathy influence opinion formation
- **Three Memory Types** — World facts, bank actions, and formed opinions with confidence scores
- **Three Memory Types** — World facts, experience facts (the bank's own actions), and observations
## Documentation

Some files were not shown because too many files have changed in this diff Show More