Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add documentation for update operations in vector store nodes #2245

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Add documentation for update operations in vector store nodes #2245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f15d24
Update Pinecone and Supabase Vector Store nodes documentation
burivuhster Jul 16, 2024
b00edd6
Fix typo
burivuhster Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions _snippets/integrations/builtin/cluster-nodes/common-vector-store-modes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- vale off -->
#### 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.
<!-- vale on -->
#### 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.
13 changes: 1 addition & 12 deletions _snippets/integrations/builtin/cluster-nodes/vector-store-mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- vale off -->
#### 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.
<!-- vale on -->
#### 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"
17 changes: 15 additions & 2 deletions ...ons/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 its ID.

On this page, you'll find the node parameters for the Pinecone node, and links to more resources.

Expand All @@ -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**

Expand All @@ -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
Expand Down
16 changes: 14 additions & 2 deletions ...ons/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# 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.

Check warning on line 9 in docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[from-write-good.Weasel] 'many' is a weasel word!

Raw Output:
{"message": "[from-write-good.Weasel] 'many' is a weasel word!", "location": {"path": "docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md", "range": {"start": {"line": 9, "column": 141}}}, "severity": "WARNING"}

On this page, you'll find the node parameters for the Supabase node, and links to more resources.

Expand All @@ -20,7 +20,15 @@

## 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**:

Expand All @@ -36,6 +44,10 @@

* Table Name

Parameters for **Update Documents**

* ID

## Node options

### Query Name
Expand Down
Loading