更新语义条目

使用完整条目定义更新一个语义条目。

PUT https://moi.matrixorigin.cn/newmoi/semantic-models/{model_id}/entries/{entry_id}

调用前准备

查询语义条目读取原条目,取得条目 ID 和现有定义,避免遗漏现有字段。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求体

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

字段

类型

必填

说明

model_id

integer

知识库 ID。

entry_id

integer

要更新的语义条目 ID。

更新使用完整替换语义。重新提交 kindkeyspec;需要保留关联表时,也重新提交 tables。已创建条目的 kind 不可更改。

字段

类型

必填

说明

kind

string

条目类型;必须与现有条目的类型一致,并决定 spec 的结构。

key

string

知识库内的稳定引用键。

tables

array of string

关联表名称;需要保留时重新提交。

spec

object

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

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

字段

类型

必填

说明

expr

string

指标的计算表达式。

成功响应

成功时返回 200。接口返回确认标记;如需读取最新条目定义,请重新查询条目列表。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "updated": true
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

object

本次操作的返回数据。

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

字段

类型

说明

updated

boolean

true 表示更新已完成。

错误响应

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

字段

类型

说明

code

string

错误代码。

msg

string

面向调用者的错误信息。

data

null

发生错误时为 null

后续操作

查询语义条目读取更新后的最新条目定义。

最后更新于