# 在任务内解析原文中查找文本

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

在任务内解析原文中查找文本。

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

## 调用前准备

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

## 请求体

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 输入示例

```bash
curl -X POST "${MOI_ENDPOINT%/}/semantic-models/runtime/search-document" \
  -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 MARKDOWN_FILE_ID "$MARKDOWN_FILE_ID" --arg KNOWLEDGE_QUERY "$KNOWLEDGE_QUERY" '
{
  "request_id": $REQUEST_ID,
  "markdown_file_id": $MARKDOWN_FILE_ID,
  "query": $KNOWLEDGE_QUERY,
  "max_matches": 5,
  "context_chars": 600
}
')"
```

:::::
:::::{tab-item} 参数说明

在当前有效原文投影内查找字面文本，不进行语义召回。total_matches 是总匹配数，truncated 表示返回片段不完整。

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `request_id` | string | 是 | 本次操作的唯一 ID，1–256 字节，无首尾空白，不以 audit: 开头；重放同一输入时保留原值。 |
| `markdown_file_id` | string | 是 | 原证据返回的 Markdown 定位 ID。 |
| `query` | string | 是 | 非空查询文本。 |
| `max_matches` | integer | 否 | 非正值/省略使用 5，最大 20。 |
| `context_chars` | integer | 否 | 非正值/省略使用 600，最大 2000。 |

:::::
::::::
:::::::

## 成功响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "call_id": "request_example",
    "output": {
      "markdown_file_id": "markdown_example",
      "file_name": "example.md",
      "query": "example",
      "total_chars": 0,
      "matches": [],
      "total_matches": 0,
      "truncated": false,
      "metadata": {}
    }
  }
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `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.markdown_file_id` | string | 当前操作返回的原始值，按公共对象说明保留。 |
| `data.output.file_name` | string | 当前操作返回的原始值，按公共对象说明保留。 |
| `data.output.query` | string | 当前操作返回的原始值，按公共对象说明保留。 |
| `data.output.total_chars` | integer | 当前操作返回的原始值，按公共对象说明保留。 |
| `data.output.matches` | array | 已返回的匹配位置和上下文片段。 |
| `data.output.total_matches` | integer | 原文中的总匹配数。 |
| `data.output.truncated` | boolean | 当前返回结果是否截断。 |
| `data.output.metadata` | object | 当前操作返回的原始值，按公共对象说明保留。 |

:::::
::::::
:::::::

## 错误响应

按 HTTP 状态、业务结果和错误字段处理，见[错误与环境](../../ai-studio/agents/message-connections/objects.md#错误与环境)。来源与版本冲突时读取当前状态，不替换身份、资源或请求 ID 自动重试。
