向量数据库 fullTextSearch

本接口（/document/fullTextSearch）基于稀疏向量实现全文检索，对查询词与文档内容进行匹配，并按相关度排序结果。
说明：
fullTextSearch 接口适用于定义了稀疏向量字段的集合。
Method 与 URL
POST https://{实例访问 IP 地址}:{实例网络端口}/document/fullTextSearch
使用示例
curl -i -X POST \\
  -H 'Content-Type: application/json' \\
  -H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\
  http://10.0.X.X:80/document/fullTextSearch \\
  -d '{
    "database": "db-test",
    "collection": "coll-sparse",
    "readConsistency": "eventualConsistency",
    "search": {
      "match": {
               "fieldName": "sparse_vector",
               "data": [[[2, 0.9611]]],
               "terminateAfter": 40,
               "cutoffFrequency": 5
        },
        "limit": 3,
        "retrieveVector": false,
        "outputFields": [
            "id",
            "text"
        ]
    }
}'
入参描述
参数名称
参数含义
子参数
是否必选
配置方法及要求
database
指定要查询的Database 名称。
-
是
获取集群中的数据库列表，复制需查询数据的集合所属的数据库名。
collection
指定要查询的Collection 名称。
-
是
获取集群中的集合列表，复制需查询数据的集合名。
readConsistency
设置检索数据的一致性要求。
-
否
取值如下所示：
strongConsistency：强一致性。
eventualConsistency：最终一致性。
search
配置检索参数
match
否
稀疏向量检索配置。
fieldName：检索的字段名，例如：sparse_vector。
data：检索的稀疏向量，仅支持输入一个。
limit：指定返回的数量。
terminateAfter：设置检索数量上限，即检索数量超过 terminateAfter 值之后，提前终止检索行为，可以有效的控制速率，在数据量较大的情况下，推荐经验值：4000。
cutoffFrequency：设置高频词出现的频次或频率上限，即词频大于 cutoffFrequency 的值之后，该关键词被忽略。
频数：可指定关键词出现的频数，取值为正整数，范围为[1,+∞]。
频率：可指定为关键词出现的频率，取值范围为[0,1]的小数。例如：0.8。
说明：
cutoff_frequency 可以排序阶段去掉高频词，在数据量较大的情况下（>=50w）推荐值：0.1。
﻿
﻿
filter
否
设置标量字段的 Filter 表达式。格式为 <field_name><operator><value>，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见 Filter 表达式。其中： 
<field_name>：表示要过滤的字段名。
<operator>：表示要使用的运算符。
string ：匹配单个字符串值（=）、排除单个字符串值（!=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。
uint64：大于（>）、大于等于（>=）、等于（=）、小于（<）、小于等于（<=）、等于（!=）。例如：expired_time > 1623388524。
array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。
json：json 类型的 Filter 表达式语法和 json 字段的键值类型保持一致。若访问 Json 对象中的键，使用点（.）符号连接。例如：Json 类型的字段 bookInfo ，其键 bookName 的 Filter 表达式如下所示。更多信息，请参见Json 类型表达式。
"filter": "bookInfo.bookName in (\\"三国演义\\",\\"西游记\\")"
<value>：表示要匹配的值。
﻿
﻿
retrieveVector
否
标识是否需要返回检索结果的向量值。
true：需要。
false：不需要。默认为 false。
﻿
﻿
limit
是
指定返回最相似的 Top K 条数据的 K 的值。K 为大于0的正整数。
﻿
﻿
outputFields
否
指定需要输出的字段。若不设置，将返回所有字段。
说明：
retrieveVector 和 outputFields 只要有其中一个配置输出向量字段即可输出 vector。
输出 Json 字段时，outputFields 仅支持指定 Json 字段的名称，而不支持直接指定 Json 字段内部的键（key）。例如，写入"a": {"b": "test", "c": 12}，outputFields 只能指定返回整个 "a" 字段，而无法单独指定返回 "a.b" 。
出参描述
{
  "code": 0,
  "msg": "Operation success",
  "documents": [
    [
      {
        "id": "0003",
        "sparse_vector": [
          [2, 0.9700000286102295],
          [5, 0.5400000214576721],
          [100, 0.4449999928474426]
        ],
        "score": 0.93227
      },
      {
        "id": "0002",
        "sparse_vector": [
          [2, 0.9700000286102295],
          [5, 0.5400000214576721],
          [100, 0.4449999928474426]
        ],
        "score": 0.93227
      },
      {
        "id": "0001",
        "sparse_vector": [
          [2, 0.9599999785423279],
          [5, 0.5299999713897705],
          [100, 0.4429999887943268]
        ],
        "score": 0.92266
      }
    ]
  ]
}
参数名
子参数
参数含义
documents
id
Document 的 ID 信息。
﻿
sparse_vector
Document 的稀疏向量。
﻿
score
表示查询向量与检索结果向量之间的相似性计算分数。
﻿
other_scalar_field
Document 其他自定义的标量字段。例如：author、bookName、page 等。

参数名称	参数含义	子参数	是否必选	配置方法及要求
database	指定要查询的Database 名称。	-	是	获取集群中的数据库列表，复制需查询数据的集合所属的数据库名。
collection	指定要查询的Collection 名称。	-	是	获取集群中的集合列表，复制需查询数据的集合名。
readConsistency	设置检索数据的一致性要求。	-	否	取值如下所示： strongConsistency：强一致性。 eventualConsistency：最终一致性。
search	配置检索参数	match	否	稀疏向量检索配置。 fieldName：检索的字段名，例如：sparse_vector。 data：检索的稀疏向量，仅支持输入一个。 limit：指定返回的数量。 terminateAfter：设置检索数量上限，即检索数量超过 terminateAfter 值之后，提前终止检索行为，可以有效的控制速率，在数据量较大的情况下，推荐经验值：4000。 cutoffFrequency：设置高频词出现的频次或频率上限，即词频大于 cutoffFrequency 的值之后，该关键词被忽略。频数：可指定关键词出现的频数，取值为正整数，范围为[1,+∞]。频率：可指定为关键词出现的频率，取值范围为[0,1]的小数。例如：0.8。说明： cutoff_frequency 可以排序阶段去掉高频词，在数据量较大的情况下（>=50w）推荐值：0.1。
				filter	否	设置标量字段的 Filter 表达式。格式为 <field_name><operator><value>，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见 Filter 表达式。其中： <field_name>：表示要过滤的字段名。 <operator>：表示要使用的运算符。 string ：匹配单个字符串值（=）、排除单个字符串值（!=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。 uint64：大于（>）、大于等于（>=）、等于（=）、小于（<）、小于等于（<=）、等于（!=）。例如：expired_time > 1623388524。 array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。 json：json 类型的 Filter 表达式语法和 json 字段的键值类型保持一致。若访问 Json 对象中的键，使用点（.）符号连接。例如：Json 类型的字段 bookInfo ，其键 bookName 的 Filter 表达式如下所示。更多信息，请参见Json 类型表达式。 `"filter":` `"bookInfo.bookName in (\\"三国演义\\",\\"西游记\\")"` <value>：表示要匹配的值。
				retrieveVector	否	标识是否需要返回检索结果的向量值。 true：需要。 false：不需要。默认为 false。
				limit	是	指定返回最相似的 Top K 条数据的 K 的值。K 为大于0的正整数。
				outputFields	否	指定需要输出的字段。若不设置，将返回所有字段。说明： retrieveVector 和 outputFields 只要有其中一个配置输出向量字段即可输出 vector。输出 Json 字段时，outputFields 仅支持指定 Json 字段的名称，而不支持直接指定 Json 字段内部的键（key）。例如，写入`"a": {"b": "test", "c": 12}`，outputFields 只能指定返回整个 "a" 字段，而无法单独指定返回 "a.b" 。

参数名	子参数	参数含义
documents	id	Document 的 ID 信息。
		sparse_vector	Document 的稀疏向量。
		score	表示查询向量与检索结果向量之间的相似性计算分数。
		other_scalar_field	Document 其他自定义的标量字段。例如：author、bookName、page 等。

fullTextSearch

本页目录：

Method 与 URL

使用示例

入参描述

出参描述