Open Design Docs

执行模式

配置 Open Design 使用本机 CLI 还是 BYOK/API 模型服务。

「执行模式」决定 Open Design 用什么方式完成生成任务。模型连不上、生成失败、想切换模型、想使用自己的 API Key,通常先看这里。

什么时候打开

  • 第一次选择生成方式
  • 页面提示模型连接失败
  • 想改用 Open Design AMR、本机 CLI 或自己的模型 API
  • 安装了本机 Coding Agent,但 Open Design 没扫描到
  • 想更换聊天模型、推理强度或 Memory 模型
  • 想测试当前模型服务是否可用

两种模式

模式通俗解释适合谁
本机 CLI使用本机 daemon 扫描到的代码代理 CLI,包括 Open Design AMR 和已安装的 Claude Code、Codex、Gemini、Cursor Agent、OpenCode 等希望让代理读取、写入或修改项目文件的用户
BYOK / API 提供方填写自己的模型服务凭证,让 Open Design 直接调用 API使用统一模型服务、阿里云 Token Plan、OpenAI 兼容服务或其他 API 服务的用户
GLOSSARY / 术语说明

BYOK

BYOK 是 "Bring Your Own Key" 的缩写,意思是「使用自己的 Key」。在 Open Design 里,它表示你把模型服务的 API Key、Base URL 和模型名称填进去,让 Open Design 通过这套服务完成对话和生成。

使用阿里云 Token Plan、OpenAI 兼容服务、公司统一模型网关或个人模型服务时,都属于 BYOK 配置。它的好处是配置集中在 Open Design 里,后续测试、切换模型和排查问题都比较直接。

使用前,需要准备 API Key、Base URL、协议类型和模型名称。Key 和地址以实际服务页面或配置说明中的信息为准。

本机 CLI

选择「本机 CLI」后,Open Design 会显示已安装和可安装的代码代理。已安装的代理在「你的 CLI」里,可安装但当前未检测到的代理在「可安装」里。

常见可用代理包括 Open Design AMR、Claude Code、Codex、Gemini CLI、OpenCode、Cursor Agent、Qwen Code、GitHub Copilot CLI、Kimi、DeepSeek 等。实际列表以页面扫描结果为准。

GLOSSARY / 术语说明

本机 Coding Agent

本机 Coding Agent 是安装在你电脑上的 AI 代码代理,例如 Claude Code、Codex、Gemini CLI、Cursor Agent 或 OpenCode。Open Design 可以通过本机 daemon 调用这些工具来生成页面、修改文件或继续处理项目。

它适合需要代理真正操作项目文件的场景。如果你只想让模型返回文本或 HTML,或者团队统一使用某个 API 服务,也可以选择 BYOK/API 提供方。

使用前,确认对应工具已经安装,并且在终端里完成登录或 API 凭据配置。Open Design 扫描不到时,先点击「重新扫描」。

常见操作:

区域 / 按钮作用使用方式
重新扫描重新查找 PATH 中可用的 CLI安装或登录新工具后点击
你的 CLI选择已检测到的代理点击代理卡片即可选中
可安装查看未安装代理的安装或文档入口按链接完成安装、认证后回到设置重新扫描
授权Open Design AMR 的登录授权入口选择 AMR 后按提示完成授权
测试验证当前本机 CLI 是否能正常回复选择非 AMR 的本机代理后点击
模型选择当前 CLI 支持的模型不确定时保持默认;需要指定模型时再选择或输入自定义模型
推理强度控制支持该选项的模型思考深度普通任务保持默认;复杂任务再提高
Memory 模型设置后台记忆提取使用的模型默认与聊天一致;想降低成本或加快提取时再单独选择
CLI 配置位置设置当前选中代理的配置目录、代理地址、API Key 或可执行文件路径只有使用自定义代理、代理网关或特殊安装路径时才需要展开

Open Design AMR 是官方托管能力,页面会显示「官方推荐」「免部署即用」「SOTA Harness」等标识。未授权时,点击「授权」完成登录;授权或充值完成后,相关任务可继续运行。

BYOK / API 提供方

选择「BYOK」后,页面会出现协议标签和当前协议的配置表单。当前支持的协议包括:

  • Anthropic
  • OpenAI
  • Azure OpenAI
  • Google Gemini
  • Ollama Cloud
  • SenseAudio
GLOSSARY / 术语说明

API 协议

API 协议指 Open Design 和模型服务之间使用哪一种请求格式。不同模型服务虽然都叫「大模型 API」,但请求地址、鉴权方式、模型字段和返回格式可能不同。

选择协议是为了让 Open Design 用正确的方式调用服务。例如 Claude 官方服务通常使用 Anthropic 协议,OpenAI 兼容网关使用 OpenAI 协议,Azure OpenAI 需要填写 Azure 资源地址和部署名称。

使用前,请先看你的模型服务说明,确认它要求使用 Anthropic、OpenAI 兼容、Azure OpenAI、Google Gemini、Ollama Cloud 还是 SenseAudio。协议、Base URL、API Key 和模型名称必须来自同一套服务。

BYOK 表单里的常见字段如下:

字段 / 区域作用注意事项
API 协议切换 Anthropic、OpenAI、Azure OpenAI、Google Gemini、Ollama Cloud、SenseAudio切换协议时,每个协议会保留自己的配置
快速填充提供方选择内置提供方并自动填入默认 Base URL 和推荐模型想手动填写时选择「自定义提供方」
API Key当前模型服务的密钥大多数提供方必填;Ollama 本地自托管等少数场景可能不需要
模型聊天使用的模型或 Azure 部署名称可以从列表选择,也可以选「自定义」后手动输入
Base URL模型服务访问地址必须是有效的 http://https:// 地址;允许 localhost,但会阻止私有网络 IP
API 版本Azure OpenAI 专用只在 Azure OpenAI 协议下显示
图片生成模型SenseAudio 专用只在 SenseAudio 协议下显示,用于 SenseAudio 图片生成默认模型
Memory 模型后台记忆提取使用的模型默认沿用当前聊天模型;也可以单独选择更快或更便宜的模型
测试 / 重新测试发送极小测试请求验证连接API Key、Base URL 和模型完整后才会显示可用

BYOK 模式会直接和模型 API 对话。它可以用于生成文本或 HTML,但不能像本机 CLI 那样直接读取、写入或修改项目文件。需要代理真正改动本地项目文件时,请切回「本机 CLI」。

拉取模型

Open Design 会在 API Key 和 Base URL 完整、地址有效,并且模型输入完成提交后,尝试从当前账号拉取可用模型。拉取成功后,模型列表会显示「已从你的账号加载」的数量。

Azure OpenAI 使用部署名称,当前不自动发现部署。Ollama Cloud 也不支持自动发现模型,需要直接选择或输入模型。

接入阿里云 Token Plan

阿里云 Token Plan 团队版和 Coding Plan 会提供专属 API Key 和 Base URL,用来接入支持 AI 编程工具的模型服务。配置时最重要的是:Key、套餐、协议、Base URL 和模型名称要互相匹配。

如果你希望按截图一步一步填写,请直接看 配置阿里云 Token Plan

GLOSSARY / 术语说明

阿里云 Token Plan

阿里云 Token Plan 团队版是阿里云百炼提供的一类模型服务套餐。它整合了多种模型,并提供可接入 AI 编程工具的专属 API Key 和 Base URL。Coding Plan 是另一套面向编程工具的套餐,两者的 Key 和 Base URL 不能混用。

在 Open Design 里使用它时,不需要理解接口细节,只需要把 API Key、Base URL、协议和模型名称填到「执行模式」里。

使用前,需要准备阿里云 Token Plan 团队版或 Coding Plan 的专属 API Key。不要把它和百炼普通按量计费的 API Key 混用,也不要把 Key 写进任务输入框、文档正文或截图里。

先准备三样信息

  1. 阿里云 Token Plan 团队版或 Coding Plan 专属 API Key
  2. 要使用的 API 协议:AnthropicOpenAI
  3. 要使用的模型名称

如果不知道应该选哪个协议,Token Plan 团队版优先使用 OpenAI 兼容配置,也就是 https://token-plan.cn-beijing.maas.aliyuncs.com/compatible-mode/v1。只有维护者明确要求时,再改用 Anthropic 协议。

Token Plan 团队版配置

API 协议Base URL
OpenAIhttps://token-plan.cn-beijing.maas.aliyuncs.com/compatible-mode/v1
Anthropichttps://token-plan.cn-beijing.maas.aliyuncs.com/apps/anthropic

Coding Plan 配置

API 协议Base URL
Anthropichttps://coding.dashscope.aliyuncs.com/apps/anthropic
OpenAIhttps://coding.dashscope.aliyuncs.com/v1

填写方式

配置项填写内容
执行模式BYOK
API 协议按套餐说明选择 OpenAIAnthropic
快速填充提供方自定义提供方
API Key当前套餐对应的专属 API Key
Base URL按上方 Token Plan 团队版或 Coding Plan 表格填写
模型按当前套餐页面里可用的模型名称填写

填完后点击「测试」。测试通过后,关闭设置,回到主页或项目页继续使用。

GLOSSARY / 术语说明

Base URL

Base URL 是模型服务的访问地址,可以理解成「Open Design 要去哪里找模型」。

阿里云不同套餐、不同协议对应不同 Base URL。Token Plan 团队版使用 token-plan.cn-beijing.maas.aliyuncs.com,Coding Plan 使用 coding.dashscope.aliyuncs.com。同一个 Key 必须搭配同一套套餐的 Base URL。

填写时只填到上面的地址即可,不要额外拼接 /chat/completions/messages 等接口路径。API Key、Base URL 和协议必须来自同一套服务,否则容易测试失败或产生错误计费。

常见问题

问题处理方式
测试失败先检查 API Key、Base URL、协议和模型名称是否匹配
测试按钮不显示先补齐必填字段,并确认 Base URL 是有效地址
拉取模型为空当前服务可能不支持自动拉取,直接手动填写可用模型
Azure OpenAI 找不到模型Azure 这里填写的是部署名称,不是普通模型名
上传图片后没被理解切换到支持图片理解的模型,或按需配置图片理解 MCP
BYOK 不能修改项目文件切换到「本机 CLI」,选择可以操作本地文件的代码代理
本机 CLI 扫描不到点击「重新扫描」;仍不出现时检查工具是否已安装、已登录,并确认 GUI 应用继承的 PATH 能找到对应命令
不确定用哪个模式需要改文件时优先用本机 CLI;只需要接入统一模型 API 时用 BYOK

Comments

评论与提问

欢迎补充问题或反馈。提交评论时需要登录,评论会先进入审核。

0 条

还没有公开评论。你可以提交第一个问题。

提交时会提示登录。 请勿填写手机号、API Key、密码等敏感信息。