Update README.md
Browse files
README.md
CHANGED
@@ -1,11 +1,50 @@
|
|
1 |
---
|
2 |
-
title:
|
3 |
-
emoji:
|
4 |
-
colorFrom:
|
5 |
-
colorTo:
|
6 |
sdk: docker
|
7 |
-
|
8 |
-
|
9 |
---
|
10 |
|
11 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
+
title: OpenAI to Tau API Proxy
|
3 |
+
emoji: 🔄
|
4 |
+
colorFrom: blue
|
5 |
+
colorTo: green
|
6 |
sdk: docker
|
7 |
+
app_port: 8000
|
8 |
+
secrets: [TAU_API_KEY]
|
9 |
---
|
10 |
|
11 |
+
# OpenAI to Tau API Proxy
|
12 |
+
|
13 |
+
这是一个部署在 Hugging Face Spaces 上的代理服务。它接收符合 OpenAI Chat Completions API 格式的请求,并将其转发给 Tau API (`https://tau-api.fly.dev`),同时处理请求和响应格式的转换,包括流式传输和 `reasoning_content` 的映射。
|
14 |
+
|
15 |
+
## 配置
|
16 |
+
|
17 |
+
**重要:** 为了使此代理正常工作,你 **必须** 在 Space 的设置 (Settings) 中配置一个名为 `TAU_API_KEY` 的 Secret。
|
18 |
+
|
19 |
+
1. 进入你的 Space 页面。
|
20 |
+
2. 点击右上角的 "Settings"。
|
21 |
+
3. 找到 "Secrets" 部分。
|
22 |
+
4. 点击 "New secret"。
|
23 |
+
5. **Name:** 输入 `TAU_API_KEY` (必须完全匹配)。
|
24 |
+
6. **Value:** 输入你的 Tau API 密钥。
|
25 |
+
7. 点击 "Save secret"。
|
26 |
+
|
27 |
+
Space 会在获取到 Secret 后自动重新构建或重启。
|
28 |
+
|
29 |
+
## 如何使用
|
30 |
+
|
31 |
+
配置好 `TAU_API_KEY` Secret 后,你可以将你的 OpenAI 客户端指向此 Space 的 URL。
|
32 |
+
|
33 |
+
**代理端点:**
|
34 |
+
|
35 |
+
* **Chat Completions:** `https://YOUR_SPACE_SUBDOMAIN.hf.space/v1/chat/completions`
|
36 |
+
* **Models:** `https://YOUR_SPACE_SUBDOMAIN.hf.space/v1/models`
|
37 |
+
|
38 |
+
**请将 `YOUR_SPACE_SUBDOMAIN` 替换为你的 Space 的实际子域名** (例如 `my-tau-proxy`)。
|
39 |
+
|
40 |
+
**示例 (使用 `curl`):**
|
41 |
+
|
42 |
+
```bash
|
43 |
+
curl https://YOUR_SPACE_SUBDOMAIN.hf.space/v1/chat/completions \
|
44 |
+
-H "Content-Type: application/json" \
|
45 |
+
-H "Authorization: Bearer DUMMY_KEY" \ # 注意:这里的 key 不会被代理使用,但有些客户端需要提供
|
46 |
+
-d '{
|
47 |
+
"model": "gpt-4o", # 或者其他支持的模型
|
48 |
+
"messages": [{"role": "user", "content": "你好,TAU!"}],
|
49 |
+
"stream": false
|
50 |
+
}'
|