查询任务内知识表结构

查询任务内知识表结构。

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

调用前准备

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

请求体

curl -X POST "${MOI_ENDPOINT%/}/semantic-models/runtime/describe-tables" \
  -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" --arg TABLE_NAME "$TABLE_NAME" '
{
  "request_id": $REQUEST_ID,
  "table_names": [
    $TABLE_NAME
  ],
  "include_samples": 1,
  "max_ddl_chars": 4000
}
')"

先读取结构、语义条目和约束,再构造只读查询。返回样本只是有限样本,不证明全部数据的分布。

字段

类型

是否必填

说明

request_id

string

是

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

table_names

string(字符串数组)

否

只允许当前绑定范围内的表;省略时选择范围内表。

keywords

string(字符串数组)

否

筛选相关语义条目。

include_samples

integer

否

非负样本行数;最多按 1000 行取样。

max_ddl_chars

integer

否

非负 DDL 文本长度限制。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "call_id": "request_example",
    "output": {
      "tables": []
    }
  }
}

字段

类型

说明

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.tables

array

当前选择的表结构。

错误响应

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

最后更新于