查询会话(含会话内的历史消息)
接口信息
接口地址:/api/v1/conversation/{conversationId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:
获取会话信息,包含会话中的历史消息
请求参数
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
conversationId | 会话ID | path | true | integer(int64) |
响应参数:
参数名称 | 参数说明 | 类型 |
---|---|---|
code | 业务状态码,0000 表示成功,其余失败 | string |
displayCode | 源系统状态码,用于问题跟踪 | string |
message | 错误描述信息 | string |
data | ConversationDto | |
id | 会话ID | integer(int64) |
userId | 创建会话的用户ID | integer(int64) |
uid | 会话唯一标识与会话ID作用相同 | string |
agentId | 智能体ID | integer(int64) |
topic | 会话主题 | string |
summary | 会话摘要 | string |
variables | 用户填写的智能体设置的会话变量内容 | object |
created | 会话创建时间 | string(date-time) |
messageList | 会话消息列表,会话列表查询时不会返回该字段值 | array |
id | 消息ID | string |
role | 可用值:USER,ASSISTANT | string |
type | 可用值:CHAT 普通消息输出THINK 思考消息PROCESS_OUTPUT 工作流过程输出节点输出内容QUESTION 工作流问答节点输出问题内容 | string |
text | 消息内容 | string |
time | 消息时间 | string |
attachments | 消息附件 | array |
fileKey | string | |
fileUrl | 文件URL | string |
fileName | string | |
mimeType | 文件类型 | string |
think | 思考内容 | string |
quotedText | 引用消息内容 | string |
messageType | 可用值:USER,ASSISTANT,SYSTEM,TOOL | string |
ext | 消息扩展内容,如果类型为QUESTION 时,里面为问题列表 | array |
finished | 是否消息内容输出结束 | boolean |
metadata | object | |
tid | 跟踪唯一标识 | string |
success | boolean |