docs: add memory manager documentation#2757
Closed
opieter-aws wants to merge 8 commits into
Closed
Conversation
Merge the latest KB store + extraction work (nested BedrockKnowledgeBaseConfig, boolean|ExtractionConfig shorthand, IntervalTrigger default, addMessages sink) onto the injection base so all three memory feature sets are present and compile together for documentation snippets. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Description
Documents the long-term memory feature (
MemoryManager) for the TypeScript SDK. The implementation shipped across #2544 (memory manager), the Bedrock KB store + extraction work, and #2631 (injection), but had no user-facing documentation. Agents that should remember a user across sessions had a supported API and no page explaining it.Adds two pages under
site/, both TypeScript-only (the feature is TS-only today):concepts/agents/memory.mdx) covers theMemoryManager: theMemoryStoreinterface and multi-store routing, thesearch_memory/add_memorytools, programmaticsearch/add, automatic extraction (triggers andModelExtractor), and context injection. It opens by distinguishing memory from the adjacent session-management and conversation-management features, since the three are easy to conflate.concepts/agents/bedrock-knowledge-base.mdx) documents the vendedBedrockKnowledgeBaseStore: the split connection/store config,CUSTOMvsS3vsOTHERwritability, search/ingestion, scope-based namespacing, and the IAM permissions a writable store needs.Code examples live in runnable, type-checked snippet files (
*.tsplus sibling*_imports.ts) and are pulled into the pages via--8<--includes, so every rendered block carries its imports and is copy-paste runnable.This PR also adds a
memorytag tosite/src/config/tags.ymland reconciles the terminology lock (.agents/references/terminology.md): "memory" was previously listed only as a banned synonym for session management, which collides with the shippedMemoryManagerfeature name. The lock now carves out "long-term memory" as the canonical term for the feature, distinct from session persistence.Related Issues
#2544, #2631
Documentation PR
This PR is the documentation. New pages registered in
site/src/config/navigation.ymlunder Concepts.Type of Change
Documentation update
Testing
Built the docs site against the SDK source (
astro build): both pages render, all--8<--snippet regions resolve, and the broken-links checker passes across all pages. The snippet sources type-check against the SDK via thesite/test-snippetsharness (tsc --noEmit). Reviewed both drafts with the docs-writer and docs-reviewer voice/terminology passes.hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.