@mastra/pg 1.6.1 → 1.7.0

package/dist/docs/references/reference-memory-memory-class.md

@@ -0,0 +1,147 @@
+# Memory Class
+
+The `Memory` class provides a robust system for managing conversation history and thread-based message storage in Mastra. It enables persistent storage of conversations, semantic search capabilities, and efficient message retrieval. You must configure a storage provider for conversation history, and if you enable semantic recall you will also need to provide a vector store and embedder.
+
+## Usage example
+
+```typescript
+import { Memory } from '@mastra/memory'
+import { Agent } from '@mastra/core/agent'
+
+export const agent = new Agent({
+  name: 'test-agent',
+  instructions: 'You are an agent with memory.',
+  model: 'openai/gpt-5.1',
+  memory: new Memory({
+    options: {
+      workingMemory: {
+        enabled: true,
+      },
+    },
+  }),
+})
+```
+
+> To enable `workingMemory` on an agent, you’ll need a storage provider configured on your main Mastra instance. See [Mastra class](https://mastra.ai/reference/core/mastra-class) for more information.
+
+## Constructor parameters
+
+**storage?:** (`MastraCompositeStore`): Storage implementation for persisting memory data. Defaults to \`new DefaultStorage({ config: { url: "file:memory.db" } })\` if not provided.
+
+**vector?:** (`MastraVector | false`): Vector store for semantic search capabilities. Set to \`false\` to disable vector operations.
+
+**embedder?:** (`EmbeddingModel<string> | EmbeddingModelV2<string>`): Embedder instance for vector embeddings. Required when semantic recall is enabled.
+
+**options?:** (`MemoryConfig`): Memory configuration options.
+
+### Options parameters
+
+**lastMessages?:** (`number | false`): Number of most recent messages to include in context. Set to \`false\` to disable loading conversation history into context. Use \`Number.MAX\_SAFE\_INTEGER\` to retrieve all messages with no limit. To prevent saving new messages, use the \`readOnly\` option instead. (Default: `10`)
+
+**readOnly?:** (`boolean`): When true, prevents memory from saving new messages and provides working memory as read-only context (without the updateWorkingMemory tool). Useful for read-only operations like previews, internal routing agents, or sub agents that should reference but not modify memory. (Default: `false`)
+
+**semanticRecall?:** (`boolean | { topK: number; messageRange: number | { before: number; after: number }; scope?: 'thread' | 'resource' }`): Enable semantic search in message history. Can be a boolean or an object with configuration options. When enabled, requires both vector store and embedder to be configured. Default topK is 4, default messageRange is {before: 1, after: 1}. (Default: `false`)
+
+**workingMemory?:** (`WorkingMemory`): Configuration for working memory feature. Can be \`{ enabled: boolean; template?: string; schema?: ZodObject\<any> | JSONSchema7; scope?: 'thread' | 'resource' }\` or \`{ enabled: boolean }\` to disable. (Default: `{ enabled: false, template: '# User Information\n- **First Name**:\n- **Last Name**:\n...' }`)
+
+**observationalMemory?:** (`boolean | ObservationalMemoryOptions`): Enable Observational Memory for long-context agentic memory. Set to \`true\` for defaults, or pass a config object to customize token budgets, models, and scope. See \[Observational Memory reference]\(/reference/memory/observational-memory) for configuration details. (Default: `false`)
+
+**generateTitle?:** (`boolean | { model: DynamicArgument<MastraLanguageModel>; instructions?: DynamicArgument<string> }`): Controls automatic thread title generation from the user's first message. Can be a boolean or an object with custom model and instructions. (Default: `false`)
+
+## Returns
+
+**memory:** (`Memory`): A new Memory instance with the specified configuration.
+
+## Extended usage example
+
+```typescript
+import { Memory } from '@mastra/memory'
+import { Agent } from '@mastra/core/agent'
+import { LibSQLStore, LibSQLVector } from '@mastra/libsql'
+
+export const agent = new Agent({
+  name: 'test-agent',
+  instructions: 'You are an agent with memory.',
+  model: 'openai/gpt-5.1',
+  memory: new Memory({
+    storage: new LibSQLStore({
+      id: 'test-agent-storage',
+      url: 'file:./working-memory.db',
+    }),
+    vector: new LibSQLVector({
+      id: 'test-agent-vector',
+      url: 'file:./vector-memory.db',
+    }),
+    options: {
+      lastMessages: 10,
+      semanticRecall: {
+        topK: 3,
+        messageRange: 2,
+        scope: 'resource',
+      },
+      workingMemory: {
+        enabled: true,
+      },
+      generateTitle: true,
+    },
+  }),
+})
+```
+
+## PostgreSQL with index configuration
+
+```typescript
+import { Memory } from '@mastra/memory'
+import { Agent } from '@mastra/core/agent'
+import { ModelRouterEmbeddingModel } from '@mastra/core/llm'
+import { PgStore, PgVector } from '@mastra/pg'
+
+export const agent = new Agent({
+  name: 'pg-agent',
+  instructions: 'You are an agent with optimized PostgreSQL memory.',
+  model: 'openai/gpt-5.1',
+  memory: new Memory({
+    storage: new PgStore({
+      id: 'pg-agent-storage',
+      connectionString: process.env.DATABASE_URL,
+    }),
+    vector: new PgVector({
+      id: 'pg-agent-vector',
+      connectionString: process.env.DATABASE_URL,
+    }),
+    embedder: new ModelRouterEmbeddingModel('openai/text-embedding-3-small'),
+    options: {
+      lastMessages: 20,
+      semanticRecall: {
+        topK: 5,
+        messageRange: 3,
+        scope: 'resource',
+        indexConfig: {
+          type: 'hnsw', // Use HNSW for better performance
+          metric: 'dotproduct', // Optimal for OpenAI embeddings
+          m: 16, // Number of bi-directional links
+          efConstruction: 64, // Construction-time candidate list size
+        },
+      },
+      workingMemory: {
+        enabled: true,
+      },
+    },
+  }),
+})
+```
+
+### Related
+
+- [Getting Started with Memory](https://mastra.ai/docs/memory/overview)
+- [Semantic Recall](https://mastra.ai/docs/memory/semantic-recall)
+- [Working Memory](https://mastra.ai/docs/memory/working-memory)
+- [Observational Memory](https://mastra.ai/docs/memory/observational-memory)
+- [Memory Processors](https://mastra.ai/docs/memory/memory-processors)
+- [createThread](https://mastra.ai/reference/memory/createThread)
+- [recall](https://mastra.ai/reference/memory/recall)
+- [getThreadById](https://mastra.ai/reference/memory/getThreadById)
+- [listThreads](https://mastra.ai/reference/memory/listThreads)
+- [deleteMessages](https://mastra.ai/reference/memory/deleteMessages)
+- [cloneThread](https://mastra.ai/reference/memory/cloneThread)
+- [Clone Utility Methods](https://mastra.ai/reference/memory/clone-utilities)

package/dist/docs/references/reference-processors-message-history-processor.md

@@ -0,0 +1,85 @@
+# MessageHistory
+
+The `MessageHistory` is a **hybrid processor** that handles both retrieval and persistence of message history. On input, it fetches historical messages from storage and prepends them to the conversation. On output, it persists new messages to storage.
+
+## Usage example
+
+```typescript
+import { MessageHistory } from '@mastra/core/processors'
+
+const processor = new MessageHistory({
+  storage: memoryStorage,
+  lastMessages: 50,
+})
+```
+
+## Constructor parameters
+
+**options:** (`MessageHistoryOptions`): Configuration options for the message history processor
+
+### Options
+
+**storage:** (`MemoryStorage`): Storage instance for retrieving and persisting messages
+
+**lastMessages?:** (`number`): Maximum number of historical messages to retrieve. If not specified, retrieves all messages
+
+## Returns
+
+**id:** (`string`): Processor identifier set to 'message-history'
+
+**name:** (`string`): Processor display name set to 'MessageHistory'
+
+**processInput:** (`(args: { messages: MastraDBMessage[]; messageList: MessageList; abort: (reason?: string) => never; tracingContext?: TracingContext; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Fetches historical messages from storage and adds them to the message list
+
+**processOutputResult:** (`(args: { messages: MastraDBMessage[]; messageList: MessageList; abort: (reason?: string) => never; tracingContext?: TracingContext; requestContext?: RequestContext }) => Promise<MessageList>`): Persists new messages (user input and assistant response) to storage, excluding system messages
+
+## Extended usage example
+
+```typescript
+import { Agent } from '@mastra/core/agent'
+import { MessageHistory } from '@mastra/core/processors'
+import { PostgresStorage } from '@mastra/pg'
+
+const storage = new PostgresStorage({
+  connectionString: process.env.DATABASE_URL,
+})
+
+export const agent = new Agent({
+  name: 'memory-agent',
+  instructions: 'You are a helpful assistant with conversation memory',
+  model: 'openai:gpt-4o',
+  inputProcessors: [
+    new MessageHistory({
+      storage,
+      lastMessages: 100,
+    }),
+  ],
+  outputProcessors: [
+    new MessageHistory({
+      storage,
+    }),
+  ],
+})
+```
+
+## Behavior
+
+### Input processing
+
+1. Retrieves `threadId` from the request context
+2. Fetches historical messages from storage (ordered by creation date, descending)
+3. Filters out system messages (they should not be stored in the database)
+4. Merges historical messages with incoming messages, avoiding duplicates by ID
+5. Adds historical messages with `source: 'memory'` tag
+
+### Output processing
+
+1. Retrieves `threadId` from the request context
+2. Skips persistence if `readOnly` is set in memory config
+3. Filters out incomplete tool calls from messages
+4. Persists new user input and assistant response messages to storage
+5. Updates the thread's `updatedAt` timestamp
+
+## Related
+
+- [Guardrails](https://mastra.ai/docs/agents/guardrails)

package/dist/docs/references/reference-processors-semantic-recall-processor.md

@@ -0,0 +1,117 @@
+# SemanticRecall
+
+The `SemanticRecall` is a **hybrid processor** that enables semantic search over conversation history using vector embeddings. On input, it performs semantic search to find relevant historical messages. On output, it creates embeddings for new messages to enable future semantic retrieval.
+
+## Usage example
+
+```typescript
+import { SemanticRecall } from '@mastra/core/processors'
+import { openai } from '@ai-sdk/openai'
+
+const processor = new SemanticRecall({
+  storage: memoryStorage,
+  vector: vectorStore,
+  embedder: openai.embedding('text-embedding-3-small'),
+  topK: 5,
+  messageRange: 2,
+  scope: 'resource',
+})
+```
+
+## Constructor parameters
+
+**options:** (`SemanticRecallOptions`): Configuration options for the semantic recall processor
+
+### Options
+
+**storage:** (`MemoryStorage`): Storage instance for retrieving messages
+
+**vector:** (`MastraVector`): Vector store for semantic search
+
+**embedder:** (`MastraEmbeddingModel<string>`): Embedder for generating query embeddings
+
+**topK?:** (`number`): Number of most similar messages to retrieve
+
+**messageRange?:** (`number | { before: number; after: number }`): Number of context messages to include before/after each match. Can be a single number (same for both) or an object with separate values
+
+**scope?:** (`'thread' | 'resource'`): Scope of semantic search. 'thread' searches within the current thread only. 'resource' searches across all threads for the resource
+
+**threshold?:** (`number`): Minimum similarity score threshold (0-1). Messages below this threshold are filtered out
+
+**indexName?:** (`string`): Index name for the vector store. If not provided, auto-generated based on embedder model
+
+**logger?:** (`IMastraLogger`): Optional logger instance for structured logging
+
+## Returns
+
+**id:** (`string`): Processor identifier set to 'semantic-recall'
+
+**name:** (`string`): Processor display name set to 'SemanticRecall'
+
+**processInput:** (`(args: { messages: MastraDBMessage[]; messageList: MessageList; abort: (reason?: string) => never; tracingContext?: TracingContext; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Performs semantic search on historical messages and adds relevant context to the message list
+
+**processOutputResult:** (`(args: { messages: MastraDBMessage[]; messageList?: MessageList; abort: (reason?: string) => never; tracingContext?: TracingContext; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Creates embeddings for new messages to enable future semantic search
+
+## Extended usage example
+
+```typescript
+import { Agent } from '@mastra/core/agent'
+import { SemanticRecall, MessageHistory } from '@mastra/core/processors'
+import { PostgresStorage } from '@mastra/pg'
+import { PgVector } from '@mastra/pg'
+import { openai } from '@ai-sdk/openai'
+
+const storage = new PostgresStorage({
+  id: 'pg-storage',
+  connectionString: process.env.DATABASE_URL,
+})
+
+const vector = new PgVector({
+  id: 'pg-vector',
+  connectionString: process.env.DATABASE_URL,
+})
+
+const semanticRecall = new SemanticRecall({
+  storage,
+  vector,
+  embedder: openai.embedding('text-embedding-3-small'),
+  topK: 5,
+  messageRange: { before: 2, after: 1 },
+  scope: 'resource',
+  threshold: 0.7,
+})
+
+export const agent = new Agent({
+  name: 'semantic-memory-agent',
+  instructions: 'You are a helpful assistant with semantic memory recall',
+  model: 'openai:gpt-4o',
+  inputProcessors: [semanticRecall, new MessageHistory({ storage, lastMessages: 50 })],
+  outputProcessors: [semanticRecall, new MessageHistory({ storage })],
+})
+```
+
+## Behavior
+
+### Input processing
+
+1. Extracts the user query from the last user message
+2. Generates embeddings for the query
+3. Performs vector search to find semantically similar messages
+4. Retrieves matched messages along with surrounding context (based on `messageRange`)
+5. For `scope: 'resource'`, formats cross-thread messages as a system message with timestamps
+6. Adds recalled messages with `source: 'memory'` tag
+
+### Output processing
+
+1. Extracts text content from new user and assistant messages
+2. Generates embeddings for each message
+3. Stores embeddings in the vector store with metadata (message ID, thread ID, resource ID, role, content, timestamp)
+4. Uses LRU caching for embeddings to avoid redundant API calls
+
+### Cross-thread recall
+
+When `scope` is set to `'resource'`, the processor can recall messages from other threads. These cross-thread messages are formatted as a system message with timestamps and conversation labels to provide context about when and where the conversation occurred.
+
+## Related
+
+- [Guardrails](https://mastra.ai/docs/agents/guardrails)

package/dist/docs/references/reference-processors-working-memory-processor.md

@@ -0,0 +1,152 @@
+# WorkingMemory
+
+The `WorkingMemory` is an **input processor** that injects working memory data as a system message. It retrieves persistent information from storage and formats it as instructions for the LLM, enabling the agent to maintain context about users across conversations.
+
+## Usage example
+
+```typescript
+import { WorkingMemory } from '@mastra/core/processors'
+
+const processor = new WorkingMemory({
+  storage: memoryStorage,
+  scope: 'resource',
+  template: {
+    format: 'markdown',
+    content: `# User Profile
+- **Name**:
+- **Preferences**:
+- **Goals**:
+`,
+  },
+})
+```
+
+## Constructor parameters
+
+**options:** (`Options`): Configuration options for the working memory processor
+
+### Options
+
+**storage:** (`MemoryStorage`): Storage instance for retrieving working memory data
+
+**template?:** (`WorkingMemoryTemplate`): Template defining the format and structure of working memory
+
+**scope?:** (`'thread' | 'resource'`): Scope of working memory. 'thread' scopes to current thread, 'resource' shares across all threads for the resource
+
+**useVNext?:** (`boolean`): Use the next-generation instruction format with improved guidelines
+
+**readOnly?:** (`boolean`): When true, working memory is provided as read-only context. The data is injected into the conversation but without the updateWorkingMemory tool or update instructions. Useful for agents that should reference working memory without modifying it.
+
+**templateProvider?:** (`{ getWorkingMemoryTemplate(args: { memoryConfig?: MemoryConfig }): Promise<WorkingMemoryTemplate | null> }`): Dynamic template provider for runtime template resolution
+
+**logger?:** (`IMastraLogger`): Optional logger instance for structured logging
+
+### WorkingMemoryTemplate
+
+**format:** (`'markdown' | 'json'`): Format of the working memory content
+
+**content:** (`string`): Template content defining the structure of working memory data
+
+## Returns
+
+**id:** (`string`): Processor identifier set to 'working-memory'
+
+**name:** (`string`): Processor display name set to 'WorkingMemory'
+
+**defaultWorkingMemoryTemplate:** (`string`): The default markdown template used when no custom template is provided
+
+**processInput:** (`(args: { messages: MastraDBMessage[]; messageList: MessageList; abort: (reason?: string) => never; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Retrieves working memory and adds it as a system message to the message list
+
+## Extended usage example
+
+```typescript
+import { Agent } from '@mastra/core/agent'
+import { WorkingMemory, MessageHistory } from '@mastra/core/processors'
+import { PostgresStorage } from '@mastra/pg'
+
+const storage = new PostgresStorage({
+  connectionString: process.env.DATABASE_URL,
+})
+
+export const agent = new Agent({
+  name: 'personalized-agent',
+  instructions: 'You are a helpful assistant that remembers user preferences',
+  model: 'openai:gpt-4o',
+  inputProcessors: [
+    new WorkingMemory({
+      storage,
+      scope: 'resource',
+      template: {
+        format: 'markdown',
+        content: `# User Information
+- **Name**:
+- **Location**:
+- **Preferences**:
+- **Communication Style**:
+- **Current Projects**:
+`,
+      },
+    }),
+    new MessageHistory({ storage, lastMessages: 50 }),
+  ],
+  outputProcessors: [new MessageHistory({ storage })],
+})
+```
+
+## JSON format example
+
+```typescript
+import { WorkingMemory } from '@mastra/core/processors'
+
+const processor = new WorkingMemory({
+  storage: memoryStorage,
+  scope: 'resource',
+  template: {
+    format: 'json',
+    content: JSON.stringify({
+      user: {
+        name: { type: 'string' },
+        preferences: { type: 'object' },
+        goals: { type: 'array' },
+      },
+    }),
+  },
+})
+```
+
+## Behavior
+
+### Input processing
+
+1. Retrieves `threadId` and `resourceId` from the request context
+
+2. Based on scope, fetches working memory from either:
+
+   - Thread metadata (`scope: 'thread'`)
+   - Resource record (`scope: 'resource'`)
+
+3. Resolves the template (from provider, options, or default)
+
+4. Generates system instructions based on mode:
+
+   - **Normal mode**: Includes guidelines for storing/updating information, template structure, and current data
+   - **Read-only mode** (`readOnly: true`): Includes only the current data as context without update instructions
+
+5. Adds the instruction as a system message with `source: 'memory'` tag
+
+### Working memory updates
+
+Working memory updates happen through the `updateWorkingMemory` tool provided by the Memory class, not through this processor. The processor only handles injecting the current working memory state into conversations.
+
+### Default template
+
+If no template is provided, the processor uses a default markdown template with fields for:
+
+- First Name, Last Name
+- Location, Occupation
+- Interests, Goals
+- Events, Facts, Projects
+
+## Related
+
+- [Guardrails](https://mastra.ai/docs/agents/guardrails)