搜索文档

对项目中的文档进行语义搜索

POST /openapi/memorylake/api/v1/projects/{id}/documents/search

对项目中的所有文档执行语义搜索。返回按相关性排序的匹配内容。结果分为三种类型 —— table、paragraph 和 figure —— 每种通过 type 字段标识。

所需权限： project:doc_search · instance

路径参数

id · string · required

项目 ID

请求体

query · string · required

搜索查询文本

top_n · integer · default: "10"

返回的最大结果数（最小为 1）

cURL

curl -X POST 'https://app.memorylake.cn/openapi/memorylake/api/v1/projects/proj-a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6/documents/search' \
  -H 'Authorization: Bearer sk_xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "What were the quarterly sales figures in 2024?",
    "top_n": 10
  }'

响应

data · object

Show 搜索结果

count · integer

实际返回的结果数量

results · array

按相关性排序的搜索结果。每个条目是一个可区分的联合类型 —— type 决定了哪些变体字段存在，以及 highlight 的哪个子字段会被填充。点击展开完整的条目结构。

Show 结果条目

type · string · required

区分符。取值为 paragraph、table 或 figure 之一。

document_id · string

文档 ID

document_name · string

文档文件名，例如 report_2024.xlsx

source_document · object

源文件信息。

Show source_document 属性

file_name · string

原始文件名

highlight · object

匹配的内容。该对象始终包含以下三个可选字段 —— 恰好有一个被填充，由父条目的 type 决定。

Show highlight 属性

chunks · Chunk[]

当 type=paragraph 时填充。匹配的文本片段，按文档顺序排列。其他情况下不存在。

Show Chunk 属性

text · string

匹配内容的纯文本片段

range · string

位置提示（例如页码 p12，或工作簿段落的单元格范围）

inner_tables · InnerTable[]

当 type=table 时填充。源表区域内匹配的子表。其他情况下不存在。

Show InnerTable 属性

id · string

内部表 ID

data_range · string

覆盖的单元格范围，例如 A1:D50

num_rows · integer

数据行数

persist_path · string

物化表的内部存储路径

columns · TableColumn[]

列描述符。

Show TableColumn 属性

id · string

列 ID

name · string

列标题名称

data_type · string

推断的数据类型（例如 string、number、date）

range · string

列单元格范围

count · integer

非空值数量

null_count · integer

空值数量

approx_ndv · integer

近似不同值数量

min_value · string

最小值（字符串编码）

max_value · string

最大值（字符串编码）

examples · object[]

列中的示例原始值

display_examples · object[]

示例格式化/显示值

semantic_comment · string

模型推断的列语义注释

has_hierarchy · boolean

该列是否参与行层级结构

figure · object

当 type=figure 时填充。匹配的图片描述符。其他情况下不存在。

Show figure 属性

caption · string

原始图片标题

text · string

图片中 OCR / 提取的文本

summary_text · string

模型生成的图片摘要

prequestion_list · string[]

预生成的该图片可以回答的问题

persist_path · string

图片资源的内部存储路径

paragraph_block_id · string

仅当 type=paragraph 时存在。 文档中的段落块 ID。

table_id · string

仅当 type=table 时存在。 表实体 ID。

title · string

仅当 type=table 时存在。 表标题。

footnote · string

仅当 type=table 时存在。 表脚注。

sheet_name · string

仅当 type=table 时存在。 工作表名称（工作簿表格）。

semantic_sheet_name · string

仅当 type=table 时存在。 模型推断的工作表语义名称。

semantic_comment · string

仅当 type=table 时存在。 模型推断的工作表语义注释。

table_region_info · string

仅当 type=table 时存在。 表区域位置，例如 A1:D50。

figure_id · integer

仅当 type=figure 时存在。 图片数字 ID。

Success (200)

{
  "success": true,
  "data": {
    "count": 3,
    "results": [
      {
        "type": "paragraph",
        "document_id": "doc-123",
        "document_name": "report_2024.pdf",
        "paragraph_block_id": "blk-456",
        "highlight": {
          "chunks": [
            {
              "text": "Q1 2024 sales reached $2.5M...",
              "range": "p12"
            }
          ]
        },
        "source_document": {
          "file_name": "report_2024.pdf"
        }
      },
      {
        "type": "table",
        "document_id": "doc-789",
        "document_name": "sales_data.xlsx",
        "table_id": "tbl-001",
        "title": "Quarterly Sales Summary",
        "sheet_name": "Sheet1",
        "table_region_info": "A1:D50",
        "highlight": {
          "inner_tables": [...]
        },
        "source_document": {
          "file_name": "sales_data.xlsx"
        }
      }
    ]
  }
}