diff --git a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoremilvus.md b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoremilvus.md new file mode 100644 index 000000000..9b4c2d0f4 --- /dev/null +++ b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoremilvus.md @@ -0,0 +1,92 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Milvus Vector Store node documentation +description: Learn how to use the Milvus Vector Store node in n8n. Follow technical documentation to integrate Milvus Vector Store node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Milvus Vector Store node + +Use the Milvus node to interact with your Milvus database as [vector store](/glossary.md#ai-vector-store). You can insert documents into a vector database, get documents from a vector database, retrieve documents to provide them to a retriever connected to a [chain](/glossary.md#ai-chain), or connect directly to an [agent](/glossary.md#ai-agent) as a [tool](/glossary.md#ai-tool). + +On this page, you'll find the node parameters for the Milvus node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/milvus.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node usage patterns + +You can use the Milvus Vector Store node in the following patterns. + +### Use as a regular node to insert and retrieve documents + +You can use the Milvus Vector Store as a regular node to insert, or get documents. This pattern places the Milvus 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/2165-chat-with-pdf-docs-using-ai-quoting-sources/), by replacing the Pinecone Vector store node with the Milvus Vector Store node. + +### Connect directly to an AI agent as a tool + +You can connect the Milvus Vector Store node directly to the tool connector of an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) to use a vector store as a resource when answering queries. + +Here, the connection would be: AI agent (tools connector) -> Milvus 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.md) node with the Milvus Vector Store node to fetch documents from the Milvus Vector Store node. This is often used with the [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) 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/) would be: Question and Answer Chain (Retriever connector) -> Vector Store Retriever (Vector Store connector) -> Milvus Vector Store. In this example, the Pinecone Vector Store node should be replaced with the Milvus Vector Store node. + +### 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.md) to summarize results and answer questions from the Milvus Vector Store node. Rather than connecting the Milvus Vector Store directly as a tool, this pattern uses a tool specifically designed to summarizes data in the vector store. + +The [connections flow](https://n8n.io/workflows/2705-chat-with-github-api-documentation-rag-powered-chatbot-with-pinecone-and-openai/) in this case would look like this: AI agent (tools connector) -> Vector Store Question Answer Tool (Vector Store connector) -> Milvus Vector store. In this example, the Pinecone Vector Store node should be replaced with the Milvus Vector Store node. + +## Node parameters + +--8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md" + + +### Get Many parameters + + +* **Milvus Collection**: Select or enter the Milvus Collection to use. +* **Prompt**: Enter your search query. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +### Insert Documents parameters + +* **Milvus Collection**: Select or enter the Milvus Collection to use. +* **Clear Collection**: Specify whether to clear the collection before inserting new documents. + +### Retrieve Documents (As Vector Store for Chain/Tool) parameters + +* **Milvus collection**: Select or enter the Milvus Collection to use. + +### 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. +* **Milvus Collection**: Select or enter the Milvus Collection to use. +* **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 + +### Metadata Filter + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/vector-store-metadata-filter.md" + +### Clear Collection + +Available in **Insert Documents** mode. Deletes all data from the collection before inserting the new data. + +## Related resources + +Refer to [LangChain's Milvus documentation](https://js.langchain.com/docs/integrations/vectorstores/milvus/) for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + diff --git a/docs/integrations/builtin/credentials/milvus.md b/docs/integrations/builtin/credentials/milvus.md new file mode 100644 index 000000000..5337ad9ba --- /dev/null +++ b/docs/integrations/builtin/credentials/milvus.md @@ -0,0 +1,35 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Milvus credentials +description: Documentation for the Milvus credentials. Use these credentials to authenticate Milvus in n8n, a workflow automation platform. +contentType: [integration, reference] +priority: high +--- + +# Milvus credentials + +You can use these credentials to authenticate the following nodes: + +* [Milvus Vector Store](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoremilvus.md) + +## Prerequisites + +Create and run an [Milvus](https://milvus.io/) instance. Refer to the [Install Milvus](https://milvus.io/docs/install-overview.md) for more information. + +## Supported authentication methods + +- Basic auth + +## Related resources + +Refer to [Milvus's Authentication documentation](https://milvus.io/docs/authenticate.md?tab=docker#Authenticate-User-Access) for more information about setting up authentication. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Using basic auth + +To configure this credential, you'll need: + +* **Base URL**: The base URL of your Milvus instance. The default is `http://localhost:19530`. +* **Username**: The username to authenticate to your Milvus instance. The default value is `root`. +* **Password**: The password to authenticate to your Milvus instance. The default value is `Milvus`. diff --git a/nav.yml b/nav.yml index 418f849b9..f8a8cfa63 100644 --- a/nav.yml +++ b/nav.yml @@ -690,6 +690,7 @@ nav: - Sentiment Analysis: integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.sentimentanalysis.md - LangChain Code: integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.code.md - Simple Vector Store: integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoreinmemory.md + - Milvus Vector Store: integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoremilvus.md - MongoDB Atlas Vector Store: integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoremongodbatlas.md - PGVector Vector Store: integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepgvector.md - Pinecone Vector Store: integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md @@ -925,6 +926,7 @@ nav: - integrations/builtin/credentials/microsoftazuremonitor.md - integrations/builtin/credentials/microsoftentra.md - integrations/builtin/credentials/microsoftsql.md + - integrations/builtin/credentials/milvus.md - integrations/builtin/credentials/mindee.md - integrations/builtin/credentials/miro.md - integrations/builtin/credentials/misp.md diff --git a/styles/config/vocabularies/default/accept.txt b/styles/config/vocabularies/default/accept.txt index caa1a939c..caeb9318d 100644 --- a/styles/config/vocabularies/default/accept.txt +++ b/styles/config/vocabularies/default/accept.txt @@ -138,6 +138,7 @@ Meraki Metabase [Mm]iddleware [Mm]illicore +Milvus('s)? Mindee [Mm]inimum Mocean