ole2242527 commited on
Commit
ffde0c4
·
verified ·
1 Parent(s): 8c0139c

Upload PUBLIC_USAGE.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. PUBLIC_USAGE.md +62 -0
PUBLIC_USAGE.md ADDED
@@ -0,0 +1,62 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # 中转站使用说明
2
+
3
+ 这是一个兼容 OpenAI 格式的中文 AI API 中转站。你拿到管理员发给你的 API Key 后,就可以在支持 OpenAI 接口的软件里使用。
4
+
5
+ ## 基本信息
6
+
7
+ Base URL:
8
+
9
+ ```text
10
+ https://<owner>-<space>.hf.space/v1
11
+ ```
12
+
13
+ 示例:如果管理员的 Hugging Face 用户名是 `liuyiyang1439`,Space 名叫 `zhongzhuanzhan`,那 Base URL 就是:
14
+
15
+ ```text
16
+ https://liuyiyang1439-zhongzhuanzhan.hf.space/v1
17
+ ```
18
+
19
+ API Key:
20
+
21
+ ```text
22
+ 由管理员单独发放,请不要公开分享
23
+ ```
24
+
25
+ ## 常见软件填写方式
26
+
27
+ 在支持 OpenAI 兼容接口的软件里填写:
28
+
29
+ - API Base / Base URL:`https://<owner>-<space>.hf.space/v1`
30
+ - API Key:你的用户 API Key
31
+ - Model:管理员告诉你的可用模型名
32
+
33
+ ## curl 测试
34
+
35
+ 把 `<user-api-key>` 和 `<model>` 换成你的实际内容:
36
+
37
+ ```powershell
38
+ $headers = @{
39
+ "Authorization" = "Bearer <user-api-key>"
40
+ "Content-Type" = "application/json"
41
+ }
42
+
43
+ $body = @{
44
+ model = "<model>"
45
+ messages = @(
46
+ @{ role = "user"; content = "你好,请用中文简单介绍你自己。" }
47
+ )
48
+ } | ConvertTo-Json -Depth 5
49
+
50
+ Invoke-RestMethod `
51
+ -Uri "https://<owner>-<space>.hf.space/v1/chat/completions" `
52
+ -Method POST `
53
+ -Headers $headers `
54
+ -Body $body
55
+ ```
56
+
57
+ ## 注意事项
58
+
59
+ - 不要把 API Key 发到群里、论坛或公开仓库。
60
+ - 如果提示 `401`,通常是 API Key 写错、被禁用,或 Base URL 少了 `/v1`。
61
+ - 如果提示 `503`,通常是当前模型没有可用上游账号、模型名不在可用列表,或上游暂时不可用。
62
+ - 额度、倍率、可用模型以管理员设置为准。