流式对话接口（SSE） - 小冰-私有化

请求参数

Path 参数

organization_id

string

必需

示例值:

组织id，通过发布页面获取,见【对话URL获取】

bot_id

string

必需

示例值:

大脑id，通过发布页面获取,见【对话接口参数获取】

session_id

string

必需

示例值:

对话id，自定义；同一session_id 代表同一对话，共享对话上下文

Header 参数

key

string

可选

API Key（该值由小冰方提供，获取方式参考接口鉴权部分）

signature

string

可选

签名（签名逻辑参考接口鉴权部分）

timestamp

string

可选

发送时间（Unix 时间戳）

accept

string

可选

text/event-stream

Body 参数application/json

query

string

对话⽂本输入

必需

（特殊场景：当设置evnet参数时，query可以
缺省）

userId

string

用户id

必需

用户id⽤于辅助⼤脑对话分析，用户画像建设
等功能

timeout

integer

首字超时时间

必需

约束⼤脑的最⼤思考时间

imageUrls

array[string]

对话图⽚输入

必需

当⼤脑所选模型⽀持多模态图⽚解析时，该参
数有效

event

string

时间

必需

选填以下枚举值： opening_statement
事件含义：
opening_statement : 开场⽩事件，选⽤⼤
脑配置的开场⽩⽂本作为对话答复；

示例

{
    "query": "你好吗",
    "userId": "qKuh1Jrra1zMbk5hVaRUkuQ3uChpDSQV",
    "timeout": 15
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v1/openapi/organizations/组织id，通过发布页面获取,见【对话URL获取】/bots/大脑id，通过发布页面获取,见【对话接口参数获取】/sessions/对话id，自定义； 同一session_id 代表同一对话，共享对话上下文/streamChat' \
--header 'key;' \
--header 'signature;' \
--header 'timestamp;' \
--header 'accept;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "你好吗",
    "userId": "qKuh1Jrra1zMbk5hVaRUkuQ3uChpDSQV",
    "timeout": 15
}'

返回响应

🟢200成功 event:message

application/json

Body

id

string

必需

text

null

必需

imageUrls

array[string]

必需

questionType

string

必需

dialogueDisplayText

string

分段输出⽂本

必需

分段输出⽂本

dialogueDisplayImages

array[string]

图⽚输出

必需

图⽚输出

dialogueDisplayPayload

null

必需

chainDisplayText

null

必需

messageType

string

必需

replyType

string

必需

matchedIntentName

string

必需

matchedIntentPostAction

string

必需

isBlocked

boolean

query是否违规

必需

blockedKeywords

array[string]

必需

responseBlock

boolean

必需

isOpeningStatement

boolean

必需

thoughtDisplayEnabled

boolean

必需

llmAnalyzeEnabled

boolean

必需

googleSearchEnabled

boolean

必需

llmAnalyzeOutput

null

必需

dialogueSetting

object

必需

thoughtDisplay

boolean

必需

llmAnalyze

boolean

必需

googleSearch

boolean

必需

modelName

string

必需

modeType

string

必需

modelDisplayName

string

必需

googleSearchOutput

null

必需

questionRecommendation

array[string]

必需

retrievedDocs

array[string]

必需

faqMatchedInfo

object

必需

selectedFaqResponseMessage

null

必需

workflowMatchedInfo

null

必需

first_message_time_cost

null

必需

prompts_count

null

必需

rawJson

null

必需

conversationId

string

必需

conversationCompleted

boolean

必需

timestamp

integer

必需

orderId

integer

必需

references

object

必需

fullReferences

array[string]

必需

示例

{
    "id": "string",
    "text": null,
    "imageUrls": [
        "string"
    ],
    "questionType": "string",
    "dialogueDisplayText": "string",
    "dialogueDisplayImages": [
        "string"
    ],
    "dialogueDisplayPayload": null,
    "chainDisplayText": null,
    "messageType": "string",
    "replyType": "string",
    "matchedIntentName": "string",
    "matchedIntentPostAction": "string",
    "isBlocked": true,
    "blockedKeywords": [
        "string"
    ],
    "responseBlock": true,
    "isOpeningStatement": true,
    "thoughtDisplayEnabled": true,
    "llmAnalyzeEnabled": true,
    "googleSearchEnabled": true,
    "llmAnalyzeOutput": null,
    "dialogueSetting": {
        "thoughtDisplay": true,
        "llmAnalyze": true,
        "googleSearch": true,
        "modelName": "string",
        "modeType": "string",
        "modelDisplayName": "string"
    },
    "googleSearchOutput": null,
    "questionRecommendation": [
        "string"
    ],
    "retrievedDocs": [
        "string"
    ],
    "faqMatchedInfo": {},
    "selectedFaqResponseMessage": null,
    "workflowMatchedInfo": null,
    "first_message_time_cost": null,
    "prompts_count": null,
    "rawJson": null,
    "conversationId": "string",
    "conversationCompleted": true,
    "timestamp": 0,
    "orderId": 0,
    "references": {},
    "fullReferences": [
        "string"
    ]
}

🟢200成功 event:close