导出语义条目

导出知识库定义和语义条目,用于审阅或迁移。

GET https://moi.matrixorigin.cn/newmoi/semantic-models/{model_id}/export

调用前准备

查询知识库列表取得知识库 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:目标工作区 ID,通过 X-Workspace-ID Header 传递。

  • $MODEL_ID:要导出定义的知识库 ID。

路径参数

参数

类型

说明

model_id

integer

要导出定义的知识库 ID。

请求示例

curl "https://moi.matrixorigin.cn/newmoi/semantic-models/$MODEL_ID/export" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

成功时返回 200。迁移前先导出当前状态,并确认导入目标没有语义条目。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "model": {
      "id": 401,
      "name": "product_docs",
      "source_counts": {
        "files": 2,
        "tables": 1,
        "total": 3
      }
    },
    "entries": [
      {
        "id": 501,
        "kind": "metric",
        "key": "total_rows",
        "tables": ["orders"],
        "spec": {
          "expr": "COUNT(*)"
        }
      }
    ]
  }
}

响应字段如下。

字段路径中的 [] 表示数组中的每一项。例如,data.entries[].id 表示 data.entries 数组中每一项的 id 字段。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.model

object

知识库定义。

data.model.id

integer

知识库 ID。

data.model.name

string

知识库名称。

data.model.source_counts

object

来源数量统计。

data.entries

object(对象数组)

当前知识库中的语义条目。

data.entries[].id

integer

条目 ID。

data.entries[].kind

string

条目类型。

data.entries[].key

string

稳定引用键。

data.entries[].tables

array[string]

关联表名称;未设置时可能省略。

data.entries[].spec

object

data.entries[].kind 对应的类型专属配置对象;字段见创建语义条目

错误响应

{
  "code": "ErrNotFound",
  "msg": "resource not found",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

model_id 无效。

使用响应中的知识库 ID。

401

ErrUnauthorized

API Key 无效或已失效。

检查 API Key。

403

ErrForbidden

调用者没有读取权限。

检查工作区和对象授权。

404

ErrNotFound

知识库不存在或不可见。

重新确认 model_id

500

ErrServer

服务未能导出定义。

保留脱敏后的响应信息后重试。

后续操作

迁移或批量写入前,用导出结果对照没有语义条目的目标知识库,再导入语义条目

最后更新于