Sync learning docs with current Learning Store APIs#556
Sync learning docs with current Learning Store APIs#556
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Learning documentation to match current Learning Store API/tool naming and default-mode behavior, reducing drift between guides and runtime behavior.
Changes:
- Renames User Profile and User Memory agentic tool references to the current tool names (
update_profile,update_user_memory). - Updates User Memory data model + retrieval example and adjusts the injected context tag (
<user_memory>). - Clarifies Decision Log default-mode behavior in both the store guide and the Learning Modes overview.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| learning/stores/user-profile.mdx | Updates agentic tool name and tightens User Profile vs User Memory guidance formatting. |
| learning/stores/user-memory.mdx | Updates tool name, data model table, retrieval snippet, and context-injection tag. |
| learning/stores/decision-log.mdx | Clarifies default mode behavior and annotates DecisionLogConfig() default. |
| learning/learning-modes.mdx | Updates tool table and default-mode guidance to match current store behavior. |
Comments suppressed due to low confidence (1)
learning/stores/decision-log.mdx:33
- In this “Basic Usage” snippet,
DecisionLogConfig()is now explicitly documented as defaulting toLearningMode.ALWAYS, but the agent instructions still tell the model to use thelog_decisiontool. Since this page later states tool-based logging is for Agentic mode, this example is internally inconsistent. Either switch the snippet toDecisionLogConfig(mode=LearningMode.AGENTIC)(and importLearningMode), or adjust the instructions/text to match ALWAYS mode behavior (automatic logging without relying onlog_decision).
learning=LearningMachine(
decision_log=DecisionLogConfig(), # defaults to LearningMode.ALWAYS
),
instructions=[
"When you make a significant choice, use log_decision to record it.",
"Include your reasoning and alternatives you considered.",
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
learning/stores/user-memory.mdx
Outdated
| ``` | ||
|
|
||
| Available tools: `save_user_memory`, `delete_user_memory` | ||
| Available tools: `update_user_memory` |
There was a problem hiding this comment.
Only a single tool is listed here (update_user_memory), but the label says “Available tools” (plural). Consider changing to “Available tool” or briefly noting that update_user_memory covers add/update/delete/clear operations, to reduce ambiguity for readers.
| Available tools: `update_user_memory` | |
| Available tool: `update_user_memory` (supports add, update, delete, and clear operations) |
| | User Profile | `update_profile` | | ||
| | User Memory | `update_user_memory` | | ||
| | Entity Memory | `search_entities`, `create_entity`, `update_entity`, `add_fact`, `update_fact`, `delete_fact`, `add_event`, `add_relationship` | |
There was a problem hiding this comment.
Docs now reference the update_profile tool, but there are still pages/examples in the repo that mention the old update_user_profile name (e.g. examples/learning/basics/b-user-profile-agentic.mdx and examples/learning/user-profile/agentic-mode.mdx). To avoid readers copying a stale tool name, please update the remaining references or add a brief note that update_user_profile was renamed/aliased to update_profile.
| | Entity Memory | Always | Continuous extraction captures entity facts/events from normal conversations | | ||
| | Learned Knowledge | Agentic | Agent decides what insights are worth saving | | ||
| | Decision Log | Agentic | Agent logs significant decisions explicitly | | ||
| | Decision Log | Always (`DecisionLogConfig()`), Agentic (`decision_log=True`) | Supports both automatic logging and explicit logging workflows | |
There was a problem hiding this comment.
The updated defaults table now says Entity Memory defaults to Always, but later in this same page the “Choosing a Mode” section still recommends Agentic for building entity knowledge graphs. If Entity Memory’s default/recommended behavior has changed, consider aligning the guidance below (and the earlier “Best for: … Entity Memory …” line) or clarifying that the default is Always but Agentic is recommended for certain workflows.
There was a problem hiding this comment.
@uzaxirr can you clarify the above as suggested?
There was a problem hiding this comment.
The Entity Memory default is Always — confirmed from the source code. The old docs had it as "Agentic" which was incorrect. I've pushed a fix that
- Fix "Available tools" (plural) to singular since only one tool listed - Update stale update_user_profile references to update_profile in examples - Align Entity Memory guidance to Always mode (matches code default in config.py) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary