向量数据库 hybridSearch-SDK 参考-文档中心-腾讯云

Method 与 URL
稠密向量与稀疏向量混合相似性检索：POST https://{实例访问 IP 地址}:{实例网络端口}/document/hybridSearch。
使用示例
Weighted 加权 Rerank 排序
RRF 排序
curl -i -X POST \\
  -H 'Content-Type: application/json' \\
  -H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\
  http://10.0.X.X:80/document/hybridSearch \\
  -d '{
    "database": "db-test",
    "collection": "book-vector",
    "search": {
        "ann": [
          {
              "fieldName": "vector",
              "data": [[0.3123, 0.43, 0.213]],
              "params": {
                  "ef": 200
              },
                "limit": 10
          }
        ],
       "match": [{
               "fieldName": "sparse_vector",
               "data": [[[2, 0.9611]]],
               "limit": 10
        }],
       "rerank": {
                "method": "weighted",
                "fieldList": ["vector", "sparse_vector"],
                "weight": [0.9, 0.1]
        },
        "limit": 3,
        "retrieveVector": false,
        "filter": "bookName in (\\"三国演义\\",\\"西游记\\")",
        "outputFields": [
            "id",
            "author",
            "bookName"
        ]
    }
}'  
curl -i -X POST \\
  -H 'Content-Type: application/json' \\
  -H 'Authorization: Bearer account=root&api_key=xB2iQyVVFy9AtEFswF4ohQPoxUYok0zcxPfN3Bj9' \\
  http://10.0.xx.xx:80/document/hybridSearch \\
  -d '{
    "database": "db-test",
    "collection": "book-vector",
    "search": {
        "ann": [
          {
              "fieldName": "vector",
              "data": [[0.3123, 0.43, 0.213]],
              "params": {
                  "ef": 200
              },
                "limit": 10
          }
        ],
       "match": [{
               "fieldName": "sparse_vector",
               "data": [[[2, 0.9611]]],
               "limit": 10
        }],
       "rerank": {
                "method": "rrf",
                "k": 1
        },
        "limit": 3,
        "retrieveVector": false,
        "filter": "bookName in (\\"三国演义\\",\\"西游记\\")",
        "outputFields": [
            "id",
            "author",
            "bookName"
        ]
    }
}'  
入参描述
参数名称
参数含义
子参数
是否必选
配置方法及要求
database
指定要查询的Database 名称。
-
是
获取集群中的数据库列表，复制需查询数据的集合所属的数据库名。
collection
指定要查询的Collection 名称。
-
是
获取集群中的集合列表，复制需查询数据的集合名。
readConsistency
设置检索数据的一致性要求。
-
否
取值如下所示：
strongConsistency：强一致性。
eventualConsistency：最终一致性。
search
配置检索条件
ann
是
配置检索信息。
fieldName：检索的字段名，可以设置为：vectors、id。只能选择其中之一。
data：检索的向量列表，当前仅支持输入一个向量。
documentIds：在 fieldName 为 id 时，设置检索的 ID 列表。例如："documentIds": ["0001"], 其中仅支持输入一个 ID。
params：检索参数，与索引类型相关。
HNSW 类型：需配置参数 ef，指定需要访问向量的数目。取值范围[1,32768]，默认为10。
IVF 系列：需设置参数 nprobe ，指定所需查询的单位数量。取值范围[1,nlist]，其中 nlist 在创建 Collection 时已设置。
﻿
﻿
match
否
稀疏向量检索配置。
fieldName：检索的字段名，例如：sparse_vector。
data：检索的稀疏向量，仅支持输入一个。
limit：指定返回的数量。
﻿
﻿
rerank
否
检索中重排序（rerank）的配置。参数 method 指定 Rerank 的方法，枚举如下值：
weighted：基于不同字段的加权组合来进行排序。
fieldList：列出用于加权计算的字段列表。例如，"fieldList": ['vector', 'sparse_vector']表示密集型与稀疏型加权计算。
weight：定义了 "fieldList" 中每个字段的权重，例如，"weight": [0.9, 0.1]表示"vector" 字段的权重是 0.9，"sparse_vector" 字段的权重是 0.1。
rrf：一种融合多个搜索方法的排名结果，通过为每个文档分配倒数排名分数并合并这些分数来生成一个新的综合排名，从而提高搜索结果的准确性和相关度。k 是一个用于计算倒数排名分数的常数，其作用是调整分数计算公式，以控制排名分数的分布。默认值为60。
﻿
﻿
filter
否
设置标量字段的 Filter 表达式。格式为 <field_name><operator><value>，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见 混合检索。其中： 
<field_name>：表示要过滤的字段名。
<operator>：表示要使用的运算符。
string ：匹配单个字符串值（=）、排除单个字符串值（!=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。
uint64：大于（>）、大于等于（>=）、等于（=）、小于（<）、小于等于（<=）。例如：expired_time > 1623388524。
array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。
<value>：表示要匹配的值。
示例：Filter('author="jerry"').And('page>20')
﻿
﻿
retrieveVector
否
标识是否需要返回检索结果的向量值。
true：需要。
false：不需要。默认为 false。
﻿
﻿

radius

否
指定相似性检索的半径范围。每一种相似性计算方法的检索半径范围如下所示。
IP：检索结果返回满足 score>=radius 的数据，此时，radius 取值范围为 (-∞, +∞)。
COSINE：检索结果返回满足 score>=radius 的数据。此时，radius 取值范围为 [-1, 1]
L2：检索结果返回满足 score<=radius 的数据。此时，radius 取值范围为 [0, +∞)
说明：
支持的索引类型为：FLAT、IVF 系列。
检索结果将限定在指定的检索半径内，并根据您设置的 'limit' 参数值来确定返回结果的数量。
﻿
﻿
limit
是
指定返回最相似的 Top K 条数据的 K 的值。K为大于0 的正整数。
﻿
﻿
outputFields
否
指定需要输出的字段。若不设置，将返回所有字段。
说明：
retrieveVector 和 outputFields 只要有其中一个配置输出向量字段即可输出 vector。
出参描述
{
  "code": 0,
  "msg": "Operation success",
  "documents": [
    [
      {
        "id": "0001",
        "score": 0.28551,
        "bookName": "三国演义",
        "author": "罗贯中"
      },
      {
        "id": "0002",
        "score": 0.28264,
        "bookName": "西游记",
        "author": "吴承恩"
      }
    ]
  ]
}
参数名
子参数
参数含义
documents
id
Document 的 ID 信息。
﻿
vector
Document 的向量值。
﻿
score
表示查询向量与检索结果向量之间的相似性计算分数。
﻿
other_scalar_field
Document 其他自定义的标量字段。例如：author、bookName、page 等。

参数名称	参数含义	子参数	是否必选	配置方法及要求
database	指定要查询的Database 名称。	-	是	获取集群中的数据库列表，复制需查询数据的集合所属的数据库名。
collection	指定要查询的Collection 名称。	-	是	获取集群中的集合列表，复制需查询数据的集合名。
readConsistency	设置检索数据的一致性要求。	-	否	取值如下所示： strongConsistency：强一致性。 eventualConsistency：最终一致性。
search	配置检索条件	ann	是	配置检索信息。 fieldName：检索的字段名，可以设置为：vectors、id。只能选择其中之一。 data：检索的向量列表，当前仅支持输入一个向量。 documentIds：在 fieldName 为 id 时，设置检索的 ID 列表。例如：`"documentIds": ["0001"],` 其中仅支持输入一个 ID。 params：检索参数，与索引类型相关。 HNSW 类型：需配置参数 ef，指定需要访问向量的数目。取值范围[1,32768]，默认为10。 IVF 系列：需设置参数 nprobe ，指定所需查询的单位数量。取值范围[1,nlist]，其中 nlist 在创建 Collection 时已设置。
				match	否	稀疏向量检索配置。 fieldName：检索的字段名，例如：sparse_vector。 data：检索的稀疏向量，仅支持输入一个。 limit：指定返回的数量。
				rerank	否	检索中重排序（rerank）的配置。参数 method 指定 Rerank 的方法，枚举如下值： weighted：基于不同字段的加权组合来进行排序。 fieldList：列出用于加权计算的字段列表。例如，`"fieldList": ['vector', 'sparse_vector']`表示密集型与稀疏型加权计算。 weight：定义了 "fieldList" 中每个字段的权重，例如，`"weight": [0.9, 0.1]`表示"vector" 字段的权重是 0.9，"sparse_vector" 字段的权重是 0.1。 rrf：一种融合多个搜索方法的排名结果，通过为每个文档分配倒数排名分数并合并这些分数来生成一个新的综合排名，从而提高搜索结果的准确性和相关度。k 是一个用于计算倒数排名分数的常数，其作用是调整分数计算公式，以控制排名分数的分布。默认值为60。
				filter	否	设置标量字段的 Filter 表达式。格式为 <field_name><operator><value>，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见混合检索。其中： <field_name>：表示要过滤的字段名。 <operator>：表示要使用的运算符。 string ：匹配单个字符串值（=）、排除单个字符串值（!=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。 uint64：大于（>）、大于等于（>=）、等于（=）、小于（<）、小于等于（<=）。例如：expired_time > 1623388524。 array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。 <value>：表示要匹配的值。示例：`Filter('author="jerry"').And('page>20')`
				retrieveVector	否	标识是否需要返回检索结果的向量值。 true：需要。 false：不需要。默认为 false。
				radius	否	指定相似性检索的半径范围。每一种相似性计算方法的检索半径范围如下所示。 IP：检索结果返回满足 score>=radius 的数据，此时，radius 取值范围为 (-∞, +∞)。 COSINE：检索结果返回满足 score>=radius 的数据。此时，radius 取值范围为 [-1, 1] L2：检索结果返回满足 score<=radius 的数据。此时，radius 取值范围为 [0, +∞) 说明：支持的索引类型为：FLAT、IVF 系列。检索结果将限定在指定的检索半径内，并根据您设置的 'limit' 参数值来确定返回结果的数量。
				limit	是	指定返回最相似的 Top K 条数据的 K 的值。K为大于0 的正整数。
				outputFields	否	指定需要输出的字段。若不设置，将返回所有字段。说明： retrieveVector 和 outputFields 只要有其中一个配置输出向量字段即可输出 vector。

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

hybridSearch

本页目录：

Method 与 URL

使用示例

入参描述

出参描述