Skip to content

端点

/api/search/fullTextSearchBlock

全文搜索块

需要认证

接口描述

全文搜索所有块内容,支持各种搜索条件和过滤选项。可以按关键词、查询语法、SQL或正则表达式进行搜索,并支持按创建时间、更新时间等排序。

请求参数

参数名类型必选描述
querystring搜索关键词
pagenumber页码,从1开始,默认为1
typesarray块类型过滤,如 ["d","h","p","c"] 等,不填则搜索所有类型
pathsarray路径过滤,可以指定在哪些路径下搜索
methodnumber搜索方式,0: 关键字,1: 查询语法,2: SQL,3: 正则表达式,默认为0
orderBynumber排序方式,0: 相关度,1: 创建时间,2: 更新时间,3: 内容长度,默认为0
groupBynumber分组方式,0: 不分组,1: 按文档分组,默认为0

返回值

参数名类型描述
codenumber返回码,0表示成功
msgstring返回信息
dataobject返回数据
data.blocksarray匹配到的块列表
data.blocks[].idstring块ID
data.blocks[].contentstring块内容
data.blocks[].typestring块类型
data.blocks[].pathstring块路径
data.blocks[].hPathstring人类可读的块路径
data.blocks[].createdstring创建时间
data.blocks[].updatedstring更新时间
data.matchedBlockCountnumber匹配的块总数
data.pageCountnumber总页数

请求示例

返回示例

请求示例

POST /api/search/fullTextSearchBlock HTTP/1.1
Host: 127.0.0.1:6806
Content-Type: application/json
Authorization: Token your-token

{
  "query": "思源笔记",
  "page": 1,
  "types": ["p", "h"],
  "paths": ["/20210808180117-czj9bvb"],
  "method": 0,
  "orderBy": 1,
  "groupBy": 0
}

返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "blocks": [
      {
        "id": "20220301153724-r5zsw01",
        "content": "思源笔记是一款本地优先的个人知识管理系统",
        "type": "p",
        "path": "/20210808180117-czj9bvb/20220301153724-r5zsw01",
        "hPath": "/教程/思源笔记简介",
        "created": "20220301153724",
        "updated": "20220301153724",
        "rootID": "20210808180117-czj9bvb",
        "box": "data",
        "depth": 1,
        "children": []
      },
      {
        "id": "20220301154213-w6f4xj9",
        "content": "思源笔记的技术架构",
        "type": "h",
        "path": "/20210808180117-czj9bvb/20220301154213-w6f4xj9",
        "hPath": "/教程/思源笔记架构",
        "created": "20220301154213",
        "updated": "20220301154213",
        "rootID": "20210808180117-czj9bvb",
        "box": "data",
        "depth": 1,
        "children": []
      }
    ],
    "matchedBlockCount": 2,
    "pageCount": 1
  }
}