概述
similarity_search_with_score 用于搜索相似文本，返回结果包含 score 值。
请求参数
参数 | 子参数 | 类型 | 是否必选 | 默认值 | 参数说明 |
|---|
query | | string | 是 | | 查询文本。 |
params | filter | map | 否 | | 过滤条件，详见 filter 表达式说明。 - 默认为空，不做过滤。
- 过滤条件包含 must、must_not、range、range_out、georange 五类查询算子，包含 and 和 or 两种对查询算子的组合。
|
| limit | int | 否 | 10 | 检索结果数量，最大5000个。 |
| output_fields | list | 否 | | 过滤标量字段，指定要返回的标量字段列表。 - output_fields 不传时，返回所有的标量字段。
- output_fields 为空列表时，不返回 fields 字段。
- output_fields 格式错误或者过滤字段不是 collection 里的字段时, 接口返回错误。
|
| partition | string/int | 否 | "default" | 子索引名称，类型与 partition_by 的 field_type 一致，字段值对应 partition_by 的 field_value。 - field_type 为 int64，list 时，partition 输入类型为 int64。
- field_type 为 string，list 时，partition 输入类型为 string，格式要求 "^[a-zA-Z0-9._]+$"。
|
filter 表达式
算子 | 算子说明 | 示例 |
|---|
must | 针对指定字段名生效，语义为必须在 [...] 之中，即 "must in"。 | JSON <br> { <br> "op": "must", <br> "field": "region", <br> "conds": ["cn", "sg"] <br> } <br>
|
must_not | 针对指定字段名生效，语义为必须不在 [...] 之中，即 "must not in"。 | JSON <br> { <br> "op": "must_not", <br> "field": "data_type", <br> "conds": [1,2,3] <br> } <br>
|
range | 针对指定字段名生效，语义为必须在指定范围内。
配置使用gte（大于等于）, gt（大于）, lte（小于等于）, lt（小于），用以圈定一维范围。
另外，支持用 center 和 radius 表示二维圆内范围。 | JSON <br> // price 在 [100.0, 500.0) <br> { <br> "op": "range", <br> "field": "price", <br> "gte": 100.0, <br> "lt": 500.0 <br> } <br> <br> //price >= 100.0 <br> { <br> "op": "range", <br> "field": "price", <br> "gte": 100.0 <br> } <br> <br> // 以 center 为中心，半径为50的圆内 <br> { <br> "op": "range", <br> "field": ["pos_x", "pos_y"], <br> "center": [100.0, 123.4], <br> "radius": 50.0 <br> } <br>
|
range_out | 针对指定字段名生效，语义为必须在指定范围外。配置使用gte（大于等于）, gt（大于）, lte（小于等于）, lt（小于），用以圈定一维范围。 | JSON <br> // 筛选价格低于100或高于500的商品 <br> { <br> "op": "range_out", <br> "field": "price", <br> "gt": 500.0, <br> "lt": 100.0 <br> } <br>
|
georange | 支持地理距离范围筛选 。
指定经纬度字段，以center为中心，筛选出地表距离在radius范围内的数据。 | JSON <br> // 距离center地表距离 radius 内 <br> { <br> "op": "georange", <br> "field": ["longitude", "latitude"], <br> "center": [100.12312, 22.4324], <br> "radius": 50.0 <br> } <br>
|
and | 逻辑算子，针对逻辑查询需求，对多个条件取交集。 | JSON <br> { <br> "op": "and", // 算子名 <br> "conds": [ // 条件列表，支持嵌套逻辑算子和 must/must_not 算子 <br> { <br> "op": "must", <br> "field": "type", <br> "conds": [1] <br> }, <br> { <br> ... // 支持>=1的任意数量的条件进行组合 <br> } <br> ] <br> } <br>
|
or | 逻辑算子，针对逻辑查询需求，对多个条件取并集。 | JSON <br> { <br> "op": "or", // 算子名 <br> "conds": [ // 条件列表，支持嵌套逻辑算子和 must/must_not 算子 <br> { <br> "op": "must", <br> "field": "type", <br> "conds": [1] <br> }, <br> { <br> ... // 支持>=1的任意数量的条件进行组合 <br> } <br> ] <br> } <br>
|
示例
请求参数
query = "What did the president say about Ketanji Brown Jackson"
docs = db.similarity_search_with_score(query, {"limit": 4})
print(docs)
返回值
调用执行上面的任务，返回 List[Tuple[Document, float]]。
向量数据库VikingDB
复制全文
下载 pdf
文档反馈
问问助手