docs(api): correct stale memory-type taxonomy in published READMEs#2447
Merged
nicoloboschi merged 1 commit intoJun 30, 2026
Merged
Conversation
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.
nicoloboschi
approved these changes
Jun 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The top "features" bullet of both primary published packages misstates the recall memory-type taxonomy:
hindsight-api/README.md:124andhindsight-api-slim/README.md:124(byte-identical):The live taxonomy is world / experience / observation (
VALID_RECALL_FACT_TYPESinhindsight-api-slim/hindsight_api/engine/response_models.py, and thefact_type IN (...)CHECK constraint):opinionwas removed (recall now 422-rejects it)bankwas renamed toexperienceSo the first thing a PyPI/GitHub visitor reads tells them
opinionis a valid recallfact_type(it isn't) and referencesbank(which no longer exists). This syncs the bullet to the live enum, matchinghindsight-docs/docs/developer/index.mdx.Scoped to that one bullet — opinion formation as a behavioral concept (e.g.
ReflectResult) is untouched.