获取对话详情
功能介绍
获取对话详情。
URI
GET /v1/{project_id}/chats/{chat_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
|
chat_id |
是 |
String |
参数解释: 对话ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Chat-Route-Id |
String |
参数解释: 对话路由ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-64]个字符。 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 对话ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
title |
String |
参数解释: 对话名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
alias |
String |
参数解释: 对话别名。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
create_time |
String |
参数解释: 对话创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
update_time |
String |
参数解释: 对话更新时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
repo_ids |
Array of strings |
参数解释: 绑定的知识库ID列表。 约束限制: 绑定的知识库数量范围为[0-5]。 取值范围: 不涉及 默认取值: 不涉及 |
|
agent_type |
String |
参数解释: 助手类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
agent_role |
String |
参数解释: 助手角色。 约束限制: 不涉及 取值范围:
默认取值: Common |
|
chat_messages |
Array of ChatMessageRsp objects |
参数解释: 对话问答列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 问答ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
role |
String |
参数解释: 问答角色。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
type |
String |
参数解释: 问答类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
create_time |
String |
参数解释: 问答创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
update_time |
String |
参数解释: 问答更新时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
message |
ChatMessage object |
参数解释: 对话内容。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
addition |
ChatAddition object |
参数解释: 对话额外信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
content |
String |
参数解释: 对话内容。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
reasoning_content |
String |
参数解释: 深度搜索思维链内容。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
tool_calls |
Array of ToolCall objects |
参数解释: 工具调用列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释: 工具类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
name |
String |
参数解释: 工具名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
operation |
String |
参数解释: 工具操作。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
parameters |
Map<String,Object> |
参数解释: 工具调用所需参数列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
workspace_id |
String |
参数解释: 实验问答使用的空间ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
job_id |
String |
参数解释: 实验问答的作业ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
job_config |
String |
参数解释: 实验问答的额外配置信息。 约束限制: 不涉及 取值范围: 取值范围为[1-2048]个字符。 默认取值: 不涉及 |
|
tool_type |
String |
参数解释: 实验类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
job_type |
String |
参数解释: 作业类型。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
data_path |
String |
参数解释: 深度探究生成报告存储路径。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
获取对话详情。
https://{endpoint}/v1/{project_id}/chats/{chat_id}
响应示例
状态码:200
OK
{
"id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488",
"title" : "demo_title",
"alias" : "alias",
"create_time" : "2021-01-30T02:34:36Z",
"update_time" : "2021-01-30T02:34:36Z",
"agent_type" : "auto",
"chat_messages" : [ {
"id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488",
"type" : "chat_call",
"create_time" : "2021-01-30T02:34:36Z",
"update_time" : "2021-01-30T02:34:36Z",
"message" : {
"content" : "什么是定量构效关系"
}
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。