查询任务内结构化知识

执行当前任务授权范围内的只读结构化查询。

POST https://api.moi.matrixorigin.cn/v5/semantic-models/runtime/query

调用前准备

仅在当前任务执行环境使用注入的服务地址、技术凭据、工作区和短期授权;保留授权头原值。普通 PAT 不能替代任务身份或建立授权。示例使用 jq;变量、对象与状态见公共说明。

请求体

curl -X POST "${MOI_ENDPOINT%/}/semantic-models/runtime/query" \
  -H "X-API-Key: $MOI_API_KEY" \
  -H "X-Workspace-ID: $MOI_WORKSPACE_ID" \
  -H "X-MOI-Runtime-Authorization: $MOI_RUNTIME_AUTHORIZATION" \
  -H 'Content-Type: application/json' \
  --data-binary "$(jq -n --arg REQUEST_ID "$REQUEST_ID" --rawfile KNOWLEDGE_SQL_FILE "$KNOWLEDGE_SQL_FILE" '
{
  "request_id": $REQUEST_ID,
  "sql": $KNOWLEDGE_SQL_FILE,
  "max_rows": 100
}
')"

SQL 文件由前一步表结构和当前问题生成,不能访问范围外表或写入。检查 truncated、行数、实际来源和 applied constraints;保存 sql_result 产物再读取与引用。

字段

类型

是否必填

说明

request_id

string

是

本次操作的唯一 ID,1–256 字节,无首尾空白,不以 audit: 开头;重放同一输入时保留原值。

sql

string

是

当前任务允许表上的只读 SELECT。

max_rows

integer

否

省略/0 使用 200,超过 1000 按 1000;负数无效。

semantic_claims

string(字符串数组)

否

实际使用的语义条目标识;不能用省略来绕过强制语义约束。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "call_id": "request_example",
    "output": {
      "artifact_id": "sql_result_example",
      "sql": "SELECT 1 AS value",
      "db_name": "example",
      "columns": [
        "value"
      ],
      "rows": [
        [
          1
        ]
      ],
      "row_count": 1,
      "max_rows": 100,
      "table_names": []
    }
  }
}

字段

类型

说明

code

string

成功时为 OK。

msg

string

响应说明。

data.call_id

string

对应原 request_id。

data.failed

boolean

true 表示业务失败;false 时可省略。

data.output

object

当前操作结果。

data.artifacts

object(对象数组)

同一任务的原始产物与证据。

data.metadata

object

操作元数据,存在时返回。

data.output.artifact_id

string

当前操作返回的原始值,按公共对象说明保留。

data.output.sql

string

当前操作返回的原始值,按公共对象说明保留。

data.output.db_name

string

当前操作返回的原始值,按公共对象说明保留。

data.output.columns

array

查询结果列名。

data.output.rows

array

查询结果行。

data.output.row_count

integer

当前操作结果行数或命中数。

data.output.max_rows

integer

当前操作返回的原始值,按公共对象说明保留。

data.output.table_names

array

当前操作返回的原始值,按公共对象说明保留。

错误响应

按 HTTP 状态、业务结果和错误字段处理,见错误与环境。来源与版本冲突时读取当前状态,不替换身份、资源或请求 ID 自动重试。

最后更新于