导入语义条目¶
向没有语义条目的知识库批量导入语义条目。
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(*)"
}
}
]
}'
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
接收导入条目的知识库 ID。 |
字段路径中的 [] 表示数组中的每一项。例如,entries[].kind 表示 entries 数组中每一项的 kind 字段。
请求体为 entries 数组;每项包含 kind、key、可选的 tables 和 spec。
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
array of object |
是 |
要导入的条目;不能为空。目标知识库不能已有语义条目。 |
下面表格展开请求示例中 entries 数组的每一项;每一行是该数组项的一个字段。
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
string |
是 |
条目类型;它决定 |
|
string |
是 |
知识库内的稳定引用键;同一请求中不能重复。 |
|
array of string |
否 |
关联表名称。 |
|
object |
是 |
|
下面表格展开请求示例中 entries[].spec 对象;仅当 entries[].kind 为 metric 时使用。
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
string |
是 |
指标的计算表达式。 |
成功响应¶
成功时返回 200。imported 为本次写入数量;随后列出条目并运行校验,不只检查 HTTP 状态。
{
"code": "OK",
"msg": "OK",
"data": {
"imported": 1,
"model_id": 401
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
object |
响应数据。 |
下面表格展开响应示例中 data 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
本次导入并写入的条目数量。 |
|
integer |
接收导入的知识库 ID。 |
错误响应¶
{
"code": "ErrConflict",
"msg": "duplicate semantic entry key",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
面向调用者的错误信息。 |
|
null |
发生错误时为 |