CreateKnowledgeBase - 创建知识库

创建一个知识库。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pailangstudio:CreateKnowledgeBasecreate
*全部资源
*

请求语法

POST /api/v1/langstudio/knowledgebases HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求体。

WorkspaceIdstring

工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces

478**
Accessibilitystring

工作空间可见性,可能值为:

  • PRIVATE:在此工作空间中,仅对您和管理员可见。
  • PUBLIC:在此工作空间中,对所有人可见。
PUBLIC
Namestring

知识库的名称。命名规则如下:

  • 可以包含字母、数字或下划线(_)。
  • 以字母开头。
  • 长度为 1~127 个字符。
myName
Descriptionstring

对知识库进行自定义描述。

This is a description of the knowledge base.
KnowledgeBaseTypestring

知识库类型。支持以下取值:

  • TEXT:文档。
  • STRUCTURED:结构化数据。
  • IMAGE:图片。
  • VIDEO:视频。
TEXT
OutputDirstring

输出数据的存储路径。

oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/
DataSourcesarray<object>

数据源。

object
Uristring

源文件存储路径。

oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/
ChunkConfigobject

文件切片配置。

ChunkSizeinteger

分块大小

1024
ChunkOverlapinteger

分块重叠大小

200
ChunkDurationinteger

分块时长,单位秒。

30
ChunkStrategystring

分块策略。支持的策略如下:

  • Default。系统默认切片策略。
  • Asr。按音频内容切分,视频知识库有效。
Default
EmbeddingConfigobject

向量索引配置。

ConnectionIdstring

索引服务连接 ID。如何获取连接 ID 请参见 ListConnections 。 各类型知识库支持的连接类型如下:

  • 文档:百炼大模型服务、通用 Embedding 模型服务、AI 搜索开放平台模型服务。
  • 结构化数据:百炼大模型服务、通用 Embedding 模型服务、AI 搜索开放平台模型服务。
  • 图片:百炼大模型服务、通用多模态 Embedding 模型服务。
  • 视频:百炼大模型服务。
conn-r3o7******38bh
Modelstring

模型名称。特别的,当选择百炼大模型服务时,各类型知识库支持的模型如下:

  • 文档:text-embedding-v1、text-embedding-v2、text-embedding-v3、text-embedding-v4
  • 结构化数据:text-embedding-v1、text-embedding-v2、text-embedding-v3、text-embedding-v4
  • 图片:multimodal-embedding-v1
  • 视频:qwen2.5-vl-embedding
text-embedding-v4
VectorDBConfigobject

向量库配置。

VectorDBTypestring

向量数据库类型。支持以下取值:

  • Elasticsearch
  • Milvus
  • Faiss(仅文档和结构化数据知识库支持)
Milvus
ConnectionIdstring

向量数据库连接 ID。如何获取连接 ID 请参见 ListConnections

conn-7y5y******jja7
CollectionNamestring

向量库的表或集合名称。

my_collection
RuntimeIdstring

运行时 ID。

rtime-apje******beaz
MetaDataConfigobject

元数据配置。

CustomMetaDataarray<object>

自定义元数据。

CustomMetaDataobject
Keystring

元数据字段名称。

author
ValueTypestring

元数据字段类型。目前只支持 String 类型。

String
IndexColumnConfigobject

结构化知识库字段列配置。

EmbeddingColumnsarray<object>

向量检索列。该列表中的字段会进行向量化并参与检索。

EmbeddingColumnobject
Keystring

列名。

column1
ContentColumnsarray<object>

内容过滤列。该列表中的字段支持按照关键字进行检索。

ContentColumnobject
Keystring

列名。

column1
ColumnDefinitionsarray<object>

所有列名。

ColumnDefinitionobject
Keystring

列名。

column1

返回参数

名称类型描述示例值
object
WorkspaceIdstring

知识库所属的工作空间 ID。

478**
KnowledgeBaseIdstring

知识库 ID。

d-ksicx823d
RequestIdstring

请求 ID

48E6392E-C3C9-5212-9FAD-13256ABD9AF6

示例

正常返回示例

JSON格式

{
  "WorkspaceId": "478**",
  "KnowledgeBaseId": "d-ksicx823d",
  "RequestId": "48E6392E-C3C9-5212-9FAD-13256ABD9AF6"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2026-01-08OpenAPI 返回结构发生变更查看变更详情