@mastra/mongodb 1.2.0 → 1.3.0-alpha.0

package/dist/docs/{vectors/01-reference.md → references/reference-vectors-mongodb.md}

@@ -1,20 +1,31 @@
-# Vectors API Reference
+# MongoDB Vector Store
 
-> API reference for vectors - 1 entries
+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.
 
+## Installation
 
----
+**npm**:
 
-## Reference: MongoDB Vector Store
+```bash
+npm install @mastra/mongodb@latest
+```
 
-> Documentation for the MongoDBVector class in Mastra, which provides vector search using MongoDB Atlas and Atlas Vector Search.
+**pnpm**:
 
-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.
+```bash
+pnpm add @mastra/mongodb@latest
+```
 
-## Installation
+**Yarn**:
 
-```bash npm2yarn
-npm install @mastra/mongodb@latest
+```bash
+yarn add @mastra/mongodb@latest
+```
+
+**Bun**:
+
+```bash
+bun add @mastra/mongodb@latest
 ```
 
 ## Usage Example
@@ -46,24 +57,64 @@ const store = new MongoDBVector({
 
 ## Constructor Options
 
+**id:** (`string`): Unique identifier for this vector store instance
+
+**uri:** (`string`): MongoDB connection string
+
+**dbName:** (`string`): Name of the MongoDB database to use
+
+**options?:** (`MongoClientOptions`): Optional MongoDB client options
+
+**embeddingFieldPath?:** (`string`): Path to the field that stores vector embeddings. Supports nested paths using dot notation (e.g., 'text.contentEmbedding'). (Default: `embedding`)
+
 ## Methods
 
 ### createIndex()
 
 Creates a new vector index (collection) in MongoDB.
 
+**indexName:** (`string`): Name of the collection to create
+
+**dimension:** (`number`): Vector dimension (must match your embedding model)
+
+**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+
 ### upsert()
 
 Adds or updates vectors and their metadata in the collection.
 
+**indexName:** (`string`): Name of the collection to insert into
+
+**vectors:** (`number[][]`): Array of embedding vectors
+
+**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+
+**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+
 ### query()
 
 Searches for similar vectors with optional metadata filtering.
 
+**indexName:** (`string`): Name of the collection to search in
+
+**queryVector:** (`number[]`): Query vector to find similar vectors for
+
+**topK?:** (`number`): Number of results to return (Default: `10`)
+
+**filter?:** (`Record<string, any>`): Metadata filters (applies to the \`metadata\` field)
+
+**documentFilter?:** (`Record<string, any>`): Filters on original document fields (not just metadata)
+
+**includeVector?:** (`boolean`): Whether to include vector data in results (Default: `false`)
+
+**minScore?:** (`number`): Minimum similarity score threshold (Default: `0`)
+
 ### describeIndex()
 
 Returns information about the index (collection).
 
+**indexName:** (`string`): Name of the collection to describe
+
 Returns:
 
 ```typescript
@@ -78,6 +129,8 @@ interface IndexStats {
 
 Deletes a collection and all its data.
 
+**indexName:** (`string`): Name of the collection to delete
+
 ### listIndexes()
 
 Lists all vector collections in the MongoDB database.
@@ -88,14 +141,36 @@ Returns: `Promise<string[]>`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
+**indexName:** (`string`): Name of the collection containing the vector
+
+**id?:** (`string`): ID of the vector entry to update (mutually exclusive with filter)
+
+**filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
+
+**update:** (`object`): Update data containing vector and/or metadata
+
+**update.vector?:** (`number[]`): New vector data to update
+
+**update.metadata?:** (`Record<string, any>`): New metadata to update
+
 ### deleteVector()
 
 Deletes a specific vector entry from an index by its ID.
 
+**indexName:** (`string`): Name of the collection containing the vector
+
+**id:** (`string`): ID of the vector entry to delete
+
 ### deleteVectors()
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
+**indexName:** (`string`): Name of the collection containing the vectors to delete
+
+**ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
+
+**filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
+
 ### disconnect()
 
 Closes the MongoDB client connection. Should be called when done using the store.
@@ -151,16 +226,35 @@ Embeddings are numeric vectors used by memory's `semanticRecall` to retrieve rel
 
 > Note: You must use a deployment hosted on MongoDB Atlas to successfully use the MongoDB Vector database.
 
-This setup uses FastEmbed, a local embedding model, to generate vector embeddings.
-To use this, install `@mastra/fastembed`:
+This setup uses FastEmbed, a local embedding model, to generate vector embeddings. To use this, install `@mastra/fastembed`:
 
-```bash npm2yarn
+**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
+```
+
 Add the following to your agent:
 
-```typescript title="src/mastra/agents/example-mongodb-agent.ts"
+```typescript
 import { Memory } from "@mastra/memory";
 import { Agent } from "@mastra/core/agent";
 import { MongoDBStore, MongoDBVector } from "@mastra/mongodb";
@@ -198,4 +292,4 @@ export const mongodbAgent = new Agent({
 
 ## Related
 
-- [Metadata Filters](../rag/metadata-filters)
+- [Metadata Filters](https://mastra.ai/reference/rag/metadata-filters)