🚀 Dify 接入 CodingPlanX 自定义模型
通过本教程,你可以轻松地将 CodingPlanX 提供的 API 接口和模型集成到你的 Dify 平台中,实现自定义 AI 能力的调用。
📋 前置准备
在开始配置之前,请确保你已经具备以下条件:
- Dify 平台访问权限:已部署好的 Dify 私有化版本,或 Dify 官方云服务账号。
- API Key:已在 CodingPlanX 平台获取了有效的 API 密钥(API Key)。
⚙️ 配置步骤
第一步:进入模型供应商设置
- 登录 Dify 控制台。
- 点击页面右上角的 「头像」,在下拉菜单中选择 「设置」(Settings)。
- 在左侧导航栏中,点击 「模型供应商」(Model Providers)。
第二步:添加自定义模型
由于 CodingPlanX 兼容 OpenAI 的接口标准,我们需要使用 Dify 提供的 OpenAI-API-compatible 通用配置选项。
- 在「模型供应商」页面向下滚动,找到 「OpenAI-API-compatible」 选项。
- 点击卡片上的 「添加模型」(Add Model)按钮。
第三步:填写配置参数(核心)
在弹出的配置窗口中,请严格按照下表填写参数:
| 参数名称 | 填写内容 / 示例 | 说明 |
|---|---|---|
| 模型类型 (Model Type) | LLM | 选择你需要接入的模型类型(通常为大语言模型 LLM)。 |
| 模型名称 (Model Name) | 例如:gpt-4-turbo 或 claude-3-opus | 必填。请填写 CodingPlanX 实际支持的模型代码(切勿填错,否则无法调用)。 |
| API Key | sk-xxxxxxxxxxxxxxxxxxx | 必填。填写你在 CodingPlanX 获取的 API 密钥。 |
| API endpoint URL | https://api.codingplanx.ai/v1 | 必填。接口地址。(⚠️ 注意:通常需要在域名后加 /v1 路径)。 |
| 模型上下文长度 (Context) | 8192 (根据模型实际情况填写) | 模型支持的最大 Token 数量,如 4096, 8192, 128000 等。 |
| 最大 Token 上限 (Max token) | 4096 (根据模型实际情况填写) | 单次回复允许生成的最大 Token 数量。 |
> 💡 小贴士 (Tips):
> * 关于 API URL:虽然基础域名是 https://api.codingplanx.ai,但在 Dify 的兼容模式中,通常需要补齐 /v1 后缀,即填写 https://api.codingplanx.ai/v1。
> * 关于模型名称:如果你不确定模型名称,请查阅 CodingPlanX 的官方接口文档获取准确的 Model ID。
第四步:保存并测试
- 确认所有信息填写无误后,点击右下角的 「保存」(Save)。
- 如果配置正确,系统会提示保存成功,并在列表中显示你刚刚添加的模型。
🧪 验证与使用
配置完成后,你可以立即在 Dify 中测试该模型:
- 进入 Dify 的 「工作室」(Studio),创建或打开一个应用(如聊天助手)。
- 在应用编排页面的右上角 「模型选择」 区域,点击下拉菜单。
- 找到
OpenAI-API-compatible分组,选择你刚刚添加的 CodingPlanX 模型。 - 在右侧的调试预览窗口发送一条消息(例如:"你好,请介绍一下你自己"),如果能收到正常的 AI 回复,说明接入成功!🎉
❓ 常见问题排查 (FAQ)
Q1: 保存时提示 "Connection failed" 或 "Invalid API Key" 怎么办?
- 检查
API Key是否复制完整,前后是否有空格。 - 检查
API endpoint URL是否正确添加了/v1后缀。 - 确认你的服务器网络是否能够正常访问
https://api.codingplanx.ai。
Q2: 聊天时提示 "Model not found"?
- 这是因为填写的 模型名称 (Model Name) 在 CodingPlanX 平台不存在或无权限调用。请仔细核对模型名称拼写(注意大小写和连字符)。
Q3: 回复突然被截断?
- 请检查配置中的 最大 Token 上限 (Max token) 是否设置得过小,建议将其调大(如 2048 或 4096)。