Skip to content

Latest commit

 

History

History
157 lines (124 loc) · 5.13 KB

README.md

File metadata and controls

157 lines (124 loc) · 5.13 KB
Raw

C2O

English · 中文

在您喜爱的 OpenAI 客户端上使用 Coze.

该项目将 Coze API 转换为 OpenAI API 格式，使您可以在您喜爱的 OpenAI 客户端中访问 Coze 的LLMs、知识库、插件和工作流程.

功能

  • 支持 Coze API 转换为 OpenAI API 格式
  • 支持流式、非流式输出
  • 支持多机器人快速切换

准备工作

  1. 在 coze.com或 coze.cn注册并获取您的 API 令牌 cozeapitoken

  2. 创建您的机器人并发布到 API cozeapi

  3. 获取机器人的 ID，即机器人参数后面的数字，并将其配置为环境变量

https://www.coze.com/space/73428668341****/bot/73428668*****

部署

Zeabur

Deploy on Zeabur

Vercel

Deploy with Vercel

注意: Vercel 的无服务器函数有 10 秒的超时限制

Railway

Deploy on Railway

本地部署

  1. 首先把.env.template文件复制改名为.env

  2. 在 .env 文件上设置环境变量

BOT_ID=xxxx
  1. 安装依赖项
pnpm install

4.运行项目

pnpm start

docker部署

  1. 按照本部部署方式，拉取工程并修改.env
  2. 构建本地镜像
cd coze2openai
docker build -t coze2openai .
  1. 启动容器
docker run -d -p 3000:3000   -v "$PWD/.env:/app/.env"   coze
  1. 浏览器访问http://localhost:3000 提示如下信息即表示正常
Coze2OpenAI
Congratulations! Your project has been successfully deployed.

用法

  1. OpenAI 三方客户端

botgem

  1. 代码里直接调用
const response = await fetch('http://localhost:3000/v1/chat/completions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_COZE_API_KEY',
  },
  body: JSON.stringify({
    model: 'model_name',
    messages: [
      { role: 'system', content: 'You are a helpful assistant.' },
      { role: 'user', content: 'Hello, how are you?' },
    ],
  }),
});

const data = await response.json();
console.log(data);
  1. shell调用
curl --location 'http://localhost:3000/v1/chat/completions' --header 'Content-Type: application/json' --header 'Authorization: Bearer pat_key' --data '{
     "model": "gpt-4",
     "messages": [{"role": "user", "content": "你好!"}],
     "stream": false
   }'
  1. 增加到new_api等 渠道选择自定义渠道 base url填写http://localhost:3000/v1/chat/completions 分组随意，因为实际是通过.env控制的

调用测试

curl --location 'http://localhost:9301/v1/chat/completions' --header 'Content-Type: application/json' --header 'Authorization: Bearer sk-B8scKkvhaUKwVEXo09C2B23dF1Ed4f688243F2Df8f26F7B8' --data '{
     "model": "gpt-4",
     "messages": [{"role": "user", "content": "你好!"}],
     "stream": false
   }'

环境变量

该项目提供了一些额外的配置项，通过环境变量设置：

环境变量 必须的 描述 例子
BOT_ID Yes 机器人的 ID。从 Coze 中机器人的开发页面 URL 获取它。 bot参数后面的数字是bot id. 73428668*****
BOT_CONFIG No 配置模型和机器人ID的对应关系，实现在客户端切换模型来调用不同的机器人的效果。如果调用不在配置文件的模型，则走默认的BOT_ID {"model_name_1": "bot_id_1", "model_name_2": "bot_id_2", "model_name_3": "bot_id_3"}
COZE_API_BASE No 选择coze.com或者coze.cn api.coze.com, api.coze.cn 默认

路线图

即将推出

  • 图像支持
  • 音频转文字
  • 文本转语音
  • Docker 部署

现在可用

  • 支持 coze.cn
  • 多机器人切换
  • 连续对话，有对话历史
  • Zeabur＆Vercel&Railway 部署
  • 流式和非流式传输
  • Workflow、插件、知识库

联系

如有任何问题或反馈，请随时联系

X
telegram

Buy Me A Coffee

许可证

该项目在 MIT 许可证下获得许可.