mirror of
https://github.com/snailyp/gemini-balance.git
synced 2026-09-09 01:46:38 +08:00
chore: Add Chinese README for Gemini Balance project with detailed features and setup instructions
This commit is contained in:
snaily
@@ -1,251 +1,253 @@
|
|||||||
# Gemini Balance - Gemini API 代理和负载均衡器
|
[Read this document in Chinese](README_ZH.md)
|
||||||
|
|
||||||
> ⚠️ 本项目采用 CC BY-NC 4.0（署名-非商业性使用）协议，禁止任何形式的商业倒卖服务，详见 LICENSE 文件。
|
# Gemini Balance - Gemini API Proxy and Load Balancer
|
||||||
|
|
||||||
> 本人从未在各个平台售卖服务，如有遇到售卖此服务者，那一定是倒卖狗，大家切记不要上当受骗。
|
> ⚠️ This project is licensed under the CC BY-NC 4.0 (Attribution-NonCommercial) license. Any form of commercial resale service is prohibited. See the LICENSE file for details.
|
||||||
|
|
||||||
|
> I have never sold this service on any platform. If you encounter someone selling this service, they are definitely a reseller. Please be careful not to be deceived.
|
||||||
|
|
||||||
[](https://www.python.org/)
|
[](https://www.python.org/)
|
||||||
[](https://fastapi.tiangolo.com/)
|
[](https://fastapi.tiangolo.com/)
|
||||||
[](https://www.uvicorn.org/)
|
[](https://www.uvicorn.org/)
|
||||||
[](https://t.me/+soaHax5lyI0wZDVl)
|
[](https://t.me/+soaHax5lyI0wZDVl)
|
||||||
> 交流群：https://t.me/+soaHax5lyI0wZDVl
|
> Telegram Group: https://t.me/+soaHax5lyI0wZDVl
|
||||||
|
|
||||||
## 项目简介
|
## Project Introduction
|
||||||
|
|
||||||
Gemini Balance 是一个基于 Python FastAPI 构建的应用程序，旨在提供 Google Gemini API 的代理和负载均衡功能。它允许您管理多个 Gemini API Key，并通过简单的配置实现 Key 的轮询、认证、模型过滤和状态监控。此外，项目还集成了图像生成和多种图床上传功能，并支持 OpenAI API 格式的代理。
|
Gemini Balance is an application built with Python FastAPI, designed to provide proxy and load balancing functions for the Google Gemini API. It allows you to manage multiple Gemini API Keys and implement key rotation, authentication, model filtering, and status monitoring through simple configuration. Additionally, the project integrates image generation and multiple image hosting upload functions, and supports proxying in the OpenAI API format.
|
||||||
|
|
||||||
**项目结构:**
|
**Project Structure:**
|
||||||
|
|
||||||
```plaintext
|
```plaintext
|
||||||
app/
|
app/
|
||||||
├── config/ # 配置管理
|
├── config/ # Configuration management
|
||||||
├── core/ # 核心应用逻辑 (FastAPI 实例创建, 中间件等)
|
├── core/ # Core application logic (FastAPI instance creation, middleware, etc.)
|
||||||
├── database/ # 数据库模型和连接
|
├── database/ # Database models and connections
|
||||||
├── domain/ # 业务领域对象 (可选)
|
├── domain/ # Business domain objects (optional)
|
||||||
├── exception/ # 自定义异常
|
├── exception/ # Custom exceptions
|
||||||
├── handler/ # 请求处理器 (可选, 或在 router 中处理)
|
├── handler/ # Request handlers (optional, or handled in router)
|
||||||
├── log/ # 日志配置
|
├── log/ # Logging configuration
|
||||||
├── main.py # 应用入口
|
├── main.py # Application entry point
|
||||||
├── middleware/ # FastAPI 中间件
|
├── middleware/ # FastAPI middleware
|
||||||
├── router/ # API 路由 (Gemini, OpenAI, 状态页等)
|
├── router/ # API routes (Gemini, OpenAI, status page, etc.)
|
||||||
├── scheduler/ # 定时任务 (如 Key 状态检查)
|
├── scheduler/ # Scheduled tasks (e.g., Key status check)
|
||||||
├── service/ # 业务逻辑服务 (聊天, Key 管理, 统计等)
|
├── service/ # Business logic services (chat, Key management, statistics, etc.)
|
||||||
├── static/ # 静态文件 (CSS, JS)
|
├── static/ # Static files (CSS, JS)
|
||||||
├── templates/ # HTML 模板 (如 Key 状态页)
|
├── templates/ # HTML templates (e.g., Key status page)
|
||||||
├── utils/ # 工具函数
|
├── utils/ # Utility functions
|
||||||
```
|
```
|
||||||
|
|
||||||
## ✨ 功能亮点
|
## ✨ Feature Highlights
|
||||||
|
|
||||||
* **多 Key 负载均衡**: 支持配置多个 Gemini API Key (`API_KEYS`)，自动按顺序轮询使用，提高可用性和并发能力。
|
* **Multi-Key Load Balancing**: Supports configuring multiple Gemini API Keys (`API_KEYS`) for automatic sequential polling, improving availability and concurrency.
|
||||||
* **可视化配置即时生效**: 通过管理后台修改配置后，无需重启服务即可生效，切记要点击保存才会生效。
|
* **Visual Configuration Takes Effect Immediately**: Configurations modified through the admin backend take effect without restarting the service. Remember to click save for changes to apply.
|
||||||
|
|
||||||
* **双协议API 兼容**: 同时支持 Gemini 和 OpenAI 格式的 CHAT API 请求转发。
|
* **Dual Protocol API Compatibility**: Supports forwarding CHAT API requests in both Gemini and OpenAI formats.
|
||||||
|
|
||||||
```palintext
|
```plaintext
|
||||||
openai baseurl `http://localhost:8000(/hf)/v1`
|
openai baseurl `http://localhost:8000(/hf)/v1`
|
||||||
gemini baseurl `http://localhost:8000(/gemini)/v1beta`
|
gemini baseurl `http://localhost:8000(/gemini)/v1beta`
|
||||||
```
|
```
|
||||||
|
|
||||||
* **支持图文对话和修改图片**: `IMAGE_MODELS`配置哪个模型可以图文对话和修图的功能，实际调用的时候，用 `配置模型-image`这个模型名对话使用该功能。
|
* **Supports Image-Text Chat and Image Modification**: `IMAGE_MODELS` configures which models can perform image-text chat and image editing. When actually calling, use the `configured_model-image` model name to use this feature.
|
||||||
|
|
||||||
|
|
||||||
* **支持联网搜索**: 支持联网搜索，`SEARCH_MODELS`配置哪些模型可以联网搜索，实际调用的时候，用 `配置模型-search`这个模型名对话使用该功能
|
* **Supports Web Search**: Supports web search. `SEARCH_MODELS` configures which models can perform web searches. When actually calling, use the `configured_model-search` model name to use this feature.
|
||||||
|
|
||||||
* **Key 状态监控**: 提供 `/keys_status` 页面（需要认证），实时查看各 Key 的状态和使用情况。
|
* **Key Status Monitoring**: Provides a `/keys_status` page (requires authentication) to view the status and usage of each Key in real-time.
|
||||||
|
|
||||||
* **详细的日志记录**: 提供详细的错误日志，方便排查。
|
* **Detailed Logging**: Provides detailed error logs for easy troubleshooting.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* **支持自定义gemini代理**: 支持自定义gemini代理，比如自行在deno或者cloudflare上搭建gemini代理
|
* **Support for Custom Gemini Proxy**: Supports custom Gemini proxies, such as those built on Deno or Cloudflare.
|
||||||
* **openai画图接口兼容**: 将`imagen-3.0-generate-002`模型接口改造成openai画图接口，支持客户端调用。
|
* **OpenAI Image Generation API Compatibility**: Adapts the `imagen-3.0-generate-002` model interface to be compatible with the OpenAI image generation API, supporting client calls.
|
||||||
* **灵活的添加密钥方式**: 灵活的添加密钥方式，采用正则匹配`gemini_key`,密钥去重
|
* **Flexible Key Addition**: Flexible way to add keys using regex matching for `gemini_key`, with key deduplication.
|
||||||
|
|
||||||
* **兼容openai格式embeddings接口**：完美适配openai格式的`embeddings`接口，可用于本地文档向量化。
|
* **OpenAI Format Embeddings API Compatibility**: Perfectly adapts to the OpenAI format `embeddings` interface, usable for local document vectorization.
|
||||||
* **流式响应优化**: 可选的流式输出优化器 (`STREAM_OPTIMIZER_ENABLED`)，改善长文本流式响应的体验。
|
* **Streamlined Response Optimization**: Optional stream output optimizer (`STREAM_OPTIMIZER_ENABLED`) to improve the experience of long-text stream responses.
|
||||||
* **失败重试与 Key 管理**: 自动处理 API 请求失败，进行重试 (`MAX_RETRIES`)，并在 Key 失效次数过多时自动禁用 (`MAX_FAILURES`)，定时检查恢复 (`CHECK_INTERVAL_HOURS`)。
|
* **Failure Retry and Key Management**: Automatically handles API request failures, retries (`MAX_RETRIES`), automatically disables Keys after too many failures (`MAX_FAILURES`), and periodically checks for recovery (`CHECK_INTERVAL_HOURS`).
|
||||||
* **Docker 支持**: 支持AMD，ARM架构的docker部署，也可自行构建docker镜像。
|
* **Docker Support**: Supports AMD and ARM architecture Docker deployments. You can also build your own Docker image.
|
||||||
>镜像地址: docker pull ghcr.io/snailyp/gemini-balance:latest
|
> Image address: docker pull ghcr.io/snailyp/gemini-balance:latest
|
||||||
* **模型列表自动维护**: 支持openai和gemini模型列表获取，与newapi自动获取模型列表完美兼容，无需手动填写。
|
* **Automatic Model List Maintenance**: Supports fetching OpenAI and Gemini model lists, perfectly compatible with NewAPI's automatic model list fetching, no manual entry required.
|
||||||
* **支持移除不使用的模型**: 默认提供的模型太多，很多用不上，可以通过`FILTERED_MODELS`过滤掉。
|
* **Support for Removing Unused Models**: Too many default models are provided, many of which are not used. You can filter them out using `FILTERED_MODELS`.
|
||||||
* **代理支持**: 支持配置 HTTP/SOCKS5 代理服务器 (`PROXIES`)，用于访问 Gemini API，方便在特殊网络环境下使用。支持批量添加代理。
|
* **Proxy Support**: Supports configuring HTTP/SOCKS5 proxy servers (`PROXIES`) for accessing the Gemini API, convenient for use in special network environments. Supports batch adding proxies.
|
||||||
|
|
||||||
## 🚀 快速开始
|
## 🚀 Quick Start
|
||||||
|
|
||||||
### 自行构建 Docker (推荐)
|
### Build Docker Yourself (Recommended)
|
||||||
|
|
||||||
#### a) dockerfile构建
|
#### a) Build with Dockerfile
|
||||||
|
|
||||||
1. **构建镜像**:
|
1. **Build Image**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build -t gemini-balance .
|
docker build -t gemini-balance .
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **运行容器**:
|
2. **Run Container**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -d -p 8000:8000 --env-file .env gemini-balance
|
docker run -d -p 8000:8000 --env-file .env gemini-balance
|
||||||
```
|
```
|
||||||
|
|
||||||
* `-d`: 后台运行。
|
* `-d`: Run in detached mode.
|
||||||
* `-p 8000:8000`: 将容器的 8000 端口映射到主机的 8000 端口。
|
* `-p 8000:8000`: Map port 8000 of the container to port 8000 of the host.
|
||||||
* `--env-file .env`: 使用 `.env` 文件设置环境变量。
|
* `--env-file .env`: Use the `.env` file to set environment variables.
|
||||||
|
|
||||||
> 注意：如果使用 SQLite 数据库，需要挂载数据卷以持久化数据：
|
> Note: If using an SQLite database, you need to mount a data volume to persist
|
||||||
> ```bash
|
> ```bash
|
||||||
> docker run -d -p 8000:8000 --env-file .env -v /path/to/data:/app/data gemini-balance
|
> docker run -d -p 8000:8000 --env-file .env -v /path/to//app/data gemini-balance
|
||||||
> ```
|
> ```
|
||||||
> 其中 `/path/to/data` 是主机上的数据存储路径，`/app/data` 是容器内的数据目录。
|
> Where `/path/to/data` is the data storage path on the host, and `/app/data` is the data directory inside the container.
|
||||||
|
|
||||||
#### b) 用现有的docker镜像部署
|
#### b) Deploy with an Existing Docker Image
|
||||||
|
|
||||||
1. **拉取镜像**:
|
1. **Pull Image**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker pull ghcr.io/snailyp/gemini-balance:latest
|
docker pull ghcr.io/snailyp/gemini-balance:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **运行容器**:
|
2. **Run Container**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run -d -p 8000:8000 --env-file .env ghcr.io/snailyp/gemini-balance:latest
|
docker run -d -p 8000:8000 --env-file .env ghcr.io/snailyp/gemini-balance:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
* `-d`: 后台运行。
|
* `-d`: Run in detached mode.
|
||||||
* `-p 8000:8000`: 将容器的 8000 端口映射到主机的 8000 端口 (根据需要调整)。
|
* `-p 8000:8000`: Map port 8000 of the container to port 8000 of the host (adjust as needed).
|
||||||
* `--env-file .env`: 使用 `.env` 文件设置环境变量 (确保 `.env` 文件存在于执行命令的目录)。
|
* `--env-file .env`: Use the `.env` file to set environment variables (ensure the `.env` file exists in the directory where the command is executed).
|
||||||
|
|
||||||
> 注意：如果使用 SQLite 数据库，需要挂载数据卷以持久化数据：
|
> Note: If using an SQLite database, you need to mount a data volume to persist
|
||||||
> ```bash
|
> ```bash
|
||||||
> docker run -d -p 8000:8000 --env-file .env -v /path/to/data:/app/data ghcr.io/snailyp/gemini-balance:latest
|
> docker run -d -p 8000:8000 --env-file .env -v /path/to//app/data ghcr.io/snailyp/gemini-balance:latest
|
||||||
> ```
|
> ```
|
||||||
> 其中 `/path/to/data` 是主机上的数据存储路径，`/app/data` 是容器内的数据目录。
|
> Where `/path/to/data` is the data storage path on the host, and `/app/data` is the data directory inside the container.
|
||||||
|
|
||||||
### 本地运行 (适用于开发和测试)
|
### Run Locally (Suitable for Development and Testing)
|
||||||
|
|
||||||
如果您想在本地直接运行源代码进行开发或测试，请按照以下步骤操作：
|
If you want to run the source code directly locally for development or testing, follow these steps:
|
||||||
|
|
||||||
1. **确保已完成准备工作**:
|
1. **Ensure Prerequisites are Met**:
|
||||||
* 克隆仓库到本地。
|
* Clone the repository locally.
|
||||||
* 安装 Python 3.9 或更高版本。
|
* Install Python 3.9 or higher.
|
||||||
* 在项目根目录下创建并配置好 `.env` 文件 (参考前面的"配置环境变量"部分)。
|
* Create and configure the `.env` file in the project root directory (refer to the "Configure Environment Variables" section above).
|
||||||
* 安装项目依赖：
|
* Install project dependencies:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **启动应用**:
|
2. **Start Application**:
|
||||||
在项目根目录下运行以下命令：
|
Run the following command in the project root directory:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload
|
uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload
|
||||||
```
|
```
|
||||||
|
|
||||||
* `app.main:app`: 指定 FastAPI 应用实例的位置 (`app` 模块中的 `main.py` 文件里的 `app` 对象)。
|
* `app.main:app`: Specifies the location of the FastAPI application instance (the `app` object in the `main.py` file within the `app` module).
|
||||||
* `--host 0.0.0.0`: 使应用可以从本地网络中的任何 IP 地址访问。
|
* `--host 0.0.0.0`: Makes the application accessible from any IP address on the local network.
|
||||||
* `--port 8000`: 指定应用监听的端口号 (您可以根据需要修改)。
|
* `--port 8000`: Specifies the port number the application listens on (you can change this as needed).
|
||||||
* `--reload`: 启用自动重载功能。当您修改代码时，服务会自动重启，非常适合开发环境 (生产环境请移除此选项)。
|
* `--reload`: Enables automatic reloading. When you modify the code, the service will automatically restart, which is very suitable for development environments (remove this option in production environments).
|
||||||
|
|
||||||
3. **访问应用**:
|
3. **Access Application**:
|
||||||
应用启动后，您可以通过浏览器或 API 工具访问 `http://localhost:8000` (或您指定的主机和端口)。
|
After the application starts, you can access `http://localhost:8000` (or the host and port you specified) through a browser or API tool.
|
||||||
|
|
||||||
### 完整配置项列表
|
### Complete Configuration List
|
||||||
|
|
||||||
| 配置项 | 说明 | 默认值 |
|
| Configuration Item | Description | Default Value |
|
||||||
| :--------------------------- | :------------------------------------------------------- | :---------------------------------------------------- |
|
| :----------------------------- | :-------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| **数据库配置** | | |
|
| **Database Configuration** | | |
|
||||||
| `DATABASE_TYPE` | 可选，数据库类型，支持 `mysql` 或 `sqlite` | `mysql` |
|
| `DATABASE_TYPE` | Optional, database type, supports `mysql` or `sqlite` | `mysql` |
|
||||||
| `SQLITE_DATABASE` | 可选，当使用 `sqlite` 时必填，SQLite 数据库文件路径 | `default_db` |
|
| `SQLITE_DATABASE` | Optional, required when using `sqlite`, SQLite database file path | `default_db` |
|
||||||
| `MYSQL_HOST` | 当使用 `mysql` 时必填，MySQL 数据库主机地址 | `localhost` |
|
| `MYSQL_HOST` | Required when using `mysql`, MySQL database host address | `localhost` |
|
||||||
| `MYSQL_SOCKET` | 可选，MySQL 数据库 socket 地址 | `/var/run/mysqld/mysqld.sock` |
|
| `MYSQL_SOCKET` | Optional, MySQL database socket address | `/var/run/mysqld/mysqld.sock` |
|
||||||
| `MYSQL_PORT` | 当使用 `mysql` 时必填，MySQL 数据库端口 | `3306` |
|
| `MYSQL_PORT` | Required when using `mysql`, MySQL database port | `3306` |
|
||||||
| `MYSQL_USER` | 当使用 `mysql` 时必填，MySQL 数据库用户名 | `your_db_user` |
|
| `MYSQL_USER` | Required when using `mysql`, MySQL database username | `your_db_user` |
|
||||||
| `MYSQL_PASSWORD` | 当使用 `mysql` 时必填，MySQL 数据库密码 | `your_db_password` |
|
| `MYSQL_PASSWORD` | Required when using `mysql`, MySQL database password | `your_db_password` |
|
||||||
| `MYSQL_DATABASE` | 当使用 `mysql` 时必填，MySQL 数据库名称 | `defaultdb` |
|
| `MYSQL_DATABASE` | Required when using `mysql`, MySQL database name | `defaultdb` |
|
||||||
| **API 相关配置** | | |
|
| **API Related Configuration** | | |
|
||||||
| `API_KEYS` | 必填，Gemini API 密钥列表，用于负载均衡 | `["your-gemini-api-key-1", "your-gemini-api-key-2"]` |
|
| `API_KEYS` | Required, list of Gemini API keys for load balancing | `["your-gemini-api-key-1", "your-gemini-api-key-2"]` |
|
||||||
| `ALLOWED_TOKENS` | 必填，允许访问的 Token 列表 | `["your-access-token-1", "your-access-token-2"]` |
|
| `ALLOWED_TOKENS` | Required, list of tokens allowed to access | `["your-access-token-1", "your-access-token-2"]` |
|
||||||
| `AUTH_TOKEN` | 可选，超级管理员token，具有所有权限，不填默认使用 ALLOWED_TOKENS 的第一个 | `sk-123456` |
|
| `AUTH_TOKEN` | Optional, super admin token with all permissions, defaults to the first of `ALLOWED_TOKENS` if not set | `sk-123456` |
|
||||||
| `TEST_MODEL` | 可选，用于测试密钥是否可用的模型名 | `gemini-1.5-flash` |
|
| `TEST_MODEL` | Optional, model name used to test if a key is usable | `gemini-1.5-flash` |
|
||||||
| `IMAGE_MODELS` | 可选，支持绘图功能的模型列表 | `["gemini-2.0-flash-exp"]` |
|
| `IMAGE_MODELS` | Optional, list of models that support drawing functions | `["gemini-2.0-flash-exp"]` |
|
||||||
| `SEARCH_MODELS` | 可选，支持搜索功能的模型列表 | `["gemini-2.0-flash-exp"]` |
|
| `SEARCH_MODELS` | Optional, list of models that support search functions | `["gemini-2.0-flash-exp"]` |
|
||||||
| `FILTERED_MODELS` | 可选，被禁用的模型列表 | `["gemini-1.0-pro-vision-latest", ...]` |
|
| `FILTERED_MODELS` | Optional, list of disabled models | `["gemini-1.0-pro-vision-latest", ...]` |
|
||||||
| `TOOLS_CODE_EXECUTION_ENABLED` | 可选，是否启用代码执行工具 | `false` |
|
| `TOOLS_CODE_EXECUTION_ENABLED` | Optional, whether to enable the code execution tool | `false` |
|
||||||
| `SHOW_SEARCH_LINK` | 可选，是否在响应中显示搜索结果链接 | `true` |
|
| `SHOW_SEARCH_LINK` | Optional, whether to display search result links in the response | `true` |
|
||||||
| `SHOW_THINKING_PROCESS` | 可选，是否显示模型思考过程 | `true` |
|
| `SHOW_THINKING_PROCESS` | Optional, whether to display the model's thinking process | `true` |
|
||||||
| `THINKING_MODELS` | 可选，支持思考功能的模型列表 | `[]` |
|
| `THINKING_MODELS` | Optional, list of models that support thinking functions | `[]` |
|
||||||
| `THINKING_BUDGET_MAP` | 可选，思考功能预算映射 (模型名:预算值) | `{}` |
|
| `THINKING_BUDGET_MAP` | Optional, thinking function budget mapping (model_name:budget_value) | `{}` |
|
||||||
| `BASE_URL` | 可选，Gemini API 基础 URL，默认无需修改 | `https://generativelanguage.googleapis.com/v1beta` |
|
| `BASE_URL` | Optional, Gemini API base URL, no modification needed by default | `https://generativelanguage.googleapis.com/v1beta` |
|
||||||
| `MAX_FAILURES` | 可选，允许单个key失败的次数 | `3` |
|
| `MAX_FAILURES` | Optional, number of times a single key is allowed to fail | `3` |
|
||||||
| `MAX_RETRIES` | 可选，API 请求失败时的最大重试次数 | `3` |
|
| `MAX_RETRIES` | Optional, maximum number of retries for failed API requests | `3` |
|
||||||
| `CHECK_INTERVAL_HOURS` | 可选，检查禁用 Key 是否恢复的时间间隔 (小时) | `1` |
|
| `CHECK_INTERVAL_HOURS` | Optional, time interval (hours) to check if a disabled Key has recovered | `1` |
|
||||||
| `TIMEZONE` | 可选，应用程序使用的时区 | `Asia/Shanghai` |
|
| `TIMEZONE` | Optional, timezone used by the application | `Asia/Shanghai` |
|
||||||
| `TIME_OUT` | 可选，请求超时时间 (秒) | `300` |
|
| `TIME_OUT` | Optional, request timeout (seconds) | `300` |
|
||||||
| `PROXIES` | 可选，代理服务器列表 (例如 `http://user:pass@host:port`, `socks5://host:port`) | `[]` |
|
| `PROXIES` | Optional, list of proxy servers (e.g., `http://user:pass@host:port`, `socks5://host:port`) | `[]` |
|
||||||
| `LOG_LEVEL` | 可选，日志级别，例如 DEBUG, INFO, WARNING, ERROR, CRITICAL | `INFO` |
|
| `LOG_LEVEL` | Optional, log level, e.g., DEBUG, INFO, WARNING, ERROR, CRITICAL | `INFO` |
|
||||||
| `AUTO_DELETE_ERROR_LOGS_ENABLED` | 可选，是否开启自动删除错误日志 | `true` |
|
| `AUTO_DELETE_ERROR_LOGS_ENABLED` | Optional, whether to enable automatic deletion of error logs | `true` |
|
||||||
| `AUTO_DELETE_ERROR_LOGS_DAYS` | 可选，自动删除多少天前的错误日志 (例如 1, 7, 30) | `7` |
|
| `AUTO_DELETE_ERROR_LOGS_DAYS` | Optional, automatically delete error logs older than this many days (e.g., 1, 7, 30) | `7` |
|
||||||
| `AUTO_DELETE_REQUEST_LOGS_ENABLED`| 可选，是否开启自动删除请求日志 | `false` |
|
| `AUTO_DELETE_REQUEST_LOGS_ENABLED`| Optional, whether to enable automatic deletion of request logs | `false` |
|
||||||
| `AUTO_DELETE_REQUEST_LOGS_DAYS` | 可选，自动删除多少天前的请求日志 (例如 1, 7, 30) | `30` |
|
| `AUTO_DELETE_REQUEST_LOGS_DAYS` | Optional, automatically delete request logs older than this many days (e.g., 1, 7, 30) | `30` |
|
||||||
| `SAFETY_SETTINGS` | 可选，安全设置 (JSON 字符串格式)，用于配置内容安全阈值。示例值可能需要根据实际模型支持情况调整。 | `[{"category": "HARM_CATEGORY_HARASSMENT", "threshold": "OFF"}, {"category": "HARM_CATEGORY_HATE_SPEECH", "threshold": "OFF"}, {"category": "HARM_CATEGORY_SEXUALLY_EXPLICIT", "threshold": "OFF"}, {"category": "HARM_CATEGORY_DANGEROUS_CONTENT", "threshold": "OFF"}, {"category": "HARM_CATEGORY_CIVIC_INTEGRITY", "threshold": "BLOCK_NONE"}]` |
|
| `SAFETY_SETTINGS` | Optional, safety settings (JSON string format), used to configure content safety thresholds. Example values may need adjustment based on actual model support. | `[{"category": "HARM_CATEGORY_HARASSMENT", "threshold": "OFF"}, {"category": "HARM_CATEGORY_HATE_SPEECH", "threshold": "OFF"}, {"category": "HARM_CATEGORY_SEXUALLY_EXPLICIT", "threshold": "OFF"}, {"category": "HARM_CATEGORY_DANGEROUS_CONTENT", "threshold": "OFF"}, {"category": "HARM_CATEGORY_CIVIC_INTEGRITY", "threshold": "BLOCK_NONE"}]` |
|
||||||
| **图像生成相关** | | |
|
| **Image Generation Related** | | |
|
||||||
| `PAID_KEY` | 可选，付费版API Key，用于图片生成等高级功能 | `your-paid-api-key` |
|
| `PAID_KEY` | Optional, paid API Key for advanced features like image generation | `your-paid-api-key` |
|
||||||
| `CREATE_IMAGE_MODEL` | 可选，图片生成模型 | `imagen-3.0-generate-002` |
|
| `CREATE_IMAGE_MODEL` | Optional, image generation model | `imagen-3.0-generate-002` |
|
||||||
| `UPLOAD_PROVIDER` | 可选，图片上传提供商: `smms`, `picgo`, `cloudflare_imgbed` | `smms` |
|
| `UPLOAD_PROVIDER` | Optional, image upload provider: `smms`, `picgo`, `cloudflare_imgbed` | `smms` |
|
||||||
| `SMMS_SECRET_TOKEN` | 可选，SM.MS图床的API Token | `your-smms-token` |
|
| `SMMS_SECRET_TOKEN` | Optional, API Token for SM.MS image hosting | `your-smms-token` |
|
||||||
| `PICGO_API_KEY` | 可选，[PicoGo](https://www.picgo.net/)图床的API Key | `your-picogo-apikey` |
|
| `PICGO_API_KEY` | Optional, API Key for [PicoGo](https://www.picgo.net/) image hosting | `your-picogo-apikey` |
|
||||||
| `CLOUDFLARE_IMGBED_URL` | 可选，[CloudFlare](https://github.com/MarSeventh/CloudFlare-ImgBed) 图床上传地址 | `https://xxxxxxx.pages.dev/upload` |
|
| `CLOUDFLARE_IMGBED_URL` | Optional, [CloudFlare](https://github.com/MarSeventh/CloudFlare-ImgBed) image hosting upload address | `https://xxxxxxx.pages.dev/upload` |
|
||||||
| `CLOUDFLARE_IMGBED_AUTH_CODE`| 可选，CloudFlare图床的鉴权key | `your-cloudflare-imgber-auth-code` |
|
| `CLOUDFLARE_IMGBED_AUTH_CODE` | Optional, authentication key for CloudFlare image hosting | `your-cloudflare-imgber-auth-code` |
|
||||||
| **流式优化器相关** | | |
|
| **Stream Optimizer Related** | | |
|
||||||
| `STREAM_OPTIMIZER_ENABLED` | 可选，是否启用流式输出优化 | `false` |
|
| `STREAM_OPTIMIZER_ENABLED` | Optional, whether to enable stream output optimization | `false` |
|
||||||
| `STREAM_MIN_DELAY` | 可选，流式输出最小延迟 | `0.016` |
|
| `STREAM_MIN_DELAY` | Optional, minimum delay for stream output | `0.016` |
|
||||||
| `STREAM_MAX_DELAY` | 可选，流式输出最大延迟 | `0.024` |
|
| `STREAM_MAX_DELAY` | Optional, maximum delay for stream output | `0.024` |
|
||||||
| `STREAM_SHORT_TEXT_THRESHOLD`| 可选，短文本阈值 | `10` |
|
| `STREAM_SHORT_TEXT_THRESHOLD` | Optional, short text threshold | `10` |
|
||||||
| `STREAM_LONG_TEXT_THRESHOLD` | 可选，长文本阈值 | `50` |
|
| `STREAM_LONG_TEXT_THRESHOLD` | Optional, long text threshold | `50` |
|
||||||
| `STREAM_CHUNK_SIZE` | 可选，流式输出块大小 | `5` |
|
| `STREAM_CHUNK_SIZE` | Optional, stream output chunk size | `5` |
|
||||||
| **伪流式 (Fake Stream) 相关** | | |
|
| **Fake Stream Related** | | |
|
||||||
| `FAKE_STREAM_ENABLED` | 可选，是否启用伪流式传输，用于不支持流式的模型或场景 | `false` |
|
| `FAKE_STREAM_ENABLED` | Optional, whether to enable fake streaming for models or scenarios that don't support streaming | `false` |
|
||||||
| `FAKE_STREAM_EMPTY_DATA_INTERVAL_SECONDS` | 可选，伪流式传输时发送心跳空数据的间隔秒数 | `5` |
|
| `FAKE_STREAM_EMPTY_DATA_INTERVAL_SECONDS` | Optional, interval in seconds for sending heartbeat empty data during fake streaming | `5` |
|
||||||
|
|
||||||
## ⚙️ API 端点
|
## ⚙️ API Endpoints
|
||||||
|
|
||||||
以下是服务提供的主要 API 端点：
|
The following are the main API endpoints provided by the service:
|
||||||
|
|
||||||
### Gemini API 相关 (`(/gemini)/v1beta`)
|
### Gemini API Related (`(/gemini)/v1beta`)
|
||||||
|
|
||||||
* `GET /models`: 列出可用的 Gemini 模型。
|
* `GET /models`: List available Gemini models.
|
||||||
* `POST /models/{model_name}:generateContent`: 使用指定的 Gemini 模型生成内容。
|
* `POST /models/{model_name}:generateContent`: Generate content using the specified Gemini model.
|
||||||
* `POST /models/{model_name}:streamGenerateContent`: 使用指定的 Gemini 模型流式生成内容。
|
* `POST /models/{model_name}:streamGenerateContent`: Stream content generation using the specified Gemini model.
|
||||||
|
|
||||||
### OpenAI API 相关
|
### OpenAI API Related
|
||||||
|
|
||||||
* `GET (/hf)/v1/models`: 列出可用的模型 (底层用的gemini格式)。
|
* `GET (/hf)/v1/models`: List available models (uses Gemini format underneath).
|
||||||
* `POST (/hf)/v1/chat/completions`: 进行聊天补全 (底层用的gemini格式, 支持流式传输)。
|
* `POST (/hf)/v1/chat/completions`: Perform chat completion (uses Gemini format underneath, supports streaming).
|
||||||
* `POST (/hf)/v1/embeddings`: 创建文本嵌入 (底层用的gemini格式)。
|
* `POST (/hf)/v1/embeddings`: Create text embeddings (uses Gemini format underneath).
|
||||||
* `POST (/hf)/v1/images/generations`: 生成图像 (底层用的gemini格式)。
|
* `POST (/hf)/v1/images/generations`: Generate images (uses Gemini format underneath).
|
||||||
* `GET /openai/v1/models`: 列出可用的模型 (底层用的openai格式)。
|
* `GET /openai/v1/models`: List available models (uses OpenAI format underneath).
|
||||||
* `POST /openai/v1/chat/completions`: 进行聊天补全 (底层用的openai格式, 支持流式传输, 可防止截断，速度也快)。
|
* `POST /openai/v1/chat/completions`: Perform chat completion (uses OpenAI format underneath, supports streaming, can prevent truncation, and is faster).
|
||||||
* `POST /openai/v1/embeddings`: 创建文本嵌入 (底层用的openai格式)。
|
* `POST /openai/v1/embeddings`: Create text embeddings (uses OpenAI format underneath).
|
||||||
* `POST /openai/v1/images/generations`: 生成图像 (底层用的openai格式)。
|
* `POST /openai/v1/images/generations`: Generate images (uses OpenAI format underneath).
|
||||||
|
|
||||||
## 🤝 贡献
|
## 🤝 Contributing
|
||||||
|
|
||||||
欢迎提交 Pull Request 或 Issue。
|
Pull Requests or Issues are welcome.
|
||||||
|
|
||||||
## 🎉 特别鸣谢
|
## 🎉 Special Thanks
|
||||||
|
|
||||||
特别鸣谢以下项目和平台为本项目提供图床服务:
|
Special thanks to the following projects and platforms for providing image hosting services for this project:
|
||||||
|
|
||||||
* [PicGo](https://www.picgo.net/)
|
* [PicGo](https://www.picgo.net/)
|
||||||
* [SM.MS](https://smms.app/)
|
* [SM.MS](https://smms.app/)
|
||||||
* [CloudFlare-ImgBed](https://github.com/MarSeventh/CloudFlare-ImgBed) 开源项目
|
* [CloudFlare-ImgBed](https://github.com/MarSeventh/CloudFlare-ImgBed) open source project
|
||||||
|
|
||||||
## 🙏 感谢贡献者
|
## 🙏 Thanks to Contributors
|
||||||
|
|
||||||
感谢所有为本项目做出贡献的开发者！
|
Thanks to all developers who contributed to this project!
|
||||||
|
|
||||||
[](https://github.com/snailyp/gemini-balance/graphs/contributors)
|
[](https://github.com/snailyp/gemini-balance/graphs/contributors)
|
||||||
|
|
||||||
@@ -253,14 +255,14 @@ app/
|
|||||||
|
|
||||||
[](https://star-history.com/#snailyp/gemini-balance&Date)
|
[](https://star-history.com/#snailyp/gemini-balance&Date)
|
||||||
|
|
||||||
## 💖 友情项目
|
## 💖 Friendly Projects
|
||||||
|
|
||||||
* **[OneLine](https://github.com/chengtx809/OneLine)** by [chengtx809](https://github.com/chengtx809) - OneLine一线：AI驱动的热点事件时间轴生成工具
|
* **[OneLine](https://github.com/chengtx809/OneLine)** by [chengtx809](https://github.com/chengtx809) - OneLine: AI-driven hot event timeline generation tool
|
||||||
|
|
||||||
## 🎁 项目支持
|
## 🎁 Project Support
|
||||||
|
|
||||||
如果你觉得这个项目对你有帮助，可以考虑通过 [爱发电](https://afdian.com/a/snaily) 支持我。
|
If you find this project helpful, consider supporting me via [Afdian](https://afdian.com/a/snaily).
|
||||||
|
|
||||||
## 许可证
|
## License
|
||||||
|
|
||||||
本项目采用 CC BY-NC 4.0（署名-非商业性使用）协议，禁止任何形式的商业倒卖服务，详见 LICENSE 文件。
|
This project is licensed under the CC BY-NC 4.0 (Attribution-NonCommercial) license. Any form of commercial resale service is prohibited. See the LICENSE file for details.
|
||||||
|
|||||||
+266
@@ -0,0 +1,266 @@
|
|||||||
|
# Gemini Balance - Gemini API 代理和负载均衡器
|
||||||
|
|
||||||
|
> ⚠️ 本项目采用 CC BY-NC 4.0（署名-非商业性使用）协议，禁止任何形式的商业倒卖服务，详见 LICENSE 文件。
|
||||||
|
|
||||||
|
> 本人从未在各个平台售卖服务，如有遇到售卖此服务者，那一定是倒卖狗，大家切记不要上当受骗。
|
||||||
|
|
||||||
|
[](https://www.python.org/)
|
||||||
|
[](https://fastapi.tiangolo.com/)
|
||||||
|
[](https://www.uvicorn.org/)
|
||||||
|
[](https://t.me/+soaHax5lyI0wZDVl)
|
||||||
|
> 交流群：https://t.me/+soaHax5lyI0wZDVl
|
||||||
|
|
||||||
|
## 项目简介
|
||||||
|
|
||||||
|
Gemini Balance 是一个基于 Python FastAPI 构建的应用程序，旨在提供 Google Gemini API 的代理和负载均衡功能。它允许您管理多个 Gemini API Key，并通过简单的配置实现 Key 的轮询、认证、模型过滤和状态监控。此外，项目还集成了图像生成和多种图床上传功能，并支持 OpenAI API 格式的代理。
|
||||||
|
|
||||||
|
**项目结构:**
|
||||||
|
|
||||||
|
```plaintext
|
||||||
|
app/
|
||||||
|
├── config/ # 配置管理
|
||||||
|
├── core/ # 核心应用逻辑 (FastAPI 实例创建, 中间件等)
|
||||||
|
├── database/ # 数据库模型和连接
|
||||||
|
├── domain/ # 业务领域对象 (可选)
|
||||||
|
├── exception/ # 自定义异常
|
||||||
|
├── handler/ # 请求处理器 (可选, 或在 router 中处理)
|
||||||
|
├── log/ # 日志配置
|
||||||
|
├── main.py # 应用入口
|
||||||
|
├── middleware/ # FastAPI 中间件
|
||||||
|
├── router/ # API 路由 (Gemini, OpenAI, 状态页等)
|
||||||
|
├── scheduler/ # 定时任务 (如 Key 状态检查)
|
||||||
|
├── service/ # 业务逻辑服务 (聊天, Key 管理, 统计等)
|
||||||
|
├── static/ # 静态文件 (CSS, JS)
|
||||||
|
├── templates/ # HTML 模板 (如 Key 状态页)
|
||||||
|
├── utils/ # 工具函数
|
||||||
|
```
|
||||||
|
|
||||||
|
## ✨ 功能亮点
|
||||||
|
|
||||||
|
* **多 Key 负载均衡**: 支持配置多个 Gemini API Key (`API_KEYS`)，自动按顺序轮询使用，提高可用性和并发能力。
|
||||||
|
* **可视化配置即时生效**: 通过管理后台修改配置后，无需重启服务即可生效，切记要点击保存才会生效。
|
||||||
|
|
||||||
|
* **双协议API 兼容**: 同时支持 Gemini 和 OpenAI 格式的 CHAT API 请求转发。
|
||||||
|
|
||||||
|
```palintext
|
||||||
|
openai baseurl `http://localhost:8000(/hf)/v1`
|
||||||
|
gemini baseurl `http://localhost:8000(/gemini)/v1beta`
|
||||||
|
```
|
||||||
|
|
||||||
|
* **支持图文对话和修改图片**: `IMAGE_MODELS`配置哪个模型可以图文对话和修图的功能，实际调用的时候，用 `配置模型-image`这个模型名对话使用该功能。
|
||||||
|
|
||||||
|
|
||||||
|
* **支持联网搜索**: 支持联网搜索，`SEARCH_MODELS`配置哪些模型可以联网搜索，实际调用的时候，用 `配置模型-search`这个模型名对话使用该功能
|
||||||
|
|
||||||
|
* **Key 状态监控**: 提供 `/keys_status` 页面（需要认证），实时查看各 Key 的状态和使用情况。
|
||||||
|
|
||||||
|
* **详细的日志记录**: 提供详细的错误日志，方便排查。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* **支持自定义gemini代理**: 支持自定义gemini代理，比如自行在deno或者cloudflare上搭建gemini代理
|
||||||
|
* **openai画图接口兼容**: 将`imagen-3.0-generate-002`模型接口改造成openai画图接口，支持客户端调用。
|
||||||
|
* **灵活的添加密钥方式**: 灵活的添加密钥方式，采用正则匹配`gemini_key`,密钥去重
|
||||||
|
|
||||||
|
* **兼容openai格式embeddings接口**：完美适配openai格式的`embeddings`接口，可用于本地文档向量化。
|
||||||
|
* **流式响应优化**: 可选的流式输出优化器 (`STREAM_OPTIMIZER_ENABLED`)，改善长文本流式响应的体验。
|
||||||
|
* **失败重试与 Key 管理**: 自动处理 API 请求失败，进行重试 (`MAX_RETRIES`)，并在 Key 失效次数过多时自动禁用 (`MAX_FAILURES`)，定时检查恢复 (`CHECK_INTERVAL_HOURS`)。
|
||||||
|
* **Docker 支持**: 支持AMD，ARM架构的docker部署，也可自行构建docker镜像。
|
||||||
|
>镜像地址: docker pull ghcr.io/snailyp/gemini-balance:latest
|
||||||
|
* **模型列表自动维护**: 支持openai和gemini模型列表获取，与newapi自动获取模型列表完美兼容，无需手动填写。
|
||||||
|
* **支持移除不使用的模型**: 默认提供的模型太多，很多用不上，可以通过`FILTERED_MODELS`过滤掉。
|
||||||
|
* **代理支持**: 支持配置 HTTP/SOCKS5 代理服务器 (`PROXIES`)，用于访问 Gemini API，方便在特殊网络环境下使用。支持批量添加代理。
|
||||||
|
|
||||||
|
## 🚀 快速开始
|
||||||
|
|
||||||
|
### 自行构建 Docker (推荐)
|
||||||
|
|
||||||
|
#### a) dockerfile构建
|
||||||
|
|
||||||
|
1. **构建镜像**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker build -t gemini-balance .
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **运行容器**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run -d -p 8000:8000 --env-file .env gemini-balance
|
||||||
|
```
|
||||||
|
|
||||||
|
* `-d`: 后台运行。
|
||||||
|
* `-p 8000:8000`: 将容器的 8000 端口映射到主机的 8000 端口。
|
||||||
|
* `--env-file .env`: 使用 `.env` 文件设置环境变量。
|
||||||
|
|
||||||
|
> 注意：如果使用 SQLite 数据库，需要挂载数据卷以持久化数据：
|
||||||
|
> ```bash
|
||||||
|
> docker run -d -p 8000:8000 --env-file .env -v /path/to/data:/app/data gemini-balance
|
||||||
|
> ```
|
||||||
|
> 其中 `/path/to/data` 是主机上的数据存储路径，`/app/data` 是容器内的数据目录。
|
||||||
|
|
||||||
|
#### b) 用现有的docker镜像部署
|
||||||
|
|
||||||
|
1. **拉取镜像**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker pull ghcr.io/snailyp/gemini-balance:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **运行容器**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run -d -p 8000:8000 --env-file .env ghcr.io/snailyp/gemini-balance:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
* `-d`: 后台运行。
|
||||||
|
* `-p 8000:8000`: 将容器的 8000 端口映射到主机的 8000 端口 (根据需要调整)。
|
||||||
|
* `--env-file .env`: 使用 `.env` 文件设置环境变量 (确保 `.env` 文件存在于执行命令的目录)。
|
||||||
|
|
||||||
|
> 注意：如果使用 SQLite 数据库，需要挂载数据卷以持久化数据：
|
||||||
|
> ```bash
|
||||||
|
> docker run -d -p 8000:8000 --env-file .env -v /path/to/data:/app/data ghcr.io/snailyp/gemini-balance:latest
|
||||||
|
> ```
|
||||||
|
> 其中 `/path/to/data` 是主机上的数据存储路径，`/app/data` 是容器内的数据目录。
|
||||||
|
|
||||||
|
### 本地运行 (适用于开发和测试)
|
||||||
|
|
||||||
|
如果您想在本地直接运行源代码进行开发或测试，请按照以下步骤操作：
|
||||||
|
|
||||||
|
1. **确保已完成准备工作**:
|
||||||
|
* 克隆仓库到本地。
|
||||||
|
* 安装 Python 3.9 或更高版本。
|
||||||
|
* 在项目根目录下创建并配置好 `.env` 文件 (参考前面的"配置环境变量"部分)。
|
||||||
|
* 安装项目依赖：
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **启动应用**:
|
||||||
|
在项目根目录下运行以下命令：
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload
|
||||||
|
```
|
||||||
|
|
||||||
|
* `app.main:app`: 指定 FastAPI 应用实例的位置 (`app` 模块中的 `main.py` 文件里的 `app` 对象)。
|
||||||
|
* `--host 0.0.0.0`: 使应用可以从本地网络中的任何 IP 地址访问。
|
||||||
|
* `--port 8000`: 指定应用监听的端口号 (您可以根据需要修改)。
|
||||||
|
* `--reload`: 启用自动重载功能。当您修改代码时，服务会自动重启，非常适合开发环境 (生产环境请移除此选项)。
|
||||||
|
|
||||||
|
3. **访问应用**:
|
||||||
|
应用启动后，您可以通过浏览器或 API 工具访问 `http://localhost:8000` (或您指定的主机和端口)。
|
||||||
|
|
||||||
|
### 完整配置项列表
|
||||||
|
|
||||||
|
| 配置项 | 说明 | 默认值 |
|
||||||
|
| :--------------------------- | :------------------------------------------------------- | :---------------------------------------------------- |
|
||||||
|
| **数据库配置** | | |
|
||||||
|
| `DATABASE_TYPE` | 可选，数据库类型，支持 `mysql` 或 `sqlite` | `mysql` |
|
||||||
|
| `SQLITE_DATABASE` | 可选，当使用 `sqlite` 时必填，SQLite 数据库文件路径 | `default_db` |
|
||||||
|
| `MYSQL_HOST` | 当使用 `mysql` 时必填，MySQL 数据库主机地址 | `localhost` |
|
||||||
|
| `MYSQL_SOCKET` | 可选，MySQL 数据库 socket 地址 | `/var/run/mysqld/mysqld.sock` |
|
||||||
|
| `MYSQL_PORT` | 当使用 `mysql` 时必填，MySQL 数据库端口 | `3306` |
|
||||||
|
| `MYSQL_USER` | 当使用 `mysql` 时必填，MySQL 数据库用户名 | `your_db_user` |
|
||||||
|
| `MYSQL_PASSWORD` | 当使用 `mysql` 时必填，MySQL 数据库密码 | `your_db_password` |
|
||||||
|
| `MYSQL_DATABASE` | 当使用 `mysql` 时必填，MySQL 数据库名称 | `defaultdb` |
|
||||||
|
| **API 相关配置** | | |
|
||||||
|
| `API_KEYS` | 必填，Gemini API 密钥列表，用于负载均衡 | `["your-gemini-api-key-1", "your-gemini-api-key-2"]` |
|
||||||
|
| `ALLOWED_TOKENS` | 必填，允许访问的 Token 列表 | `["your-access-token-1", "your-access-token-2"]` |
|
||||||
|
| `AUTH_TOKEN` | 可选，超级管理员token，具有所有权限，不填默认使用 ALLOWED_TOKENS 的第一个 | `sk-123456` |
|
||||||
|
| `TEST_MODEL` | 可选，用于测试密钥是否可用的模型名 | `gemini-1.5-flash` |
|
||||||
|
| `IMAGE_MODELS` | 可选，支持绘图功能的模型列表 | `["gemini-2.0-flash-exp"]` |
|
||||||
|
| `SEARCH_MODELS` | 可选，支持搜索功能的模型列表 | `["gemini-2.0-flash-exp"]` |
|
||||||
|
| `FILTERED_MODELS` | 可选，被禁用的模型列表 | `["gemini-1.0-pro-vision-latest", ...]` |
|
||||||
|
| `TOOLS_CODE_EXECUTION_ENABLED` | 可选，是否启用代码执行工具 | `false` |
|
||||||
|
| `SHOW_SEARCH_LINK` | 可选，是否在响应中显示搜索结果链接 | `true` |
|
||||||
|
| `SHOW_THINKING_PROCESS` | 可选，是否显示模型思考过程 | `true` |
|
||||||
|
| `THINKING_MODELS` | 可选，支持思考功能的模型列表 | `[]` |
|
||||||
|
| `THINKING_BUDGET_MAP` | 可选，思考功能预算映射 (模型名:预算值) | `{}` |
|
||||||
|
| `BASE_URL` | 可选，Gemini API 基础 URL，默认无需修改 | `https://generativelanguage.googleapis.com/v1beta` |
|
||||||
|
| `MAX_FAILURES` | 可选，允许单个key失败的次数 | `3` |
|
||||||
|
| `MAX_RETRIES` | 可选，API 请求失败时的最大重试次数 | `3` |
|
||||||
|
| `CHECK_INTERVAL_HOURS` | 可选，检查禁用 Key 是否恢复的时间间隔 (小时) | `1` |
|
||||||
|
| `TIMEZONE` | 可选，应用程序使用的时区 | `Asia/Shanghai` |
|
||||||
|
| `TIME_OUT` | 可选，请求超时时间 (秒) | `300` |
|
||||||
|
| `PROXIES` | 可选，代理服务器列表 (例如 `http://user:pass@host:port`, `socks5://host:port`) | `[]` |
|
||||||
|
| `LOG_LEVEL` | 可选，日志级别，例如 DEBUG, INFO, WARNING, ERROR, CRITICAL | `INFO` |
|
||||||
|
| `AUTO_DELETE_ERROR_LOGS_ENABLED` | 可选，是否开启自动删除错误日志 | `true` |
|
||||||
|
| `AUTO_DELETE_ERROR_LOGS_DAYS` | 可选，自动删除多少天前的错误日志 (例如 1, 7, 30) | `7` |
|
||||||
|
| `AUTO_DELETE_REQUEST_LOGS_ENABLED`| 可选，是否开启自动删除请求日志 | `false` |
|
||||||
|
| `AUTO_DELETE_REQUEST_LOGS_DAYS` | 可选，自动删除多少天前的请求日志 (例如 1, 7, 30) | `30` |
|
||||||
|
| `SAFETY_SETTINGS` | 可选，安全设置 (JSON 字符串格式)，用于配置内容安全阈值。示例值可能需要根据实际模型支持情况调整。 | `[{"category": "HARM_CATEGORY_HARASSMENT", "threshold": "OFF"}, {"category": "HARM_CATEGORY_HATE_SPEECH", "threshold": "OFF"}, {"category": "HARM_CATEGORY_SEXUALLY_EXPLICIT", "threshold": "OFF"}, {"category": "HARM_CATEGORY_DANGEROUS_CONTENT", "threshold": "OFF"}, {"category": "HARM_CATEGORY_CIVIC_INTEGRITY", "threshold": "BLOCK_NONE"}]` |
|
||||||
|
| **图像生成相关** | | |
|
||||||
|
| `PAID_KEY` | 可选，付费版API Key，用于图片生成等高级功能 | `your-paid-api-key` |
|
||||||
|
| `CREATE_IMAGE_MODEL` | 可选，图片生成模型 | `imagen-3.0-generate-002` |
|
||||||
|
| `UPLOAD_PROVIDER` | 可选，图片上传提供商: `smms`, `picgo`, `cloudflare_imgbed` | `smms` |
|
||||||
|
| `SMMS_SECRET_TOKEN` | 可选，SM.MS图床的API Token | `your-smms-token` |
|
||||||
|
| `PICGO_API_KEY` | 可选，[PicoGo](https://www.picgo.net/)图床的API Key | `your-picogo-apikey` |
|
||||||
|
| `CLOUDFLARE_IMGBED_URL` | 可选，[CloudFlare](https://github.com/MarSeventh/CloudFlare-ImgBed) 图床上传地址 | `https://xxxxxxx.pages.dev/upload` |
|
||||||
|
| `CLOUDFLARE_IMGBED_AUTH_CODE`| 可选，CloudFlare图床的鉴权key | `your-cloudflare-imgber-auth-code` |
|
||||||
|
| **流式优化器相关** | | |
|
||||||
|
| `STREAM_OPTIMIZER_ENABLED` | 可选，是否启用流式输出优化 | `false` |
|
||||||
|
| `STREAM_MIN_DELAY` | 可选，流式输出最小延迟 | `0.016` |
|
||||||
|
| `STREAM_MAX_DELAY` | 可选，流式输出最大延迟 | `0.024` |
|
||||||
|
| `STREAM_SHORT_TEXT_THRESHOLD`| 可选，短文本阈值 | `10` |
|
||||||
|
| `STREAM_LONG_TEXT_THRESHOLD` | 可选，长文本阈值 | `50` |
|
||||||
|
| `STREAM_CHUNK_SIZE` | 可选，流式输出块大小 | `5` |
|
||||||
|
| **伪流式 (Fake Stream) 相关** | | |
|
||||||
|
| `FAKE_STREAM_ENABLED` | 可选，是否启用伪流式传输，用于不支持流式的模型或场景 | `false` |
|
||||||
|
| `FAKE_STREAM_EMPTY_DATA_INTERVAL_SECONDS` | 可选，伪流式传输时发送心跳空数据的间隔秒数 | `5` |
|
||||||
|
|
||||||
|
## ⚙️ API 端点
|
||||||
|
|
||||||
|
以下是服务提供的主要 API 端点：
|
||||||
|
|
||||||
|
### Gemini API 相关 (`(/gemini)/v1beta`)
|
||||||
|
|
||||||
|
* `GET /models`: 列出可用的 Gemini 模型。
|
||||||
|
* `POST /models/{model_name}:generateContent`: 使用指定的 Gemini 模型生成内容。
|
||||||
|
* `POST /models/{model_name}:streamGenerateContent`: 使用指定的 Gemini 模型流式生成内容。
|
||||||
|
|
||||||
|
### OpenAI API 相关
|
||||||
|
|
||||||
|
* `GET (/hf)/v1/models`: 列出可用的模型 (底层用的gemini格式)。
|
||||||
|
* `POST (/hf)/v1/chat/completions`: 进行聊天补全 (底层用的gemini格式, 支持流式传输)。
|
||||||
|
* `POST (/hf)/v1/embeddings`: 创建文本嵌入 (底层用的gemini格式)。
|
||||||
|
* `POST (/hf)/v1/images/generations`: 生成图像 (底层用的gemini格式)。
|
||||||
|
* `GET /openai/v1/models`: 列出可用的模型 (底层用的openai格式)。
|
||||||
|
* `POST /openai/v1/chat/completions`: 进行聊天补全 (底层用的openai格式, 支持流式传输, 可防止截断，速度也快)。
|
||||||
|
* `POST /openai/v1/embeddings`: 创建文本嵌入 (底层用的openai格式)。
|
||||||
|
* `POST /openai/v1/images/generations`: 生成图像 (底层用的openai格式)。
|
||||||
|
|
||||||
|
## 🤝 贡献
|
||||||
|
|
||||||
|
欢迎提交 Pull Request 或 Issue。
|
||||||
|
|
||||||
|
## 🎉 特别鸣谢
|
||||||
|
|
||||||
|
特别鸣谢以下项目和平台为本项目提供图床服务:
|
||||||
|
|
||||||
|
* [PicGo](https://www.picgo.net/)
|
||||||
|
* [SM.MS](https://smms.app/)
|
||||||
|
* [CloudFlare-ImgBed](https://github.com/MarSeventh/CloudFlare-ImgBed) 开源项目
|
||||||
|
|
||||||
|
## 🙏 感谢贡献者
|
||||||
|
|
||||||
|
感谢所有为本项目做出贡献的开发者！
|
||||||
|
|
||||||
|
[](https://github.com/snailyp/gemini-balance/graphs/contributors)
|
||||||
|
|
||||||
|
## ⭐ Star History
|
||||||
|
|
||||||
|
[](https://star-history.com/#snailyp/gemini-balance&Date)
|
||||||
|
|
||||||
|
## 💖 友情项目
|
||||||
|
|
||||||
|
* **[OneLine](https://github.com/chengtx809/OneLine)** by [chengtx809](https://github.com/chengtx809) - OneLine一线：AI驱动的热点事件时间轴生成工具
|
||||||
|
|
||||||
|
## 🎁 项目支持
|
||||||
|
|
||||||
|
如果你觉得这个项目对你有帮助，可以考虑通过 [爱发电](https://afdian.com/a/snaily) 支持我。
|
||||||
|
|
||||||
|
## 许可证
|
||||||
|
|
||||||
|
本项目采用 CC BY-NC 4.0（署名-非商业性使用）协议，禁止任何形式的商业倒卖服务，详见 LICENSE 文件。
|
||||||
Reference in New Issue
Block a user