获取对话详情

GET /studio/rag/data/v1/conversations/{conversation_id}:detail

请求头（Request Header）

Authorization 可以使用如下两种Header

• 动态生成 Authorization Header, 参考认证（authentication）

-H "X-Date: $xdate" \
-H "Authorization: $auth" 

• 直接提供完整的 Authorization Header,可以通过浏览器的开发者工具DevTools查看并复制接口调用的完整信息

-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB...'

请求参数（Request Parameters）

名称	类型	必须	描述
conversation_id	string	是	对话ID

请求示例（Request Example）

curl 'https://aidmp.cn-sh-01.sensecoreapi.cn/studio/rag/data/v1/conversations/4930418d-eae7-4372-9ef2-02c17ffb1c04:detail' \
  -H "X-Date: $xdate" \
  -H "Authorization: $auth" \
  -X GET

响应（Response）

名称	类型	描述
conversation	object	对话详情
channel	object	大模型渠道资源
history	array[object]	对话历史

其中，conversation的参数如下

名称	类型	描述
conversation_id	string	对话ID(只输出).
channel_id	string	大模型渠道资源ID.
display_name	string	显示名称，第一次对话后自动更新.
create_time	string($date-time)	创建时间(只输出).
update_time	string($date-time)	更新时间(只输出).
model	string	模型名称.
search_config	object	知识搜索配置.
prompt	string	知识库提示，改写用户问题，增加知识库检索到的知识信息.
model_config	object	模型配置.
sys_prompt	string	人设提示，大模型所需要扮演的人设信息.
conversation_question_prompt_enabled	bool	是否提供用户可能想问的三个问题.
user	string	用户名.
chat_times	int32	聊天次数.
total_feedback_like	int32	点赞反馈的总数.
total_feedback_unlike	int32	差评反馈的总数.

其中，conversation.search_config的参数如下

名称	类型	描述
dataset_list	array[object]	要搜索的知识库列表.
top_k	int32	返回结果的Top K值.
confidence	float	置信度.
weight	float	权重：表示两种方法之间的比例.
open_window	bool	是否在提示中包含检索段的前后片段.

其中，search_config.dataset_list的参数如下

名称	类型	描述
id	string	知识库ID.
display_name	string	知识库显示名称.

其中，conversation.model_config的参数如下

名称	类型	描述
frequency_penalty	float	重复惩罚系数.
max_tokens	int32	在聊天补全中生成的最大token数，默认值为102.
n	int32	为每条输入消息生成的聊天补全选择数量.
temperature	float	使用的采样温度，范围在0到2之间.
top_p	float	采样温度的替代方案，称为核采样.

其中，channel的参数如下

名称	类型	描述
secret	object	大模型渠道的密钥
display_name	string	大模型渠道显示名称
channel_type	integer($enum)	大模型渠道类型
create_time	string($date-time)	创建时间
update_time	string($date-time)	更新时间

其中，channel.secret的参数如下

名称	类型	描述
secret_type	integer($enum)	密钥类型
ak	string	ak，当 secret_type 为 AK_SK 时有效
sk	string	sk，当 secret_type 为 AK_SK 时有效
api_key	string	api_key，当 secret_type 为 API_KEY 时有效

其中，channel.secret_type有如下情况

枚举值	数值	含义
SECRET_TYPE_UNSPECIFIED	0	未指定
AK_SK	1	AK/SK类型
API_KEY	2	API_KEY类型

其中，channel.channel_type有如下情况

枚举值	数值	含义
CHANNEL_TYPE_UNSPECIFIED	0	未指定
CHANNEL_TYPE_SENSE_NOVA	1	Sense nova类型

其中，history的参数如下

名称	类型	描述
seq	int32	序列号
query	string	用户查询内容
result	string	用户查询结果
id	string	历史ID
feed_back	integer($enum)	反馈类型
knowledge_base_results	object	知识检索的中间结果

其中，history.feed_back有如下情况

枚举值	数值	含义
FEED_BACK_TYPE_UNSPECIFIED	0	未指定
FEED_BACK_TYPE_LIKE	1	喜欢
FEED_BACK_TYPE_UNLIKE	2	不喜欢

其中，history.knowledge_base_results的参数如下

名称	类型	描述
page_content	string	页面内容.
document	object	相关知识文档.
confidence	float	结果置信度.
token_count	int64	内容的token数量.
segment_number	int32	段落数量.
words	int32	段落的字数.
type	integer($enum)	段落类型.
display_type	integer($enum)	显示类型.
table_content	string	表格内容.
image_uri	string	图片URI.
image_key	string	图片键.
image_keys	array[string]	图片键集合.
display_content	string	显示内容.

其中，knowledge_base_results.document的参数如下

名称	类型	描述
document_id	string	知识文档的ID.
display_name	string	知识文档的名称.
type	integer($enum)	知识文档的类型.
document_size	int64	知识文档的大小.
token_count	int64	知识文档的令牌计数.
segment_count	int64	知识文档的段落计数.
dataset_id	string	知识文档所属知识库的ID.
dataset_display	string	知识文档所属知识库的显示名称.
p_id	string	父知识文档的ID.
data_source_type	integer($enum)	知识文档的数据源类型.
creator	string	知识文档的创建者.
create_time	string($date-time)	知识文档的创建时间.
update_time	string($date-time)	知识文档的更新时间.
segments	array[object]	知识文档的段落详细信息列表.
uri	string	知识文档在OSS中的预签名URI.

其中，document.type有如下情况

枚举值	数值	含义
DOCUMENT_TYPE_UNSPECIFIED	0	未指定
WEBPAGE	1	网页
FOLDER	2	文件夹
TXT	3	文本文件
PDF	4	PDF文件
HTML	5	HTML文件
XLSX	6	XLSX文件
XLS	7	XLS文件
DOCX	8	DOCX文件
CSV	9	CSV文件
PPTX	10	PPTX文件
PPT	11	PPT文件，暂不支持
XML	12	XML文件
MARKDOWN	13	Markdown文件
MD	14	MD文件
JSON	15	Json文件

其中，document.data_source_type有如下情况

枚举值	数值	含义
DATA_SOURCE_TYPE_UNSPECIFIED	0	开始，默认
LOCAL_FILE	1	本地知识
WEB	2	网络知识
NOTION	3	Notion知识

其中，document.segments的参数如下

名称	类型	描述
segment_id	string	段ID.
dataset_id	string	知识库ID
document_id	string	文档ID
content	string	段落内容
token_count	int32	词元数量
number	int32	段落编号
metadata	object	元数据
words	int32	单词数量
segment_type	integer($enum)	段落类型
table_content	string	表格内容
image_key	string	图片键值
image_uri	string	图片URI
display_type	integer($enum)	显示类型
image_keys	array[string]	图片键值列表
display_content	string	展示内容

其中，segments.metadata的参数如下

名称	类型	描述
key_words	array[string]	关键词
image_name_value	string	图片名称
image_size	int32	图片大小
table_name_value	string	表格名称
table_rows	int32	表格行数
table_columns	array[string]	表格列
score	float	分数

其中，knowledge_base_results.type和segments.segment_type有如下情况

枚举值	数值	含义
SEGMENT_TYPE_UNSPECIFIED	0	未指定状态
SEGMENT_TYPE_TEXT	1	文字
SEGMENT_TYPE_IMAGE	2	图片
SEGMENT_TYPE_TABLE	3	表格
SEGMENT_TYPE_WEB_IMAGE	4	网页图片

其中，knowledge_base_results.display_type和segments.display_type有如下情况

枚举值	数值	含义
DISPLAY_TYPE_UNSPECIFIED	0	未指定状态
DISPLAY_TYPE_TEXT	1	文字
DISPLAY_TYPE_MARKDOWN	2	Markdown

响应示例（Response Example）

{
  "conversation": {
    "name": "",
    "conversation_id": "67361554-3b1b-4861-b5e7-96ca8e7b8b5f",
    "channel_id": "fake",
    "display_name": "法定结婚年龄",
    "create_time": "2024-09-24T10:43:00.792967Z",
    "update_time": "2024-09-24T10:43:00.792979Z",
    "model": "SenseChat",
    "search_config": {
      "dataset_list": [
        {
          "id": "1431194b72344e88a4df1af91a710ca1",
          "display_name": "testywj06141431"
        }
      ],
      "top_k": 3,
      "confidence": 0.5,
      "weight": 0,
      "open_window": false
    },
    "prompt": "",
    "model_config": null,
    "sys_prompt": "",
    "conversation_question_prompt_enabled": false,
    "user": "adimp0224",
    "chat_times": 1,
    "total_feedback_like": 0,
    "total_feedback_unlike": 0
  },
  "channel": {
    "name": "",
    "secret": null,
    "display_name": "SenseNova-6380A0DB10A1481E98316D41B39B3918",
    "channel_type": 1,
    "create_time": null,
    "update_time": null
  },
  "history": [
    {
      "seq": 1,
      "query": "法定结婚年龄",
      "result": " ",
      "id": "a285e430-65fc-4041-81ec-a21d3d9058fe",
      "feed_back": 0,
      "knowledge_base_results": []
    }
  ]
}