shenbing commited on
Commit
8a23edf
·
verified ·
1 Parent(s): 87de743

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -73
README.md CHANGED
@@ -1,73 +1,10 @@
1
- # DocsAnthropic2API 接入指南:基于 Hugging Face Spaces 的实现
2
-
3
- ## 项目简介
4
- 本项目提供了一种简单、高效的方式通过 Hugging Face Spaces 访问 DocsAnthropic2API 服务,并且转换为openAI格式。
5
-
6
- ## 支持模型
7
- - claude-3-5-sonnet-20241022
8
- ## 获取方式
9
-
10
- ### 方法一:GitHub 仓库部署
11
- - **地址**:[DocsAnthropic2API](https://github.com/xLmiler/DocsAnthropic2API)
12
- - **优点**:独立部署,降低被封风险
13
- - **步骤**:
14
- 1. 克隆仓库或者下载仓库文件
15
- 2. 在 Hugging Face 创建空间为docker,并且上传文件
16
- 3. 部署项目
17
-
18
- ### 方法二:直接复制空间
19
- - **地址**:[ClaudeService](https://huggingface.co/spaces/yxmiler/ClaudeService)
20
- - **优点**:快速部署,开箱即用
21
-
22
- ## 配置说明
23
-
24
- ### 环境变量
25
- - `API_KEY`:鉴权密钥
26
- - **默认值**:`sk-123456`
27
- - **建议**:使用自定义密钥增强安全性
28
-
29
- ## 请求逻辑
30
-
31
- ### 消息处理
32
- - **System 消息**:
33
- - 首次连续 System 消息会合并
34
- - 后续 System 消息自动转换为 User 消息
35
- - **User/Assistant 消息**:自动合并
36
- - **请求格式类型**:openAI格式
37
-
38
- ### 上下文特点
39
- - **注意**:当前实现的上下文为伪造上下文,可能存在一定程度的降智
40
-
41
- ## API 接口
42
- - 根据抱脸用户名和项目名字构建请求url: https://用户名-项目名字.hf.space/hf/v1
43
- ## 获取模型列表
44
- ```
45
- curl https://用户名-项目名字.hf.space/hf/v1/models
46
- ```
47
- ## 聊天请求
48
- ```
49
- curl https://用户名-项目名字.hf.space/hf/v1/chat/completions \
50
- -H "Content-Type: application/json" \
51
- -H "Authorization: Bearer YOUR_API_KEY" \
52
- -d '{
53
- "model": "claude-3-5-sonnet-20241022",
54
- "messages": [
55
- {
56
- "role": "user",
57
- "content": "Hello, can you help me?"
58
- }
59
- ]
60
- }'
61
- ```
62
-
63
- ### 响应处理
64
- - **当前支持响应**:流式和非流,
65
- - **性能**:流式响应为非流进行模拟流式,可能略慢于非流式请求
66
-
67
- ### 使用建议
68
- - 建议使用自定义 API Key
69
- - 注意上下文限制,大概为50k左右
70
- - 延迟略高
71
-
72
- ## 注意事项
73
- ⚠️ 本项目仅供学习和研究目的,请遵守相关使用条款。
 
1
+ ---
2
+ title: ClaudeService
3
+ emoji: 📈
4
+ colorFrom: green
5
+ colorTo: indigo
6
+ sdk: docker
7
+ pinned: false
8
+ ---
9
+
10
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference