检索任务内文本证据

检索任务内文本证据。

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

调用前准备

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

请求体

curl -X POST "${MOI_ENDPOINT%/}/semantic-models/runtime/search" \
  -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 KNOWLEDGE_QUERY "$KNOWLEDGE_QUERY" '
{
  "request_id": $REQUEST_ID,
  "keywords": [
    $KNOWLEDGE_QUERY
  ],
  "max_hits": 3,
  "before": 2,
  "after": 1
}
')"

文本证据和完整段落在 artifacts 的原始对象中保留。output 可能是有界视图;不要只用摘要登记完整读取。source_page 不做语义排序,按 output.source_page.has_more/next_cursor 继续;不得混入普通字段。

字段

类型

是否必填

说明

request_id

string

是

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

keywords

string(字符串数组)

条件必填

普通检索提供有效关键词;source_page 模式不提供。

max_hits

integer

条件必填

普通检索必须大于 0。

file_ids

string(字符串数组)

否

限于当前任务允许来源。

volume_id

string

否

限于绑定的卷范围。

max_rows

integer

否

非负的检索行数限制。

before

integer

否

非负的前文展开量。

after

integer

否

非负的后文展开量。

fulltext_only

boolean

否

使用全文索引,不启用向量候选。

source_page

object

否

顺序列举同一来源的启用段落;与普通检索字段互斥。

source_page.semantic_model_id

integer

条件必填

来源实际返回的模型 ID。

source_page.file_id

string

条件必填

同一来源的文件 ID。

source_page.cursor

string

否

返回的 next_cursor 原值。

source_page.page_size

integer

否

0/省略使用 20,最大 100,不接受负数。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "call_id": "request_example",
    "output": {
      "chunks": [],
      "row_count": 0
    }
  }
}

字段

类型

说明

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

array

当前文本结果视图;完整证据同时保存在产物中。

data.output.row_count

integer

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

错误响应

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

最后更新于