查询对话历史列表
功能介绍
查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。
URI
GET /v1/{project_id}/applications/{application_id}/uni-search/chat-history
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
application_id |
是 |
String |
参数解释: 应用ID,获取方法请参见获取应用ID。 约束限制: 字符串 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
user_name |
否 |
String |
参数解释: 用户名。 约束限制: 不涉及 取值范围: 必须为1-64位的字母、数字、下划线或短横线。 默认取值: 不涉及 |
repo_id |
否 |
String |
参数解释: 知识库ID。 约束限制: 不涉及 取值范围: 必须为1-64位的字母、数字、下划线或短横线 默认取值: 不涉及 |
chat_id |
否 |
String |
参数解释: 对话ID。 约束限制: 不涉及 取值范围: 必须为1-64位的字母、数字、下划线或短横线 默认取值: 不涉及 |
tags |
否 |
Array of strings |
参数解释: 文档标签,查询时取交集。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
type |
否 |
String |
参数解释: 类型,必须为AnswerFromType枚举类中的有效值。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
page_num |
否 |
Integer |
参数解释: 当前请求的页码,表示从第几页开始获取数据。默认值为1,表示第一页。 约束限制: 不涉及 取值范围: 1~65535 默认取值: 1 |
page_size |
否 |
Integer |
参数解释: 每页显示的记录数,表示一次请求返回的数据条数。默认值为10,表示一页展示10条数据。 约束限制: 不涉及 取值范围: 1-65535 默认取值: 10 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
参数解释: 会话历史总数。 取值范围: 不涉及 |
size |
Integer |
参数解释: 当前页面返回条数。 取值范围: 不涉及 |
pages |
Integer |
参数解释: 总页数。 取值范围: 不涉及 |
current |
Integer |
参数解释: 当前页码。 取值范围: 不涉及 |
optimize_count_sql |
Boolean |
参数解释: 当前无实际意义。 取值范围: 不涉及 |
search_count |
Boolean |
参数解释: 当前无实际意义 取值范围: 不涉及 |
records |
Array of ChatHistoryRecordInfo objects |
参数解释: 会话历史详情。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
chat_id |
String |
参数解释: 会话ID,会话的唯一标识。 取值范围: 不涉及 |
knowledge_repo_id |
String |
参数解释: 知识库ID,标识当前会话参考的知识库。 取值范围: 不涉及 |
chat_title |
String |
参数解释: 当前会话中的query。 取值范围: 不涉及 |
user_name |
String |
参数解释: 用户名。 取值范围: 不涉及 |
create_date_time |
String |
参数解释: 会话发生的时间戳。 取值范围: 不涉及 |
project_id |
String |
参数解释: 项目ID,1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。预留字段,可联系负责开通服务的工作人员获取该字段的值。 取值范围: 不涉及 |
is_del |
Integer |
参数解释: 当前对话是否删除标记。 取值范围:
|
slave_repo_id |
String |
参数解释: 从知识库ID,标识当前会话参考的知识库,使用‘","分隔。 取值范围: 不涉及 |
type |
String |
参数解释: 类型。 取值范围: 不涉及 |
question_models |
Array of QuestionModel objects |
参数解释: 历史记录。 取值范围: 不涉及 |
actions |
Array of strings |
参数解释: 权限列表。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
question_id |
String |
参数解释: 问题ID。 取值范围: 不涉及 |
chat_id |
String |
参数解释: 会话ID。 取值范围: 不涉及 |
question |
String |
参数解释: 问题。 取值范围: 不涉及 |
rewrited_question |
String |
参数解释: 改写问题。 取值范围: 不涉及 |
answer |
String |
参数解释: 答案。 取值范围: 不涉及 |
pangu_answer |
String |
参数解释: pangu答案。 取值范围: 不涉及 |
user_name |
String |
参数解释: 用户名。 取值范围: 不涉及 |
create_date_time |
String |
参数解释: 对话发生时间。 取值范围: 不涉及 |
feedback_status |
Integer |
参数解释: 是否有问题反馈。 取值范围: 不涉及 |
feedback_type |
String |
参数解释: 反馈类型。 取值范围: 不涉及 |
pangu_question |
String |
参数解释: pangu问题。 取值范围: 不涉及 |
feedback_date_time |
String |
参数解释: 反馈时间。 取值范围: 不涉及 |
feedback_detail |
String |
参数解释: 反馈详情。 取值范围: 不涉及 |
context_relation |
String |
参数解释: 关联上下文。 取值范围: 不涉及 |
revised_answer |
String |
参数解释: 优化后结果。 取值范围: 不涉及 |
revised_reason |
String |
参数解释: 优化后问题。 取值范围: 不涉及 |
standard_answer |
String |
参数解释: 标准答案。 取值范围: 不涉及 |
project_id |
String |
参数解释: 项目ID。 取值范围: 不涉及 |
search_plan |
String |
参数解释: 搜索规划内容。 取值范围: 不涉及 |
web_reference |
String |
参数解释: web引用。 取值范围: 不涉及 |
question_reference_models |
Array of QuestionReferenceModel objects |
参数解释: 当前答案的参考文件和分片详情。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 参考分片ID。 取值范围: 不涉及 |
file_id |
String |
参数解释: 文件ID。 取值范围: 不涉及 |
reference_id |
String |
参数解释: 参考文件ID。 取值范围: 不涉及 |
question_id |
String |
参数解释: 问题ID。 取值范围: 不涉及 |
doc_index |
String |
参数解释: 参考文件索引。 取值范围: 不涉及 |
doc_title |
String |
参数解释: 参考文件名称。 取值范围: 不涉及 |
subtitle |
String |
参数解释: 参考分片子标题。 取值范围: 不涉及 |
doc_content |
String |
参数解释: 参考分片内容。 取值范围: 不涉及 |
score |
Float |
参数解释: 参考分片与问题的相关性得分。 取值范围: 不涉及 |
type |
String |
参数解释: 类型。 取值范围: 不涉及 |
page_num |
Integer |
参数解释: 页码。 取值范围: 不涉及 |
component_num |
Integer |
参数解释: 组件数量。 取值范围: 不涉及 |
请求示例
查询对话历史列表实例。
/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/chat-history?page_num=1&page_size=10
响应示例
状态码:200
查看成功。
{ "records" : [ { "chat_id" : "e447ed24-b3e0-4184-96cc-e06a9dc6cf89", "knowledge_repo_id" : "176e63a2-73bd-415c-aab2-f688030855e3", "chat_title" : "今天天气", "create_date_time" : "1695196394925", "is_del" : 0 }, { "chat_id" : "2c57dd12-0384-46c8-8d13-ae78dc857d94", "knowledge_repo_id" : "176e63a2-73bd-415c-aab2-f688030855e3", "chat_title" : "人工智能会取代人类吗", "create_date_time" : "1695195832442", "is_del" : 0 }, { "chat_id" : "ff193ad6-c812-402c-8233-f7ab5f4b0b11", "knowledge_repo_id" : "176e63a2-73bd-415c-aab2-f688030855e3", "chat_title" : "人工智能会取代人类吗", "create_date_time" : "1695195733199", "is_del" : 0 }, { "chat_id" : "f557e561-cc8f-47b1-bbd7-9d6064293588", "knowledge_repo_id" : "176e63a2-73bd-415c-aab2-f688030855e3", "chat_title" : "今天天气好吗", "create_date_time" : "1695195285924", "is_del" : 0 }, { "chat_id" : "a0330214-ea10-4aba-874a-06cefa4bc77a", "knowledge_repo_id" : "852947fe-6c60-4d91-af65-839a0292127e", "chat_title" : "神经网络是什么", "create_date_time" : "1695193989920", "is_del" : 0 }, { "chat_id" : "fbc01f0d-a9c4-4d80-a8e4-7c2e191472e9", "knowledge_repo_id" : "fba6ea89-5d9a-4835-9a8d-3ecebfc023e9", "chat_title" : "你好吗", "create_date_time" : "1695193289515", "is_del" : 0 }, { "chat_id" : "475ad732-d682-4899-8263-6643e1f1d045", "knowledge_repo_id" : "d3e0e470-0032-4907-ba64-9aba4521ed0c", "chat_title" : "你好吗", "create_date_time" : "1695193277246", "is_del" : 0 }, { "chat_id" : "73e00b01-df45-4222-81f1-018726e66315", "knowledge_repo_id" : "fba6ea89-5d9a-4835-9a8d-3ecebfc023e9", "chat_title" : "杭州在哪里", "create_date_time" : "1695192613055", "is_del" : 0 }, { "chat_id" : "f6bee59c-a8b9-41d7-bca3-06b4e28fd70b", "knowledge_repo_id" : "d3e0e470-0032-4907-ba64-9aba4521ed0c", "chat_title" : "杭州在哪里", "create_date_time" : "1695192600724", "is_del" : 0 }, { "chat_id" : "8b8d345e-833c-4b71-9bdd-e4ba75a6457e", "knowledge_repo_id" : "dbac6a40-6142-4447-b7ad-6718c089faf4", "chat_title" : "something", "create_date_time" : "1695115924537", "is_del" : 0 } ], "total" : 222, "size" : 10, "current" : 1, "optimize_count_sql" : true, "search_count" : true, "pages" : 23 }
状态码
状态码 |
描述 |
---|---|
200 |
查看成功。 |
错误码
请参见错误码。