one api下載 - one api源代碼下載

one api

其他源碼

v0.6.8

下載

中文 | English | 日本語

部署到 Zeabur

Zeabur 的服务器在国外，自动解决了网络的问题，同时免费的额度也足够个人使用

首先 fork 一份代码。
进入 Zeabur，登录，进入控制台。
新建一个 Project，在 Service -> Add Service 选择 Marketplace，选择 MySQL，并记下连接参数（用户名、密码、地址、端口）。
复制链接参数，运行 create database `one-api` 创建数据库。
然后在 Service -> Add Service，选择 Git（第一次使用需要先授权），选择你 fork 的仓库。
Deploy 会自动开始，先取消。进入下方 Variable，添加一个 PORT，值为 3000，再添加一个 SQL_DSN，值为 <username>:<password>@tcp(<addr>:<port>)/one-api ，然后保存。注意如果不填写 SQL_DSN，数据将无法持久化，重新部署后数据会丢失。
选择 Redeploy。
进入下方 Domains，选择一个合适的域名前缀，如 "my-one-api"，最终域名为 "my-one-api.zeabur.app"，也可以 CNAME 自己的域名。
等待部署完成，点击生成的域名进入 One API。

部署到 Render

Render 提供免费额度，绑卡后可以进一步提升额度

Render 可以直接部署 docker 镜像，不需要 fork 仓库：https://dashboard.render.com

配置

系统本身开箱即用。

你可以通过设置环境变量或者命令行参数进行配置。

等到系统启动后，使用 root 用户登录系统并做进一步的配置。

Note：如果你不知道某个配置项的含义，可以临时删掉值以看到进一步的提示文字。

使用方法

在渠道页面中添加你的 API Key，之后在令牌页面中新增访问令牌。

之后就可以使用你的令牌访问 One API 了，使用方式与 OpenAI API 一致。

你需要在各种用到 OpenAI API 的地方设置 API Base 为你的 One API 的部署地址，例如：https://openai.justsong.cn，API Key 则为你在 One API 中生成的令牌。

注意，具体的 API Base 的格式取决于你所使用的客户端。

例如对于 OpenAI 的官方库：

OPENAI_API_KEY="sk-xxxxxx"
OPENAI_API_BASE="https://<HOST>:<PORT>/v1"

graph LR
    A(用户)
    A --->|使用 One API 分发的 key 进行请求| B(One API)
    B -->|中继请求| C(OpenAI)
    B -->|中继请求| D(Azure)
    B -->|中继请求| E(其他 OpenAI API 格式下游渠道)
    B -->|中继并修改请求体和返回体| F(非 OpenAI API 格式下游渠道)

可以通过在令牌后面添加渠道 ID 的方式指定使用哪一个渠道处理本次请求，例如：Authorization: Bearer ONE_API_KEY-CHANNEL_ID。注意，需要是管理员用户创建的令牌才能指定渠道 ID。

不加的话将会使用负载均衡的方式使用多个渠道。

环境变量

One API 支持从 .env 文件中读取环境变量，请参照 .env.example 文件，使用时请将其重命名为 .env。

REDIS_CONN_STRING：设置之后将使用 Redis 作为缓存使用。
- 例子：REDIS_CONN_STRING=redis://default:redispw@localhost:49153
- 如果数据库访问延迟很低，没有必要启用 Redis，启用后反而会出现数据滞后的问题。
SESSION_SECRET：设置之后将使用固定的会话密钥，这样系统重新启动后已登录用户的 cookie 将依旧有效。
- 例子：SESSION_SECRET=random_string
SQL_DSN：设置之后将使用指定数据库而非 SQLite，请使用 MySQL 或 PostgreSQL。
- 例子：
  - MySQL：SQL_DSN=root:123456@tcp(localhost:3306)/oneapi
  - PostgreSQL：SQL_DSN=postgres://postgres:123456@localhost:5432/oneapi（适配中，欢迎反馈）
- 注意需要提前建立数据库 oneapi，无需手动建表，程序将自动建表。
- 如果使用本地数据库：部署命令可添加 --network="host" 以使得容器内的程序可以访问到宿主机上的 MySQL。
- 如果使用云数据库：如果云服务器需要验证身份，需要在连接参数中添加 ?tls=skip-verify。
- 请根据你的数据库配置修改下列参数（或者保持默认值）：
  - SQL_MAX_IDLE_CONNS：最大空闲连接数，默认为 100。
  - SQL_MAX_OPEN_CONNS：最大打开连接数，默认为 1000。
    - 如果报错 Error 1040: Too many connections，请适当减小该值。
  - SQL_CONN_MAX_LIFETIME：连接的最大生命周期，默认为 60，单位分钟。
LOG_SQL_DSN：设置之后将为 logs 表使用独立的数据库，请使用 MySQL 或 PostgreSQL。
FRONTEND_BASE_URL：设置之后将重定向页面请求到指定的地址，仅限从服务器设置。
- 例子：FRONTEND_BASE_URL=https://openai.justsong.cn
MEMORY_CACHE_ENABLED：启用内存缓存，会导致用户额度的更新存在一定的延迟，可选值为 true 和 false，未设置则默认为 false。
- 例子：MEMORY_CACHE_ENABLED=true
SYNC_FREQUENCY：在启用缓存的情况下与数据库同步配置的频率，单位为秒，默认为 600 秒。
- 例子：SYNC_FREQUENCY=60
NODE_TYPE：设置之后将指定节点类型，可选值为 master 和 slave，未设置则默认为 master。
- 例子：NODE_TYPE=slave
CHANNEL_UPDATE_FREQUENCY：设置之后将定期更新渠道余额，单位为分钟，未设置则不进行更新。
- 例子：CHANNEL_UPDATE_FREQUENCY=1440
CHANNEL_TEST_FREQUENCY：设置之后将定期检查渠道，单位为分钟，未设置则不进行检查。 +例子：CHANNEL_TEST_FREQUENCY=1440
POLLING_INTERVAL：批量更新渠道余额以及测试可用性时的请求间隔，单位为秒，默认无间隔。
- 例子：POLLING_INTERVAL=5
BATCH_UPDATE_ENABLED：启用数据库批量更新聚合，会导致用户额度的更新存在一定的延迟可选值为 true 和 false，未设置则默认为 false。
- 例子：BATCH_UPDATE_ENABLED=true
- 如果你遇到了数据库连接数过多的问题，可以尝试启用该选项。
BATCH_UPDATE_INTERVAL=5：批量更新聚合的时间间隔，单位为秒，默认为 5。
- 例子：BATCH_UPDATE_INTERVAL=5
请求频率限制：
- GLOBAL_API_RATE_LIMIT：全局 API 速率限制（除中继请求外），单 ip 三分钟内的最大请求数，默认为 180。
- GLOBAL_WEB_RATE_LIMIT：全局 Web 速率限制，单 ip 三分钟内的最大请求数，默认为 60。
编码器缓存设置：
- TIKTOKEN_CACHE_DIR：默认程序启动时会联网下载一些通用的词元的编码，如：gpt-3.5-turbo，在一些网络环境不稳定，或者离线情况，可能会导致启动有问题，可以配置此目录缓存数据，可迁移到离线环境。
- DATA_GYM_CACHE_DIR：目前该配置作用与 TIKTOKEN_CACHE_DIR 一致，但是优先级没有它高。
RELAY_TIMEOUT：中继超时设置，单位为秒，默认不设置超时时间。
RELAY_PROXY：设置后使用该代理来请求 API。
USER_CONTENT_REQUEST_TIMEOUT：用户上传内容下载超时时间，单位为秒。
USER_CONTENT_REQUEST_PROXY：设置后使用该代理来请求用户上传的内容，例如图片。
SQLITE_BUSY_TIMEOUT：SQLite 锁等待超时设置，单位为毫秒，默认 3000。
GEMINI_SAFETY_SETTING：Gemini 的安全设置，默认 BLOCK_NONE。
GEMINI_VERSION：One API 所使用的 Gemini 版本，默认为 v1。
THEME：系统的主题设置，默认为 default，具体可选值参考此处。
ENABLE_METRIC：是否根据请求成功率禁用渠道，默认不开启，可选值为 true 和 false。
METRIC_QUEUE_SIZE：请求成功率统计队列大小，默认为 10。
METRIC_SUCCESS_RATE_THRESHOLD：请求成功率阈值，默认为 0.8。
INITIAL_ROOT_TOKEN：如果设置了该值，则在系统首次启动时会自动创建一个值为该环境变量值的 root 用户令牌。
INITIAL_ROOT_ACCESS_TOKEN：如果设置了该值，则在系统首次启动时会自动创建一个值为该环境变量的 root 用户创建系统管理令牌。
ENFORCE_INCLUDE_USAGE：是否强制在 stream 模型下返回 usage，默认不开启，可选值为 true 和 false。

命令行参数

--port <port_number>: 指定服务器监听的端口号，默认为 3000。
- 例子：--port 3000
--log-dir <log_dir>: 指定日志文件夹，如果没有设置，默认保存至工作目录的 logs 文件夹下。
- 例子：--log-dir ./logs
--version: 打印系统版本号并退出。
--help: 查看命令的使用帮助和参数说明。

演示

在线演示

注意，该演示站不提供对外服务： https://openai.justsong.cn

截图展示

channel token

常见问题

额度是什么？怎么计算的？One API 的额度计算有问题？
- 额度 = 分组倍率 * 模型倍率 * （提示 token 数 + 补全 token 数 * 补全倍率）
- 其中补全倍率对于 GPT3.5 固定为 1.33，GPT4 为 2，与官方保持一致。
- 如果是非流模式，官方接口会返回消耗的总 token，但是你要注意提示和补全的消耗倍率不一样。
- 注意，One API 的默认倍率就是官方倍率，是已经调整过的。
账户额度足够为什么提示额度不足？
- 请检查你的令牌额度是否足够，这个和账户额度是分开的。
- 令牌额度仅供用户设置最大使用量，用户可自由设置。
提示无可用渠道？
- 请检查的用户分组和渠道分组设置。
- 以及渠道的模型设置。
渠道测试报错：invalid character '<' looking for beginning of value
- 这是因为返回值不是合法的 JSON，而是一个 HTML 页面。
- 大概率是你的部署站的 IP 或代理的节点被 CloudFlare 封禁了。
ChatGPT Next Web 报错：Failed to fetch
- 部署的时候不要设置 BASE_URL。
- 检查你的接口地址和 API Key 有没有填对。
- 检查是否启用了 HTTPS，浏览器会拦截 HTTPS 域名下的 HTTP 请求。
报错：当前分组负载已饱和，请稍后再试
- 上游渠道 429 了。
升级之后我的数据会丢失吗？
- 如果使用 MySQL，不会。
- 如果使用 SQLite，需要按照我所给的部署命令挂载 volume 持久化 one-api.db 数据库文件，否则容器重启后数据会丢失。
升级之前数据库需要做变更吗？
- 一般情况下不需要，系统将在初始化的时候自动调整。
- 如果需要的话，我会在更新日志中说明，并给出脚本。
手动修改数据库后报错：数据库一致性已被破坏，请联系管理员？
- 这是检测到 ability 表里有些记录的渠道 id 是不存在的，这大概率是因为你删了 channel 表里的记录但是没有同步在 ability 表里清理无效的渠道。
- 对于每一个渠道，其所支持的模型都需要有一个专门的 ability 表的记录，表示该渠道支持该模型。