From 5f15d248d00bceadfe2b620ec1de9e8f0b4fb70c Mon Sep 17 00:00:00 2001 From: Eugene Molodkin Date: Tue, 16 Jul 2024 17:12:36 +0200 Subject: [PATCH 1/2] Update Pinecone and Supabase Vector Store nodes documentation --- .../cluster-nodes/common-vector-store-modes.md | 12 ++++++++++++ .../builtin/cluster-nodes/vector-store-mode.md | 13 +------------ .../n8n-nodes-langchain.vectorstorepinecone.md | 17 +++++++++++++++-- .../n8n-nodes-langchain.vectorstoresupabase.md | 14 +++++++++++++- 4 files changed, 41 insertions(+), 15 deletions(-) create mode 100644 _snippets/integrations/builtin/cluster-nodes/common-vector-store-modes.md diff --git a/_snippets/integrations/builtin/cluster-nodes/common-vector-store-modes.md b/_snippets/integrations/builtin/cluster-nodes/common-vector-store-modes.md new file mode 100644 index 00000000000..294a0369e41 --- /dev/null +++ b/_snippets/integrations/builtin/cluster-nodes/common-vector-store-modes.md @@ -0,0 +1,12 @@ + +#### Get Many + +In this mode, you can retrieve multiple documents from your vector database by providing a prompt. The prompt will be embedded and used for similarity search. The node will return the documents that are most similar to the prompt with their similarity score. This is useful if you want to retrieve a list of similar documents and pass them to an agent as additional context. + +#### Insert Documents + +Use insert documents mode to insert new documents into your vector database. + +#### Retrieve Documents (For Agent/Chain) + +Use Retrieve Documents mode with a vector-store retriever to retrieve documents from a vector database and provide them to the retriever connected to a chain. In this mode you must connect the node to a retriever node or root node. diff --git a/_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md b/_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md index 8f16d23b7b0..caa883e0213 100644 --- a/_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md +++ b/_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md @@ -2,15 +2,4 @@ Vector Store nodes in n8n have three modes: **Get Many**, **Insert Documents** and **Retrieve Documents**. The mode you select determines the operations you can perform with the node and what inputs and outputs are available. - -#### Get Many - -In this mode, you can retrieve multiple documents from your vector database by providing a prompt. The prompt will be embedded and used for similarity search. The node will return the documents that are most similar to the prompt with their similarity score. This is useful if you want to retrieve a list of similar documents and pass them to an agent as additional context. - -#### Insert Documents - -Use insert documents mode to insert new documents into your vector database. - -#### Retrieve Documents (For Agent/Chain) - -Use Retrieve Documents mode with a vector-store retriever to retrieve documents from a vector database and provide them to the retriever connected to a chain. In this mode you must connect the node to a retriever node or root node. +--8<-- "_snippets/integrations/builtin/cluster-nodes/common-vector-store-modes.md" diff --git a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md index 242c41b463f..9b8f0b0673d 100644 --- a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md +++ b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md @@ -6,7 +6,7 @@ description: Documentation for the Pinecone node in n8n, a workflow automation p # Pinecone Vector Store -Use the Pinecone node to interact with your Pinecone database as vector store. You can insert documents into a vector database, get documents from a vector database, and retrieve documents to provide them to a retriever connected to a chain. +Use the Pinecone node to interact with your Pinecone database as vector store. You can insert documents into a vector database, get documents from a vector database, and retrieve documents to provide them to a retriever connected to a chain. You can also update an item in a vector database by it's ID. On this page, you'll find the node parameters for the Pinecone node, and links to more resources. @@ -18,7 +18,16 @@ You can find authentication information for this node [here](/integrations/built ## Node parameters ---8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md" +### Operation Mode + +Pinecone Vector Store node in n8n have four modes: **Get Many**, **Insert Documents**, **Retrieve Documents** and **Update Documents**. The mode you select determines the operations you can perform with the node and what inputs and outputs are available. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/common-vector-store-modes.md" + +#### Update Documents + +Use Update Documents mode to update existing items in vector database by ID. + ### Parameters for **Get Many** @@ -34,6 +43,10 @@ You can find authentication information for this node [here](/integrations/built * Pinecone Index +### Parameters for **Update Documents** + +* ID + ## Node options #### Pinecone Namespace diff --git a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md index b8d5a66f851..48e0d769d35 100644 --- a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md +++ b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md @@ -20,7 +20,15 @@ Supabase provides a [quickstart for setting up your vector store](https://supaba ## Node parameters ---8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md" +### Operation Mode + +Supabase Vector Store node in n8n have four modes: **Get Many**, **Insert Documents**, **Retrieve Documents** and **Update Documents**. The mode you select determines the operations you can perform with the node and what inputs and outputs are available. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/common-vector-store-modes.md" + +#### Update Documents + +Use Update Documents mode to update existing items in vector database by ID. Parameters for **Get Many**: @@ -36,6 +44,10 @@ Parameters for **Retrieve Documents (For Agent/Chain)**: * Table Name +Parameters for **Update Documents** + +* ID + ## Node options ### Query Name From b00edd6eb99eb408d69e2a676eba4b6b5f4608f3 Mon Sep 17 00:00:00 2001 From: Eugene Molodkin Date: Tue, 16 Jul 2024 17:17:22 +0200 Subject: [PATCH 2/2] Fix typo --- .../root-nodes/n8n-nodes-langchain.vectorstorepinecone.md | 2 +- .../root-nodes/n8n-nodes-langchain.vectorstoresupabase.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md index 9b8f0b0673d..84353405071 100644 --- a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md +++ b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md @@ -6,7 +6,7 @@ description: Documentation for the Pinecone node in n8n, a workflow automation p # Pinecone Vector Store -Use the Pinecone node to interact with your Pinecone database as vector store. You can insert documents into a vector database, get documents from a vector database, and retrieve documents to provide them to a retriever connected to a chain. You can also update an item in a vector database by it's ID. +Use the Pinecone node to interact with your Pinecone database as vector store. You can insert documents into a vector database, get documents from a vector database, and retrieve documents to provide them to a retriever connected to a chain. You can also update an item in a vector database by its ID. On this page, you'll find the node parameters for the Pinecone node, and links to more resources. diff --git a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md index 48e0d769d35..7a32cdaeaba 100644 --- a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md +++ b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md @@ -6,7 +6,7 @@ description: Documentation for the Supabase node in n8n, a workflow automation p # Supabase Vector Store -Use the Supabase Vector Store to interact with your Supabase database as vector store. You can insert documents into a vector database, get many documents from a vector database, and retrieve documents to provide them to a retriever connected to a chain. +Use the Supabase Vector Store to interact with your Supabase database as vector store. You can insert documents into a vector database, get many documents from a vector database, and retrieve documents to provide them to a retriever connected to a chain. You can also update an item in a vector store by its ID. On this page, you'll find the node parameters for the Supabase node, and links to more resources.