sse模式ai聊天运行 - 联犀-企业版

请求参数

Header 参数

Ithings-Project-Id

string

可选

默认值:

Ithings-Token

string

可选

默认值:

app-code

string

可选

默认值:

device-id

string

可选

用户正在使用的设备ID(小程序,ios,安卓的设备ID)

Body 参数application/json

appCode

string

执行的应用

必需

inputs

object

可选

query

string

用户输入/提问内容

必需

conversationID

string

可选

（选填）会话 ID，需要基于之前的聊天记录继续对话，必须传之前消息的 conversation_id。

user

string

必需

用户标识，用于定义终端用户的身份，方便检索、统计。由开发者定义规则，需保证用户标识在应用内唯一。

示例

{
  "appCode": "string",
  "inputs": {},
  "query": "string",
  "conversationID": "string",
  "user": "string"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v1/ai/app/sse/chat-run' \
--header 'Ithings-Project-Id: {{Ithings-Project-Id}}' \
--header 'Ithings-Token: {{iThings-token}}' \
--header 'app-code: {{appCode}}' \
--header 'device-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appCode": "string",
    "inputs": {},
    "query": "string",
    "conversationID": "string",
    "user": "string"
}'

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

data

object (AiAppChatSendResp)

可选

event

string

可选

message(阻塞模式只有这种) LLM 返回文本块事件，即：完整的文本以分块的方式输出。 message_end 消息结束事件，收到此事件则代表流式返回结束。 agent_message Agent模式下返回文本块事件，即：在Agent模式下，文章的文本以分块的方式输出（仅Agent模式下使用） agent_thought Agent模式下有关Agent思考步骤的相关内容，涉及到工具调用（仅Agent模式下使用） ping 每 10s 一次的 ping 事件，保持连接存活。

messageID

string

消息唯一 ID

必需

conversationID

string

会话 ID

必需

mode

string

必需

App 模式，固定为 chat

answer

string

完整回复内容

必需

createdAt

integer <int64>

必需

消息创建时间戳，如：1705395332

示例

{
  "code": "200",
  "msg": "string",
  "data": {
    "event": "string",
    "messageID": "string",
    "conversationID": "string",
    "mode": "string",
    "answer": "string",
    "createdAt": 0
  }
}