创建一个知识库。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| pailangstudio:CreateKnowledgeBase | create | *全部资源 * |
| 无 |
请求语法
POST /api/v1/langstudio/knowledgebases HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 请求体。 | |
| WorkspaceId | string | 是 | 工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces 。 | 478** |
| Accessibility | string | 否 | 工作空间可见性,可能值为:
| PUBLIC |
| Name | string | 是 | 知识库的名称。命名规则如下:
| myName |
| Description | string | 否 | 对知识库进行自定义描述。 | This is a description of the knowledge base. |
| KnowledgeBaseType | string | 是 | 知识库类型。支持以下取值:
| TEXT |
| OutputDir | string | 是 | 输出数据的存储路径。 | oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/ |
| DataSources | array<object> | 是 | 数据源。 | |
| object | 否 | |||
| Uri | string | 否 | 源文件存储路径。 | oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/ |
| ChunkConfig | object | 是 | 文件切片配置。 | |
| ChunkSize | integer | 否 | 分块大小 | 1024 |
| ChunkOverlap | integer | 否 | 分块重叠大小 | 200 |
| ChunkDuration | integer | 否 | 分块时长,单位秒。 | 30 |
| ChunkStrategy | string | 否 | 分块策略。支持的策略如下:
| Default |
| EmbeddingConfig | object | 是 | 向量索引配置。 | |
| ConnectionId | string | 是 | 索引服务连接 ID。如何获取连接 ID 请参见 ListConnections 。 各类型知识库支持的连接类型如下:
| conn-r3o7******38bh |
| Model | string | 是 | 模型名称。特别的,当选择百炼大模型服务时,各类型知识库支持的模型如下:
| text-embedding-v4 |
| VectorDBConfig | object | 是 | 向量库配置。 | |
| VectorDBType | string | 是 | 向量数据库类型。支持以下取值:
| Milvus |
| ConnectionId | string | 否 | 向量数据库连接 ID。如何获取连接 ID 请参见 ListConnections 。 | conn-7y5y******jja7 |
| CollectionName | string | 否 | 向量库的表或集合名称。 | my_collection |
| RuntimeId | string | 否 | 运行时 ID。 | rtime-apje******beaz |
| MetaDataConfig | object | 否 | 元数据配置。 | |
| CustomMetaData | array<object> | 否 | 自定义元数据。 | |
| CustomMetaData | object | 否 | ||
| Key | string | 否 | 元数据字段名称。 | author |
| ValueType | string | 否 | 元数据字段类型。目前只支持 String 类型。 | String |
| IndexColumnConfig | object | 否 | 结构化知识库字段列配置。 | |
| EmbeddingColumns | array<object> | 否 | 向量检索列。该列表中的字段会进行向量化并参与检索。 | |
| EmbeddingColumn | object | 否 | ||
| Key | string | 否 | 列名。 | column1 |
| ContentColumns | array<object> | 否 | 内容过滤列。该列表中的字段支持按照关键字进行检索。 | |
| ContentColumn | object | 否 | ||
| Key | string | 否 | 列名。 | column1 |
| ColumnDefinitions | array<object> | 否 | 所有列名。 | |
| ColumnDefinition | object | 否 | ||
| Key | string | 否 | 列名。 | column1 |
返回参数
示例
正常返回示例
JSON格式
{
"WorkspaceId": "478**",
"KnowledgeBaseId": "d-ksicx823d",
"RequestId": "48E6392E-C3C9-5212-9FAD-13256ABD9AF6"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-01-08 | OpenAPI 返回结构发生变更 | 查看变更详情 |
