导入语义条目

向没有语义条目的知识库批量导入语义条目。

POST https://api.moi.matrixorigin.cn/v5/semantic-models/{model_id}/import

调用前准备

查询知识库列表取得知识库 ID,并确认目标知识库没有语义条目。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求体

curl -X POST "https://api.moi.matrixorigin.cn/v5/semantic-models/$MODEL_ID/import" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "entries": [
      {
        "kind": "metric",
        "key": "total_rows",
        "spec": {
          "expr": "COUNT(*)"
        }
      }
    ]
  }'

字段

类型

必填

说明

model_id

integer

接收导入条目的知识库 ID。

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

请求体为 entries 数组;每项包含 kindkey、可选的 tablesspec

字段

类型

必填

说明

entries

array of object

要导入的条目;不能为空。目标知识库不能已有语义条目。

下面表格展开请求示例中 entries 数组的每一项;每一行是该数组项的一个字段。

字段

类型

必填

说明

kind

string

条目类型;它决定 entries[].spec 的结构。

key

string

知识库内的稳定引用键;同一请求中不能重复。

tables

array of string

关联表名称。

spec

object

json.RawMessage 类型专属配置对象;仅接受 entries[].kind 对应的稳定结构。各 kind 的固定字段、join_columns[] 子字段和 sql_resultset 嵌套字段与创建语义条目相同。

下面表格展开请求示例中 entries[].spec 对象;仅当 entries[].kindmetric 时使用。

字段

类型

必填

说明

expr

string

指标的计算表达式。

成功响应

成功时返回 200imported 为本次写入数量;随后列出条目并运行校验,不只检查 HTTP 状态。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "imported": 1,
    "model_id": 401
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

object

响应数据。

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

字段

类型

说明

imported

integer

本次导入并写入的条目数量。

model_id

integer

接收导入的知识库 ID。

错误响应

{
  "code": "ErrConflict",
  "msg": "duplicate semantic entry key",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

面向调用者的错误信息。

data

null

发生错误时为 null

后续操作

查询语义条目校验语义条目,确认导入结果。

最后更新于