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 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 60% rename from docs/integrations/builtin/app-nodes/n8n-nodes-base.openai.md rename to docs/integrations/builtin/app-nodes/n8n-nodes-langchain.openai.md index f353fef34..122fba1d1 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-base.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. /// @@ -45,6 +49,22 @@ 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. +## 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. + +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. + +### Operations that support tool connectors + +* Assistant + * Message Assistant +* Text + * Message Model 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" 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 30b8eb8fb..165b15f7c 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -111,7 +111,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. @@ -3199,7 +3199,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. diff --git a/mkdocs.yml b/mkdocs.yml index 9093796e3..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 @@ -729,7 +729,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