创建知识库
POST /studio/rag/data/v1/datasets
请求头（Request Header）
Authorization 可以使用如下两种Header
- 动态生成 Authorization Header, 参考认证（authentication）
-H "X-Date: $xdate" \
-H "Authorization: $auth"
- 直接提供完整的 Authorization Header,可以通过浏览器的开发者工具DevTools查看并复制接口调用的完整信息
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InB...'
请求参数（Request Parameters）
无请求参数
请求体（Request Body）
| 名称 | 类型 | 必须 | 默认值 | 取值范围 | 描述 |
|---|---|---|---|---|---|
| display_name | string | 是 | - | - | 知识库的显示名称. |
| desc | string | 是 | - | - | 知识库的描述. |
| cover_image | string | 否 | - | - | 知识库的封面图片. |
| embedding_model | string | 否 | - | - | 嵌入模型. |
| embedding_model_provider | string | 否 | - | - | 嵌入模型的提供者. |
| share_type | integer($enum) | 否 | - | - | 共享类型. |
其中，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 | 所有用户都有用户权限. |
请求示例（Request Example）
curl 'https://aidmp.cn-sh-01.sensecoreapi.cn/studio/rag/data/v1/datasets' \
-H "X-Date: $xdate" \
-H "Authorization: $auth" \
-X POST \
--data-raw '{
"display_name":"test0722",
"desc":"openapi",
"cover_image":"coverImage/15d5d66d-edf9-44ff-a1a2-af28c5d89659"
}'
响应（Response）
| 名称 | 类型 | 描述 |
|---|---|---|
| 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($date-time) | 创建时间. |
| update_time | string($date-time) | 更新时间. |
| 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）
{
"name": "",
"dataset_id": "rag_6838d91b6d8b4696be0f497d0868c10e",
"display_name": "test0722",
"desc": "openapi",
"cover_image": "https://rag-system.aoss.cn-sh-01.sensecoreapi-oss.cn/coverImage/15d5d66d-edf9-44ff-a1a2-af28c5d89659?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=CD840429150E4FD2805997FE12D18A86%2F20240722%2Fdefault%2Fs3%2Faws4_request&X-Amz-Date=20240722T073000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=b4685821d0a991f4c9e511f03695804109fe4f9755dd0866a6c1e4bee9a2807b",
"state": 2,
"is_empty": true,
"document_count": "0",
"document_size": "0",
"segment_count": "0",
"token_count": "0",
"embedding_model": "",
"embedding_model_provider": "",
"creator": "aidmpywj",
"create_time": "2024-07-22T07:30:00.653745752Z",
"update_time": "2024-07-22T07:30:00.653745966Z",
"acl": [],
"share_type": 0
}