From 9247cf846fb17dc7bce770533f34eccd12546cde Mon Sep 17 00:00:00 2001 From: Ace Data Cloud Dev Date: Tue, 6 Oct 2026 21:38:58 +0800 Subject: [PATCH] docs: verify Open WebUI AceDataCloud integration --- docs.json | 14 +++++++++++++ en/integrations/open-webui.mdx | 31 +++++++++++++++++++++++++++++ zh-Hans/integrations/open-webui.mdx | 31 +++++++++++++++++++++++++++++ 3 files changed, 76 insertions(+) create mode 100644 en/integrations/open-webui.mdx create mode 100644 zh-Hans/integrations/open-webui.mdx diff --git a/docs.json b/docs.json index 72b26598..cef5d051 100644 --- a/docs.json +++ b/docs.json @@ -70,6 +70,13 @@ "zh-Hans/concepts/async-tasks" ] }, + { + "group": "生态集成", + "icon": "puzzle-piece", + "pages": [ + "zh-Hans/integrations/open-webui" + ] + }, { "group": "AI 聊天", "icon": "comments", @@ -812,6 +819,13 @@ "en/concepts/async-tasks" ] }, + { + "group": "Integrations", + "icon": "puzzle-piece", + "pages": [ + "en/integrations/open-webui" + ] + }, { "group": "AI Chat", "icon": "comments", diff --git a/en/integrations/open-webui.mdx b/en/integrations/open-webui.mdx new file mode 100644 index 00000000..344ec8d2 --- /dev/null +++ b/en/integrations/open-webui.mdx @@ -0,0 +1,31 @@ +--- +title: "Use AceDataCloud in Open WebUI" +description: "Connect Open WebUI to AceDataCloud chat models through the OpenAI-compatible API." +--- + +Open WebUI can call AceDataCloud through its built-in OpenAI-compatible **Chat Completions** connection. You do not need a custom Pipe. These steps were checked in Open WebUI v0.11.4. + +## Before you start + +- Get an AceDataCloud API token from the [application console](https://platform.acedata.cloud/console/applications). Give the application access to a chat model and check its current price. +- Use an Open WebUI account with admin rights to add a server-side connection. Keep this instance private or protect it with your normal authentication controls: anyone allowed to use the model can consume the token's credits. + +## Add the connection + +1. Open Open WebUI. In the user menu, choose **Admin Panel → Settings → Connections**. +2. Under **OpenAI API → Manage OpenAI API Connections**, click **Add Connection** (`+`). +3. Leave **Connection Type** at **External**. Set **URL** to `https://api.acedata.cloud/v1` (no trailing slash), **Auth** to **Bearer**, and **API Key** to your AceDataCloud API token. Leave **API Type** at **Chat Completions**. +4. Click **Verify Connection**. It checks the `/v1/models` endpoint; the button is optional when you save. Click **Save** in the connection dialog, then **Save** in the main Connections settings if prompted. +5. Start a new chat, open the model selector, choose a model such as `gpt-4o-mini`, and send a short prompt. Check the response in the chat and the corresponding entry in [AceDataCloud usage history](https://platform.acedata.cloud/console/usages). + +`/v1/models` currently returns the model list for a valid token, so models can appear automatically. To show only chosen models, open the connection's **Advanced** section and add each exact ID under **Model IDs** using **Add** (`+`), then save. This is an allowlist: it replaces the full discovered list in Open WebUI. If verification fails but the token and chat route are valid, add a model ID manually and test a real chat. Use an ID from the [current chat model catalog](https://platform.acedata.cloud/documents/openai-chat-completions). + +## Check the request and solve problems + +The connection URL already contains `/v1`; Open WebUI appends `/models` for discovery and `/chat/completions` for messages. Do not enter the full chat endpoint as the connection URL. A blank or invalid token fails authentication. If the model appears but a chat fails, check the selected model ID, application access and remaining credits in AceDataCloud, then inspect the Open WebUI error. A successful **Verify Connection** checks model discovery only; a completed message proves the chat route. + +Open WebUI also ships with a default OpenAI connection. If you do not use it, disable that connection in **Connections** to avoid selecting or probing it. The AceDataCloud token stays in Open WebUI's server-side connection settings. Anyone who administers that server can change or use the connection, so rotate the token if server access is compromised. + +Each chat consumes credits. Open WebUI may make additional model requests for chat titles, tags, or follow-up suggestions; these can appear as separate charges. Review charges in [usage history](https://platform.acedata.cloud/console/usages); Open WebUI's local chat history is not the billing record. Tools, images, files, and other Open WebUI features depend on both the selected model and its API support. Validate each feature separately before enabling it for users. This guide covers text chat only. + +For Open WebUI's current UI and connection rules, see its [OpenAI-compatible provider guide](https://docs.openwebui.com/getting-started/quick-start/connect-a-provider/starting-with-openai-compatible/). For the request schema, see [AceDataCloud Chat Completions](/en/guides/openai/openai_chat_completions). diff --git a/zh-Hans/integrations/open-webui.mdx b/zh-Hans/integrations/open-webui.mdx new file mode 100644 index 00000000..c9d944f4 --- /dev/null +++ b/zh-Hans/integrations/open-webui.mdx @@ -0,0 +1,31 @@ +--- +title: "在 Open WebUI 中使用 AceDataCloud" +description: "通过 OpenAI 兼容接口，将 Open WebUI 连接到 AceDataCloud 聊天模型。" +--- + +Open WebUI 内置的 OpenAI 兼容 **Chat Completions** 连接可以直接调用 AceDataCloud，无需编写自定义 Pipe。以下步骤已在 Open WebUI v0.11.4 核对。 + +## 准备工作 + +- 在[应用控制台](https://platform.acedata.cloud/console/applications)获取 AceDataCloud API Token，确认该应用可使用聊天模型，并查看当前价格。 +- 用 Open WebUI 管理员账户添加服务端连接。请保护实例访问权限：获准使用模型的人都可能消耗这枚 Token 的额度。 + +## 添加连接 + +1. 在 Open WebUI 用户菜单中打开 **Admin Panel → Settings → Connections**。 +2. 在 **OpenAI API → Manage OpenAI API Connections** 下点击 **Add Connection**（`+`）。 +3. **Connection Type** 保持 **External**；**URL** 填 `https://api.acedata.cloud/v1`（末尾不要加 `/`）；**Auth** 选择 **Bearer**；**API Key** 填 AceDataCloud API Token；**API Type** 保持 **Chat Completions**。 +4. 点击 **Verify Connection** 检查 `/v1/models`；保存连接时也可以跳过这一步。点击连接弹窗中的 **Save**，如页面仍提示，再点击 Connections 主设置页的 **Save**。 +5. 新建对话，在模型选择器中选择 `gpt-4o-mini` 等模型，发送一条简短消息。确认聊天返回，并在 [AceDataCloud 使用历史](https://platform.acedata.cloud/console/usages)核对对应调用。 + +有效 Token 当前可以通过 `/v1/models` 自动发现模型。如果只想显示指定模型，打开连接的 **Advanced**，在 **Model IDs** 中逐个输入准确 ID 并点击 **Add**（`+`），然后保存。这是允许列表，会替代 Open WebUI 中完整的发现列表。如果验证失败，但 Token 和聊天路由可用，可手动添加模型 ID 后用真实对话验证。模型 ID 请以[当前聊天模型目录](https://platform.acedata.cloud/documents/openai-chat-completions)为准。 + +## 核对请求与排错 + +连接 URL 已包含 `/v1`；Open WebUI 会分别追加 `/models` 和 `/chat/completions`。不要把完整聊天接口地址填入连接 URL。缺失或无效的 Token 会导致鉴权失败。如果模型可见但聊天失败，检查模型 ID、应用权限及剩余额度，再查看 Open WebUI 错误。**Verify Connection** 成功只证明模型发现可用；收到完整回复才证明聊天路由可用。 + +Open WebUI 默认还带有 OpenAI 连接。如不使用，可在 **Connections** 中停用，避免误选或对其发起探测。AceDataCloud Token 存放在 Open WebUI 的服务端连接设置里；能够管理该服务器的人可以修改或使用连接。如果服务器访问权限泄露，请轮换 Token。 + +每次聊天都会消耗 Credits。Open WebUI 可能额外调用模型生成标题、标签或后续提问，这些请求会形成独立的扣费记录。请在[使用历史](https://platform.acedata.cloud/console/usages)核对扣费；Open WebUI 本地聊天记录不是账单。工具、图片、文件等功能还取决于所选模型和接口能力，向用户开放前应分别验证。本指南仅覆盖文字聊天。 + +Open WebUI 的最新界面及连接规则请见[官方 OpenAI 兼容供应商指南](https://docs.openwebui.com/getting-started/quick-start/connect-a-provider/starting-with-openai-compatible/)。请求格式请见 [AceDataCloud Chat Completions](/zh-Hans/guides/openai/openai_chat_completions)。