菜单

GPT集成接口-流模式

下载

接口说明

该接口用于向 AI 提问，并通过流式（Streaming）方式实时返回回答内容，适合聊天、智能客服或问答类场景。

请求地址

复制代码 
POST https://api.helplook.net/api/chats/stream

请求 Headers

参数名 类型 是否必填 描述
x-api-key string 是 用户的 API Key，用于认证

请求参数（JSON Body）

参数名 类型 是否必填 描述
question string 是 用户提问内容
session_id string 否 会话 ID，用于维持上下文，可为空字符串表示新会话
version_id string 否 站点启用多版本, 可以传版本ID, 无则忽略
web_search_switch int 否 是否启用联网搜索功能，0=不启用，1=启用

示例请求体

json 复制代码 
curl --location --request POST 'https://api.helplook.net/api/chats/stream' \
--header 'x-api-key: {api-key}' \
--data-raw '{
    "question":"提问",
    "session_id":"会话id",
    "version_id":"",
    "web_search_switch":0
}'

响应

该接口为 流式响应 (streaming)，返回格式为 Server-Sent Events（SSE），或者 Chunked Transfer-Encoding 的文本流。

每一条流数据通常是一段 JSON，表示生成的一部分回答内容。

单条流式响应示例

json 复制代码 
data: {"choices":[{"delta":{"content":"","reasoning_content":"我这是推理","role":"assistant"}}],"object":"chat.completion.chunk","data":[]}
json 复制代码 
data: {"choices":[{"delta":{"content":"你好","role":"assistant"}}],"object":"chat.completion.chunk","data":[]}
json 复制代码 
data: {"choices":[],"object":"source","data":{"source":[]}}  // 该回答基于的文档来源
json 复制代码 
data: {"choices":[],"object":"error","data":{"code": "错误码", "message": "错误信息"}} // 该回答失败
json 复制代码 
data: [DONE]

响应字段说明

字段名 类型 描述
object string 用于区分该条json数据, chat.completion.chunk-大模型的回答, source-该回答的数据来源, error-此次回答失败, 错误信息
choices[0].delta.content string 回答的内容
choices[0].delta.reasoning_content string AI推理内容
data object 用于存储错误信息或文档来源数据
上一个
GPT集成接口
下一个
推荐问题
最近修改: 2025-07-07Powered by