From d1c0c8dcd9b02cb7fcb80f9a7a1924ec60e34cae Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 11:12:31 -0500 Subject: [PATCH 01/15] rename from base to langchain --- .../{n8n-nodes-base.openai.md => n8n-nodes-langchain.openai.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/integrations/builtin/app-nodes/{n8n-nodes-base.openai.md => n8n-nodes-langchain.openai.md} (100%) diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.openai.md b/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md similarity index 100% rename from docs/integrations/builtin/app-nodes/n8n-nodes-base.openai.md rename to docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md From 96a795b44e22783f9b646bfd822e06776f51260d Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 11:13:52 -0500 Subject: [PATCH 02/15] Update links to this page in other docs --- docs/integrations/builtin/credentials/openai.md | 2 +- docs/release-notes.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integrations/builtin/credentials/openai.md b/docs/integrations/builtin/credentials/openai.md index 110a0e4d7..66ba03ec6 100644 --- a/docs/integrations/builtin/credentials/openai.md +++ b/docs/integrations/builtin/credentials/openai.md @@ -8,7 +8,7 @@ contentType: integration You can use these credentials to authenticate the following nodes with OpenAI. -- [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-base.openai/) +- [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/) - [Chat OpenAI](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai) - [Embeddings OpenAI](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsopenai) - [LM OpenAI](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmopenai) diff --git a/docs/release-notes.md b/docs/release-notes.md index 9c020c4f6..60540f535 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -3144,7 +3144,7 @@ You can now quickly write expressions inline in a node parameter. You can still #### Open AI node -This release adds an integration with OpenAI. Refer to the [OpenAI node documentation](/integrations/builtin/app-nodes/n8n-nodes-base.openai/) for details. +This release adds an integration with OpenAI. Refer to the [OpenAI node documentation](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/) for details. From 75e9396ba15521ff1067e6ce9b7291455f5cf99a Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 11:16:33 -0500 Subject: [PATCH 03/15] Add redirect and confirm no other redirects to old URL --- docs/_redirects | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/_redirects b/docs/_redirects index 5a724842f..fce12933e 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,3 +1,4 @@ +/n8n-nodes-base.openai/ /n8n-nodes-langchain.openai/ /langchain/ /advanced/ai/ /langchain/langchain-tutorial/ /advanced-ai/intro-tutorial/ /langchain/learning-resources/ /advanced-ai/langchain/langchain-learning-resources/ From 884f49d240538ea61cdc45890a59ae976ac90340 Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 12:46:38 -0500 Subject: [PATCH 04/15] Add tools explanation and related ops and resources --- .../app-nodes/n8n-nodes-langchain.openai.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md b/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md index f353fef34..f79b251ae 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md @@ -48,3 +48,21 @@ Refer to [OpenAI's documentation](https://beta.openai.com/docs/introduction){:ta View [example workflows and related content](https://n8n.io/integrations/openai/){:target=_blank .external-link} on n8n's website. +## Using tools with OpenAI assistants + +Some operations allow you to connect tools. [Tools](https://docs.n8n.io/advanced-ai/examples/understand-tools/) act like addons that your AI can use to access extra context or resources. + +Clicking the Tools connector for these operations will let you browse the available n8n tools to add tools sub-nodes. + +Once you add a tool connection, the OpenAI node becomes a root node, allowing it to form a cluster node with the tools sub-nodes. See [Node types](/integrations/builtin/node-types/#cluster-nodes) for more information on cluster nodes and root nodes. + +### Operations that support tool connectors + +* Assistant + * Message Assistant +* Text + * Message Model + +### Related resources + +Refer to [OpenAI's documentation](https://platform.openai.com/docs/assistants/how-it-works/objects){:target=_blank .external-link} for more information about how assistants work. From 0e135a4edaac688ef56d397d8858fdfbbd163f36 Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 12:56:19 -0500 Subject: [PATCH 05/15] Add deprecation warning to OpenAI Assistant node --- .../root-nodes/n8n-nodes-langchain.openaiassistant.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md index d1bf650fc..6e6ef8670 100644 --- a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md +++ b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md @@ -9,6 +9,10 @@ Use the OpenAI Assistant node to work with OpenAI's [Assistants API](https://pla On this page, you'll find a list of operations the OpenAI Assistant node supports, and links to more resources. +/// warning | Deprecated in 1.29.0 +n8n deprecated this node in version 1.29.0. Older workflows continue to work, and the node is still available in older versions of n8n. From 1.29.0, n8n replaces the OpenAI assistant node with the [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/) node. +/// + /// note | Credentials You can find authentication information for this node [here](/integrations/builtin/credentials/openai/). /// From cc3749ffdba59d04cbcca0793479c1bab19e5c8f Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 13:03:31 -0500 Subject: [PATCH 06/15] Revert "Add deprecation warning to OpenAI Assistant node" This reverts commit 0e135a4edaac688ef56d397d8858fdfbbd163f36. --- .../root-nodes/n8n-nodes-langchain.openaiassistant.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md index 6e6ef8670..d1bf650fc 100644 --- a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md +++ b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md @@ -9,10 +9,6 @@ Use the OpenAI Assistant node to work with OpenAI's [Assistants API](https://pla On this page, you'll find a list of operations the OpenAI Assistant node supports, and links to more resources. -/// warning | Deprecated in 1.29.0 -n8n deprecated this node in version 1.29.0. Older workflows continue to work, and the node is still available in older versions of n8n. From 1.29.0, n8n replaces the OpenAI assistant node with the [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/) node. -/// - /// note | Credentials You can find authentication information for this node [here](/integrations/builtin/credentials/openai/). /// From 41418d7a7fe625033311043d8b940517fc6fde46 Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 13:11:17 -0500 Subject: [PATCH 07/15] Add openaiassistant deprecation note --- .../builtin/app-nodes/n8n-nodes-langchain.openai.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md b/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md index f79b251ae..b9f57dad2 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md @@ -10,6 +10,10 @@ Use the OpenAI node to automate work in OpenAI, and integrate OpenAI with other On this page, you'll find a list of operations the OpenAI node supports and links to more resources. +/// note | OpenAI assistant node +The OpenAI node replaces the OpenAI assistant node from version 1.29.0 on. +/// + /// note | Credentials Refer to [OpenAI credentials](/integrations/builtin/credentials/openai/) for guidance on setting up authentication. /// From 5689a8faade892d6e316299fb79140602b9e9224 Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 13:13:22 -0500 Subject: [PATCH 08/15] Redirect openaiassistant to openai node --- docs/_redirects | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/_redirects b/docs/_redirects index fce12933e..8727ceb0b 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,3 +1,4 @@ +/n8n-nodes-langchain.openaiassistant.md/ /n8n-nodes-langchain.openai/ /n8n-nodes-base.openai/ /n8n-nodes-langchain.openai/ /langchain/ /advanced/ai/ /langchain/langchain-tutorial/ /advanced-ai/intro-tutorial/ From c9052bbaac50212d628f1b2b1ffaeae832085ae3 Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 13:14:27 -0500 Subject: [PATCH 09/15] Delete openaiassistant file --- .../n8n-nodes-langchain.openaiassistant.md | 52 ------------------- 1 file changed, 52 deletions(-) delete mode 100644 docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md diff --git a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md b/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md deleted file mode 100644 index d1bf650fc..000000000 --- a/docs/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OpenAI Assistant -description: Documentation for the OpenAI Assistant node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. ---- - -# OpenAI Assistant - -Use the OpenAI Assistant node to work with OpenAI's [Assistants API](https://platform.openai.com/docs/assistants/overview){:target=_blank .external-link}. - -On this page, you'll find a list of operations the OpenAI Assistant node supports, and links to more resources. - -/// note | Credentials -You can find authentication information for this node [here](/integrations/builtin/credentials/openai/). -/// - -/// note | Examples and templates -For usage examples and templates to help you get started, refer to n8n's [OpenAI Assistant's integrations](https://n8n.io/integrations/openai-assistant/){:target=_blank .external-link} page. -/// - -## Node parameters - -### Operation - -You can choose **Use New Assistant** or **Use Existing Assistant**. - -* To use a new assistant: define the **Name**, **Instructions**, and the **Model** you want to use. -* To use an existing assistant: select your **Assistant**. - -/// note | Use New Assistant -The **Use New Assistant** option creates a new assistant on every run. -/// - -### Text - -The input from the chat. This is the user's query, also known as the prompt. - -### OpenAI Tools - -Choose the [OpenAI Assistants Tools](https://platform.openai.com/docs/assistants/tools){:target=_blank .external-link} you're using with this assistant. - -### Options - -* Base URL: change the OpenAI API URL. -* Max Retries: how many times to retry a request. -* Timeout: maximum amount of time a request is allowed to take in milliseconds. - -## Related resources - -View [example workflows and related content](https://n8n.io/integrations/openai-assistant/){:target=_blank .external-link} on n8n's website. - -Refer to [LangChain's OpenAI assistant documentation](https://js.langchain.com/docs/modules/agents/agent_types/openai_assistant){:target=_blank .external-link} for more information about the service. ---8<-- "_glossary/ai-glossary.md" From ec208b2cf480d6b52289e7678aade55b244bbfeb Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 13:15:48 -0500 Subject: [PATCH 10/15] Remove openaiassistant from nav --- mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index f3630e9bf..6bc744f5b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -686,7 +686,6 @@ nav: - integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa.md - integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainsummarization.md - integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.code.md - - integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.openaiassistant.md - integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoreinmemory.md - integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md - integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoreqdrant.md From c77d2c2b42374484574826cc070fe70012d2c2e1 Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 13:22:24 -0500 Subject: [PATCH 11/15] Fix link in overlooked release note --- docs/release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes.md b/docs/release-notes.md index 60540f535..ce7117097 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -56,7 +56,7 @@ For full release details, refer to [Releases](https://github.com/n8n-io/n8n/rele #### OpenAI node overhaul -This release includes a new version of the [OpenAI node](/integrations/builtin/app-nodes/n8n-nodes-base.openai/), adding more operations, including support for working with assistants. +This release includes a new version of the [OpenAI node](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/), adding more operations, including support for working with assistants. From 170b0be425d441c1c17c204fc841ef3c038f7307 Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 26 Feb 2024 15:21:22 -0500 Subject: [PATCH 12/15] Update redirects now that merge conflicts resolved --- docs/_redirects | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/_redirects b/docs/_redirects index 31022e2a1..13206c46e 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,3 +1,5 @@ +/n8n-nodes-langchain.openaiassistant.md/ /n8n-nodes-langchain.openai/ +/n8n-nodes-base.openai/ /n8n-nodes-langchain.openai/ /contributing/ /help-community/contributing/ /manage-cloud/ /manage-cloud/overview/ /hosting/environment-variables/* /hosting/configuration/:splat From ab11ecf4cf767ac5c3b524b6086f746dc9b5b72f Mon Sep 17 00:00:00 2001 From: Deborah Date: Mon, 4 Mar 2024 10:34:19 +0000 Subject: [PATCH 13/15] Update docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md --- .../builtin/app-nodes/n8n-nodes-langchain.openai.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md b/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md index b9f57dad2..79be4a225 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md @@ -10,7 +10,7 @@ Use the OpenAI node to automate work in OpenAI, and integrate OpenAI with other On this page, you'll find a list of operations the OpenAI node supports and links to more resources. -/// note | OpenAI assistant node +/// note | OpenAI Assistant node The OpenAI node replaces the OpenAI assistant node from version 1.29.0 on. /// From 0db4050198988488eac64771b074d96c3a816b9a Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 4 Mar 2024 11:34:42 -0500 Subject: [PATCH 14/15] Remove second related resources section, wording tweaks --- .../builtin/app-nodes/n8n-nodes-langchain.openai.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md b/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md index 79be4a225..122fba1d1 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md @@ -49,6 +49,8 @@ For usage examples and templates to help you get started, take a look at n8n's [ ## Related resources Refer to [OpenAI's documentation](https://beta.openai.com/docs/introduction){:target=_blank .external-link} for more information about the service. + +Refer to [OpenAI's assistants documentation](https://platform.openai.com/docs/assistants/how-it-works/objects){:target=_blank .external-link} for more information about how assistants work. View [example workflows and related content](https://n8n.io/integrations/openai/){:target=_blank .external-link} on n8n's website. @@ -56,7 +58,7 @@ View [example workflows and related content](https://n8n.io/integrations/openai/ Some operations allow you to connect tools. [Tools](https://docs.n8n.io/advanced-ai/examples/understand-tools/) act like addons that your AI can use to access extra context or resources. -Clicking the Tools connector for these operations will let you browse the available n8n tools to add tools sub-nodes. +Select the **Tools** connector to browse the available tools and add them. Once you add a tool connection, the OpenAI node becomes a root node, allowing it to form a cluster node with the tools sub-nodes. See [Node types](/integrations/builtin/node-types/#cluster-nodes) for more information on cluster nodes and root nodes. @@ -66,7 +68,3 @@ Once you add a tool connection, the OpenAI node becomes a root node, allowing it * Message Assistant * Text * Message Model - -### Related resources - -Refer to [OpenAI's documentation](https://platform.openai.com/docs/assistants/how-it-works/objects){:target=_blank .external-link} for more information about how assistants work. From ba03015390ba337369832aee434dd1f2bbf9f331 Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 4 Mar 2024 11:35:00 -0500 Subject: [PATCH 15/15] Update nav to match other changes --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 68380affb..bac76713b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -544,7 +544,7 @@ nav: - integrations/builtin/app-nodes/n8n-nodes-base.odoo.md - integrations/builtin/app-nodes/n8n-nodes-base.onesimpleapi.md - integrations/builtin/app-nodes/n8n-nodes-base.onfleet.md - - integrations/builtin/app-nodes/n8n-nodes-base.openai.md + - integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md - integrations/builtin/app-nodes/n8n-nodes-base.openthesaurus.md - integrations/builtin/app-nodes/n8n-nodes-base.openweathermap.md - integrations/builtin/app-nodes/n8n-nodes-base.orbit.md