MongoDB Atlas Vector Store Documentation (#2981)

Co-authored-by: Nick Veitch <nick.veitch@n8n.io>

docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoremongodbatlas.md

@@ -0,0 +1,137 @@
+---
+#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4
+title: MongoDB Atlas Vector Store node documentation
+description: Learn how to use the MongoDB Atlas Vector Store node in n8n. Follow technical documentation to integrate MongoDB Atlas Vector Store node into your workflows.
+contentType: [integration, reference]
+priority: medium
+---
+
+# MongoDB Atlas Vector Store node
+
+MongoDB Atlas Vector Search is a feature of MongoDB Atlas that enables users to store and query vector embeddings. Use this node to interact with Vector Search indexes in your MongoDB Atlas collections. You can insert documents, retrieve documents, and use the vector store in chains or as a tool for agents.
+
+On this page, you'll find the node parameters for the MongoDB Atlas Vector Store node, and links to more resources.
+
+/// note | Credentials
+You can find authentication information for this node [here](/integrations/builtin/credentials/mongoDb/).
+///
+
+--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md"
+
+## Prerequisites
+
+Before using this node, create a [Vector Search index](https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-type/) in your MongoDB Atlas collection. Follow these steps to create one:
+
+1. Log in to the [MongoDB Atlas dashboard](https://cloud.mongodb.com/).
+
+3. Select your organization and project.
+4. Find "Search & Vector Search" section.
+5. Select your cluster and click "Go to search".
+7. Click "Create Search Index".
+8. Choose "Vector Search" mode and use the visual or JSON editors. For example:
+   ```json
+   {
+     "fields": [
+       {
+         "type": "vector",
+         "path": "<field-name>",
+         "numDimensions": 1536, // any other value
+         "similarity": "<similarity-function>"
+       }
+     ]
+   }
+   ```
+
+9. Adjust the "dimensions" value according to your embedding model (For example, `1536` for OpenAI's `text-embedding-small-3`).
+10. Name your index and create.
+
+Make sure to note the following values which are required when configuring the node:
+
+- Collection name
+- Vector index name 
+- Field names for embeddings and metadata
+
+## Node usage patterns
+
+You can use the MongoDB Atlas Vector Store node in the following patterns:
+
+### Use as a regular node to insert and retrieve documents
+
+You can use the MongoDB Atlas Vector Store as a regular node to insert or get documents. This pattern places the MongoDB Atlas Vector Store in the regular connection flow without using an agent.
+
+You can see an example of this in scenario 1 of [this template](https://n8n.io/workflows/2621-ai-agent-to-chat-with-files-in-supabase-storage/) (the template uses the Supabase Vector Store, but the pattern is the same).
+
+### Connect directly to an AI agent as a tool
+
+You can connect the MongoDB Atlas Vector Store node directly to the tool connector of an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/) to use the vector store as a resource when answering queries.
+
+Here, the connection would be: AI agent (tools connector) -> MongoDB Atlas Vector Store node.
+
+### Use a retriever to fetch documents
+
+You can use the [Vector Store Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievervectorstore/) node with the MongoDB Atlas Vector Store node to fetch documents from the MongoDB Atlas Vector Store node. This is often used with the [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/) node to fetch documents from the vector store that match the given chat input.
+
+An [example of the connection flow](https://n8n.io/workflows/1960-ask-questions-about-a-pdf-using-ai/) (the linked example uses Pinecone, but the pattern is the same) would be: Question and Answer Chain (Retriever connector) -> Vector Store Retriever (Vector Store connector) -> MongoDB Atlas Vector Store.
+
+### Use the Vector Store Question Answer Tool to answer questions
+
+Another pattern uses the [Vector Store Question Answer Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore/) to summarize results and answer questions from the MongoDB Atlas Vector Store node. Rather than connecting the MongoDB Atlas Vector Store directly as a tool, this pattern uses a tool specifically designed to summarize data in the vector store.
+
+The [connections flow](https://n8n.io/workflows/2465-building-your-first-whatsapp-chatbot/) (the linked example uses the In-Memory Vector Store, but the pattern is the same) in this case would look like this: AI agent (tools connector) -> Vector Store Question Answer Tool (Vector Store connector) -> In-Memory Vector store.
+
+## Node parameters
+
+--8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md"
+
+<!-- vale off -->
+### Get Many parameters
+<!-- vale on -->
+
+- **Mongo Collection**: Enter the name of the MongoDB collection to use.
+- **Vector Index Name**: Enter the name of the Vector Search index in your MongoDB Atlas collection.
+- **Embedding Field**: Enter the field name in your documents that contains the vector embeddings.
+- **Metadata Field**: Enter the field name in your documents that contains the text metadata.
+
+### Insert Documents parameters
+
+- **Mongo Collection**: Enter the name of the MongoDB collection to use.
+- **Vector Index Name**: Enter the name of the Vector Search index in your MongoDB Atlas collection.
+- **Embedding Field**: Enter the field name in your documents that contains the vector embeddings.
+- **Metadata Field**: Enter the field name in your documents that contains the text metadata.
+
+### Retrieve Documents parameters (As Vector Store for Chain/Tool)
+
+- **Mongo Collection**: Enter the name of the MongoDB collection to use.
+- **Vector Index Name**: Enter the name of the Vector Search index in your MongoDB Atlas collection.
+- **Embedding Field**: Enter the field name in your documents that contains the vector embeddings.
+- **Metadata Field**: Enter the field name in your documents that contains the text metadata.
+
+### Retrieve Documents (As Tool for AI Agent) parameters
+
+- **Name**: The name of the vector store.
+- **Description**: Explain to the LLM what this tool does. A good, specific description allows LLMs to produce expected results more often.
+- **Mongo Collection**: Enter the name of the MongoDB collection to use.
+- **Vector Index Name**: Enter the name of the Vector Search index in your MongoDB Atlas collection.
+- **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results.
+
+## Node options
+
+### Options
+
+- **Metadata Filter**: Filters results based on metadata.
+
+## Templates and examples
+
+<!-- see https://www.notion.so/n8n/Pull-in-templates-for-the-integrations-pages-37c716837b804d30a33b47475f6e3780 -->
+[[ templatesWidget(page.title, 'mongodb-atlas-vector-store') ]]
+
+## Related resources
+
+Refer to:
+
+- [LangChain's MongoDB Atlas Vector Search documentation](https://js.langchain.com/docs/integrations/vectorstores/mongodb_atlas){:target=_blank .external-link} for more information about the service.
+- [MongoDB Atlas Vector Search documentation](https://www.mongodb.com/docs/atlas/atlas-vector-search/){:target=_blank .external-link} for more information about MongoDB Atlas Vector Search.
+
+--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md"
+
+--8<-- "_snippets/self-hosting/starter-kits/self-hosted-ai-starter-kit.md"

docs/integrations/builtin/credentials/mongodb.md

@@ -11,6 +11,7 @@ priority: medium
 You can use these credentials to authenticate the following nodes:
 
 - [MongoDB](/integrations/builtin/app-nodes/n8n-nodes-base.mongodb.md)
+- [MongoDB Atlas Vector Store](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoremongodbatlas.md)
 
 ## Prerequisites