# 检索图纸

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

按图号精确查当前版本，或使用文字/图片检索相关图纸。返回按来源文件聚合的命中及可用的文本、页面来源证据。

```text
POST https://api.moi.matrixorigin.cn/v5/drawings/search
```

## 调用前准备

`MOI_ENDPOINT` 使用产品 API 前缀 `https://api.moi.matrixorigin.cn/v5`；专有部署填写对应的产品 API 地址。

准备目标环境个人访问令牌、工作区ID、图纸知识库ID及已完成索引的数据。工作区由X-Workspace-ID选择；需要该知识库的semantic_model.use权限。将示例42与变量替换为同环境实际值。语义检索可能调用已配置模型并产生用量；源数据、索引与模型是否实际可用须分别确认。

## 请求参数

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

```bash
curl --request POST "$MOI_ENDPOINT/drawings/search" \
  --header "X-API-Key: $AI_STUDIO_API_KEY" --header "X-Workspace-ID: $WORKSPACE_ID" \
  --header "Content-Type: application/json" \
  --data '{"knowledge_base_id":42,"drawing_number":"AB-001"}'
```

按文字进行语义检索：

```bash
curl --request POST "$MOI_ENDPOINT/drawings/search" \
  --header "X-API-Key: $AI_STUDIO_API_KEY" --header "X-Workspace-ID: $WORKSPACE_ID" \
  --header "Content-Type: application/json" \
  --data '{"knowledge_base_id":42,"query":"带法兰的接头","top_k":8}'
```

以本地图片检索；不要手动设置multipart的boundary：

```bash
curl --request POST "$MOI_ENDPOINT/drawings/search" \
  --header "X-API-Key: $AI_STUDIO_API_KEY" --header "X-Workspace-ID: $WORKSPACE_ID" \
  --form "knowledge_base_id=42" --form "top_k=8" --form "file=@$QUERY_IMAGE"
```

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

[请求字段及三种检索方式](search-inputs.md)区分JSON与multipart、图号优先及top_k限制。
:::::
::::::
:::::::

## 成功响应

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

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "drawings": [
      {
        "source_file_id": "source-example",
        "drawing_id": "cad-example",
        "score": 0.9,
        "best_hit": {
          "source_file_id": "source-example",
          "score": 0.9,
          "text_id": "text-example",
          "text_kind": "dimension",
          "canonical_text": "标注：0±0.1",
          "recognition_status": "partial",
          "status_reasons": [
            "candidate_only"
          ],
          "coordinate_space": "source_page_px",
          "source_refs": [
            {
              "artifact": "report-example",
              "json_pointer": "/metadata/ocr_text",
              "method": "crop_ocr"
            }
          ],
          "structured_refs": [
            "dimension-example"
          ],
          "dimension_candidate": {
            "text_id": "text-example",
            "nominal": 0,
            "value_min": -0.1,
            "value_max": 0.1,
            "unit": "mm",
            "raw_text": "0±0.1",
            "authority": "candidate"
          }
        },
        "supporting_hits": [],
        "external_source_uri": null,
        "visual_manifest_file_id": null,
        "provenance_status": "legacy_unmigrated",
        "gaps": [
          "drawing_provenance_unmigrated"
        ],
        "pages": null
      }
    ],
    "count": 1,
    "match_mode": "semantic",
    "diagnostics": {
      "total_ms": 1,
      "plan_ms": 0,
      "merge_ms": 0,
      "aggregate_ms": 0,
      "channels": [
        "text_l1"
      ],
      "candidate_hit_count": 1,
      "unique_drawing_count": 1,
      "result_count": 1,
      "identifier_route_used": false,
      "identifier_hit_count": 0,
      "identifier_filename_hit_count": 0,
      "identifier_l1_hit_count": 0,
      "vector_hit_count": 1
    }
  }
}
```

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| code | string | 成功为OK。 |
| msg | string | 成功为OK。 |
| data.drawings | object（对象数组） | 来源文件聚合的命中。完整对象/证据/诊断见[返回字段](drawing-results.md)。 |
| data.count | integer | 本次返回的图纸条数，不是全库或可分页总数。 |
| data.match_mode | string | exact或semantic；部分空结果路径可省略。 |
| data.diagnostics | object | 当次检索诊断，不作召回覆盖或权限证明。 |

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

## 错误响应

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

```json
{
  "code": "ErrDrawingCurrentUnavailable",
  "msg": "Service unavailable"
}
```

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| code | string | 如ErrParamInvalid、ErrDrawingCurrentUnavailable、ErrServiceSlotUnavailable、ErrForbidden。 |
| msg | string | 普通错误本地化消息；示例为英文。计费准入拒绝采用数字code/message及reason等诊断，见[相关接口](index.md)。 |

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