@mastra/core 1.6.0 → 1.7.0-alpha.0

package/dist/docs/references/docs-memory-semantic-recall.md

@@ -1,272 +0,0 @@
-# Semantic Recall
-
-If you ask your friend what they did last weekend, they will search in their memory for events associated with "last weekend" and then tell you what they did. That's sort of like how semantic recall works in Mastra.
-
-> **Watch 📹:** What semantic recall is, how it works, and how to configure it in Mastra → [YouTube (5 minutes)](https://youtu.be/UVZtK8cK8xQ)
-
-## How Semantic Recall Works
-
-Semantic recall is RAG-based search that helps agents maintain context across longer interactions when messages are no longer within [recent message history](https://mastra.ai/docs/memory/message-history).
-
-It uses vector embeddings of messages for similarity search, integrates with various vector stores, and has configurable context windows around retrieved messages.
-
-![Diagram showing Mastra Memory semantic recall](/assets/images/semantic-recall-fd7b9336a6d0d18019216cb6d3dbe710.png)
-
-When it's enabled, new messages are used to query a vector DB for semantically similar messages.
-
-After getting a response from the LLM, all new messages (user, assistant, and tool calls/results) are inserted into the vector DB to be recalled in later interactions.
-
-## Quick Start
-
-Semantic recall is enabled by default, so if you give your agent memory it will be included:
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { Memory } from "@mastra/memory";
-
-const agent = new Agent({
-  id: "support-agent",
-  name: "SupportAgent",
-  instructions: "You are a helpful support agent.",
-  model: "openai/gpt-5.1",
-  memory: new Memory(),
-});
-```
-
-## Using the recall() Method
-
-While `listMessages` retrieves messages by thread ID with basic pagination, [`recall()`](https://mastra.ai/reference/memory/recall) adds support for **semantic search**. When you need to find messages by meaning rather than just recency, use `recall()` with a `vectorSearchString`:
-
-```typescript
-const memory = await agent.getMemory();
-
-// Basic recall - similar to listMessages
-const { messages } = await memory!.recall({
-  threadId: "thread-123",
-  perPage: 50,
-});
-
-// Semantic recall - find messages by meaning
-const { messages: relevantMessages } = await memory!.recall({
-  threadId: "thread-123",
-  vectorSearchString: "What did we discuss about the project deadline?",
-  threadConfig: {
-    semanticRecall: true,
-  },
-});
-```
-
-## Storage configuration
-
-Semantic recall relies on a [storage and vector db](https://mastra.ai/reference/memory/memory-class) to store messages and their embeddings.
-
-```ts
-import { Memory } from "@mastra/memory";
-import { Agent } from "@mastra/core/agent";
-import { LibSQLStore, LibSQLVector } from "@mastra/libsql";
-
-const agent = new Agent({
-  memory: new Memory({
-    // this is the default storage db if omitted
-    storage: new LibSQLStore({
-      id: 'agent-storage',
-      url: "file:./local.db",
-    }),
-    // this is the default vector db if omitted
-    vector: new LibSQLVector({
-      id: 'agent-vector',
-      url: "file:./local.db",
-    }),
-  }),
-});
-```
-
-Each vector store page below includes installation instructions, configuration parameters, and usage examples:
-
-- [Astra](https://mastra.ai/reference/vectors/astra)
-- [Chroma](https://mastra.ai/reference/vectors/chroma)
-- [Cloudflare Vectorize](https://mastra.ai/reference/vectors/vectorize)
-- [Convex](https://mastra.ai/reference/vectors/convex)
-- [Couchbase](https://mastra.ai/reference/vectors/couchbase)
-- [DuckDB](https://mastra.ai/reference/vectors/duckdb)
-- [Elasticsearch](https://mastra.ai/reference/vectors/elasticsearch)
-- [LanceDB](https://mastra.ai/reference/vectors/lance)
-- [libSQL](https://mastra.ai/reference/vectors/libsql)
-- [MongoDB](https://mastra.ai/reference/vectors/mongodb)
-- [OpenSearch](https://mastra.ai/reference/vectors/opensearch)
-- [Pinecone](https://mastra.ai/reference/vectors/pinecone)
-- [PostgreSQL](https://mastra.ai/reference/vectors/pg)
-- [Qdrant](https://mastra.ai/reference/vectors/qdrant)
-- [S3 Vectors](https://mastra.ai/reference/vectors/s3vectors)
-- [Turbopuffer](https://mastra.ai/reference/vectors/turbopuffer)
-- [Upstash](https://mastra.ai/reference/vectors/upstash)
-
-## Recall configuration
-
-The three main parameters that control semantic recall behavior are:
-
-1. **topK**: How many semantically similar messages to retrieve
-2. **messageRange**: How much surrounding context to include with each match
-3. **scope**: Whether to search within the current thread or across all threads owned by a resource (the default is resource scope).
-
-```typescript
-const agent = new Agent({
-  memory: new Memory({
-    options: {
-      semanticRecall: {
-        topK: 3, // Retrieve 3 most similar messages
-        messageRange: 2, // Include 2 messages before and after each match
-        scope: "resource", // Search across all threads for this user (default setting if omitted)
-      },
-    },
-  }),
-});
-```
-
-## Embedder configuration
-
-Semantic recall relies on an [embedding model](https://mastra.ai/reference/memory/memory-class) to convert messages into embeddings. Mastra supports embedding models through the model router using `provider/model` strings, or you can use any [embedding model](https://sdk.vercel.ai/docs/ai-sdk-core/embeddings) compatible with the AI SDK.
-
-#### Using the Model Router (Recommended)
-
-The simplest way is to use a `provider/model` string with autocomplete support:
-
-```ts
-import { Memory } from "@mastra/memory";
-import { Agent } from "@mastra/core/agent";
-import { ModelRouterEmbeddingModel } from "@mastra/core/llm";
-
-const agent = new Agent({
-  memory: new Memory({
-    embedder: new ModelRouterEmbeddingModel("openai/text-embedding-3-small"),
-  }),
-});
-```
-
-Supported embedding models:
-
-- **OpenAI**: `text-embedding-3-small`, `text-embedding-3-large`, `text-embedding-ada-002`
-- **Google**: `gemini-embedding-001`
-
-The model router automatically handles API key detection from environment variables (`OPENAI_API_KEY`, `GOOGLE_GENERATIVE_AI_API_KEY`).
-
-#### Using AI SDK Packages
-
-You can also use AI SDK embedding models directly:
-
-```ts
-import { Memory } from "@mastra/memory";
-import { Agent } from "@mastra/core/agent";
-import { ModelRouterEmbeddingModel } from "@mastra/core/llm";
-
-const agent = new Agent({
-  memory: new Memory({
-    embedder: new ModelRouterEmbeddingModel("openai/text-embedding-3-small"),
-  }),
-});
-```
-
-#### Using FastEmbed (Local)
-
-To use FastEmbed (a local embedding model), install `@mastra/fastembed`:
-
-**npm**:
-
-```bash
-npm install @mastra/fastembed@latest
-```
-
-**pnpm**:
-
-```bash
-pnpm add @mastra/fastembed@latest
-```
-
-**Yarn**:
-
-```bash
-yarn add @mastra/fastembed@latest
-```
-
-**Bun**:
-
-```bash
-bun add @mastra/fastembed@latest
-```
-
-Then configure it in your memory:
-
-```ts
-import { Memory } from "@mastra/memory";
-import { Agent } from "@mastra/core/agent";
-import { fastembed } from "@mastra/fastembed";
-
-const agent = new Agent({
-  memory: new Memory({
-    embedder: fastembed,
-  }),
-});
-```
-
-## PostgreSQL Index Optimization
-
-When using PostgreSQL as your vector store, you can optimize semantic recall performance by configuring the vector index. This is particularly important for large-scale deployments with thousands of messages.
-
-PostgreSQL supports both IVFFlat and HNSW indexes. By default, Mastra creates an IVFFlat index, but HNSW indexes typically provide better performance, especially with OpenAI embeddings which use inner product distance.
-
-```typescript
-import { Memory } from "@mastra/memory";
-import { PgStore, PgVector } from "@mastra/pg";
-
-const agent = new Agent({
-  memory: new Memory({
-    storage: new PgStore({
-      id: 'agent-storage',
-      connectionString: process.env.DATABASE_URL,
-    }),
-    vector: new PgVector({
-      id: 'agent-vector',
-      connectionString: process.env.DATABASE_URL,
-    }),
-    options: {
-      semanticRecall: {
-        topK: 5,
-        messageRange: 2,
-        indexConfig: {
-          type: "hnsw", // Use HNSW for better performance
-          metric: "dotproduct", // Best for OpenAI embeddings
-          m: 16, // Number of bi-directional links (default: 16)
-          efConstruction: 64, // Size of candidate list during construction (default: 64)
-        },
-      },
-    },
-  }),
-});
-```
-
-For detailed information about index configuration options and performance tuning, see the [PgVector configuration guide](https://mastra.ai/reference/vectors/pg).
-
-## Disabling
-
-There is a performance impact to using semantic recall. New messages are converted into embeddings and used to query a vector database before new messages are sent to the LLM.
-
-Semantic recall is enabled by default but can be disabled when not needed:
-
-```typescript
-const agent = new Agent({
-  memory: new Memory({
-    options: {
-      semanticRecall: false,
-    },
-  }),
-});
-```
-
-You might want to disable semantic recall in scenarios like:
-
-- When message history provides sufficient context for the current conversation.
-- In performance-sensitive applications, like realtime two-way audio, where the added latency of creating embeddings and running vector queries is noticeable.
-
-## Viewing Recalled Messages
-
-When tracing is enabled, any messages retrieved via semantic recall will appear in the agent's trace output, alongside recent message history (if configured).

package/dist/docs/references/docs-memory-storage.md

@@ -1,261 +0,0 @@
-# Storage
-
-For agents to remember previous interactions, Mastra needs a database. Use a storage adapter for one of the [supported databases](#supported-providers) and pass it to your Mastra instance.
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { LibSQLStore } from "@mastra/libsql";
-
-export const mastra = new Mastra({
-  storage: new LibSQLStore({
-    id: 'mastra-storage',
-    url: "file:./mastra.db",
-  }),
-});
-```
-
-> **Sharing the database with Mastra Studio:** When running `mastra dev` alongside your application (e.g., Next.js), use an absolute path to ensure both processes access the same database:
->
-> ```typescript
-> url: "file:/absolute/path/to/your/project/mastra.db"
-> ```
->
-> Relative paths like `file:./mastra.db` resolve based on each process's working directory, which may differ.
-
-This configures instance-level storage, which all agents share by default. You can also configure [agent-level storage](#agent-level-storage) for isolated data boundaries.
-
-Mastra automatically creates the necessary tables on first interaction. See the [core schema](https://mastra.ai/reference/storage/overview) for details on what gets created, including tables for messages, threads, resources, workflows, traces, and evaluation datasets.
-
-## Supported providers
-
-Each provider page includes installation instructions, configuration parameters, and usage examples:
-
-- [libSQL](https://mastra.ai/reference/storage/libsql)
-- [PostgreSQL](https://mastra.ai/reference/storage/postgresql)
-- [MongoDB](https://mastra.ai/reference/storage/mongodb)
-- [Upstash](https://mastra.ai/reference/storage/upstash)
-- [Cloudflare D1](https://mastra.ai/reference/storage/cloudflare-d1)
-- [Cloudflare Durable Objects](https://mastra.ai/reference/storage/cloudflare)
-- [Convex](https://mastra.ai/reference/storage/convex)
-- [DynamoDB](https://mastra.ai/reference/storage/dynamodb)
-- [LanceDB](https://mastra.ai/reference/storage/lance)
-- [Microsoft SQL Server](https://mastra.ai/reference/storage/mssql)
-
-> **Tip:** libSQL is the easiest way to get started because it doesn’t require running a separate database server.
-
-## Configuration scope
-
-Storage can be configured at the instance level (shared by all agents) or at the agent level (isolated to a specific agent).
-
-### Instance-level storage
-
-Add storage to your Mastra instance so all agents, workflows, observability traces and scores share the same memory provider:
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { PostgresStore } from "@mastra/pg";
-
-export const mastra = new Mastra({
-  storage: new PostgresStore({
-    id: 'mastra-storage',
-    connectionString: process.env.DATABASE_URL,
-  }),
-});
-
-// Both agents inherit storage from the Mastra instance above
-const agent1 = new Agent({ id: "agent-1", memory: new Memory() });
-const agent2 = new Agent({ id: "agent-2", memory: new Memory() });
-```
-
-This is useful when all primitives share the same storage backend and have similar performance, scaling, and operational requirements.
-
-#### Composite storage
-
-[Composite storage](https://mastra.ai/reference/storage/composite) is an alternative way to configure instance-level storage. Use `MastraCompositeStore` to set the `memory` domain (and any other [domains](https://mastra.ai/reference/storage/composite) you need) to different storage providers.
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { MastraCompositeStore } from "@mastra/core/storage";
-import { MemoryLibSQL } from "@mastra/libsql";
-import { WorkflowsPG } from "@mastra/pg";
-import { ObservabilityStorageClickhouse } from "@mastra/clickhouse";
-
-export const mastra = new Mastra({
-  storage: new MastraCompositeStore({
-    id: "composite",
-    domains: {
-      memory: new MemoryLibSQL({ url: "file:./memory.db" }),
-      workflows: new WorkflowsPG({ connectionString: process.env.DATABASE_URL }),
-      observability: new ObservabilityStorageClickhouse({
-        url: process.env.CLICKHOUSE_URL,
-        username: process.env.CLICKHOUSE_USERNAME,
-        password: process.env.CLICKHOUSE_PASSWORD,
-      }),
-    },
-  }),
-});
-```
-
-This is useful when different types of data have different performance or operational requirements, such as low-latency storage for memory, durable storage for workflows, and high-throughput storage for observability.
-
-### Agent-level storage
-
-Agent-level storage overrides storage configured at the instance level. Add storage to a specific agent when you need data boundaries or compliance requirements:
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { Memory } from "@mastra/memory";
-import { PostgresStore } from "@mastra/pg";
-
-export const agent = new Agent({
-  id: "agent",
-  memory: new Memory({
-    storage: new PostgresStore({
-      id: 'agent-storage',
-      connectionString: process.env.AGENT_DATABASE_URL,
-    }),
-  }),
-});
-```
-
-> **Warning:** [Mastra Cloud Store](https://mastra.ai/docs/mastra-cloud/deployment) doesn't support agent-level storage.
-
-## Threads and resources
-
-Mastra organizes conversations using two identifiers:
-
-- **Thread** - a conversation session containing a sequence of messages.
-- **Resource** - the entity that owns the thread, such as a user, organization, project, or any other domain entity in your application.
-
-Both identifiers are required for agents to store information:
-
-**Generate**:
-
-```typescript
-const response = await agent.generate("hello", {
-  memory: {
-    thread: "conversation-abc-123",
-    resource: "user_123",
-  },
-});
-```
-
-**Stream**:
-
-```typescript
-const stream = await agent.stream("hello", {
-  memory: {
-    thread: "conversation-abc-123",
-    resource: "user_123",
-  },
-});
-```
-
-> **Note:** [Studio](https://mastra.ai/docs/getting-started/studio) automatically generates a thread and resource ID for you. When calling `stream()` or `generate()` yourself, remember to provide these identifiers explicitly.
-
-### Thread title generation
-
-Mastra can automatically generate descriptive thread titles based on the user's first message when `generateTitle` is enabled.
-
-Use this option when implementing a ChatGPT-style chat interface to render a title alongside each thread in the conversation list (for example, in a sidebar) derived from the thread’s initial user message.
-
-```typescript
-export const agent = new Agent({
-  id: "agent",
-  memory: new Memory({
-    options: {
-      generateTitle: true,
-    },
-  }),
-});
-```
-
-Title generation runs asynchronously after the agent responds and does not affect response time.
-
-To optimize cost or behavior, provide a smaller [`model`](https://mastra.ai/models) and custom `instructions`:
-
-```typescript
-export const agent = new Agent({
-  id: "agent",
-  memory: new Memory({
-    options: {
-      generateTitle: {
-        model: "openai/gpt-4o-mini",
-        instructions: "Generate a 1 word title",
-      },
-    },
-  }),
-});
-```
-
-## Semantic recall
-
-Semantic recall has different storage requirements - it needs a vector database in addition to the standard storage adapter. See [Semantic recall](https://mastra.ai/docs/memory/semantic-recall) for setup and supported vector providers.
-
-## Handling large attachments
-
-Some storage providers enforce record size limits that base64-encoded file attachments (such as images) can exceed:
-
-| Provider                                                           | Record size limit |
-| ------------------------------------------------------------------ | ----------------- |
-| [DynamoDB](https://mastra.ai/reference/storage/dynamodb)           | 400 KB            |
-| [Convex](https://mastra.ai/reference/storage/convex)               | 1 MiB             |
-| [Cloudflare D1](https://mastra.ai/reference/storage/cloudflare-d1) | 1 MiB             |
-
-PostgreSQL, MongoDB, and libSQL have higher limits and are generally unaffected.
-
-To avoid this, use an input processor to upload attachments to external storage (S3, R2, GCS, [Convex file storage](https://docs.convex.dev/file-storage), etc.) and replace them with URL references before persistence.
-
-```typescript
-import type { Processor } from "@mastra/core/processors";
-import type { MastraDBMessage } from "@mastra/core/memory";
-
-export class AttachmentUploader implements Processor {
-  id = "attachment-uploader";
-
-  async processInput({ messages }: { messages: MastraDBMessage[] }) {
-    return Promise.all(messages.map((msg) => this.processMessage(msg)));
-  }
-
-  async processMessage(msg: MastraDBMessage) {
-    const attachments = msg.content.experimental_attachments;
-    if (!attachments?.length) return msg;
-
-    const uploaded = await Promise.all(
-      attachments.map(async (att) => {
-        // Skip if already a URL
-        if (!att.url?.startsWith("data:")) return att;
-
-        // Upload base64 data and replace with URL
-        const url = await this.upload(att.url, att.contentType);
-        return { ...att, url };
-      })
-    );
-
-    return { ...msg, content: { ...msg.content, experimental_attachments: uploaded } };
-  }
-
-  async upload(dataUri: string, contentType?: string): Promise<string> {
-    const base64 = dataUri.split(",")[1];
-    const buffer = Buffer.from(base64, "base64");
-
-    // Replace with your storage provider (S3, R2, GCS, Convex, etc.)
-    // return await s3.upload(buffer, contentType);
-    throw new Error("Implement upload() with your storage provider");
-  }
-}
-```
-
-Use the processor with your agent:
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { Memory } from "@mastra/memory";
-import { AttachmentUploader } from "./processors/attachment-uploader";
-
-const agent = new Agent({
-  id: "my-agent",
-  memory: new Memory({ storage: yourStorage }),
-  inputProcessors: [new AttachmentUploader()],
-});
-```