Leeflour commited on
Commit
681eca8
·
verified ·
1 Parent(s): d0dd276

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -123
README.md CHANGED
@@ -1,123 +1,6 @@
1
- # 🚀 HAJIMI Gemini API Proxy
2
-
3
- - 这是一个基于 FastAPI 构建的 Gemini API 代理,旨在提供一个简单、安全且可配置的方式来访问 Google 的 Gemini 模型。适用于在 Hugging Face Spaces 上部署,并支持openai api格式的工具集成。
4
-
5
- ## 管理前端一键部署模板
6
- [![Use EdgeOne Pages to deploy](https://cdnstatic.tencentcs.com/edgeone/pages/deploy.svg)](https://edgeone.ai/pages/new?repository-url=https%3A%2F%2Fgithub.com%2Fwyeeeee%2Fhajimi&root-directory=.%2Fpage&output-directory=..%2Fapp%2Ftemplates%2Fassets&install-command=npm%20install&build-command=npm%20run%20build)
7
-
8
- # 本项目基于CC BY-NC 4.0许可开源,需遵守以下规则
9
- - 您必须给出适当的署名,提供指向本协议的链接,并指明是否(对原作)作了修改。您可以以任何合理方式进行,但不得以任何方式暗示许可方认可您或您的使用。
10
- - 您不得将本作品用于商业目的,包括但不限于任何形式的商业倒卖、SaaS、API 付费接口、二次销售、打包出售、收费分发或其他直接或间接盈利行为。
11
-
12
- ### 如需商业授权,请联系原作者获得书面许可。违者将承担相应法律责任。
13
-
14
- ### 感谢[@warming-afternoon](https://github.com/warming-afternoon),[@任梓樂](https://github.com/rzline)在技术上的大力支持
15
-
16
- ### 错误自查
17
-
18
- 遇到问题请先查看以下的 **错误自查** 文档,确保已尝试按照其上的指示进行了相应的排查与处理。
19
-
20
- - [错误自查](./wiki/error.md)
21
- ### 使用文档
22
- - [huggingface 部署的使用文档(复活?!)(推荐,免费,手机电脑均可使用)](./wiki/huggingface2.md)
23
-
24
- - [Claw Cloud部署的使用文档(推荐,免费,手机电脑均可使用)](./wiki/claw.md) 感谢[@IDeposit](https://github.com/IDeposit)编写
25
-
26
- - [termux部署的使用文档(手机使用)](./wiki/Termux.md) 感谢[@天命不又](https://github.com/tmby)编写
27
-
28
- - [windows 本地部署的使用文档](./wiki/windows.md)
29
-
30
- - ~~[zeabur部署的使用文档(需付费)](./wiki/zeabur.md) 感谢**墨舞ink**编写~~(已过时且暂时无人更新,欢迎提交pull requests)
31
-
32
- - [vertex模式的使用文档](./wiki/vertex.md)
33
-
34
- ### 更新日志
35
- * v1.0.1
36
- * 新增`清除失效密钥`功能
37
- * 新增`输出有效秘钥`功能
38
-
39
- ## ✨ 主要功能:
40
-
41
- ### 🔑 API 密钥轮询和管理
42
-
43
- ### 📑 模型列表接口
44
-
45
- ### 💬 聊天补全接口:
46
-
47
- * 提供 `/v1/chat/completions` 接口,支持流式和非流式响应,支持函数调用,与 OpenAI API 格式兼容。
48
- * 支持的输入内容: 文本、文件、图像
49
- * 自动将 OpenAI 格式的请求转换为 Gemini 格式。
50
-
51
- ### 🔒 密码保护(可选):
52
-
53
- * 通过 `PASSWORD` 环境变量设置密码。
54
- * 提供默认密码 `"123"`。
55
-
56
- ### 🧩 服务兼容
57
-
58
- * 提供的接口与 OpenAI API 格式兼容,便于接入各种服务
59
-
60
- ### ⚙️ 功能配置
61
-
62
- * 方式 1 : 通过网页前端进行配置
63
- * 方式 2 : 根据 [配置文档](./app/config/settings.py) 中的注释说明,修改对应的变量
64
-
65
- ## ⚠️ 注意事项:
66
-
67
- * **强烈建议在生产环境中设置 `PASSWORD` 环境变量,并使用强密码。**
68
- * 根据你的使用情况调整速率限制相关的环境变量。
69
- * 确保你的 Gemini API 密钥具有足够的配额。
70
-
71
-
72
- ## 💡 特色功能:
73
-
74
- ### 🎭 假流式传输
75
-
76
- * **作用:** 解决部分网络环境下客户端通过非流式请求 Gemini 时可能遇到的断连问题。**默认开启**。
77
-
78
- * **原理简述:** 当客户端请求流式响应时,本代理会每隔一段时间向客户端发出一个空信息以维持连接,同时在后台向 Gemini 发起一个完整的、非流式的请求。等 Gemini 返回完整响应后,再一次性将响应发回给客户端。
79
-
80
- * **注意:** 如果想使用真的流式请求,请**关闭**该功能
81
-
82
- ### ⚡ 并发与缓存
83
-
84
- * **作用:** 允许您为用户的单次提问同时向 Gemini 发送多个请求,并将额外的成功响应缓存起来,用于后续重新生成回复。
85
-
86
- * **注意:** 此功能**默认关闭** 。只有当您将并发数设置为 2 或以上时,缓存才会生效。缓存匹配要求提问的上下文与被缓存的问题**完全一致**(包括标点符号)。此外,该模式目前仅支持非流式及假流式传输
87
-
88
- **Q: 新版本增加的并发缓存功能会增加 gemini 配额的使用量吗?**
89
-
90
- **A: 不会**。因为默认情况下该功能是关闭的。只有当你主动将并发数 `CONCURRENT_REQUESTS` 设置为大于 1 的数值时,才会实际发起并发请求,这才会消耗更多配额。
91
-
92
- **Q: 如何使用并发缓存功能?**
93
-
94
- **A:** 修改并发请求数,使其等于你想在一次用户提问中同时向 Gemini 发送的请求数量(例如设置为 `3`)。
95
-
96
- 这样设置后,如果一次并发请求中收到了多个成功的响应,除了第一个返回给用户外,其他���就会被缓存起来。
97
-
98
- ### 🎭 伪装信息
99
-
100
- * **作用:** 在发送给 Gemini 的消息中添加一段随机生成的、无意义的字符串,用于“伪装”请求,可能有助于防止被识别为自动化程序。**默认开启**。
101
-
102
- * **注意:** 如果使用非 SillyTavern 的其余客户端 (例如 cherryStudio ),请**关闭**该功能
103
-
104
- ### 🌐 联网模式
105
-
106
- * **作用:** 让 Gemini 模型能够利用搜索工具进行联网搜索,以回答需要最新信息或超出其知识库范围的问题。
107
-
108
- * **如何使用:**
109
-
110
- 在客户端请求时,选择模型名称带有 `-search` 后缀的模型(例如 `gemini-2.5-pro-search`,具体可用模型请通过 `/v1/models` 接口查询)。
111
-
112
-
113
- ### 🚦 速率限制和防滥用:
114
-
115
- * 通过环境变量自定义限制:
116
- * `MAX_REQUESTS_PER_MINUTE`:每分钟最大请求数(默认 30)。
117
- * `MAX_REQUESTS_PER_DAY_PER_IP`:每天每个 IP 最大请求数(默认 600)。
118
- * 超过速率限制时返回 429 错误。
119
-
120
- # 赞助商
121
- [![edgeone logo](https://edgeone.ai/_next/static/media/headLogo.daeb48ad.png?auto=format&fit=max&w=384)](https://edgeone.ai)
122
- CDN acceleration and security protection for this project are sponsored by Tencent EdgeOne.
123
- 本项目的CDN加速及安全防护由腾讯EdgeOne赞助支持。
 
1
+ title: Fufeigemini
2
+ emoji: ⚡
3
+ colorFrom: pink
4
+ colorTo: gray
5
+ sdk: docker
6
+ pinned: false