One API 项目文档

项目简介

One API 是一个基于大语言模型（LLM）的开源平台，支持多种主流的 AI 模型。它通过统一接口连接多个不同的 LLM 提供商，并提供丰富的功能来管理和优化这些模型的调用。

环境要求

• 操作系统：Linux (推荐) 或 macOS
• 编程语言：Python 3.8+
• 依赖项：
  • python-dotenv：用于加载环境变量
  • websockets：支持 WebSocket 协议的库
  • fastapi：基于 ASGI 的 Web 框架
  • uvicorn：ASGI 服务器

安装与部署

克隆仓库

git clone https://github.com/yourusername/one-api.git
cd one-api

安装依赖

pip install python-dotenv websockets fastapi uvicorn

启动服务

uvicorn main:app --reload

配置文件

项目使用 config.json 文件进行配置，示例内容如下：

{
  "debug_mode": true,
  "web_port": 8000,
  "allowed_origins": ["http://localhost", "https://yourdomain.com"],
  "api_key": "your_api_key_here"
}

功能特性

1. 多模型支持：集成多个主流 LLM 提供商。
2. 渠道管理：允许配置和管理不同的 API 提供商。
3. 额度计算：基于提示 token 和补全 token 的消耗进行计费。

使用演示

在线示例

访问以下链接体验： 在线演示站

截图展示

常见问题

1. 额度是什么？如何计算？

   • 额度 = 分组倍率 × 模型倍率 × (提示 token 数 + 补全 token 数 × 补全倍率)
   • 提示 token 和补全 token 的倍率因模型不同而有所区别。

2. 关于 API 调用的问题

   • 确保配置文件中的 api_key 正确无误。
   • 检查网络连接，确保能够访问外部服务。

3. 如何处理错误？

   • 查看控制台输出的详细日志信息。
   • 确认环境变量和配置文件是否正确设置。

命令行选项

启动命令

uvicorn main:app --reload

其他参数

• --port：指定服务端口，默认为 8000。
• --debug：启用调试模式，显示详细日志。

相关项目

• GitHub 仓库
• 官方文档

注意事项

1. MIT 协议：本项目遵循 MIT 开源协议，允许自由使用、修改和分发。
2. 署名要求：在二开项目中需注明出处并保留相关链接。
3. 问题反馈：欢迎通过 GitHub 提交 issues 或 pull request。

如有任何疑问或需要进一步帮助，请参考官方文档。