Appearance
接口说明
大模型对话
- 请求示例:
https://api.sizhi.com/chat?appid=【机器人id】&userid=【自定义用户id】&spoken=【问题】
- 请求参数:支持GET/POST,请采用utf8编码进行请求。
参数 | 类型 | 是否必填 | 描述 |
---|---|---|---|
appid | string | 是 | 机器人id,在机器人形象设置里面可以看到此参数。请将请求示例的【机器人id】替换为看到的appid。 |
userid | string | 否 | 自定义用户id,随便填写,填入可以用来区分用户的字符串即可。此参数主要作用是标识当前与机器人交互的用户,支持根据上下文来回答问题,使用方自行维护此字段。 |
spoken | string | 是 | 问题,用户输入的问题。 |
stream | bool | 否 | 是否以流的方式返回,如果是的话,将会返回多个json。默认值false。 |
memory | bool | 否 | 是否使用记忆功能。默认值true。 |
- 返回参数:
参数 | 类型 | 描述 |
---|---|---|
status | int | 请求状态,0表示操作成功,非零返回状态码,-1表示通用错误,-2表示token过期 |
message | string | 请求的状态消息 |
data | object | 返回的数据内容 |
data.type | string | 回复类型,text表示文本回复 |
data.info | object | 机器人相关的回复信息。 |
info.text | text | 机器人的文本回复。 |
- 返回示例:
{
"status": 0
"message": "请求成功",
"data": {
"type": "text",
"info": {
"text": "你好,很高兴认识你。有什么我可以帮助你的吗?"
}
}
}
- 流返回示例:
data: {"status": 0, "message": "success", "data": {"type": "text", "info": {"text": "你好,"}}}
data: {"status": 0, "message": "success", "data": {"type": "text", "info": {"text": "很高兴认识你。"}}}
data: {"status": 0, "message": "success", "data": {"type": "text", "info": {"text": "有什么我可以帮助你的吗?"}}}
data: {"status": 0, "message": "success", "data": {"type": "text", "info": {"text": ""}}}