Chat（流式返回） - 数字先锋API文档

# Chat Completions（流式返回）API文档
所有对话模型，都可使用此接口， 修改 model 属性为模型名
给定一个提示，该模型将返回一个或多个预测的完成，并且还可以返回每个位置的替代标记的概率。
为提供的提示和参数创建完成
## 1) 接口地址

```http
POST /v1/chat/completions
```

Base URL:
```text
https://api.cxsee.com
```

完整地址：
```text
https://api.cxsee.com/v1/chat/completions
```

---

## 2) 认证方式

```http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
```

---

## 3) 模型

- `gpt-5.4-mini`

---

## 4) 流式请求参数

在普通 Chat 请求基础上，增加：

- `stream: true`（必填，用于开启流式）
- `stream_options.include_usage`（选填，是否在流末尾返回 usage）

### 请求体示例
```json
{
  "model": "gpt-5.4-mini",
  "messages": [
    { "role": "system", "content": "你是一个简洁的中文助手" },
    { "role": "user", "content": "请用三句话介绍机器学习" }
  ],
  "temperature": 0.7,
  "stream": true,
  "stream_options": {
    "include_usage": true
  }
}
```

---

## 5) cURL 调用示例（流式）

```bash
curl -N "https://api.cxsee.com/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4-mini",
    "messages": [
      {"role":"system","content":"你是一个简洁的中文助手"},
      {"role":"user","content":"请用三句话介绍机器学习"}
    ],
    "stream": true,
    "stream_options": {"include_usage": true}
  }'
```

> `-N` 用于关闭 curl 缓冲，实时查看增量输出。

---

## 6) 流式响应格式（SSE）

响应为 `text/event-stream`，按行返回多个事件块：

```text
data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":...,"model":"gpt-5.4-mini","choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":...,"model":"gpt-5.4-mini","choices":[{"index":0,"delta":{"content":"机器学习是"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":...,"model":"gpt-5.4-mini","choices":[{"index":0,"delta":{"content":"让计算机从数据中学习规律的方法。"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":...,"model":"gpt-5.4-mini","choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":...,"model":"gpt-5.4-mini","choices":[],"usage":{"prompt_tokens":22,"completion_tokens":38,"total_tokens":60}}

data: [DONE]
```

---

## 7) 客户端处理规则

1. 逐条读取 `data:` 行并解析 JSON。
2. 拼接 `choices[0].delta.content` 作为最终答案。
3. 收到 `finish_reason:"stop"` 说明正文结束。
4. 若开启 `include_usage`，在末尾额外读取 `usage`。
5. 收到 `data: [DONE]` 后结束连接。

---

## 8) 非流式对照（可选）

若不需要流式，设置 `stream: false` 或省略 `stream`，返回一次性完整 JSON。

---

## 9) 错误码

- `400` 参数错误
- `401` 认证失败
- `403` 无权限
- `404` 路径错误
- `429` 频率超限
- `500/502/503` 服务异常

---

上一篇：MiniMax 语音合成（TTS）下一篇：Chat（分析图片）