[doc] Add documents for memory of flink-agents. #466
+906
−373
Conversation
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
github-actions
bot
added
priority/major
xintongsong
reviewed
Jan 23, 2026
xintongsong
reviewed
Jan 24, 2026
api/src/main/java/org/apache/flink/agents/api/memory/compaction/CompactionSetup.java
Outdated
Show resolved
Hide resolved
Co-authored-by: Shekharrajak <shekharrajak@live.com>
address comments
address comments.
address comments.
xintongsong
reviewed
Jan 25, 2026
| # store collection | ||
| memory.set("collection", [1, 2, 3]) | ||
| # store general class types | ||
| memory.set("object", LocalPrompt("the test {content}")) |
Contributor
There was a problem hiding this comment.
Suggested change
| memory.set("object", LocalPrompt("the test {content}")) | |
| memory.set("object", Prompt.from_text("the test {content}")) |
| # store general class types | ||
| memory.set("object", LocalPrompt("the test {content}")) | ||
| # store memory object | ||
| memory.new_object("memory_object") |
Contributor
There was a problem hiding this comment.
Suggested change
| memory.new_object("memory_object") | |
| obj1: MemoryObject = memory.new_object("obj1") | |
| obj1.set("foo", "bar") |
| value1: int = memory.get("primitive") | ||
| value2: List[int] = memory.get("collection") | ||
| value3: Prompt = memory.get("object") | ||
| value4: MemoryObject = memory.get("memory_object") |
Contributor
There was a problem hiding this comment.
Suggested change
| value4: MemoryObject = memory.get("memory_object") | |
| value4: MemoryObject = memory.get("obj1") | |
| value5: str = value4.get("foo") |
| // store general class types | ||
| memory.set("object", new LocalPrompt("the test {content}")); | ||
| // store memory object | ||
| memory.newObject("memory_object", true); // The second argument means whether to overwrite existing field if it's not a nested object |
Contributor
There was a problem hiding this comment.
I think we should add an overload method that does not require the second argument and use false for default (aligned with python), and use that for the example.
| // store general class types | ||
| memory.set("object", new LocalPrompt("the test {content}")); | ||
| // store memory object | ||
| memory.newObject("memory_object", true); // The second argument means whether to overwrite existing field if it's not a nested object |
Contributor
There was a problem hiding this comment.
Suggested change
| memory.newObject("memory_object", true); // The second argument means whether to overwrite existing field if it's not a nested object | |
| MemoryObject obj1 = memory.newObject("obj1", true); // The second argument means whether to overwrite existing field if it's not a nested object | |
| obj1.set("foo", "bar"); |
Comment on lines
+133
to
+134
| * Use `new_object` to manually create nested field. | ||
| * Use dot-separated path as key to created nested field. |
Contributor
There was a problem hiding this comment.
This doesn't seem right. "Always using new_object for creating memory objects" is something we need to emphasis, but it's not a way of accessing the fields.
Comment on lines
+133
to
+134
| * Use `new_object` to manually create nested field. | ||
| * Use dot-separated path as key to created nested field. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Use `new_object` to manually create nested field. | |
| * Use dot-separated path as key to created nested field. | |
| * Use `new_object` to manually create nested field. | |
| * Use dot-separated path as key to access nested field. |
|
|
||
| {{< tab "Python" >}} | ||
| ```python | ||
| # Use new_object |
Contributor
There was a problem hiding this comment.
Suggested change
| # Use new_object | |
| # access fields from the innermost memory object with field names |
| name: str = user.get("name") | ||
| age: int = user.get("age") | ||
|
|
||
| # Use dot-separated path |
Contributor
There was a problem hiding this comment.
Suggested change
| # Use dot-separated path | |
| # access fields from an outer memory object with paths to the fields |
|
|
||
| ### Memory Reference | ||
|
|
||
| `MemoryRef` is a reference of the objects stored in memory. The `set` method memory object will return a `MemoryRef`. |
Contributor
There was a problem hiding this comment.
Suggested change
| `MemoryRef` is a reference of the objects stored in memory. The `set` method memory object will return a `MemoryRef`. | |
| `MemoryRef` is a reference of the objects stored in memory. The `set` method of memory object will return a `MemoryRef`. |
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.
Linked issue: #350 and #351
Purpose of change
Refactor the doc organization for flink-agents memory, and add docs for sensory and long-term memory.
This pr is based on #401 and #402.
Tests
No
API
No
Documentation
doc-neededdoc-not-neededdoc-included