nomid2 commited on
Commit
8355b22
·
verified ·
1 Parent(s): 713d43c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -110
README.md CHANGED
@@ -1,110 +1,9 @@
1
- # Replicate API Proxy for LobeChat
2
-
3
- 这是一个部署在 Hugging Face Spaces 上的代理服务,用于将 Replicate API 转换为 OpenAI 兼容的 API 格式,以便在 LobeChat 等第三方客户端中使用。
4
-
5
- ## 功能特性
6
-
7
- - 🔄 将 OpenAI 格式的请求转换为 Replicate API 格式
8
- - 📡 支持流式和非流式响应
9
- - 🌐 兼容 LobeChat、ChatGPT-Next-Web 等客户端
10
- - 🚀 一键部署到 Hugging Face Spaces
11
- - 🔒 安全的 API 密钥管理
12
-
13
- ## 部署步骤
14
-
15
- ### 1. 在 Hugging Face 上创建 Space
16
-
17
- 1. 访问 [Hugging Face Spaces](https://huggingface.co/spaces)
18
- 2. 点击 "Create new Space"
19
- 3. 填写以下信息:
20
- - Space name: `replicate-api-proxy`
21
- - License: `MIT`
22
- - SDK: `Docker`
23
- - Hardware: `CPU basic` (免费)
24
-
25
- ### 2. 上传文件
26
-
27
- 将以下文件上传到你的 Space:
28
- - `app.py`
29
- - `requirements.txt`
30
- - `Dockerfile`
31
- - `README.md`
32
-
33
- ### 3. 配置环境变量
34
-
35
- 在 Space 的 Settings 页面中,添加以下环境变量:
36
- - `REPLICATE_API_TOKEN`: 你的 Replicate API 密钥
37
-
38
- ### 4. 部署
39
-
40
- 上传完文件后,Space 会自动开始构建和部署。
41
-
42
- ## 在 LobeChat 中使用
43
-
44
- 1. 打开 LobeChat 设置
45
- 2. 在模型服务提供商中添加自定义 OpenAI 服务
46
- 3. 填写以下信息:
47
- - API 地址: `https://你的用户名-replicate-api-proxy.hf.space/v1`
48
- - API 密钥: 任意值(代理会使用环境变量中的 Replicate 密钥)
49
- - 模型列表: `claude-4-sonnet,claude-3-sonnet,claude-3-haiku`
50
-
51
- ## 支持的模型
52
-
53
- - `claude-4-sonnet`: Anthropic Claude 4 Sonnet
54
- - `claude-3-sonnet`: Anthropic Claude 3 Sonnet
55
- - `claude-3-haiku`: Anthropic Claude 3 Haiku
56
-
57
- ## API 端点
58
-
59
- ### GET /
60
- 健康检查端点
61
-
62
- ### GET /v1/models
63
- 列出可用模型(兼容 OpenAI API)
64
-
65
- ### POST /v1/chat/completions
66
- 聊天完成端点(兼容 OpenAI API)
67
-
68
- 支持的参数:
69
- - `model`: 模型名称
70
- - `messages`: 消息数组
71
- - `stream`: 是否流式响应
72
- - `max_tokens`: 最大生成令牌数
73
- - `temperature`: 温度参数
74
-
75
- ## 示例请求
76
-
77
- ```bash
78
- curl -X POST "https://你的用户名-replicate-api-proxy.hf.space/v1/chat/completions" \
79
- -H "Content-Type: application/json" \
80
- -H "Authorization: Bearer your-api-key" \
81
- -d '{
82
- "model": "claude-4-sonnet",
83
- "messages": [
84
- {
85
- "role": "user",
86
- "content": "Hello, how are you?"
87
- }
88
- ],
89
- "stream": true
90
- }'
91
- ```
92
-
93
- ## 注意事项
94
-
95
- 1. 确保你有有效的 Replicate API 密钥
96
- 2. Hugging Face Spaces 的免费配额可能有限制
97
- 3. 流式响应可能会有轻微延迟
98
- 4. 建议在生产环境中使用付费的 Hugging Face 硬件
99
-
100
- ## 故障排除
101
-
102
- 如果遇到问题,请检查:
103
- 1. Replicate API 密钥是否正确配置
104
- 2. Space 是否正常运行
105
- 3. 网络连接是否正常
106
- 4. 查看 Space 的日志输出
107
-
108
- ## 许可证
109
-
110
- MIT License
 
1
+ ---
2
+ title: Replicate API Proxy
3
+ emoji: 🔄
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: docker
7
+ pinned: false
8
+ license: mit
9
+ ---