diff --git a/docs/advanced-ai/chat-hub.md b/docs/advanced-ai/chat-hub.md new file mode 100644 index 000000000..86128a492 --- /dev/null +++ b/docs/advanced-ai/chat-hub.md @@ -0,0 +1,69 @@ +--- +title: Chat Hub +description: +status: beta +--- + +# Chat Hub + +## Overview + +Chat Hub is a centralized AI chat interface where you can access multiple AI models, interact with n8n agents, and create your own agents. Chat Hub also introduces Chat user, a role that lets users interact with the chat interface without accessing n8n workflows. + +## How to use + +To use Chat Hub, find the **Chat** option in the navigation bar, select a model, and start a conversation. + +### Creating simple personal agents + +To make AI more reliable for simple, repetitive tasks, you can create Custom Agents with custom instructions. To create a simple personal agent: + +1. Click on **Personal Agents** and then **+New Agent**. +2. Define the name, description, system prompt, preferred model, and access to tools. +3. Select **Save**. + +Once created, you can select the personal agent from the model selector. + +### Using n8n workflows agents + +For more complex scenarios, use n8n workflow agents (built by you or your colleagues) to make your workflows available in Chat Hub. Right now, you can only use workflows that have a **Chat Trigger** with streaming enabled in the **Agent** node. To make your workflow available: + +1. Open your selected workflow. +2. Open the **Chat Trigger**. + + /// note + Only chat triggers of the newest version will work. To get the newest chat trigger version, delete your existing chat trigger and insert a new one. + /// + +3. Enable the **Make Available in n8n Chat** option and set the name and description of the personal agent. +4. Make sure that your AI Agent node has the **Enable Streaming** option enabled. +5. Activate your workflow. + +Once defined, you can select your workflow from the model selector in Chat Hub. Your colleagues need access to the workflow by sharing it or having it in a project where they have at least viewer access. + +## Managing permissions + +You can define which users can perform which actions through n8n's role system. Chat Hub also gives you more ways to control who uses what. + +### Chat user role + +The Chat user is a role for people in your organization who want to use workflows without building them. Chat users only see the chat interface and can't add credentials or workflows by default. + +Chat users are only available on Starter, Pro, Business and Enterprise plans. + +### Provider settings + +Admins can control which models and providers users can access in Chat Hub. This includes: + +- Enabling or disabling specific models and providers +- Preventing users from adding their own models +- Setting default credentials for each provider +- Restricting users from adding their own credentials (through n8n's permission system) + +To manage these settings, go to **Settings > Chat** and edit the providers. + +## Considerations and limitations + +1. You can't add file knowledge when creating simple personal agents. +2. Tool selection is limited to a few options. +2. Only workflows with [Chat Trigger node](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md) and streaming-enabled [AI Agent node](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) work as workflow agents. Your workflows must meet specific requirements. \ No newline at end of file diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md b/docs/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md index ff2d2cbdd..511c48224 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md @@ -26,14 +26,14 @@ Set whether the chat should be publicly available (turned on) or only available Leave this turned off while you're building the workflow. Turn it on when you're ready to publish the workflow and allow users to access the chat. -### Mode +#### Mode Choose how users access the chat. Select from: * **Hosted Chat**: Use n8n's hosted chat interface. Recommended for most users because you can configure the interface using the [node options](#node-options) and don't have to do any other setup. * **Embedded Chat**: This option requires you to create your own chat interface. You can use n8n's [chat widget](https://www.npmjs.com/package/@n8n/chat) or build your own. Your chat interface must call the webhook URL shown in **Chat URL** in the node. -### Authentication +#### Authentication Choose whether and how to restrict access to the chat. Select from: @@ -42,10 +42,22 @@ Choose whether and how to restrict access to the chat. Select from: * Select or create a **Credential for Basic Auth** with a username and password. All users must use the same username and password. * **n8n User Auth**: Only users logged in to an n8n account can use the chat. -### Initial Message(s) +#### Initial Message(s) This parameter's only available if you're using **Hosted Chat**. Use it to configure the message the n8n chat interface displays when the user arrives on the page. +### Make Available in n8n Chat + +Choose whether to make the agent available to Chat Hub. + +#### Agent Name + +The name of the agent on Chat Hub. + +#### Agent description + +The description of the agent on Chat Hub. + ## Node options Available options depend on the chat mode. diff --git a/nav.yml b/nav.yml index 477aec512..860ee7d91 100644 --- a/nav.yml +++ b/nav.yml @@ -1317,6 +1317,7 @@ nav: - Advanced AI: - advanced-ai/index.md - "AI Workflow Builder": advanced-ai/ai-workflow-builder.md + - "Chat Hub": advanced-ai/chat-hub.md - "Accessing n8n MCP server": advanced-ai/accessing-n8n-mcp-server.md - "Tutorial: Build an AI workflow in n8n": advanced-ai/intro-tutorial.md - RAG in n8n: advanced-ai/rag-in-n8n.md