jardan commited on
Commit
17fe4e0
·
verified ·
1 Parent(s): d8b800a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +168 -159
README.md CHANGED
@@ -1,3 +1,171 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  # Ki2API - Claude Sonnet 4 OpenAI兼容API
2
 
3
  一个简单易用的Docker化OpenAI兼容API服务,专门用于Claude Sonnet 4模型。
@@ -7,162 +175,3 @@
7
  - 🐳 **Docker傻瓜式运行** - 一行命令启动服务
8
  - 🔑 **固定API密钥** - 使用 `ki2api-key-2024`
9
  - 🎯 **单一模型** - 仅支持 `claude-sonnet-4-20250514`
10
- - 🌐 **OpenAI兼容** - 完全兼容OpenAI API格式
11
- - 📡 **流式传输** - 支持SSE流式响应
12
- - 🔄 **自动token刷新** - 支持token过期自动刷新
13
-
14
- ## 快速开始
15
-
16
- ### 零配置启动(推荐)
17
-
18
- 只需确保已登录Kiro,然后一键启动:
19
-
20
- ```bash
21
- docker-compose up -d
22
- ```
23
-
24
- 服务将在 http://localhost:8989 启动
25
-
26
- ### 自动读取token
27
-
28
- 容器会自动读取你本地的token文件:
29
- - **macOS/Linux**: `~/.aws/sso/cache/kiro-auth-token.json`
30
- - **Windows**: `%USERPROFILE%\.aws\sso\cache\kiro-auth-token.json`
31
-
32
- ### 3. 测试API
33
-
34
- #### 获取模型列表
35
- ```bash
36
- curl -H "Authorization: Bearer ki2api-key-2024" \
37
- http://localhost:8989/v1/models
38
- ```
39
-
40
- #### 非流式对话
41
- ```bash
42
- curl -X POST http://localhost:8989/v1/chat/completions \
43
- -H "Authorization: Bearer ki2api-key-2024" \
44
- -H "Content-Type: application/json" \
45
- -d '{
46
- "model": "claude-sonnet-4-20250514",
47
- "messages": [
48
- {"role": "user", "content": "你好,请介绍一下自己"}
49
- ],
50
- "max_tokens": 1000
51
- }'
52
- ```
53
-
54
- #### 流式对话
55
- ```bash
56
- curl -X POST http://localhost:8989/v1/chat/completions \
57
- -H "Authorization: Bearer ki2api-key-2024" \
58
- -H "Content-Type: application/json" \
59
- -d '{
60
- "model": "claude-sonnet-4-20250514",
61
- "messages": [
62
- {"role": "user", "content": "写一首关于春天的诗"}
63
- ],
64
- "stream": true,
65
- "max_tokens": 500
66
- }'
67
- ```
68
-
69
- ## Docker使用方法
70
-
71
- ### 使用Docker Compose(推荐)
72
- ```bash
73
- # 启动服务
74
- docker-compose up -d
75
-
76
- # 查看日志
77
- docker-compose logs -f
78
-
79
- # 停止服务
80
- docker-compose down
81
- ```
82
-
83
- ### 使用Docker命令
84
- ```bash
85
- # 构建镜像
86
- docker build -t ki2api .
87
-
88
- # 运行容器
89
- docker run -d \
90
- -p 8989:8989 \
91
- -e KIRO_ACCESS_TOKEN=your_token \
92
- -e KIRO_REFRESH_TOKEN=your_refresh_token \
93
- --name ki2api \
94
- ki2api
95
- ```
96
-
97
- ## API端点
98
-
99
- ### GET /v1/models
100
- 获取可用模型列表
101
-
102
- ### POST /v1/chat/completions
103
- 创建聊天完成
104
-
105
- ### GET /health
106
- 健康检查端点
107
-
108
- ## 环境变量
109
-
110
- | 变量名 | 默认值 | 说明 |
111
- |--------|--------|------|
112
- | API_KEY | ki2api-key-2024 | API访问密钥 |
113
- | KIRO_ACCESS_TOKEN | - | Kiro访问令牌(必需) |
114
- | KIRO_REFRESH_TOKEN | - | Kiro刷新令牌(必需) |
115
-
116
- ## 开发模式
117
-
118
- ### 本地运行
119
- ```bash
120
- # 安装依赖
121
- pip install -r requirements.txt
122
-
123
- # 设置环境变量
124
- export KIRO_ACCESS_TOKEN=your_token
125
- export KIRO_REFRESH_TOKEN=your_refresh_token
126
-
127
- # 启动服务
128
- python app.py
129
- ```
130
-
131
- ## 故障排除
132
-
133
- ### 常见问题
134
-
135
- 1. **Token过期**
136
- - 确保refresh token有效
137
- - 重新获取最新的token
138
-
139
- 2. **连接失败**
140
- - 检查端口8989是否被占用
141
- - 确认Docker容器正常运行
142
-
143
- 3. **API返回401**
144
- - 确认使用了正确的API密钥:`ki2api-key-2024`
145
- - 检查token是否有效
146
-
147
- ### 查看日志
148
- ```bash
149
- # Docker日志
150
- docker-compose logs -f ki2api
151
-
152
- # 本地日志
153
- python app.py 2>&1 | tee ki2api.log
154
- ```
155
-
156
- ## 项目结构
157
- ```
158
- ki2api/
159
- ├── app.py # 主应用文件
160
- ├── Dockerfile # Docker镜像定义
161
- ├── docker-compose.yml # Docker Compose配置
162
- ├── requirements.txt # Python依赖
163
- └── README.md # 本文档
164
- ```
165
-
166
- ## 许可证
167
-
168
- MIT License
 
1
+ ---
2
+ title: Kr2
3
+ emoji: 📉
4
+ colorFrom: yellow
5
+ colorTo: blue
6
+ sdk: docker
7
+ pinned: false
8
+ ---
9
+
10
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
11
+
12
+
13
+
14
+
15
+
16
+
17
+
18
+
19
+
20
+
21
+
22
+
23
+
24
+
25
+
26
+
27
+
28
+
29
+
30
+
31
+
32
+
33
+
34
+
35
+
36
+
37
+
38
+
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+
47
+
48
+
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
  # Ki2API - Claude Sonnet 4 OpenAI兼容API
170
 
171
  一个简单易用的Docker化OpenAI兼容API服务,专门用于Claude Sonnet 4模型。
 
175
  - 🐳 **Docker傻瓜式运行** - 一行命令启动服务
176
  - 🔑 **固定API密钥** - 使用 `ki2api-key-2024`
177
  - 🎯 **单一模型** - 仅支持 `claude-sonnet-4-20250514`