mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-11-03 22:32:27 +08:00
feat:doc add coze runner (#65)
* feat:doc add coze runner * add token info * doc: add comment on coze base url * doc: update features --------- Co-authored-by: Junyan Qin <[email protected]>
This commit is contained in:
fdc310
@@ -146,6 +146,7 @@ export default defineConfig({
|
||||
{ text: "n8n", link: "/zh/deploy/pipelines/n8n" },
|
||||
{ text: "Langflow", link: "/zh/deploy/pipelines/langflow" },
|
||||
{ text: "TBox", link: "/zh/deploy/pipelines/tbox" },
|
||||
{ text: "Coze", link: "/zh/deploy/pipelines/coze" },
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 691 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 227 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 250 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 87 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 121 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 236 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 182 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 788 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 59 KiB |
@@ -0,0 +1,49 @@
|
||||
# Integrating Coze API
|
||||
|
||||
This document explains how to obtain the Token and Bot ID from the Coze platform and enter them into the LangBot pipeline configuration.
|
||||
|
||||
## 1. Obtaining the Token and Bot ID
|
||||
|
||||
1. Log in to the Coze platform and enter your developer console.
|
||||
|
||||
|
||||
2. In "API Management", create and copy the token.
|
||||
|
||||
|
||||
:::info
|
||||
In Coze authorization, coze.cn supports long-term authorization through "Service Identities and Credentials", while coze.com only provides Personal Access Tokens.
|
||||
:::
|
||||
|
||||
3. Select your own agent (or create a new one) from the project development section. The obtained ID is the `bot_id`.
|
||||
|
||||
|
||||
* Make sure to select the API option when publishing the agent
|
||||
|
||||
|
||||
Please securely store the following two pieces of information:
|
||||
- **token**: The token generated by the Coze platform
|
||||
- **bot_id**: The Bot ID
|
||||
|
||||
## 2. Entering the Configuration in LangBot
|
||||
|
||||
1. Open the LangBot WebUI and navigate to the configuration page of a pipeline (or create a new pipeline and enter its configuration page)
|
||||
|
||||
2. Under "AI Capabilities", select the runner as `Coze API`
|
||||
|
||||
3. In the runner's configuration items, enter:
|
||||
- **token**: Paste the API Token you copied from the Coze platform
|
||||
- **bot_id**: Paste the corresponding Bot ID
|
||||
- Please select the `API Base URL` according to the Coze site you are using: coze.cn please fill in `https://api.coze.cn`; coze.com please fill in `https://api.coze.com`
|
||||
|
||||
|
||||
|
||||
4. Click "Save" to complete the configuration
|
||||
|
||||
Once completed, you can invoke the Coze agent within this pipeline for dialogue processing
|
||||
|
||||
## Frequently Asked Questions (FAQ)
|
||||
|
||||
- **Save fails or invocation returns an error**: Please verify that the token and bot_id are correct and do not contain extra spaces
|
||||
- **Unable to select `Coze API`**: Please confirm whether the current version supports this runner. If not yet supported, please upgrade to a version that includes the Coze runner
|
||||
|
||||
For more general pipeline configuration instructions, please refer to [Modifying Dialogue Pipeline Configuration](/en/deploy/pipelines/readme)
|
||||
@@ -46,6 +46,7 @@ LangBot is an open-source LLM native instant messaging robot development platfor
|
||||
| [Aliyun Bailian](https://bailian.console.aliyun.com/) | ✅ | LLM gateway(MaaS), LLMOps platform |
|
||||
| [Volc Engine Ark](https://console.volcengine.com/ark/region:ark+cn-beijing/model?vendor=Bytedance&view=LIST_VIEW) | ✅ | LLM gateway(MaaS), LLMOps platform |
|
||||
| [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) | ✅ | LLM gateway(MaaS) |
|
||||
| [Coze](https://coze.com) | ✅ | LLMOps platform |
|
||||
|
||||
## LLM Application Paradigm Implementation
|
||||
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
# 接入 Coze API
|
||||
|
||||
本文仅说明如何在 Coze 平台获取 Token 与 Bot ID，并将其填写到 LangBot 流水线配置中。
|
||||
|
||||
## 1. 获取 Token 与 Bot ID
|
||||
|
||||
1. 登录 Coze 平台，进入你的开发控制台。
|
||||
|
||||
2. 在“API 管理”中创建并复制令牌。
|
||||
|
||||
|
||||
:::info
|
||||
coze.cn 的授权中有可以长期授权的`服务身份及凭证`，但是 coze.com 只有个人访问令牌。
|
||||
:::
|
||||
|
||||
3. 从项目开发中选择你自己的智能体，或者新建智能体，拿到一下id就是bot_id。
|
||||
|
||||
* 智能体发布一定要选上api的选项
|
||||
|
||||
|
||||
|
||||
|
||||
请妥善保存以上两项信息：
|
||||
- token：Coze 平台生成的令牌
|
||||
- bot_id：机器人 ID
|
||||
|
||||
## 2. 在 LangBot 中填写配置
|
||||
|
||||
1. 打开 LangBot WebUI，进入一个流水线的配置页面（或新建流水线后进入配置页面）。
|
||||
2. 在“AI 能力”中选择运行器为 `Coze API`。
|
||||
3. 在运行器的配置项中，填写：
|
||||
- token：粘贴你在 Coze 平台复制的 API Token
|
||||
- bot_id：粘贴对应机器人的 Bot ID
|
||||
- 请根据您使用的 Coze 站点选择 `API 基础 URL`：coze.cn 请填写 `https://api.coze.cn`；coze.com 请填写 `https://api.coze.com`
|
||||
|
||||
|
||||
4. 点击“保存”完成配置。
|
||||
|
||||
完成后，你即可在该流水线中调用 Coze 机器人完成对话处理。
|
||||
|
||||
## 常见问题
|
||||
- 保存失败或调用报错：请确认 token 与 bot_id 是否正确且未包含多余空格。
|
||||
- 无法选择 `Coze API`：请确认当前版本是否已支持该运行器；若尚未支持，请升级到包含 Coze 运行器的版本。
|
||||
|
||||
更多流水线通用配置说明，请参考[修改对话流水线配置](/zh/deploy/pipelines/readme)。
|
||||
@@ -48,6 +48,7 @@ LangBot 是一个开源的大语言模型原生即时通信机器人开发平台
|
||||
| [火山方舟](https://console.volcengine.com/ark/region:ark+cn-beijing/model?vendor=Bytedance&view=LIST_VIEW) | ✅ | 大模型聚合平台, LLMOps 平台 |
|
||||
| [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) | ✅ | 大模型聚合平台 |
|
||||
| [TBox（蚂蚁百宝箱）](https://tbox.cn/) | ✅ | LLMOps 平台 |
|
||||
| [Coze](https://coze.cn) | ✅ | LLMOps 平台 |
|
||||
|
||||
## LLM 应用范式实现
|
||||
|
||||
|
||||
Reference in New Issue
Block a user