Add memory agent and caching functionality 🧠✨ #761
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -290,6 +292,57 @@ defAgent( | |||
| ````` | |||
|
|
|||
|
|
|||
| ### `system.agent_memory` | |||
|
|
|||
| agent that retreives memories | |||
There was a problem hiding this comment.
Typo in the word "retreives"; it should be "retrieves".
generated by pr-docs-review-commit
typo
| arrayify(tools) | ||
| [...arrayify(tools), memory ? "agent_memory" : undefined].filter( | ||
| (t) => !!t | ||
| ) |
There was a problem hiding this comment.
The filter function is unnecessary here as the 'undefined' values will not affect the functionality of the 'arrayify' function.
generated by pr-review-commit
unnecessary_filter
| cachedValue.answer, | ||
| "markdown" | ||
| ) | ||
| }) |
There was a problem hiding this comment.
There is no error handling for the async function 'agentMemory.set'. If it fails, it could lead to unexpected behavior.
generated by pr-review-commit
missing_error_handling
|
|
||
| - Use the information in MEMORY exclusively to answer the question in QUERY. | ||
| - If the information in MEMORY is not enough to answer the question in QUERY, respond <NO_MEMORY>. | ||
| ` |
There was a problem hiding this comment.
The sentence "- The memory" is incomplete and seems to be cut off. It should be removed or completed.
generated by pr-docs-review-commit
incomplete_sentence
| @@ -313,7 +315,8 @@ export function createChatGenerationContext( | |||
| ) => Promise<void>, | |||
| options?: DefAgentOptions | |||
| ): void => { | |||
| const { tools, system, ...rest } = options || {} | |||
| const { tools, system, disableMemory, ...rest } = options || {} | |||
There was a problem hiding this comment.
The disableMemory option in the options object is not given a default value. If it is not provided in the function call, it will be undefined, which may lead to unexpected behavior.
generated by pr-review-commit
missing_default_value
| arrayify(tools) | ||
| [...arrayify(tools), memory ? "agent_memory" : undefined].filter( | ||
| (t) => !!t | ||
| ) |
There was a problem hiding this comment.
The filter function (t) => !!t is used to remove undefined values from the array. However, this could also remove other falsy values like 0, '', false, null, NaN, which might be valid in some cases.
generated by pr-review-commit
filter_undefined
| @@ -313,7 +315,8 @@ export function createChatGenerationContext( | |||
| ) => Promise<void>, | |||
| options?: DefAgentOptions | |||
| ): void => { | |||
| const { tools, system, ...rest } = options || {} | |||
| const { tools, system, disableMemory, ...rest } = options || {} | |||
There was a problem hiding this comment.
The disableMemory property is destructured from options but not used in the function. Consider removing it if it's not needed.
generated by pr-review-commit
missing_destructuring
| arrayify(tools) | ||
| [...arrayify(tools), memory ? "agent_memory" : undefined].filter( | ||
| (t) => !!t | ||
| ) |
There was a problem hiding this comment.
The expression used to generate the agentTools array is complex and may be difficult to understand. Consider breaking it down into smaller parts for better readability.
generated by pr-review-commit
complex_expression
| @@ -290,6 +292,57 @@ defAgent( | |||
| ````` | |||
|
|
|||
|
|
|||
| ### `system.agent_memory` | |||
|
|
|||
| agent that retreives memories | |||
There was a problem hiding this comment.
Typo in the word "retreives"; it should be "retrieves".
generated by pr-docs-review-commit
spelling
| @@ -11,4 +11,5 @@ import { LinkCard } from '@astrojs/starlight/components'; | |||
| <LinkCard title="agent git" description="query a repository using Git to accomplish tasks. Provide all the context information available to execute git queries." href="/genaiscript/reference/scripts/system#systemagent_git" /> | |||
| <LinkCard title="agent github" description="query GitHub to accomplish tasks" href="/genaiscript/reference/scripts/system#systemagent_github" /> | |||
| <LinkCard title="agent interpreter" description="run code interpreters for Python, Math. Use this agent to ground computation questions." href="/genaiscript/reference/scripts/system#systemagent_interpreter" /> | |||
| <LinkCard title="agent memory" description="queries the memories created by other agent conversations." href="/genaiscript/reference/scripts/system#systemagent_memory" /> | |||
There was a problem hiding this comment.
A new agent 'agent memory' has been added to the documentation. Ensure that the description and link are accurate and consistent with the rest of the documentation.
generated by pr-docs-review-commit
content_addition
| @@ -209,6 +209,7 @@ defAgent( | |||
| { | |||
| model, | |||
| system: ["system.git_info", "system.github_info", "system.git"], | |||
| memory: true | |||
There was a problem hiding this comment.
The 'memory' property has been added to the 'system.git_info', 'system.github_info', 'system.git' agent. Verify that this property addition is intentional and correctly documented.
generated by pr-docs-review-commit
property_addition
| @@ -248,6 +249,7 @@ defAgent( | |||
| "system.github_issues", | |||
| "system.github_pulls", | |||
| ], | |||
| memory: true, | |||
There was a problem hiding this comment.
The 'memory' property has been added to the 'system.github_issues', 'system.github_pulls' agent. Verify that this property addition is intentional and correctly documented.
generated by pr-docs-review-commit
property_addition
| flexTokens: 30000, | ||
| system: ["system"], | ||
| disableMemory: true, | ||
| } |
There was a problem hiding this comment.
A new section for system.agent_memory has been introduced. Ensure that the documentation for this new agent is complete and that the example code provided is correct and functional.
generated by pr-docs-review-commit
new_section
|
|
||
| ```js "disableMemory: true" | ||
| defAgent(..., { disableMemory: true }) | ||
| ``` |
There was a problem hiding this comment.
New section 'Agent Memory' added to provide details on the usage and configuration of the 'agent_memory'.
generated by pr-docs-review-commit
content_addition
| @@ -209,6 +209,7 @@ defAgent( | |||
| { | |||
| model, | |||
| system: ["system.git_info", "system.github_info", "system.git"], | |||
| memory: true | |||
There was a problem hiding this comment.
Memory feature enabled in the 'system.agent_git' agent configuration.
generated by pr-docs-review-commit
content_addition
| @@ -248,6 +249,7 @@ defAgent( | |||
| "system.github_issues", | |||
| "system.github_pulls", | |||
| ], | |||
| memory: true, | |||
There was a problem hiding this comment.
Memory feature enabled in the 'system.agent_github' agent configuration.
generated by pr-docs-review-commit
content_addition
| system: ["system"], | ||
| disableMemory: true, | ||
| } | ||
| ) |
There was a problem hiding this comment.
New section 'system.agent_memory' added to describe the agent that retrieves memories.
generated by pr-docs-review-commit
content_addition
|
|
||
| - Use the information in MEMORY exclusively to answer the question in QUERY. | ||
| - If the information in MEMORY is not enough to answer the question in QUERY, respond <NO_MEMORY>. | ||
| - The memory |
There was a problem hiding this comment.
There is a typo in the word "helpfull"; it should be "helpful". Additionally, the sentence "The memory" in line 320 is incomplete and should be revised or removed.
generated by pr-docs-review-commit
typo
|
|
||
| - Use the information in MEMORY exclusively to answer the question in QUERY. | ||
| - If the information in MEMORY is not enough to answer the question in QUERY, respond <NO_MEMORY>. | ||
| - The memory |
There was a problem hiding this comment.
The instructions within the code snippet may be unclear due to the incomplete sentence on line 320. This could lead to confusion about the expected behavior of the agent.
generated by pr-docs-review-commit
content_clarity
| @@ -11,4 +11,5 @@ import { LinkCard } from '@astrojs/starlight/components'; | |||
| <LinkCard title="agent git" description="query a repository using Git to accomplish tasks. Provide all the context information available to execute git queries." href="/genaiscript/reference/scripts/system#systemagent_git" /> | |||
| <LinkCard title="agent github" description="query GitHub to accomplish tasks" href="/genaiscript/reference/scripts/system#systemagent_github" /> | |||
| <LinkCard title="agent interpreter" description="run code interpreters for Python, Math. Use this agent to ground computation questions." href="/genaiscript/reference/scripts/system#systemagent_interpreter" /> | |||
| <LinkCard title="agent memory" description="queries the memories created by other agent conversations." href="/genaiscript/reference/scripts/system#systemagent_memory" /> | |||
There was a problem hiding this comment.
The newly added LinkCard for "agent memory" should maintain consistency with the other LinkCard entries. Consider adding a period at the end of the description for uniformity.
generated by pr-docs-review-commit
content_structure
|
|
||
| The `agent_memory` is a special agent that queries the memories created by other agent conversations. It is used to store and retrieve information from the LLM's memory. | ||
|
|
||
| All agent contribute to the conversation memory, and use the `agent_memory`, tool unless it is explicitely disabled using `disableMemory`. |
There was a problem hiding this comment.
The word "explicitely" is misspelled. It should be corrected to "explicitly".
generated by pr-docs-review-commit
spelling_error
|
|
||
| ```js "disableMemory: true" | ||
| defAgent(..., { disableMemory: true }) | ||
| ``` |
There was a problem hiding this comment.
The code snippet provided for disabling memory should be enclosed in a code block for consistency with other code snippets in the documentation.
generated by pr-docs-review-commit
code_snippet_format
| flexTokens: 30000, | ||
| system: ["system"], | ||
| disableMemory: true, | ||
| } |
There was a problem hiding this comment.
The section for system.agent_memory seems incomplete and lacks proper formatting. It should be structured and formatted consistently with other sections in the document. The placeholder text "agent that retrieves memories" and the repeated empty lines should be addressed for clarity and conciseness.
generated by pr-docs-review-commit
document_structure
Investigator reportSummary of Root CauseThe failure in the GitHub Action run is due to a TypeScript compilation error in the Error MessagesSuggested FixTo resolve this issue, you need to either add the Diff with Suggested Fixes--- src/genaisrc/system.agent_git.genai.mjs
+++ src/genaisrc/system.agent_git.genai.mjs
@@ -15,7 +15,7 @@
const agentOptions = {
name: 'gitAgent',
description: 'An agent for handling git operations',
- memory: {
+ // memory: {
size: '1GB'
},
...--- src/genaisrc/system.agent_github.genai.mjs
+++ src/genaisrc/system.agent_github.genai.mjs
@@ -22,7 +22,7 @@
const agentOptions = {
name: 'githubAgent',
description: 'An agent for handling GitHub operations',
- memory: {
+ // memory: {
size: '2GB'
},
...This change comments out the problematic
|
|
I couldn't find the workflow run with ID
|
Workflow Run Analysis
Relevant Commits and Pull Requests
Issues
Source Code ComparisonThe comparison between the source code of the failed run and the last successful run didn't return any changes. This may need further exploration in the code changes or manual inspection on the platform. ConclusionThe failure seems to be associated with changes introduced in the PR #761, focusing on adding memory agent and caching functionality. Additional debugging and review of the pull request may be necessary to determine the exact cause of failure.
|
| @@ -235,7 +235,6 @@ defAgent( | |||
| "query GitHub to accomplish tasks", | |||
| `Your are a helpfull LLM agent that can query GitHub to accomplish tasks. Answer the question in QUERY. | |||
| - Prefer diffing job logs rather downloading entire logs which can be very large. | |||
There was a problem hiding this comment.
There seems to be a typo here. "ar" should be "are".
generated by pr-docs-review-commit
typo
|
|
||
| The `agent_memory` is a special agent that queries the memories created by other agent conversations. It is used to store and retrieve information from the LLM's memory. | ||
|
|
||
| All agent contribute to the conversation memory, and use the `agent_memory`, tool unless it is explicitely disabled using `disableMemory`. |
There was a problem hiding this comment.
The word "explicitely" is misspelled; it should be "explicitly".
generated by pr-docs-review-commit
typo
| ...cacheKey, | ||
| answer: text, | ||
| } | ||
| await agentMemory.set(cacheKey, cachedValue) |
There was a problem hiding this comment.
The set method of agentMemory is used without error handling. If an error occurs during the execution of this method, it will not be caught and might lead to unexpected behavior. Consider adding error handling.
generated by pr-review-commit
missing_error_handling
🔄 Workflow Update: Modified the workflow scripts to include a
failure_run_idvariable, enhancing the tracking and debugging of failed runs.🧠 Agent Memory Integration: Introduced a new
agent_memorytool across multiple components, allowing agents to query and store conversation memories for better context management.🛠️ Cache System Refactor: Refactored the cache system by introducing
MemoryCacheand updatingJSONLineCacheto extend it. This improves memory management and cache retrieval efficiency.📚 Documentation Enhancement: Added documentation for the new
agent_memoryfeature, explaining its purpose and usage.🚀 Dependency Updates: Upgraded several dependencies in
yarn.lockto their latest versions, ensuring better performance and security.🐛 Bug Fixes and Improvements: Corrected typos and improved the logic in various scripts and configurations, leading to more robust and error-free execution.