文档首页/ 应用平台 AppStage/ API参考/ API/ 知识中心/ 创建知识库
更新时间：2024-12-11 GMT+08:00
查看PDF
分享

创建知识库

功能介绍

创建知识库

URI

POST /v1/knowledge-bases

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

AI原生应用引擎鉴权API Key。

1.以管理员身份登录AI原生应用引擎工作台，在左侧导航栏选择“系统管理 > 平台租户鉴权”。

2.在“平台租户鉴权”页面，选择“平台API Key”页签，单击“新增平台API Key”。

3.在“新增平台API Key”对话框中的输入框设置API Key名称，用以区分API Key。

4.在弹出的下载窗口中单击“立即下载”，将API Key下载到本地查看。

5.使用时，需在sk前加上Bearer ，如Bearer sk-xxxxxxxx。
表2 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

知识库名称，支持中英文、数字、下划线(_)，2-50个字符，以中英文、数字开头

description

否

String

知识库描述

retrieval_status

是

String

知识库召回状态，枚举值：ENABLE（启用召回）、DISABLE（禁用召回）

knowledge_data_sets

是

Array of KnowledgeDataSet objects

知识数据集信息列表，选择知识数据集创建知识库
表3 KnowledgeDataSet

参数

是否必选

参数类型

描述

data_set_id

是

String

数据集id，仅支持数字、字母和中划线，可通过查询数据集详情接口获取

data_set_version

是

String

数据集版本，格式为：v2024-11-21T11:36:55Z，可通过查询数据集详情接口获取

index_config_id

是

String

索引配置id，仅支持数字、字母和中划线，可通过查询数据集详情接口获取

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

String

正常返回的结果

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

异常错误码

error_msg

String

异常错误信息

请求示例

{
  "name" : "知识库名称",
  "description" : "知识库描述",
  "retrieval_status" : "ENABLE",
  "knowledge_data_sets" : [ {
    "data_set_id" : "djh28e62-xxxxxxxxx-a15be0d63812",
    "data_set_version" : "v2024-11-21T11:36:55Z",
    "index_config_id" : "d3f28e62-xxxxxxx-a15be0d638a2"
  } ]
}

响应示例

状态码： 200

操作成功，返回知识库id

{
  "data" : "3f28e62-xxxxxxxx-a15be0d638a2"
}

状态码： 400

请求错误

{
  "error_code" : "AIAE.40001001",
  "error_msg" : "参数xxxx不合法。"
}

状态码

状态码

描述

200

操作成功，返回知识库id

400

请求错误

错误码

请参见错误码。

父主题： 知识中心

相关文档