创建知识库及数据域¶

创建不含数据源的知识库。创建成功后，再上传并添加文件或数据表。

POST https://api.moi.matrixorigin.cn/v5/semantic-models/create-empty

调用前准备¶

准备有目标工作区创建知识库权限的个人访问令牌和工作区 ID。示例使用 $AI_STUDIO_API_KEY 和 $WORKSPACE_ID。

请求体¶

请求示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/semantic-models/create-empty" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "product_docs",
    "description": "产品资料",
    "image_index_enabled": false
  }'

参数说明

请求体

字段	类型	必填	说明
`name`	string	是	知识库名称。
`description`	string	否	知识库说明。
`image_index_enabled`	boolean	否	是否启用图片索引；未传时为 `false`。

成功响应¶

成功时返回 201。保存 data.model.id，后续接口将它作为 model_id 使用。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "model": {
      "id": 401,
      "name": "product_docs",
      "tables": []
    },
    "data_domain": {
      "model_id": 401,
      "ensure_status": "ready"
    }
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。

创建结果

下面表格展开响应示例中 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`model`	object	新建的知识库。
`data_domain`	object	该知识库的数据域信息。

知识库信息

下面表格展开响应示例中 data.model 对象；每一行是该对象的一个字段。

字段	类型	说明
`id`	integer	知识库 ID。
`name`	string	知识库名称。
`description`	string	知识库说明。
`tables`	array of object	兼容的旧式表来源定义。
`files`	object	兼容的旧式文件来源定义；未设置时可能省略。
`source_counts`	object	来源数量。
`created_at`	integer	创建时间。
`updated_at`	integer	最近更新时间。

数据表

下面表格展开响应示例中 data.model.tables 数组的每一项；每一行是该数组项的一个字段。

字段	类型	说明
`db_name`	string	数据库名称。
`table_names`	array of string	该数据库中的表名称。

文件来源

下面表格展开响应示例中 data.model.files 对象；每一行是该对象的一个字段。

字段	类型	说明
`file_ids`	array of string	文件 ID。
`parents`	array of string	文件父目录路径。
`volume_ids`	array of integer	卷 ID。
`volumes`	array of object	卷及其扫描路径。
`vector_table`	string	文本向量表名称。
`embedding_model`	string	文本嵌入模型标识。
`image_vector_table`	string	图片向量表名称。
`image_embedding_model`	string	图片嵌入模型标识。
`image_embedding_backend_id`	string	图片嵌入后端 ID。
`image_embedding_dimension`	integer	图片嵌入维度。
`image_preprocess_version`	string	图片预处理版本。
`image_distance_metric`	string	图片向量距离度量。
`tags`	array of string	文件来源标签。

数据卷

下面表格展开响应示例中 data.model.files.volumes 数组的每一项；每一行是该数组项的一个字段。

字段	类型	说明
`volume_id`	integer	卷 ID。
`parents`	array of string	卷内父目录路径。
`path`	string	卷内起始路径。

来源统计

下面表格展开响应示例中 data.model.source_counts 对象；每一行是该对象的一个字段。

字段	类型	说明
`files`	integer	文件来源数量。
`tables`	integer	表来源数量。
`total`	integer	来源总数。

数据域

下面表格展开响应示例中 data.data_domain 对象；每一行是该对象的一个字段。

字段	类型	说明
`model_id`	integer	知识库 ID。
`catalog_id`	integer	Catalog ID。
`database_id`	integer	数据库 ID。
`raw_volume_id`	integer	原始文件卷 ID。
`processed_volume_id`	integer	处理结果卷 ID。
`ensure_status`	string	数据域准备状态。
`last_ensure_error`	string 或 null	最近确保错误。
`last_checked_at`	integer	最近检查时间。

后续操作¶

使用 data.model.id 上传本地文件或添加数据源。

最后更新于 2026 年 9 月 11 日