@mastra/memory 1.1.0-alpha.1 → 1.2.0-alpha.0

package/dist/docs/agents/01-agent-memory.md

@@ -1,166 +0,0 @@
-> Learn how to add memory to agents to store message history and maintain context across interactions.
-
-# Agent memory
-
-Agents use memory to maintain context across interactions. LLMs are stateless and don't retain information between calls, so agents need memory to track message history and recall relevant information.
-
-Mastra agents can be configured to store message history, with optional [working memory](../memory/working-memory) to maintain recent context or [semantic recall](../memory/semantic-recall) to retrieve past messages based on meaning.
-
-## When to use memory
-
-Use memory when your agent needs to maintain multi-turn conversations that reference prior exchanges, recall user preferences or facts from earlier in a session, or build context over time within a conversation thread. Skip memory for single-turn requests where each interaction is independent.
-
-## Setting up memory
-
-To enable memory in Mastra, install the `@mastra/memory` package along with a storage provider.
-
-```bash npm2yarn
-npm install @mastra/memory@latest @mastra/libsql@latest
-```
-
-## Storage providers
-
-Memory requires a storage provider to persist message history, including user messages and agent responses. For more details on available providers and how storage works in Mastra, see the [Storage](https://mastra.ai/docs/memory/storage) documentation.
-
-## Configuring memory
-
-  ### Step
-
-Enable memory by creating a `Memory` instance and passing it to the agent’s `memory` option.
-
-```typescript {7-11} title="src/mastra/agents/memory-agent.ts"
-import { Agent } from "@mastra/core/agent";
-import { Memory } from "@mastra/memory";
-
-export const memoryAgent = new Agent({
-  id: 'memory-agent',
-  name: 'Memory Agent',
-  memory: new Memory({
-    options: {
-      lastMessages: 20,
-    },
-  }),
-});
-```
-
-> **Note:**
-
-Visit [Memory Class](https://mastra.ai/reference/memory/memory-class) for a full list of configuration options.
-
-  
-
-  ### Step
-
-Add a storage provider to your main Mastra instance to enable memory across all configured agents.
-
-```typescript {5-8} title="src/mastra/index.ts"
-import { Mastra } from "@mastra/core";
-import { LibSQLStore } from "@mastra/libsql";
-
-export const mastra = new Mastra({
-  storage: new LibSQLStore({
-    id: 'mastra-storage',
-    url: ":memory:",
-  }),
-});
-```
-
-> **Note:**
-
-Visit [libSQL Storage](https://mastra.ai/reference/storage/libsql) for a full list of configuration options.
-
-  
-
-Alternatively, add storage directly to an agent’s memory to keep data separate or use different providers per agent.
-
-```typescript {9-12} title="src/mastra/agents/memory-agent.ts"
-import { Agent } from "@mastra/core/agent";
-import { Memory } from "@mastra/memory";
-import { LibSQLStore } from "@mastra/libsql";
-
-export const memoryAgent = new Agent({
-  id: 'memory-agent',
-  name: 'Memory Agent',
-  memory: new Memory({
-    storage: new LibSQLStore({
-      id: 'mastra-storage',
-      url: ":memory:",
-    }),
-  }),
-});
-```
-
-> **Mastra Cloud Store limitation**
-Agent-level storage is not supported when using [Mastra Cloud Store](https://mastra.ai/docs/mastra-cloud/deployment#using-mastra-cloud-store). If you use Mastra Cloud Store, configure storage on the Mastra instance instead. This limitation does not apply if you bring your own database.
-
-## Message history
-
-Include a `memory` object with both `resource` and `thread` to track message history during agent calls.
-
-- `resource`: A stable identifier for the user or entity.
-- `thread`: An ID that isolates a specific conversation or session.
-
-These fields tell the agent where to store and retrieve context, enabling persistent, thread-aware memory across a conversation.
-
-```typescript {4-7}
-const response = await memoryAgent.generate(
-  "Remember my favorite color is blue.",
-  {
-    memory: {
-      resource: "user-123",
-      thread: "conversation-123",
-    },
-  },
-);
-```
-
-To recall information stored in memory, call the agent with the same `resource` and `thread` values used in the original conversation.
-
-```typescript {2-5}
-const response = await memoryAgent.generate("What's my favorite color?", {
-  memory: {
-    resource: "user-123",
-    thread: "conversation-123",
-  },
-});
-```
-
-> **Note:**
-Each thread has an owner (`resourceId`) that cannot be changed after creation. Avoid reusing the same thread ID for threads with different owners, as this will cause errors when querying.
-
-To learn more about memory see the [Memory](../memory/overview) documentation.
-
-## Using `RequestContext`
-
-Use [RequestContext](https://mastra.ai/docs/server/request-context) to access request-specific values. This lets you conditionally select different memory or storage configurations based on the context of the request.
-
-```typescript title="src/mastra/agents/memory-agent.ts"
-export type UserTier = {
-  "user-tier": "enterprise" | "pro";
-};
-
-const premiumMemory = new Memory();
-
-const standardMemory = new Memory();
-
-export const memoryAgent = new Agent({
-  id: 'memory-agent',
-  name: 'Memory Agent',
-  memory: ({ requestContext }) => {
-    const userTier = requestContext.get("user-tier") as UserTier["user-tier"];
-
-    return userTier === "enterprise" ? premiumMemory : standardMemory;
-  },
-});
-```
-
-> **Note:**
-
-Visit [Request Context](https://mastra.ai/docs/server/request-context) for more information.
-
-## Related
-
-- [Working Memory](../memory/working-memory)
-- [Semantic Recall](../memory/semantic-recall)
-- [Storage](../memory/storage)
-- [Request Context](https://mastra.ai/docs/server/request-context)

package/dist/docs/core/01-reference.md

@@ -1,114 +0,0 @@
-# Core API Reference
-
-> API reference for core - 2 entries
-
-
----
-
-## Reference: Mastra.getMemory()
-
-> Documentation for the `Mastra.getMemory()` method in Mastra, which retrieves a registered memory instance by its registry key.
-
-The `.getMemory()` method retrieves a memory instance from the Mastra registry by its key. Memory instances are registered in the Mastra constructor and can be referenced by stored agents.
-
-## Usage example
-
-```typescript
-const memory = mastra.getMemory("conversationMemory");
-
-// Use the memory instance
-const thread = await memory.createThread({
-  resourceId: "user-123",
-  title: "New Conversation",
-});
-```
-
-## Parameters
-
-## Returns
-
-## Example: Registering and Retrieving Memory
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { Memory } from "@mastra/memory";
-import { LibSQLStore } from "@mastra/libsql";
-
-const conversationMemory = new Memory({
-  storage: new LibSQLStore({ id: 'conversation-store', url: ":memory:" }),
-});
-
-const mastra = new Mastra({
-  memory: {
-    conversationMemory,
-  },
-});
-
-// Later, retrieve the memory instance
-const memory = mastra.getMemory("conversationMemory");
-```
-
-## Related
-
-- [Mastra.listMemory()](https://mastra.ai/reference/core/listMemory)
-- [Memory overview](https://mastra.ai/docs/memory/overview)
-- [Agent Memory](https://mastra.ai/docs/agents/agent-memory)
-
----
-
-## Reference: Mastra.listMemory()
-
-> Documentation for the `Mastra.listMemory()` method in Mastra, which returns all registered memory instances.
-
-The `.listMemory()` method returns all memory instances registered with the Mastra instance.
-
-## Usage example
-
-```typescript
-const memoryInstances = mastra.listMemory();
-
-for (const [key, memory] of Object.entries(memoryInstances)) {
-  console.log(`Memory "${key}": ${memory.id}`);
-}
-```
-
-## Parameters
-
-This method takes no parameters.
-
-## Returns
-
-## Example: Checking Registered Memory
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { Memory } from "@mastra/memory";
-import { LibSQLStore } from "@mastra/libsql";
-
-const conversationMemory = new Memory({
-  id: "conversation-memory",
-  storage: new LibSQLStore({ id: 'conversation-store', url: ":memory:" }),
-});
-
-const analyticsMemory = new Memory({
-  id: "analytics-memory",
-  storage: new LibSQLStore({ id: 'analytics-store', url: ":memory:" }),
-});
-
-const mastra = new Mastra({
-  memory: {
-    conversationMemory,
-    analyticsMemory,
-  },
-});
-
-// List all registered memory instances
-const allMemory = mastra.listMemory();
-console.log(Object.keys(allMemory)); // ["conversationMemory", "analyticsMemory"]
-```
-
-## Related
-
-- [Mastra.getMemory()](https://mastra.ai/reference/core/getMemory)
-- [Memory overview](https://mastra.ai/docs/memory/overview)
-- [Agent Memory](https://mastra.ai/docs/agents/agent-memory)