From 05b5d6f2555cb34a03dcbc2472ad497c73b55706 Mon Sep 17 00:00:00 2001 From: CalciumIon <1808837298@qq.com> Date: Sat, 23 Nov 2024 16:26:15 +0800 Subject: [PATCH] Update README.md --- BT.md | 143 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 12 ++--- 2 files changed, 146 insertions(+), 9 deletions(-) create mode 100644 BT.md diff --git a/BT.md b/BT.md new file mode 100644 index 00000000..5eba17d0 --- /dev/null +++ b/BT.md @@ -0,0 +1,143 @@ +
+ +![new-api](/web/public/logo.png) + +# New API + +Calcium-Ion%2Fnew-api | Trendshift + +
+ +> [!NOTE] +> 本项目为开源项目，在[One API](https://github.com/songquanpeng/one-api)的基础上进行二次开发 + +> [!IMPORTANT] +> 使用者必须在遵循 OpenAI 的[使用条款](https://openai.com/policies/terms-of-use)以及**法律法规**的情况下使用，不得用于非法用途。 +> 本项目仅供个人学习使用，不保证稳定性，且不提供任何技术支持。 +> 根据[《生成式人工智能服务管理暂行办法》](http://www.cac.gov.cn/2023-07/13/c_1690898327029107.htm)的要求，请勿对中国地区公众提供一切未经备案的生成式人工智能服务。 + +> [!TIP] +> 最新版Docker镜像：`calciumion/new-api:latest` +> 默认账号root 密码123456 +> 更新指令： +> ``` +> docker run --rm -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower -cR +> ``` + + +## 主要变更 +此分叉版本的主要变更如下： + +1. 全新的UI界面（部分界面还待更新） +2. 添加[Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy)接口的支持，[对接文档](Midjourney.md) +3. 支持在线充值功能，可在系统设置中设置，当前支持的支付接口： + + [x] 易支付 +4. 支持用key查询使用额度: + + 配合项目[neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool)可实现用key查询使用 +5. 渠道显示已使用额度，支持指定组织访问 +6. 分页支持选择每页显示数量 +7. 兼容原版One API的数据库，可直接使用原版数据库（one-api.db） +8. 支持模型按次数收费，可在 系统设置-运营设置 中设置 +9. 支持渠道**加权随机** +10. 数据看板 +11. 可设置令牌能调用的模型 +12. 支持Telegram授权登录。 + 1. 系统设置-配置登录注册-允许通过Telegram登录 + 2. 对[@Botfather](https://t.me/botfather)输入指令/setdomain + 3. 选择你的bot，然后输入http(s)://你的网站地址/login + 4. Telegram Bot 名称是bot username 去掉@后的字符串 +13. 添加 [Suno API](https://github.com/Suno-API/Suno-API)接口的支持，[对接文档](Suno.md) +14. 支持Rerank模型，目前仅兼容Cohere和Jina，可接入Dify，[对接文档](Rerank.md) +15. **[OpenAI Realtime API](https://platform.openai.com/docs/guides/realtime/integration)** - 支持OpenAI的Realtime API，支持Azure渠道。 + +## 模型支持 +此版本额外支持以下模型： +1. 第三方模型 **gps** （gpt-4-gizmo-*） +2. 智谱glm-4v，glm-4v识图 +3. Anthropic Claude 3 +4. [Ollama](https://github.com/ollama/ollama?tab=readme-ov-file)，添加渠道时，密钥可以随便填写，默认的请求地址是[http://localhost:11434](http://localhost:11434)，如果需要修改请在渠道中修改 +5. [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy)接口，[对接文档](Midjourney.md) +6. [零一万物](https://platform.lingyiwanwu.com/) +7. 自定义渠道，支持填入完整调用地址 +8. [Suno API](https://github.com/Suno-API/Suno-API) 接口，[对接文档](Suno.md) +9. Rerank模型，目前支持[Cohere](https://cohere.ai/)和[Jina](https://jina.ai/)，[对接文档](Rerank.md) +10. Dify +11. Vertex AI，目前兼容Claude，Gemini，Llama3.1 + +您可以在渠道中添加自定义模型gpt-4-gizmo-*，此模型并非OpenAI官方模型，而是第三方模型，使用官方key无法调用。 + +## 比原版One API多出的配置 +- `GENERATE_DEFAULT_TOKEN`：是否为新注册用户生成初始令牌，默认为 `false`。 +- `STREAMING_TIMEOUT`：设置流式一次回复的超时时间，默认为 30 秒。 +- `DIFY_DEBUG`：设置 Dify 渠道是否输出工作流和节点信息到客户端，默认为 `true`。 +- `FORCE_STREAM_OPTION`：是否覆盖客户端stream_options参数，请求上游返回流模式usage，默认为 `true`，建议开启，不影响客户端传入stream_options参数返回结果。 +- `GET_MEDIA_TOKEN`：是统计图片token，默认为 `true`，关闭后将不再在本地计算图片token，可能会导致和上游计费不同，此项覆盖 `GET_MEDIA_TOKEN_NOT_STREAM` 选项作用。 +- `GET_MEDIA_TOKEN_NOT_STREAM`：是否在非流（`stream=false`）情况下统计图片token，默认为 `true`。 +- `UPDATE_TASK`：是否更新异步任务（Midjourney、Suno），默认为 `true`，关闭后将不会更新任务进度。 +- `GEMINI_MODEL_MAP`：Gemini模型指定版本(v1/v1beta)，使用“模型:版本”指定，","分隔，例如：-e GEMINI_MODEL_MAP="gemini-1.5-pro-latest:v1beta,gemini-1.5-pro-001:v1beta"，为空则使用默认配置(v1beta) +- `COHERE_SAFETY_SETTING`：Cohere模型[安全设置](https://docs.cohere.com/docs/safety-modes#overview)，可选值为 `NONE`, `CONTEXTUAL`，`STRICT`，默认为 `NONE`。 +## 部署 +### 部署要求 +- 本地数据库（默认）：SQLite（Docker 部署默认使用 SQLite，必须挂载 `/data` 目录到宿主机） +- 远程数据库：MySQL 版本 >= 5.7.8，PgSQL 版本 >= 9.6 +### 基于 Docker 进行部署 +```shell +# 使用 SQLite 的部署命令： +docker run --name new-api -d --restart always -p 3000:3000 -e TZ=Asia/Shanghai -v /home/ubuntu/data/new-api:/data calciumion/new-api:latest +# 使用 MySQL 的部署命令，在上面的基础上添加 `-e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi"`，请自行修改数据库连接参数。 +# 例如： +docker run --name new-api -d --restart always -p 3000:3000 -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" -e TZ=Asia/Shanghai -v /home/ubuntu/data/new-api:/data calciumion/new-api:latest +``` +### 使用宝塔面板Docker功能部署 +安装宝塔面板 (**9.2.0版本**及以上)，前往 宝塔面板 官网，选择正式版的脚本下载安装 +安装后登录宝塔面板，在菜单栏中点击 Docker ，首次进入会提示安装 Docker 服务，点击立即安装，按提示完成安装 +安装完成后在应用商店中找到 **New-API** ，点击安装，配置基本选项 即可完成安装 +[图文教程](BT.md) + +## 渠道重试 +渠道重试功能已经实现，可以在`设置->运营设置->通用设置`设置重试次数，**建议开启缓存**功能。 +如果开启了重试功能，第一次重试使用同优先级，第二次重试使用下一个优先级，以此类推。 +### 缓存设置方法 +1. `REDIS_CONN_STRING`：设置之后将使用 Redis 作为缓存使用。 + + 例子：`REDIS_CONN_STRING=redis://default:redispw@localhost:49153` +2. `MEMORY_CACHE_ENABLED`：启用内存缓存（如果设置了`REDIS_CONN_STRING`，则无需手动设置），会导致用户额度的更新存在一定的延迟，可选值为 `true` 和 `false`，未设置则默认为 `false`。 + + 例子：`MEMORY_CACHE_ENABLED=true` +### 为什么有的时候没有重试 +这些错误码不会重试：400，504，524 +### 我想让400也重试 +在`渠道->编辑`中，将`状态码复写`改为 +```json +{ + "400": "500" +} +``` +可以实现400错误转为500错误，从而重试 + +## Midjourney接口设置文档 +[对接文档](Midjourney.md) + +## Suno接口设置文档 +[对接文档](Suno.md) + +## 界面截图 +![796df8d287b7b7bd7853b2497e7df511](https://github.com/user-attachments/assets/255b5e97-2d3a-4434-b4fa-e922ad88ff5a) + +![image](https://github.com/Calcium-Ion/new-api/assets/61247483/ad0e7aae-0203-471c-9716-2d83768927d4) + +![image](https://github.com/Calcium-Ion/new-api/assets/61247483/3ca0b282-00ff-4c96-bf9d-e29ef615c605) +夜间模式 +![image](https://github.com/Calcium-Ion/new-api/assets/61247483/1c66b593-bb9e-4757-9720-ff2759539242) +![image](https://github.com/Calcium-Ion/new-api/assets/61247483/af9a07ee-5101-4b3d-8bd9-ae21a4fd7e9e) + +## 交流群 + + +## 相关项目 +- [One API](https://github.com/songquanpeng/one-api)：原版项目 +- [Midjourney-Proxy](https://github.com/novicezk/midjourney-proxy)：Midjourney接口支持 +- [chatnio](https://github.com/Deeptrain-Community/chatnio)：下一代 AI 一站式 B/C 端解决方案 +- [neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool)：用key查询使用额度 + +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=Calcium-Ion/new-api&type=Date)](https://star-history.com/#Calcium-Ion/new-api&Date) diff --git a/README.md b/README.md index e1504288..e3880e97 100644 --- a/README.md +++ b/README.md @@ -89,15 +89,9 @@ docker run --name new-api -d --restart always -p 3000:3000 -e TZ=Asia/Shanghai - docker run --name new-api -d --restart always -p 3000:3000 -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" -e TZ=Asia/Shanghai -v /home/ubuntu/data/new-api:/data calciumion/new-api:latest ``` ### 使用宝塔面板Docker功能部署 -```shell -# 使用 SQLite 的部署命令： -docker run --name new-api -d --restart always -p 3000:3000 -e TZ=Asia/Shanghai -v /www/wwwroot/new-api:/data calciumion/new-api:latest -# 使用 MySQL 的部署命令，在上面的基础上添加 `-e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi"`，请自行修改数据库连接参数。 -# 例如： -# 注意：数据库要开启远程访问，并且只允许服务器IP访问 -docker run --name new-api -d --restart always -p 3000:3000 -e SQL_DSN="root:123456@tcp(宝塔的服务器地址:宝塔数据库端口)/宝塔数据库名称" -e TZ=Asia/Shanghai -v /www/wwwroot/new-api:/data calciumion/new-api:latest -# 注意：数据库要开启远程访问，并且只允许服务器IP访问 -``` +安装宝塔面板 (9.2.0版本及以上)，前往 宝塔面板 官网，选择正式版的脚本下载安装 +安装后登录宝塔面板，在菜单栏中点击 Docker ，首次进入会提示安装 Docker 服务，点击立即安装，按提示完成安装 +安装完成后在应用商店中找到 lucky ，点击安装，配置基本选项 即可完成安装 ## 渠道重试 渠道重试功能已经实现，可以在`设置->运营设置->通用设置`设置重试次数，**建议开启缓存**功能。