-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs(voltagent-memory): add README with usage examples and config reference #1350
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
Open
nuthalapativarun
wants to merge
2
commits into
VoltAgent:main
Choose a base branch
from
nuthalapativarun:docs/voltagent-memory-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
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,5 @@ | ||
| --- | ||
| "@voltagent/voltagent-memory": patch | ||
| --- | ||
|
|
||
| Add README documentation |
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,108 @@ | ||
| <div align="center"> | ||
| <a href="https://voltagent.dev/"> | ||
| <img width="1500" height="276" alt="voltagent" src="https://github.com/user-attachments/assets/d9ad69bd-b905-42a3-81af-99a0581348c0" /> | ||
| </a> | ||
|
|
||
| <h3 align="center"> | ||
| AI Agent Engineering Platform | ||
| </h3> | ||
|
|
||
| <div align="center"> | ||
| <a href="https://voltagent.dev">Home Page</a> | | ||
| <a href="https://voltagent.dev/docs/">Documentation</a> | | ||
| <a href="https://github.com/voltagent/voltagent/tree/main/examples">Examples</a> | ||
| </div> | ||
| </div> | ||
|
|
||
| <br/> | ||
|
|
||
| <div align="center"> | ||
|
|
||
| [](https://github.com/voltagent/voltagent/issues) | ||
| [](https://github.com/voltagent/voltagent/pulls) | ||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://www.npmjs.com/package/@voltagent/voltagent-memory) | ||
| [](https://www.npmjs.com/package/@voltagent/voltagent-memory) | ||
| [](https://s.voltagent.dev/discord) | ||
|
|
||
| </div> | ||
|
|
||
| ## @voltagent/voltagent-memory | ||
|
|
||
| VoltAgent's managed memory adapter, backed by the VoltOps API. `ManagedMemoryAdapter` stores conversations, messages, working memory, and workflow state without you having to provision or operate a database, and `ManagedMemoryVectorAdapter` provides managed vector storage for RAG/retriever use cases. | ||
|
|
||
| --- | ||
|
|
||
| ## Install | ||
|
|
||
| ```bash | ||
| npm install @voltagent/voltagent-memory | ||
| # or | ||
| yarn add @voltagent/voltagent-memory | ||
| # or | ||
| pnpm add @voltagent/voltagent-memory | ||
| ``` | ||
|
|
||
| ## Setup | ||
|
|
||
| Managed memory requires a VoltOps project. Set your keys as environment variables, or pass a `voltOpsClient` explicitly: | ||
|
|
||
| ```bash | ||
| VOLTAGENT_PUBLIC_KEY=... | ||
| VOLTAGENT_SECRET_KEY=... | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```typescript | ||
| import { Agent, Memory } from "@voltagent/core"; | ||
| import { ManagedMemoryAdapter } from "@voltagent/voltagent-memory"; | ||
| import { openai } from "@ai-sdk/openai"; | ||
|
|
||
| const memory = new Memory({ | ||
| storage: new ManagedMemoryAdapter({ | ||
| databaseName: "my-database", | ||
| // or: databaseId: "db_123" | ||
| }), | ||
| }); | ||
|
|
||
| const agent = new Agent({ | ||
| name: "my-agent", | ||
| instructions: "A helpful assistant", | ||
| model: openai("gpt-4o-mini"), | ||
| memory, | ||
| }); | ||
| ``` | ||
|
|
||
| ### Managed Memory Options | ||
|
|
||
| | Option | Type | Default | Description | | ||
| | --------------- | --------------- | ------- | --------------------------------------------------------------------- | | ||
| | `databaseId` | `string` | — | Select a managed database by ID | | ||
| | `databaseName` | `string` | — | Select a managed database by name (used if `databaseId` is not set) | | ||
| | `voltOpsClient` | `VoltOpsClient` | — | Explicit VoltOps client; falls back to the globally registered client | | ||
| | `debug` | `boolean` | `false` | Enable debug logging | | ||
|
|
||
| If neither `databaseId` nor `databaseName` is provided, the adapter uses the first managed database returned for your VoltOps credentials. | ||
|
|
||
| ## Vector Adapter | ||
|
|
||
| ```typescript | ||
| import { ManagedMemoryVectorAdapter } from "@voltagent/voltagent-memory"; | ||
|
|
||
| const vectorStore = new ManagedMemoryVectorAdapter({ | ||
| databaseName: "my-database", | ||
| }); | ||
| ``` | ||
|
|
||
| `ManagedMemoryVectorAdapter` accepts the same options as `ManagedMemoryAdapter` above. | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [VoltAgent Documentation](https://voltagent.dev/docs/) | ||
| - [Managed Memory](https://voltagent.dev/docs/agents/memory/managed-memory) | ||
| - [Memory Overview](https://voltagent.dev/docs/agents/memory/overview/) | ||
|
|
||
| ## License | ||
|
|
||
| Licensed under the MIT License, Copyright © 2026-present VoltAgent. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.