@mastra/memory 1.6.2-alpha.0 → 1.6.2

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

@@ -2,7 +2,7 @@
 
 The `listThreads()` method retrieves threads with pagination support and optional filtering by `resourceId`, `metadata`, or both.
 
-## Usage Examples
+## Usage examples
 
 ### List all threads with pagination
 
@@ -26,7 +26,7 @@ const result = await memory.listThreads({
 })
 ```
 
-### Filter by resourceId
+### Filter by `resourceId`
 
 ```typescript
 const result = await memory.listThreads({
@@ -119,7 +119,7 @@ while (hasMorePages) {
 }
 ```
 
-## Metadata Filtering
+## Metadata filtering
 
 The metadata filter uses AND logic - all specified key-value pairs must match for a thread to be included in the results:
 

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

@@ -1,4 +1,4 @@
-# Memory Class
+# 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.
 

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

@@ -1,4 +1,4 @@
-# Observational Memory
+# Observational memory
 
 **Added in:** `@mastra/memory@1.1.0`
 

package/dist/docs/references/reference-storage-dynamodb.md

@@ -1,4 +1,4 @@
-# DynamoDB Storage
+# DynamoDB storage
 
 The DynamoDB storage implementation provides a scalable and performant NoSQL database solution for Mastra, leveraging a single-table design pattern with [ElectroDB](https://electrodb.dev/).
 
@@ -120,7 +120,7 @@ For local development, you can use [DynamoDB Local](https://docs.aws.amazon.com/
 
 **config.ttl** (`object`): TTL (Time To Live) configuration for automatic data expiration. Configure per entity type: thread, message, trace, eval, workflow\_snapshot, resource, score. Each entity config includes: enabled (boolean), attributeName (string, default: 'ttl'), defaultTtlSeconds (number).
 
-## TTL (Time To Live) Configuration
+## TTL (time to live) configuration
 
 DynamoDB TTL allows you to automatically delete items after a specified time period. This is useful for:
 
@@ -216,7 +216,7 @@ aws dynamodb update-time-to-live \
 
 > **Note:** DynamoDB deletes expired items within 48 hours after expiration. Items remain queryable until actually deleted.
 
-## AWS IAM Permissions
+## AWS IAM permissions
 
 The IAM role or user executing the code needs appropriate permissions to interact with the specified DynamoDB table and its indexes. Below is a sample policy. Replace `${YOUR_TABLE_NAME}` with your actual table name and `${YOUR_AWS_REGION}` and `${YOUR_AWS_ACCOUNT_ID}` with appropriate values.
 
@@ -246,7 +246,7 @@ The IAM role or user executing the code needs appropriate permissions to interac
 }
 ```
 
-## Key Considerations
+## Key considerations
 
 Before diving into the architectural details, keep these key points in mind when working with the DynamoDB storage adapter:
 
@@ -255,7 +255,7 @@ Before diving into the architectural details, keep these key points in mind when
 - **Understanding GSIs:** Familiarity with how the GSIs are structured (as per `TABLE_SETUP.md`) is important for understanding data retrieval and potential query patterns.
 - **ElectroDB:** The adapter uses ElectroDB to manage interactions with DynamoDB, providing a layer of abstraction and type safety over raw DynamoDB operations.
 
-## Architectural Approach
+## Architectural approach
 
 This storage adapter utilizes a **single-table design pattern** leveraging [ElectroDB](https://electrodb.dev/), a common and recommended approach for DynamoDB. This differs architecturally from relational database adapters (like `@mastra/pg` or `@mastra/libsql`) that typically use multiple tables, each dedicated to a specific entity (threads, messages, etc.).
 

package/dist/docs/references/reference-storage-libsql.md

@@ -1,4 +1,4 @@
-# libSQL Storage
+# libSQL storage
 
 [libSQL](https://docs.turso.tech/libsql) is an open-source, SQLite-compatible database that supports both local and remote deployments. It can be used to store message history, workflow snapshots, traces, and eval scores.
 

package/dist/docs/references/reference-storage-mongodb.md

@@ -1,4 +1,4 @@
-# MongoDB Storage
+# MongoDB storage
 
 The MongoDB storage implementation provides a scalable storage solution using MongoDB databases with support for both document storage and vector operations.
 
@@ -56,7 +56,7 @@ const storage = new MongoDBStore({
 
 > **Deprecation Notice:** The `url` parameter is deprecated but still supported for backward compatibility. Please use `uri` instead in all new code.
 
-## Constructor Examples
+## Constructor examples
 
 You can instantiate `MongoDBStore` in the following ways:
 
@@ -84,7 +84,7 @@ const store2 = new MongoDBStore({
 })
 ```
 
-## Additional Notes
+## Additional notes
 
 ### Collection Management
 
@@ -138,7 +138,7 @@ const thread = await memoryStore?.getThreadById({ threadId: '...' })
 
 > **Warning:** If `init()` isn't called, collections won't be created and storage operations will fail silently or throw errors.
 
-## Vector Search Capabilities
+## Vector search capabilities
 
 MongoDB storage includes built-in vector search capabilities for AI applications:
 
@@ -190,7 +190,7 @@ const results = await vectorStore.query({
 });
 ```
 
-## Usage Example
+## Usage example
 
 ### Adding memory to an agent
 

package/dist/docs/references/reference-storage-postgresql.md

@@ -1,4 +1,4 @@
-# PostgreSQL Storage
+# PostgreSQL storage
 
 The PostgreSQL storage implementation provides a production-ready storage solution using PostgreSQL databases.
 
@@ -71,7 +71,7 @@ const storage = new PostgresStore({
 
 **indexes** (`CreateIndexOptions[]`): Custom indexes to create during initialization.
 
-## Constructor Examples
+## Constructor examples
 
 You can instantiate `PostgresStore` in the following ways:
 
@@ -119,7 +119,7 @@ const store4 = new PostgresStore({
 })
 ```
 
-## Additional Notes
+## Additional notes
 
 ### Schema Management
 
@@ -316,7 +316,7 @@ This pattern ensures only one `PostgresStore` instance is created regardless of
 
 > **Tip:** This singleton pattern is only necessary during local development with HMR. In production builds, modules are only loaded once.
 
-## Usage Example
+## Usage example
 
 ### Adding memory to an agent
 
@@ -387,7 +387,7 @@ for await (const chunk of stream.textStream) {
 }
 ```
 
-## Index Management
+## Index management
 
 PostgreSQL storage provides index management to optimize query performance.
 

package/dist/docs/references/reference-storage-upstash.md

@@ -1,4 +1,4 @@
-# Upstash Storage
+# Upstash storage
 
 The Upstash storage implementation provides a serverless-friendly storage solution using Upstash's Redis-compatible key-value store.
 
@@ -52,7 +52,7 @@ const storage = new UpstashStore({
 
 **prefix** (`string`): Key prefix for all stored items (Default: `mastra:`)
 
-## Additional Notes
+## Additional notes
 
 ### Key Structure
 
@@ -87,7 +87,7 @@ For optimal performance:
 - Monitor Redis memory usage
 - Consider data expiration policies if needed
 
-## Usage Example
+## Usage example
 
 ### Adding memory to an agent
 

package/dist/docs/references/reference-vectors-libsql.md

@@ -1,4 +1,4 @@
-# libSQL Vector Store
+# libSQL vector store
 
 The libSQL storage implementation provides a SQLite-compatible vector search [libSQL](https://github.com/tursodatabase/libsql), a fork of SQLite with vector extensions, and [Turso](https://turso.tech/) with vector extensions, offering a lightweight and efficient vector database solution. It's part of the `@mastra/libsql` package and offers efficient vector similarity search with metadata filtering.
 
@@ -69,7 +69,7 @@ const results = await store.query({
 });
 ```
 
-## Constructor Options
+## Constructor options
 
 **url** (`string`): libSQL database URL. Use ':memory:' for in-memory database, 'file:dbname.db' for local file, or a libSQL-compatible connection string like 'libsql://your-database.turso.io'.
 
@@ -81,7 +81,7 @@ const results = await store.query({
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 Creates a new vector collection. The index name must start with a letter or underscore and can only contain letters, numbers, and underscores. The dimension must be a positive integer.
 
@@ -91,7 +91,7 @@ Creates a new vector collection. The index name must start with a letter or unde
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search. Note: Currently only cosine similarity is supported by libSQL. (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
 Adds or updates vectors and their metadata in the index. Uses a transaction to ensure all vectors are inserted atomically - if any insert fails, the entire operation is rolled back.
 
@@ -103,7 +103,7 @@ Adds or updates vectors and their metadata in the index. Uses a transaction to e
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 Searches for similar vectors with optional metadata filtering.
 
@@ -119,7 +119,7 @@ Searches for similar vectors with optional metadata filtering.
 
 **minScore** (`number`): Minimum similarity score threshold (Default: `0`)
 
-### describeIndex()
+### `describeIndex()`
 
 Gets information about an index.
 
@@ -135,25 +135,25 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 Deletes an index and all its data.
 
 **indexName** (`string`): Name of the index to delete
 
-### listIndexes()
+### `listIndexes()`
 
 Lists all vector indexes in the database.
 
 Returns: `Promise<string[]>`
 
-### truncateIndex()
+### `truncateIndex()`
 
 Removes all vectors from an index while keeping the index structure.
 
 **indexName** (`string`): Name of the index to truncate
 
-### updateVector()
+### `updateVector()`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
@@ -169,7 +169,7 @@ Update a single vector by ID or by metadata filter. Either `id` or `filter` must
 
 **update.metadata** (`Record<string, any>`): New metadata to update
 
-### deleteVector()
+### `deleteVector()`
 
 Deletes a specific vector entry from an index by its ID.
 
@@ -177,7 +177,7 @@ Deletes a specific vector entry from an index by its ID.
 
 **id** (`string`): ID of the vector entry to delete
 
-### deleteVectors()
+### `deleteVectors()`
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
@@ -187,7 +187,7 @@ Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` m
 
 **filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -200,7 +200,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws specific errors for different failure cases:
 
@@ -232,7 +232,7 @@ Common error cases include:
 - Database connection issues
 - Transaction failures during upsert
 
-## Usage Example
+## Usage example
 
 ### Local embeddings with fastembed
 

package/dist/docs/references/reference-vectors-mongodb.md

@@ -1,4 +1,4 @@
-# MongoDB Vector Store
+# MongoDB vector store
 
 The `MongoDBVector` class provides vector search using [MongoDB Atlas Vector Search](https://www.mongodb.com/docs/atlas/atlas-vector-search/). It enables efficient similarity search and metadata filtering within your MongoDB collections.
 
@@ -28,7 +28,7 @@ yarn add @mastra/mongodb@latest
 bun add @mastra/mongodb@latest
 ```
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { MongoDBVector } from '@mastra/mongodb'
@@ -55,7 +55,7 @@ const store = new MongoDBVector({
 })
 ```
 
-## Constructor Options
+## Constructor options
 
 **id** (`string`): Unique identifier for this vector store instance
 
@@ -69,7 +69,7 @@ const store = new MongoDBVector({
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 Creates a new vector index (collection) in MongoDB.
 
@@ -79,7 +79,7 @@ Creates a new vector index (collection) in MongoDB.
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
 Adds or updates vectors and their metadata in the collection.
 
@@ -91,7 +91,7 @@ Adds or updates vectors and their metadata in the collection.
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 Searches for similar vectors with optional metadata filtering.
 
@@ -109,7 +109,7 @@ Searches for similar vectors with optional metadata filtering.
 
 **minScore** (`number`): Minimum similarity score threshold (Default: `0`)
 
-### describeIndex()
+### `describeIndex()`
 
 Returns information about the index (collection).
 
@@ -125,19 +125,19 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 Deletes a collection and all its data.
 
 **indexName** (`string`): Name of the collection to delete
 
-### listIndexes()
+### `listIndexes()`
 
 Lists all vector collections in the MongoDB database.
 
 Returns: `Promise<string[]>`
 
-### updateVector()
+### `updateVector()`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
@@ -153,7 +153,7 @@ Update a single vector by ID or by metadata filter. Either `id` or `filter` must
 
 **update.metadata** (`Record<string, any>`): New metadata to update
 
-### deleteVector()
+### `deleteVector()`
 
 Deletes a specific vector entry from an index by its ID.
 
@@ -161,7 +161,7 @@ Deletes a specific vector entry from an index by its ID.
 
 **id** (`string`): ID of the vector entry to delete
 
-### deleteVectors()
+### `deleteVectors()`
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
@@ -171,11 +171,11 @@ Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` m
 
 **filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
-### disconnect()
+### `disconnect()`
 
 Closes the MongoDB client connection. Should be called when done using the store.
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -188,7 +188,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 
@@ -212,15 +212,15 @@ try {
 }
 ```
 
-## Best Practices
+## Best practices
 
 - Index metadata fields used in filters for optimal query performance.
 - Use consistent field naming in metadata to avoid unexpected query results.
 - Regularly monitor index and collection statistics to ensure efficient search.
 
-## Usage Example
+## Usage example
 
-### Vector embeddings with MongoDB
+### Vector embeddings with `MongoDB`
 
 Embeddings are numeric vectors used by memory's `semanticRecall` to retrieve related messages by meaning (not keywords).
 

package/dist/docs/references/reference-vectors-pg.md

@@ -1,8 +1,8 @@
-# PG Vector Store
+# PG vector store
 
 The PgVector class provides vector search using [PostgreSQL](https://www.postgresql.org/) with [pgvector](https://github.com/pgvector/pgvector) extension. It provides robust vector similarity search capabilities within your existing PostgreSQL database.
 
-## Constructor Options
+## Constructor options
 
 **connectionString** (`string`): PostgreSQL connection URL
 
@@ -26,7 +26,7 @@ The PgVector class provides vector search using [PostgreSQL](https://www.postgre
 
 **pgPoolOptions** (`PoolConfig`): Additional pg pool configuration options
 
-## Constructor Examples
+## Constructor examples
 
 ### Connection String
 
@@ -70,7 +70,7 @@ const vectorStore = new PgVector({
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 **indexName** (`string`): Name of the index to create
 
@@ -84,7 +84,7 @@ const vectorStore = new PgVector({
 
 **metadataIndexes** (`string[]`): Array of metadata field names to create btree indexes on. Improves query performance when filtering by these metadata fields.
 
-#### IndexConfig
+#### `IndexConfig`
 
 **type** (`'flat' | 'hnsw' | 'ivfflat'`): Index type (Default: `ivfflat`)
 
@@ -114,7 +114,7 @@ HNSW indexes require significant shared memory during construction. For 100K vec
 
 Higher M values or efConstruction values will increase memory requirements significantly. Adjust your system's shared memory limits if needed.
 
-### upsert()
+### `upsert()`
 
 **indexName** (`string`): Name of the index to upsert vectors into
 
@@ -124,7 +124,7 @@ Higher M values or efConstruction values will increase memory requirements signi
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 **indexName** (`string`): Name of the index to query
 
@@ -144,11 +144,11 @@ Higher M values or efConstruction values will increase memory requirements signi
 
 **options.probes** (`number`): IVF search parameter
 
-### listIndexes()
+### `listIndexes()`
 
 Returns an array of index names as strings.
 
-### describeIndex()
+### `describeIndex()`
 
 **indexName** (`string`): Name of the index to describe
 
@@ -169,11 +169,11 @@ interface PGIndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 **indexName** (`string`): Name of the index to delete
 
-### updateVector()
+### `updateVector()`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
@@ -208,7 +208,7 @@ await pgVector.updateVector({
 })
 ```
 
-### deleteVector()
+### `deleteVector()`
 
 **indexName** (`string`): Name of the index containing the vector
 
@@ -220,7 +220,7 @@ Deletes a single vector by ID from the specified index.
 await pgVector.deleteVector({ indexName: 'my_vectors', id: 'vector123' })
 ```
 
-### deleteVectors()
+### `deleteVectors()`
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
@@ -230,11 +230,11 @@ Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` m
 
 **filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
-### disconnect()
+### `disconnect()`
 
 Closes the database connection pool. Should be called when done using the store.
 
-### buildIndex()
+### `buildIndex()`
 
 **indexName** (`string`): Name of the index to define
 
@@ -268,7 +268,7 @@ await pgVector.buildIndex('my_vectors', 'cosine', {
 })
 ```
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -281,7 +281,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 
@@ -299,7 +299,7 @@ try {
 }
 ```
 
-## Index Configuration Guide
+## Index configuration guide
 
 ### Performance Optimization
 
@@ -331,14 +331,14 @@ The system automatically detects configuration changes and only rebuilds indexes
 - Changed configuration: Index is dropped and rebuilt
 - This prevents the performance issues from unnecessary index recreations
 
-## Best Practices
+## Best practices
 
 - Regularly evaluate your index configuration to ensure optimal performance.
 - Adjust parameters like `lists` and `m` based on dataset size and query requirements.
 - **Monitor index performance** using `describeIndex()` to track usage
 - Rebuild indexes periodically to maintain efficiency, especially after significant data changes
 
-## Direct Pool Access
+## Direct pool access
 
 The `PgVector` class exposes its underlying PostgreSQL connection pool as a public field:
 
@@ -354,7 +354,7 @@ This enables advanced usage such as running direct SQL queries, managing transac
 
 This design supports advanced use cases but requires careful resource management by the user.
 
-## Usage Example
+## Usage example
 
 ### Local embeddings with fastembed