docs: clarify memory lifecycle across flows#267
Open
mason5052 wants to merge 1 commit intovxcontrol:mainfrom
Open
docs: clarify memory lifecycle across flows#267mason5052 wants to merge 1 commit intovxcontrol:mainfrom
mason5052 wants to merge 1 commit intovxcontrol:mainfrom
Conversation
Signed-off-by: Mason Kim(ZINUS US_SALES) <mkim@zinus.com>
There was a problem hiding this comment.
Pull request overview
Adds documentation clarifying how PentAGI’s memory/knowledge storage behaves across flows, and how to persist reusable context between engagements (issue #74).
Changes:
- Add “Memory Lifecycle Across Flows” guidance to the README near the
etesterembedding/search documentation. - Extend
backend/docs/flow_execution.mdwith lifecycle guidance distinguishing flow-scoped execution history (memory) from reusable knowledge (guide/answer/code).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| backend/docs/flow_execution.md | Adds lifecycle guidance on when to rely on flow-scoped memory vs storing durable guide/answer/code. |
| README.md | Adds a new section explaining practical workflows for inspecting per-flow history and persisting reusable target knowledge. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Treat `memory` as flow-scoped execution history. It is most useful for understanding what happened in a specific engagement and is commonly inspected with a `flow_id` filter. | ||
| - Treat `guide`, `answer`, and `code` as reusable knowledge. These document types exist to preserve durable procedures, reusable target notes, Q&A material, and code snippets across future runs. | ||
| - If you want a later flow to begin with known context, store the confirmed result intentionally through `store_guide`, `store_answer`, or `store_code` instead of assuming execution history alone will provide the right reusable context. | ||
| - Current prompt templates already distinguish these roles: reusable guides/code live in vector documents, while Graphiti is intended for episodic memory about what actually happened during execution. |
|
|
||
| For example, if a target has recurring setup notes, authentication quirks, or target-specific testing methodology, instruct the agent to save that information as a `guide` and search for it at the beginning of the next engagement. This is the safest current workflow when you want a new flow to start with reusable context. | ||
|
|
||
| Flow deletion removes the flow from normal queries through PentAGI's soft-delete mechanism, so reusable knowledge should be treated as a separate concern from per-flow execution history. If you need broader episodic context across operations, enable the optional Graphiti knowledge graph described earlier in this README. |
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
Problem
Issue #74 asks whether PentAGI should keep memory after flows are removed and how users should preserve target knowledge between runs. The current repository already has the underlying concepts (
memory,guide,answer,code, Graphiti, andflow_idfilters), but the docs do not explain how they fit together operationally.Solution
etesterdocumentationflow_idand when to store durable knowledge explicitly asguide,answer, orcodebackend/docs/flow_execution.mdwith lifecycle guidance that distinguishes flow-scoped execution history from reusable knowledge and references the current prompt-template behaviorUser Impact
Users now have a clearer path for deciding what should stay attached to a single engagement and what should be stored intentionally for future flows. This makes it easier to preserve reusable target notes without assuming that raw execution history alone will provide the right cross-run context.
Test Plan
etestersearch options and embedding docsgit diff --checkCloses #74