Skip to content

Commit b7ad29c

Browse files
committed
docs: 更新 API.md 补充 Responses 流式事件、usage、effort、timing
1 parent 9e297d1 commit b7ad29c

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

API.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,67 @@ curl --location 'http://你的服务器ip:8080/v1/responses' \
197197
}'
198198
```
199199

200+
### Responses 流式事件序列
201+
202+
开启 `stream: true` 后,服务端以 SSE 返回以下事件:
203+
204+
```
205+
event: response.created
206+
data: {"type":"response.created","response":{...,"status":"in_progress"}}
207+
208+
event: response.output_item.added
209+
data: {"type":"response.output_item.added","output_index":0,"item":{"type":"reasoning",...}}
210+
211+
event: response.reasoning_text.delta ← 思维链(仅思考模型)
212+
data: {"type":"response.reasoning_text.delta","delta":"..."}
213+
214+
event: response.output_item.added
215+
data: {"type":"response.output_item.added","output_index":1,"item":{"type":"message",...}}
216+
217+
event: response.output_text.delta
218+
data: {"type":"response.output_text.delta","delta":"..."}
219+
220+
event: response.output_item.done
221+
data: {"type":"response.output_item.done","item":{"type":"reasoning","status":"completed",...}}
222+
223+
event: response.output_item.done
224+
data: {"type":"response.output_item.done","item":{"type":"message","status":"completed",...}}
225+
226+
event: response.completed
227+
data: {"type":"response.completed","response":{...,"usage":{...}}}
228+
```
229+
230+
### Responses 参数
231+
232+
| 参数 | 类型 | 说明 |
233+
|---|---|---|
234+
| `reasoning.effort` | string | 思考强度:`none` / `minimal` / `low` / `medium` / `high` / `xhigh` / `max`,映射到 ChatGPT 上游的 `low` / `medium` / `high` |
235+
| `store` | bool | 是否存储响应(默认 false) |
236+
| `stream_options` | object | 流式选项 |
237+
238+
### Usage 响应字段
239+
240+
```json
241+
{
242+
"usage": {
243+
"input_tokens": 100,
244+
"input_tokens_details": { "cached_tokens": 80, "cache_write_tokens": 20 },
245+
"output_tokens": 50,
246+
"output_tokens_details": { "reasoning_tokens": 30 },
247+
"total_tokens": 150
248+
}
249+
}
250+
```
251+
252+
注意:`cached_tokens` / `cache_write_tokens`**模拟值**(按文本指纹 + 5 分钟 TTL),ChatGPT 上游不返回真实缓存数据。
253+
254+
### 响应耗时信息
255+
256+
流式 `response.completed` 事件附带耗时字段:
257+
258+
- `ms_since_start`:请求开始到完成的毫秒数
259+
- `ms_ttft`:请求开始到首个 output_text delta 的毫秒数(首字延迟)
260+
200261
## 模型列表
201262

202263
```bash

0 commit comments

Comments
 (0)