检索知识列表

POST /studio/rag/data/v1/datasets/{dataset_id}/documents:search

请求头（Request Header）

Authorization 可以使用如下两种Header

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

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

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

-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB...'

请求参数（Request Parameters）

名称	类型	必须	描述
dataset_id	string	是	知识库的ID.
p_id	string	否	父知识的ID.
dir_path	string	否	知识的文件路径.
order_by	string	否	排序关键字，如：create_time desc.
page_token	string	否	当前页的起始值.
page_size	int32	是	此请求的页面大小（最大1000）.

请求示例（Request Example）

curl --location --request POST 'https://aidmp.cn-sh-01.sensecoreapi.cn/studio/rag/data/v1/datasets/{dataset_id}/documents:search' \
  -H "X-Date: $xdate" \
  -H "Authorization: $auth" \
  -X POST \
  --data-raw '{
    "p_id": "parent_document_id",
    "order_by": "create_time desc",
    "page_size": 10
  }'

响应（Response）

名称	类型	描述
documents	array[object]	知识文档列表.
total_size	int32	知识文档总数.
next_page_token	string	用于分页的下一页标记字段.

其中，documents的参数如下

名称	类型	描述
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	分数

其中，segments.segment_type有如下情况

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

其中，segments.display_type有如下情况

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

响应示例（Response Example）

{
  "documents": [
    {
      "document_id": "abc123",
      "display_name": "知识文档名称",
      "type": 3,
      "document_size": 1024,
      "token_count": 5000,
      "segment_count": 10,
      "dataset_id": "b2dc6d90-6b68-46e2-a1d1-fd4b323eef40",
      "dataset_display": "知识库名称",
      "p_id": "parent_document_id",
      "data_source_type": 1,
      "creator": "创建者ID",
      "create_time": "2023-10-07T09:04:08.109Z",
      "update_time": "2023-10-07T09:04:08.109Z"
    }
  ],
  "total_size": 1,
  "next_page_token": ""
}