docs(python-sdk): document retain_async kwarg per #1306#1347
Merged
nicoloboschi merged 2 commits intovectorize-io:mainfrom Apr 30, 2026
Merged
docs(python-sdk): document retain_async kwarg per #1306#1347nicoloboschi merged 2 commits intovectorize-io:mainfrom
nicoloboschi merged 2 commits intovectorize-io:mainfrom
Conversation
nicoloboschi
approved these changes
Apr 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
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
#1306 added
retain_async: bool = Falsetoclient.retain()/client.aretain()so the convenience wrappers reach parity withretain_batch()/aretain_batch()and the TypeScript SDK. The Python SDK doc still documents the kwarg only onretain_batch()(line 93), leaving the new behavior undiscoverable from### Retain (Store Memory).This PR adds the same
retain_async=False # Set True for background processingline to the existing "With options" example forclient.retain(), mirroring the wording used in theretain_batchblock right below it (line 93) and in the Node.js SDK doc'sretain()example (async: false).Changes
hindsight-docs/docs/sdks/python.md: +1 line in the Retain (Store Memory) "With options" example.skills/hindsight-docs/references/sdks/python.md: same +1 line in the skill mirror.Notes
retain_async: bool = False, fully backwards compatible).versioned_docs/version-0.5/sdks/python.mdmirror is intentionally left for the nextchore(docs): sync version-0.5 docs from nextpass (cf. chore(docs): sync version-0.5 docs from next #1328).