@mastra/memory 1.6.1 → 1.6.2

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
 
@@ -82,7 +82,9 @@ const vectorStore = new PgVector({
 
 **buildIndex** (`boolean`): Whether to build the index (Default: `true`)
 
-#### IndexConfig
+**metadataIndexes** (`string[]`): Array of metadata field names to create btree indexes on. Improves query performance when filtering by these metadata fields.
+
+#### `IndexConfig`
 
 **type** (`'flat' | 'hnsw' | 'ivfflat'`): Index type (Default: `ivfflat`)
 
@@ -112,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
 
@@ -122,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
 
@@ -142,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
 
@@ -167,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.
 
@@ -206,7 +208,7 @@ await pgVector.updateVector({
 })
 ```
 
-### deleteVector()
+### `deleteVector()`
 
 **indexName** (`string`): Name of the index containing the vector
 
@@ -218,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.
 
@@ -228,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
 
@@ -266,7 +268,7 @@ await pgVector.buildIndex('my_vectors', 'cosine', {
 })
 ```
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -279,7 +281,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 
@@ -297,7 +299,7 @@ try {
 }
 ```
 
-## Index Configuration Guide
+## Index configuration guide
 
 ### Performance Optimization
 
@@ -329,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:
 
@@ -352,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
 

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

@@ -1,8 +1,8 @@
-# Upstash Vector Store
+# Upstash vector store
 
 The UpstashVector class provides vector search using [Upstash Vector](https://upstash.com/vector), a serverless vector database service that provides vector similarity search with metadata filtering capabilities and hybrid search support.
 
-## Constructor Options
+## Constructor options
 
 **url** (`string`): Upstash Vector database URL
 
@@ -10,7 +10,7 @@ The UpstashVector class provides vector search using [Upstash Vector](https://up
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 Note: This method is a no-op for Upstash as indexes are created automatically.
 
@@ -20,7 +20,7 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
 **indexName** (`string`): Name of the index to upsert into
 
@@ -32,7 +32,7 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 **indexName** (`string`): Name of the index to query
 
@@ -50,11 +50,11 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
 
 **queryMode** (`QueryMode`): Search mode: 'DENSE' for dense-only, 'SPARSE' for sparse-only, or 'HYBRID' for combined search
 
-### listIndexes()
+### `listIndexes()`
 
 Returns an array of index names (namespaces) as strings.
 
-### describeIndex()
+### `describeIndex()`
 
 **indexName** (`string`): Name of the index to describe
 
@@ -68,11 +68,11 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 **indexName** (`string`): Name of the index (namespace) to delete
 
-### updateVector()
+### `updateVector()`
 
 **indexName** (`string`): Name of the index to update
 
@@ -86,7 +86,7 @@ The `update` object can have the following properties:
 - `sparseVector` (optional): A sparse vector object with `indices` and `values` arrays for hybrid indexes.
 - `metadata` (optional): A record of key-value pairs for metadata.
 
-### deleteVector()
+### `deleteVector()`
 
 **indexName** (`string`): Name of the index from which to delete the item
 
@@ -94,7 +94,7 @@ The `update` object can have the following properties:
 
 Attempts to delete an item by its ID from the specified index. Logs an error message if the deletion fails.
 
-## Hybrid Vector Search
+## Hybrid vector search
 
 Upstash Vector supports hybrid search that combines semantic search (dense vectors) with keyword-based search (sparse vectors) for improved relevance and accuracy.
 
@@ -182,7 +182,7 @@ await vectorStore.updateVector({
 })
 ```
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -195,7 +195,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 
@@ -213,14 +213,14 @@ try {
 }
 ```
 
-## Environment Variables
+## Environment variables
 
 Required environment variables:
 
 - `UPSTASH_VECTOR_URL`: Your Upstash Vector database URL
 - `UPSTASH_VECTOR_TOKEN`: Your Upstash Vector API token
 
-## Usage Example
+## Usage example
 
 ### Local embeddings with fastembed