-
-
Notifications
You must be signed in to change notification settings - Fork 756
feat: add runtime memory envelope for per-call memory overrides #1136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
458763b
feat: add runtime memory envelope and deprecate legacy memory fields
omeraplak f4f6082
docs: add legacy and memory envelope examples to changeset
omeraplak d73138e
fix: address review findings for runtime memory envelope
omeraplak c394d0c
fix: apply follow-up review findings for memory runtime overrides
omeraplak a214a9d
fix: honor user-scoped working memory and align docs defaults
omeraplak f4fe8a6
fix: ignore blank memory ids when resolving runtime identity
omeraplak File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| "@voltagent/core": patch | ||
| "@voltagent/server-core": patch | ||
| "@voltagent/resumable-streams": patch | ||
| --- | ||
|
|
||
| feat: add runtime memory envelope (`options.memory`) and deprecate legacy top-level memory fields | ||
|
|
||
| ### What's New | ||
|
|
||
| - Added a preferred per-call memory envelope: | ||
| - `options.memory.conversationId` for conversation-scoped memory | ||
| - `options.memory.userId` for user-scoped memory | ||
| - `options.memory.options` for memory behavior overrides (`contextLimit`, `semanticMemory`, `conversationPersistence`) | ||
| - Kept legacy top-level fields for backward compatibility: | ||
| - `options.conversationId`, `options.userId`, `options.contextLimit`, `options.semanticMemory`, `options.conversationPersistence` | ||
| - Legacy fields are now marked deprecated in type/docs, and envelope values are preferred when both are provided. | ||
|
|
||
| ### Usage Examples | ||
|
|
||
| Legacy (still supported, deprecated): | ||
|
|
||
| ```ts | ||
| await agent.generateText("Hello", { | ||
| userId: "user-123", | ||
| conversationId: "conv-123", | ||
| contextLimit: 20, | ||
| semanticMemory: { | ||
| enabled: true, | ||
| semanticLimit: 5, | ||
| }, | ||
| conversationPersistence: { | ||
| mode: "step", | ||
| debounceMs: 150, | ||
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| Preferred (new `memory` envelope): | ||
|
|
||
| ```ts | ||
| await agent.generateText("Hello", { | ||
| memory: { | ||
| userId: "user-123", | ||
| conversationId: "conv-123", | ||
| options: { | ||
| contextLimit: 20, | ||
| semanticMemory: { | ||
| enabled: true, | ||
| semanticLimit: 5, | ||
| }, | ||
| conversationPersistence: { | ||
| mode: "step", | ||
| debounceMs: 150, | ||
| }, | ||
| }, | ||
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| ### Server and Resumable Stream Alignment | ||
|
|
||
| - `@voltagent/server-core` now accepts/documents the `options.memory` envelope in request schemas. | ||
| - Resumable stream identity resolution now reads `conversationId`/`userId` from `options.memory` first and falls back to legacy fields. | ||
| - Added tests for: | ||
| - parsing `options.memory` in server schemas | ||
| - resolving resumable stream keys from `options.memory` | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use a minor bump for the new
options.memoryAPI.This changeset adds a new supported public configuration shape across all three packages. That is backward-compatible feature work, so shipping it as
patchunderstates the semver impact.Suggested change
📝 Committable suggestion
🤖 Prompt for AI Agents