docs(python-client): async-first pydoc + low-level API access + missing params#711
Merged
nicoloboschi merged 2 commits intomainfrom Mar 26, 2026
Merged
Conversation
…low-level API access - Class docstring now clearly documents async-first pattern: a* methods preferred, sync wrappers for scripts/REPLs only - Every sync method docstring points to its async counterpart - Every async method docstring says "preferred" - Expose 10 low-level API properties (documents, entities, operations, webhooks, monitoring, etc.) so agents/users can discover the full API surface without guessing at _-prefixed internals - Add missing API parameters: tag_groups (recall/reflect), fact_types, exclude_mental_models, exclude_mental_model_ids (reflect), observation_scopes/strategy (retain items), background (create_bank) - Fix areflect missing include_facts param that sync reflect already had - Sync recall/reflect now delegate to async counterparts (no logic duplication)
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
1 participant
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.
Summary
a*methods (async) and explains sync wrappers are for scripts/REPLs only@propertyaccessors (client.documents,client.entities,client.operations,client.webhooks,client.monitoring, etc.) so agents can discover the full API surface without guessing at_-prefixed internalstag_groups(recall/reflect),fact_types/exclude_mental_models/exclude_mental_model_ids(reflect),observation_scopes/strategy(retain items),background(create_bank),include_facts(areflect — was missing)recall/reflectnow delegate to async counterparts instead of duplicating request-building logicAll changes are fully backwards compatible — every new parameter has a default value, no existing signatures were altered.
Test plan
uv run python -c "from hindsight_client import Hindsight; ..."— imports, properties, and introspection verified./scripts/hooks/lint.sh)