docs: explain quickstart forget call (follow-up to #2879)#3040
Open
Vasilije1990 wants to merge 4 commits into
Open
docs: explain quickstart forget call (follow-up to #2879)#3040Vasilije1990 wants to merge 4 commits into
Vasilije1990 wants to merge 4 commits into
Conversation
Follow-up to #2879: the new "What this example creates" section explained the remember and recall calls but skipped the example's final forget(dataset="main_dataset") line. Name the default dataset explicitly and tell beginners what the cleanup call does and when to remove it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The trailing-whitespace pre-commit hook runs with --all-files and was failing on README.md line 62, which this branch inherits from main. Co-Authored-By: Claude Fable 5 <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
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.
Summary
Follow-up to #2879. That PR adds a beginner-friendly "What this example creates" section after the Quickstart code sample, but the explanation stops at the two
recallcalls and never mentions the example's finalforget(dataset="main_dataset")line — the one step most likely to surprise a beginner, since it deletes the memory the example just built.This PR:
main_dataset, matching the default incognee/api/v1/add/add.py), so theforget(dataset="main_dataset")argument is no longer an unexplained magic string.forgetcall does, why it is useful while experimenting, and that it should be removed once you want the agent's memory to persist between runs.Stacking note
Since #2879 comes from a fork, this PR targets
mainand includes the commits of #2879. It stacks on top of #2879 and should be merged after it; once #2879 lands, the diff here reduces to the single README paragraph above.🤖 Generated with Claude Code