@n8n/n8n-nodes-langchain 2.21.2 → 2.22.0

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreAzureAISearch/v12/mode_load.ts

@@ -10,6 +10,26 @@ interface Credentials {
 
 /** Get many ranked documents from vector store for query */
 export type LcVectorStoreAzureAISearchV12LoadParams = {
+  /**
+   * One-shot similarity search on the main flow using the `prompt` parameter. Declare with `vectorStore({...})`. Required subnodes: `embedding`. For LLM-driven querying (RAG), use `mode: 'retrieve-as-tool'` instead.
+   * <patterns>
+   * <pattern title="load mode — one-shot similarity search (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const lookup = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'load',
+   *       prompt: expr('{{ $json.query }}'),
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'load';
 /**
  * The name of the Azure AI Search index. Will be created automatically if it does not exist.

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreAzureAISearch/v12/mode_retrieve.ts

@@ -10,6 +10,31 @@ interface Credentials {
 
 /** Retrieve documents from vector store to be used as vector store with AI nodes */
 export type LcVectorStoreAzureAISearchV12RetrieveParams = {
+  /**
+   * Exposes the store as an `ai_vectorStore` subnode for another node (e.g. `toolVectorStore`). Declare with `vectorStore({...})`. Required subnodes: `embedding`. For RAG with an AI Agent directly, prefer `mode: 'retrieve-as-tool'`.
+   * <patterns>
+   * <pattern title="retrieve mode — feed another node as a subnode (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const store = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: { mode: 'retrieve' /* + provider-specific parameters *\/ },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * 
+   * const retrieverTool = tool({
+   *   type: '@n8n/n8n-nodes-langchain.toolVectorStore',
+   *   config: {
+   *     name: 'KB Retriever',
+   *     parameters: { description: 'Search the product knowledge base' },
+   *     subnodes: { vectorStore: store, model: openAiModel }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'retrieve';
 /**
  * The name of the Azure AI Search index. Will be created automatically if it does not exist.

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreAzureAISearch/v12/mode_retrieve_as_tool.ts

@@ -10,6 +10,36 @@ interface Credentials {
 
 /** Retrieve documents from vector store to be used as tool with AI nodes */
 export type LcVectorStoreAzureAISearchV12RetrieveAsToolParams = {
+  /**
+   * Canonical RAG mode — declare with the `tool({...})` factory (NOT `vectorStore`) and plug into an AI Agent's `subnodes.tools`. Required subnodes: `embedding`. Set `toolDescription` so the agent knows when to call it.
+   * <patterns>
+   * <pattern title="retrieve-as-tool mode — RAG via AI Agent (generic, works for any vectorStore* node)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file
+   * // for the exact shape (e.g. pineconeIndex, qdrantCollection, supabaseTableName).
+   * const knowledgeBase = tool({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'retrieve-as-tool',
+   *       toolDescription: 'Search the product knowledge base',
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * 
+   * const agent = node({
+   *   type: '@n8n/n8n-nodes-langchain.agent',
+   *   config: {
+   *     name: 'Support Agent',
+   *     parameters: { promptType: 'define', text: expr('{{ $json.question }}') },
+   *     subnodes: { model: openAiModel, tools: [knowledgeBase] }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'retrieve-as-tool';
 /**
  * Name of the vector store

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreAzureAISearch/v12/mode_update.ts

@@ -10,6 +10,22 @@ interface Credentials {
 
 /** Update documents in vector store by ID */
 export type LcVectorStoreAzureAISearchV12UpdateParams = {
+  /**
+   * Updates a single document by `id`. Declare with `vectorStore({...})`. Required subnodes: `embedding`. Only available on stores whose `operationModes` enables it — most providers omit this mode.
+   * <patterns>
+   * <pattern title="update mode — update document by ID (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const store = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: { mode: 'update', id: expr('{{ $json.docId }}') },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'update';
 /**
  * The name of the Azure AI Search index. Will be created automatically if it does not exist.

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreAzureAISearch/v13/mode_insert.ts

@@ -10,6 +10,26 @@ interface Credentials {
 
 /** Insert documents into vector store */
 export type LcVectorStoreAzureAISearchV13InsertParams = {
+  /**
+   * Sits on the main flow — pipe the documents you want to embed into this node. Declare with `vectorStore({...})`. Required subnodes: `embedding` and `documentLoader`. If the goal is letting an LLM query the store, use `mode: 'retrieve-as-tool'` instead.
+   * <patterns>
+   * <pattern title="insert mode — upsert documents (generic, works for any vectorStore* node)">
+   * // Substitute the type literal and provider-specific parameters (e.g. pineconeIndex,
+   * // qdrantCollection, supabaseTableName) — see the rest of this file for the exact shape.
+   * const store = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'insert',
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi, documentLoader: defaultDataLoader }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'insert';
 /**
  * The name of the Azure AI Search index. Will be created automatically if it does not exist.

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreAzureAISearch/v13/mode_load.ts

@@ -10,6 +10,26 @@ interface Credentials {
 
 /** Get many ranked documents from vector store for query */
 export type LcVectorStoreAzureAISearchV13LoadParams = {
+  /**
+   * One-shot similarity search on the main flow using the `prompt` parameter. Declare with `vectorStore({...})`. Required subnodes: `embedding`. For LLM-driven querying (RAG), use `mode: 'retrieve-as-tool'` instead.
+   * <patterns>
+   * <pattern title="load mode — one-shot similarity search (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const lookup = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'load',
+   *       prompt: expr('{{ $json.query }}'),
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'load';
 /**
  * The name of the Azure AI Search index. Will be created automatically if it does not exist.

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreAzureAISearch/v13/mode_retrieve.ts

@@ -10,6 +10,31 @@ interface Credentials {
 
 /** Retrieve documents from vector store to be used as vector store with AI nodes */
 export type LcVectorStoreAzureAISearchV13RetrieveParams = {
+  /**
+   * Exposes the store as an `ai_vectorStore` subnode for another node (e.g. `toolVectorStore`). Declare with `vectorStore({...})`. Required subnodes: `embedding`. For RAG with an AI Agent directly, prefer `mode: 'retrieve-as-tool'`.
+   * <patterns>
+   * <pattern title="retrieve mode — feed another node as a subnode (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const store = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: { mode: 'retrieve' /* + provider-specific parameters *\/ },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * 
+   * const retrieverTool = tool({
+   *   type: '@n8n/n8n-nodes-langchain.toolVectorStore',
+   *   config: {
+   *     name: 'KB Retriever',
+   *     parameters: { description: 'Search the product knowledge base' },
+   *     subnodes: { vectorStore: store, model: openAiModel }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'retrieve';
 /**
  * The name of the Azure AI Search index. Will be created automatically if it does not exist.

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreAzureAISearch/v13/mode_retrieve_as_tool.ts

@@ -10,6 +10,36 @@ interface Credentials {
 
 /** Retrieve documents from vector store to be used as tool with AI nodes */
 export type LcVectorStoreAzureAISearchV13RetrieveAsToolParams = {
+  /**
+   * Canonical RAG mode — declare with the `tool({...})` factory (NOT `vectorStore`) and plug into an AI Agent's `subnodes.tools`. Required subnodes: `embedding`. Set `toolDescription` so the agent knows when to call it.
+   * <patterns>
+   * <pattern title="retrieve-as-tool mode — RAG via AI Agent (generic, works for any vectorStore* node)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file
+   * // for the exact shape (e.g. pineconeIndex, qdrantCollection, supabaseTableName).
+   * const knowledgeBase = tool({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'retrieve-as-tool',
+   *       toolDescription: 'Search the product knowledge base',
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * 
+   * const agent = node({
+   *   type: '@n8n/n8n-nodes-langchain.agent',
+   *   config: {
+   *     name: 'Support Agent',
+   *     parameters: { promptType: 'define', text: expr('{{ $json.question }}') },
+   *     subnodes: { model: openAiModel, tools: [knowledgeBase] }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'retrieve-as-tool';
 /**
  * Explain to the LLM what this tool does, a good, specific description would allow LLMs to produce expected results much more often

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreAzureAISearch/v13/mode_update.ts

@@ -10,6 +10,22 @@ interface Credentials {
 
 /** Update documents in vector store by ID */
 export type LcVectorStoreAzureAISearchV13UpdateParams = {
+  /**
+   * Updates a single document by `id`. Declare with `vectorStore({...})`. Required subnodes: `embedding`. Only available on stores whose `operationModes` enables it — most providers omit this mode.
+   * <patterns>
+   * <pattern title="update mode — update document by ID (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const store = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: { mode: 'update', id: expr('{{ $json.docId }}') },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'update';
 /**
  * The name of the Azure AI Search index. Will be created automatically if it does not exist.

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v1/mode_insert.ts

@@ -11,6 +11,26 @@ interface Credentials {
 
 /** Insert documents into vector store */
 export type LcVectorStoreChromaDBV1InsertParams = {
+  /**
+   * Sits on the main flow — pipe the documents you want to embed into this node. Declare with `vectorStore({...})`. Required subnodes: `embedding` and `documentLoader`. If the goal is letting an LLM query the store, use `mode: 'retrieve-as-tool'` instead.
+   * <patterns>
+   * <pattern title="insert mode — upsert documents (generic, works for any vectorStore* node)">
+   * // Substitute the type literal and provider-specific parameters (e.g. pineconeIndex,
+   * // qdrantCollection, supabaseTableName) — see the rest of this file for the exact shape.
+   * const store = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'insert',
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi, documentLoader: defaultDataLoader }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'insert';
   authentication?: 'chromaSelfHostedApi' | 'chromaCloudApi' | Expression<string>;
   chromaCollection?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v1/mode_load.ts

@@ -11,6 +11,26 @@ interface Credentials {
 
 /** Get many ranked documents from vector store for query */
 export type LcVectorStoreChromaDBV1LoadParams = {
+  /**
+   * One-shot similarity search on the main flow using the `prompt` parameter. Declare with `vectorStore({...})`. Required subnodes: `embedding`. For LLM-driven querying (RAG), use `mode: 'retrieve-as-tool'` instead.
+   * <patterns>
+   * <pattern title="load mode — one-shot similarity search (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const lookup = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'load',
+   *       prompt: expr('{{ $json.query }}'),
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'load';
   authentication?: 'chromaSelfHostedApi' | 'chromaCloudApi' | Expression<string>;
   chromaCollection?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v1/mode_retrieve.ts

@@ -11,6 +11,31 @@ interface Credentials {
 
 /** Retrieve documents from vector store to be used as vector store with AI nodes */
 export type LcVectorStoreChromaDBV1RetrieveParams = {
+  /**
+   * Exposes the store as an `ai_vectorStore` subnode for another node (e.g. `toolVectorStore`). Declare with `vectorStore({...})`. Required subnodes: `embedding`. For RAG with an AI Agent directly, prefer `mode: 'retrieve-as-tool'`.
+   * <patterns>
+   * <pattern title="retrieve mode — feed another node as a subnode (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const store = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: { mode: 'retrieve' /* + provider-specific parameters *\/ },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * 
+   * const retrieverTool = tool({
+   *   type: '@n8n/n8n-nodes-langchain.toolVectorStore',
+   *   config: {
+   *     name: 'KB Retriever',
+   *     parameters: { description: 'Search the product knowledge base' },
+   *     subnodes: { vectorStore: store, model: openAiModel }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'retrieve';
   authentication?: 'chromaSelfHostedApi' | 'chromaCloudApi' | Expression<string>;
   chromaCollection?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v1/mode_retrieve_as_tool.ts

@@ -11,6 +11,36 @@ interface Credentials {
 
 /** Retrieve documents from vector store to be used as tool with AI nodes */
 export type LcVectorStoreChromaDBV1RetrieveAsToolParams = {
+  /**
+   * Canonical RAG mode — declare with the `tool({...})` factory (NOT `vectorStore`) and plug into an AI Agent's `subnodes.tools`. Required subnodes: `embedding`. Set `toolDescription` so the agent knows when to call it.
+   * <patterns>
+   * <pattern title="retrieve-as-tool mode — RAG via AI Agent (generic, works for any vectorStore* node)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file
+   * // for the exact shape (e.g. pineconeIndex, qdrantCollection, supabaseTableName).
+   * const knowledgeBase = tool({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'retrieve-as-tool',
+   *       toolDescription: 'Search the product knowledge base',
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * 
+   * const agent = node({
+   *   type: '@n8n/n8n-nodes-langchain.agent',
+   *   config: {
+   *     name: 'Support Agent',
+   *     parameters: { promptType: 'define', text: expr('{{ $json.question }}') },
+   *     subnodes: { model: openAiModel, tools: [knowledgeBase] }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'retrieve-as-tool';
 /**
  * Name of the vector store

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v11/mode_insert.ts

@@ -11,6 +11,26 @@ interface Credentials {
 
 /** Insert documents into vector store */
 export type LcVectorStoreChromaDBV11InsertParams = {
+  /**
+   * Sits on the main flow — pipe the documents you want to embed into this node. Declare with `vectorStore({...})`. Required subnodes: `embedding` and `documentLoader`. If the goal is letting an LLM query the store, use `mode: 'retrieve-as-tool'` instead.
+   * <patterns>
+   * <pattern title="insert mode — upsert documents (generic, works for any vectorStore* node)">
+   * // Substitute the type literal and provider-specific parameters (e.g. pineconeIndex,
+   * // qdrantCollection, supabaseTableName) — see the rest of this file for the exact shape.
+   * const store = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'insert',
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi, documentLoader: defaultDataLoader }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'insert';
   authentication?: 'chromaSelfHostedApi' | 'chromaCloudApi' | Expression<string>;
   chromaCollection?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v11/mode_load.ts

@@ -11,6 +11,26 @@ interface Credentials {
 
 /** Get many ranked documents from vector store for query */
 export type LcVectorStoreChromaDBV11LoadParams = {
+  /**
+   * One-shot similarity search on the main flow using the `prompt` parameter. Declare with `vectorStore({...})`. Required subnodes: `embedding`. For LLM-driven querying (RAG), use `mode: 'retrieve-as-tool'` instead.
+   * <patterns>
+   * <pattern title="load mode — one-shot similarity search (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const lookup = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'load',
+   *       prompt: expr('{{ $json.query }}'),
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'load';
   authentication?: 'chromaSelfHostedApi' | 'chromaCloudApi' | Expression<string>;
   chromaCollection?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v11/mode_retrieve.ts

@@ -11,6 +11,31 @@ interface Credentials {
 
 /** Retrieve documents from vector store to be used as vector store with AI nodes */
 export type LcVectorStoreChromaDBV11RetrieveParams = {
+  /**
+   * Exposes the store as an `ai_vectorStore` subnode for another node (e.g. `toolVectorStore`). Declare with `vectorStore({...})`. Required subnodes: `embedding`. For RAG with an AI Agent directly, prefer `mode: 'retrieve-as-tool'`.
+   * <patterns>
+   * <pattern title="retrieve mode — feed another node as a subnode (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const store = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: { mode: 'retrieve' /* + provider-specific parameters *\/ },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * 
+   * const retrieverTool = tool({
+   *   type: '@n8n/n8n-nodes-langchain.toolVectorStore',
+   *   config: {
+   *     name: 'KB Retriever',
+   *     parameters: { description: 'Search the product knowledge base' },
+   *     subnodes: { vectorStore: store, model: openAiModel }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'retrieve';
   authentication?: 'chromaSelfHostedApi' | 'chromaCloudApi' | Expression<string>;
   chromaCollection?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v11/mode_retrieve_as_tool.ts

@@ -11,6 +11,36 @@ interface Credentials {
 
 /** Retrieve documents from vector store to be used as tool with AI nodes */
 export type LcVectorStoreChromaDBV11RetrieveAsToolParams = {
+  /**
+   * Canonical RAG mode — declare with the `tool({...})` factory (NOT `vectorStore`) and plug into an AI Agent's `subnodes.tools`. Required subnodes: `embedding`. Set `toolDescription` so the agent knows when to call it.
+   * <patterns>
+   * <pattern title="retrieve-as-tool mode — RAG via AI Agent (generic, works for any vectorStore* node)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file
+   * // for the exact shape (e.g. pineconeIndex, qdrantCollection, supabaseTableName).
+   * const knowledgeBase = tool({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'retrieve-as-tool',
+   *       toolDescription: 'Search the product knowledge base',
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * 
+   * const agent = node({
+   *   type: '@n8n/n8n-nodes-langchain.agent',
+   *   config: {
+   *     name: 'Support Agent',
+   *     parameters: { promptType: 'define', text: expr('{{ $json.question }}') },
+   *     subnodes: { model: openAiModel, tools: [knowledgeBase] }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'retrieve-as-tool';
 /**
  * Name of the vector store

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v12/mode_insert.ts

@@ -11,6 +11,26 @@ interface Credentials {
 
 /** Insert documents into vector store */
 export type LcVectorStoreChromaDBV12InsertParams = {
+  /**
+   * Sits on the main flow — pipe the documents you want to embed into this node. Declare with `vectorStore({...})`. Required subnodes: `embedding` and `documentLoader`. If the goal is letting an LLM query the store, use `mode: 'retrieve-as-tool'` instead.
+   * <patterns>
+   * <pattern title="insert mode — upsert documents (generic, works for any vectorStore* node)">
+   * // Substitute the type literal and provider-specific parameters (e.g. pineconeIndex,
+   * // qdrantCollection, supabaseTableName) — see the rest of this file for the exact shape.
+   * const store = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'insert',
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi, documentLoader: defaultDataLoader }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'insert';
   authentication?: 'chromaSelfHostedApi' | 'chromaCloudApi' | Expression<string>;
   chromaCollection?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v12/mode_load.ts

@@ -11,6 +11,26 @@ interface Credentials {
 
 /** Get many ranked documents from vector store for query */
 export type LcVectorStoreChromaDBV12LoadParams = {
+  /**
+   * One-shot similarity search on the main flow using the `prompt` parameter. Declare with `vectorStore({...})`. Required subnodes: `embedding`. For LLM-driven querying (RAG), use `mode: 'retrieve-as-tool'` instead.
+   * <patterns>
+   * <pattern title="load mode — one-shot similarity search (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const lookup = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'load',
+   *       prompt: expr('{{ $json.query }}'),
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'load';
   authentication?: 'chromaSelfHostedApi' | 'chromaCloudApi' | Expression<string>;
   chromaCollection?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v12/mode_retrieve.ts

@@ -11,6 +11,31 @@ interface Credentials {
 
 /** Retrieve documents from vector store to be used as vector store with AI nodes */
 export type LcVectorStoreChromaDBV12RetrieveParams = {
+  /**
+   * Exposes the store as an `ai_vectorStore` subnode for another node (e.g. `toolVectorStore`). Declare with `vectorStore({...})`. Required subnodes: `embedding`. For RAG with an AI Agent directly, prefer `mode: 'retrieve-as-tool'`.
+   * <patterns>
+   * <pattern title="retrieve mode — feed another node as a subnode (generic)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file.
+   * const store = vectorStore({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: { mode: 'retrieve' /* + provider-specific parameters *\/ },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * 
+   * const retrieverTool = tool({
+   *   type: '@n8n/n8n-nodes-langchain.toolVectorStore',
+   *   config: {
+   *     name: 'KB Retriever',
+   *     parameters: { description: 'Search the product knowledge base' },
+   *     subnodes: { vectorStore: store, model: openAiModel }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'retrieve';
   authentication?: 'chromaSelfHostedApi' | 'chromaCloudApi' | Expression<string>;
   chromaCollection?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };

package/dist/node-definitions/nodes/n8n-nodes-langchain/vectorStoreChromaDB/v12/mode_retrieve_as_tool.ts

@@ -11,6 +11,36 @@ interface Credentials {
 
 /** Retrieve documents from vector store to be used as tool with AI nodes */
 export type LcVectorStoreChromaDBV12RetrieveAsToolParams = {
+  /**
+   * Canonical RAG mode — declare with the `tool({...})` factory (NOT `vectorStore`) and plug into an AI Agent's `subnodes.tools`. Required subnodes: `embedding`. Set `toolDescription` so the agent knows when to call it.
+   * <patterns>
+   * <pattern title="retrieve-as-tool mode — RAG via AI Agent (generic, works for any vectorStore* node)">
+   * // Substitute the type literal and provider-specific parameters — see the rest of this file
+   * // for the exact shape (e.g. pineconeIndex, qdrantCollection, supabaseTableName).
+   * const knowledgeBase = tool({
+   *   type: '@n8n/n8n-nodes-langchain.vectorStoreXxx',
+   *   config: {
+   *     name: 'Knowledge Base',
+   *     parameters: {
+   *       mode: 'retrieve-as-tool',
+   *       toolDescription: 'Search the product knowledge base',
+   *       // ...provider-specific parameters
+   *     },
+   *     subnodes: { embedding: embeddingsOpenAi }
+   *   }
+   * });
+   * 
+   * const agent = node({
+   *   type: '@n8n/n8n-nodes-langchain.agent',
+   *   config: {
+   *     name: 'Support Agent',
+   *     parameters: { promptType: 'define', text: expr('{{ $json.question }}') },
+   *     subnodes: { model: openAiModel, tools: [knowledgeBase] }
+   *   }
+   * });
+   * </pattern>
+   * </patterns>
+   */
   mode: 'retrieve-as-tool';
 /**
  * Name of the vector store