第九章 SQL Search REST 接口

文章目录

• [第九章 SQL Search REST 接口](#第九章 SQL Search REST 接口)
• [用于`SQL Search`的`REST`语法](#用于SQL Search的REST语法)
• 搜索参数

第九章 SQL Search REST 接口

用于SQL Search的REST语法

SQL Search提供REST API来访问SQL Search索引结果。

终结点语法为"/table/:TableName/search"，其中TableName是包含至少一个SQL搜索索引的表。

示例访问路径如下所示

http://localhost:443/api/iKnow/v1/user/table/iFind.Table/search.

需要使用"POST"来访问终结点。可以将搜索参数作为JSON对象放在请求正文中。

搜索参数

以下是支持的参数：

{      "query":"string",   "index":"string",   "option": 0,   "distance": "string",   "language":"string",   "includeText": 0,   "columns": ["string"],   "highlightSpec": {      "tag": "<b>",      "limit": 0,      "name": "Highlighted"      },   "rankSpec": {      "name": "Rank"     } 

• "query"指定 SQL 搜索查询。
• "index"指定要搜索的 SQL 搜索索引。如果不指定索引，SQL 搜索将使用找到的第一个索引。
• "option"是一个整数，指定要执行的搜索类型。可用值包括 0（语法搜索）、1（带词干的语法搜索）、2（带分解和词干的语法搜索）、3（带模糊搜索的语法搜索）和 4（带正则表达式的语法搜索）。
• "language"指定一个两个字符的字符串，该字符串指定文本的语言。例如，"en"指定英语。
• "includeText"和"column"指定要返回的列。当"includeText"指定为1时，返回由SQL搜索索引索引的字段。可以使用"columns"将其他列名称指定为 JSON 字符串数组。
  - "highlightSpec {name}"指定突出显示列的列别名。
• "rankSpec {name}"指定排名列的列别名。

返回的结果格式为JSON对象。返回的行采用"rows"JSON 数组的格式：{ "rows":[{},{},{}] }。