检索知识库列表

POST /studio/rag/data/v1/datasets:search

请求头（Request Header）

Authorization 可以使用如下两种Header

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

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

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

-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB...'

请求体（Request Body）

名称	类型	必须	描述
filter_msg	string	否	根据名称、正则表达式或知识库描述进行过滤.
dataset_filter_type	integer($enum)	否	知识库过滤类型枚举.
page_token	string	否	当前页的起始值.
page_size	int32	是	每页的数据条数，最大为1000.
order_by	string	否	排序关键字，例如 `create_time desc`.

其中，dataset_filter_type有如下情况

枚举值	数值	含义
DATASET_FILTER_TYPE_UNSPECIFIED	0	未定义的过滤类型
CREATED_BY_ME	1	我创建的知识库
MANAGED_BY_ME	2	我管理的知识库
ACCESSIBLE_BY_ME	3	我可访问的知识库
DEMONSTRATION	4	演示知识库

请求示例（Request Example）

curl --location --request POST 'https://aidmp.cn-sh-01.sensecoreapi.cn/studio/rag/data/v1/datasets:search' \
  -H "X-Date: $xdate" \
  -H "Authorization: $auth" \
  -X POST \
  --data '{
    "filter_msg": "搜索关键词",
    "dataset_filter_type": 3,
    "page_size": 20,
    "order_by": "create_time desc"
  }'

响应（Response）

名称	类型	描述
datasets	array[object]	知识库数据集列表.
total_size	int32	符合条件的知识库总数.
next_page_token	string	下一页的令牌字段，用于分页.

其中，dataset的参数如下

名称	类型	描述
dataset_id	string	知识库的ID.
display_name	string	知识库的显示名称.
desc	string	知识库的描述.
cover_image	string	知识库的封面图片.
state	integer($enum)	知识库状态（0: 未指定，1: 创建中，2: 可用，3: 不可用）.
is_empty	boolean	知识库是否为空.
document_count	int64	知识库的知识数量.
document_size	int64	知识库的知识大小.
segment_count	int64	知识库的分段数量.
token_count	int64	知识库的令牌数量.
embedding_model	string	嵌入模型.
embedding_model_provider	string	嵌入模型的提供者.
creator	string	创建者.
create_time	string	创建时间.
update_time	string	更新时间.
acl	array[integer($enum)]	知识库的访问控制列表.
share_type	integer($enum)	共享类型.

其中，state有如下情况

状态	数值	含义
STATE_UNSPECIFIED	0	开始，默认.
CREATING	1	知识库正在创建中.
AVAILABLE	2	知识库可用.
UNAVAILABLE	3	知识库不可用.

其中，acl有如下情况

状态	数值	含义
DATASET_ACTION_UNSPECIFIED	0	未指定.
DATASET_READ	1	读权限.
DATASET_WRITE	2	写权限.

其中，share_type有如下情况

状态	数值	含义
SHARE_TYPE_UNSPECIFIED	0	未指定.
SHARE_TYPE_MAINTAINER_IN_TENANT	1	租户内的所有用户都有维护者权限.
SHARE_TYPE_USER_IN_TENANT	2	租户内的所有用户都有用户权限.
SHARE_TYPE_MAINTAINER_ALL	3	所有用户都有维护者权限.
SHARE_TYPE_USER_ALL	4	所有用户都有用户权限.

响应示例（Response Example）

{
  "datasets": [
    {
      "dataset_id": "b2dc6d90-6b68-46e2-a1d1-fd4b323eef40",
      "display_name": "知识库名称",
      "desc": "知识库描述",
      "cover_image": "http://example.com/image.png",
      "state": 2,
      "is_empty": false,
      "document_count": 100,
      "document_size": 1024,
      "segment_count": 10,
      "token_count": 5000,
      "embedding_model": "模型名称",
      "embedding_model_provider": "模型提供者",
      "creator": "创建者ID",
      "create_time": "2023-10-07T09:04:08.109Z",
      "update_time": "2023-10-07T09:04:08.109Z",
      "acl": [1, 2],
      "share_type": 2
    }
  ],
  "total_size": 1,
  "next_page_token": "next_page_token_value"
}

检索知识库列表

请求头（Request Header）​

请求体（Request Body）​

请求示例（Request Example）​

响应（Response）​

响应示例（Response Example）​

请求头（Request Header）

请求体（Request Body）

请求示例（Request Example）

响应（Response）

响应示例（Response Example）