You need to enable JavaScript to run this app.
导航

search

最近更新时间2023.12.07 19:34:44

首次发布时间2023.11.09 18:59:55

概述

search 用于在当前 Index 进行检索,支持向量检索、标量检索、混合检索。

  • 当请求参数 order 配置为向量 VectorOrder 对象中的 vector 字段,表示根据向量字段名称进行向量检索。
    • filter 参数配置时,表示混合检索。
    • filter 参数没有配置时,表示基于向量字段名称的纯向量检索。
  • 当请求参数 order 配置为向量 VectorOrder 对象中的主键 id,表示根据主键 id 进行向量检索。
    • filter 参数配置时,表示混合检索。
    • filter 参数没有配置时,表示基于主键 id 的纯向量检索。
  • 当请求参数 order 配置为标量 ScalarOrder 对象中的 field_name 和 order,表示根据标量字段名称进行标量排序检索。filter 参数可选配置,均表示标量检索。

说明

Collection 数据写入/删除后,Index 数据更新时间最长滞后 20s,不能立即在 Index 检索到。

请求参数

参数

类型

是否必选

默认值

参数说明

order

map

指定向量 VectorOrder 对象或者标量 ScalarOrder 对象,两者二选一进行配置。

  • VectorOrder:参数 vector 和 id 两者二选一进行配置。
    • vector:向量字段名称,该场景即 search_by_vector,根据向量字段名称,搜索与其相似的向量。
    • id:主键 id,该场景即 search_by_id,根据主键 id,搜索与其相似的向量。
  • ScalarOrder:参数 field_name 和 order 需要同时配置
    • field_name:用于做排序的标量字段名称。
    • order:排序方式,Order.Asc(升序)、Order.Desc(降序)。

filter

map

过滤条件,详见 filter 表达式说明。

  • 默认为空,不做过滤。
  • 过滤条件包含 must、must_not、range、range_out、georange 五类查询算子,包含 and 和 or 两种对查询算子的组合。

limit

int

10

检索结果数量,最大5000个。

output_fields

list<string>

过滤标量字段,指定要返回的标量字段列表。

  • output_fields 不传时,返回所有的标量字段。
  • output_fields 为空列表时,不返回 fields 字段。
  • output_fields 格式错误或者过滤字段不是 collection 里的字段时, 接口返回错误。

partition

string/int

"default"

子索引名称,类型与 partition_by 的 field_type 一致,字段值对应 partition_by 的 field_value。

  • field_type 为 int64,list<int64> 时,partition 输入类型为 int64。
  • field_type 为 string,list<string> 时,partition 输入类型为 string,格式要求 "^[a-zA-Z0-9._]+$"。

filter 表达式

算子

算子说明

示例

must

针对指定字段名生效,语义为必须在 [...] 之中,即 "must in"。

{
  "op": "must",
  "field": "region",
  "conds": ["cn", "sg"]
}

must_not

针对指定字段名生效,语义为必须不在 [...] 之中,即 "must not in"。

{
  "op": "must_not",
  "field": "data_type",
  "conds": [1,2,3]
}

range

针对指定字段名生效,语义为必须在指定范围内。
配置使用gte(大于等于), gt(大于), lte(小于等于), lt(小于),用以圈定一维范围。
另外,支持用 centerradius 表示二维圆内范围。

// price 在 [100.0, 500.0)
{
  "op": "range",
  "field": "price",
  "gte": 100.0,
  "lt": 500.0
}

//price >= 100.0
{
  "op": "range",
  "field": "price",
  "gte": 100.0
}

// 以 center 为中心,半径为50的圆内
{
  "op": "range",
  "field": ["pos_x", "pos_y"],
  "center": [100.0, 123.4],
  "radius": 50.0
}

range_out

针对指定字段名生效,语义为必须在指定范围外。配置使用gte(大于等于), gt(大于), lte(小于等于), lt(小于),用以圈定一维范围。

// 筛选价格低于100或高于500的商品
{
  "op": "range_out",
  "field": "price",
  "gt": 500.0,
  "lt": 100.0
}

georange

支持地理距离范围筛选 。
指定经纬度字段,以center为中心,筛选出地表距离在radius范围内的数据。

// 距离center地表距离 radius 内
{
  "op": "georange",
  "field": ["longitude", "latitude"],
  "center": [100.12312, 22.4324],
  "radius": 50.0
}

and

逻辑算子,针对逻辑查询需求,对多个条件取交集。

{
  "op": "and",   // 算子名
  "conds": [     // 条件列表,支持嵌套逻辑算子和 must/must_not 算子
    {
      "op": "must",
      "field": "type",
      "conds": [1]
    },
    {
        ...         // 支持>=1的任意数量的条件进行组合
    }
  ]
}

or

逻辑算子,针对逻辑查询需求,对多个条件取并集。

{
  "op": "or",   // 算子名
  "conds": [    // 条件列表,支持嵌套逻辑算子和 must/must_not 算子
    {
      "op": "must",
      "field": "type",
      "conds": [1]
    },
    {
        ...      // 支持>=1的任意数量的条件进行组合
    }
  ]
}

示例

请求参数

index = vikingdb_service.get_index("example", "example_index")
def gen_random_vector(dim):
    res = [0, ] * dim
    for i in range(dim):
        res[i] = random.random() - 0.5
    return res
res = index.search(order=VectorOrder(gen_random_vector(10), "1"), limit=2,
                   output_fields=["doc_id", "like", "text_vector"],
                   partition="1", filter={"op": "range", "field": "price", "lt": 3.5})

返回值

Python 调用执行上面的任务,返回 List<Data> 。Data 实例包含的属性如下表所示。

属性

说明

id

主键 id。

fields

请求返回中的 fields 字段,是具体的数据,字典类型。

score

表示找到的向量和输入的向量的匹配程度。