BYOKSBYOKS Docs

指南

从 OpenAI 迁移

本指南帮助你将现有的 OpenAI 应用迁移到 BYOKS,享受多 Provider 路由和故障转移等功能。

迁移概览

迁移前:你的应用 → 直连 OpenAI

迁移后:你的应用 → BYOKS → OpenAI / Anthropic / Google

迁移步骤

创建 BYOKS 账户

  1. 访问 byoks.com
  2. 注册账户
  3. 获取 BYOKS API Key

配置 Provider

在 Dashboard 中添加你的 OpenAI Key:

  1. 点击 Providers > Add Provider
  2. 选择 OpenAI
  3. 输入你的 OpenAI API Key
  4. 保存

修改代码

只需修改两个配置:

// 迁移前
import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'sk-xxx',  // OpenAI Key
});

// 迁移后
import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://api.byoks.com/v1',  // 新增
  apiKey: 'byoks-xxx',                   // 改为 BYOKS Key
});
# 迁移前
export OPENAI_API_KEY=sk-xxx

# 迁移后
export OPENAI_BASE_URL=https://api.byoks.com/v1
export OPENAI_API_KEY=byoks-xxx

代码无需修改:

import OpenAI from 'openai';

const client = new OpenAI();  // 自动读取环境变量

测试

运行你的应用,验证功能正常:

const response = await client.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: '测试' }],
});

console.log(response.choices[0].message.content);

常见问题

模型 ID 需要修改吗?

不需要。BYOKS 使用与 OpenAI 相同的模型 ID:

// 这些模型 ID 保持不变
'gpt-4o'
'gpt-4-turbo'
'gpt-3.5-turbo'

功能都支持吗?

是的。BYOKS 完整支持 OpenAI API 的所有功能:

功能支持
Chat Completions
流式响应
工具调用
图片输入
JSON 模式
Embeddings

会有延迟增加吗?

BYOKS 使用边缘节点处理请求,增加的延迟通常 < 10ms。对于大多数应用,这个延迟可以忽略。

费用会变化吗?

不会。使用 BYOK 模式时,费用直接计入你的 OpenAI 账户,与直连完全相同。

迁移检查清单

  • 创建 BYOKS 账户
  • 配置 OpenAI Provider
  • 修改 Base URL 配置
  • 替换 API Key
  • 测试核心功能
  • 测试流式响应
  • 测试工具调用(如使用)
  • 更新生产环境配置

回滚

如果需要回滚,只需恢复原来的配置:

const client = new OpenAI({
  // 移除 baseURL
  apiKey: 'sk-xxx',  // 恢复 OpenAI Key
});

或恢复环境变量:

unset OPENAI_BASE_URL
export OPENAI_API_KEY=sk-xxx

下一步

迁移完成后,你可以: