跳到主要内容

Chat Completions 格式

向指定模型发送对话消息并获取生成结果。本接口遵循 OpenAI Chat Completions(聊天补全)格式,支持非流式和 SSE 流式响应。

请求​

POST /v1/chat/completions
Content-Type: application/json
Authorization: Bearer sk-your-api-key

调用示例​

curl -X POST "https://www.walmind.cn/v1/chat/completions" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $API_KEY" \
-d '{
"model": "your-model-id",
"messages": [
{"role": "system", "content": "你是一个有帮助的助手。"},
{"role": "user", "content": "解释一下什么是向量数据库。"}
],
"temperature": 0.7,
"stream": false
}'

常用参数​

参数类型说明
modelstring模型列表中的模型 ID,必填
messagesarray按顺序排列的消息,必填
streamboolean是否使用 SSE 流式响应,默认 false
temperaturenumber输出随机性,范围和默认值以模型支持情况为准
max_tokensinteger限制生成 Token 数量
top_pnumber核采样参数
toolsarray工具调用定义(模型支持时使用)

非流式响应​

{
"id": "chatcmpl-example",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {"role": "assistant", "content": "向量数据库用于存储和检索向量表示。"},
"finish_reason": "stop"
}
],
"usage": {"prompt_tokens": 20, "completion_tokens": 18, "total_tokens": 38}
}

流式响应​

设置 stream: true 后,响应使用 text/event-stream 返回多个数据块。客户端应持续读取,直到收到 data: [DONE]。

curl -X POST "https://www.walmind.cn/v1/chat/completions" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $API_KEY" \
-d '{"model":"your-model-id","messages":[{"role":"user","content":"你好"}],"stream":true}'