order

map

否

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

• VectorOrder：参数 Vector 和 Id 两者二选一进行配置。
  • Vector：向量字段名称，该场景即 SearchByVector，根据向量字段名称，搜索与其相似的向量。
  • Id：主键 id，该场景即 SearchById，根据主键 id，搜索与其相似的向量。

• ScalarOrder：参数 FieldName 和 Order 需要同时配置。
  • FieldName：用于做排序的标量字段名称。
  • Order：排序方式，Order.Asc（升序）、Order.Desc（降序）。

searchOptions

filter

map

否

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

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

limit

int

否

10

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

outputFields

list<string>

否

过滤字段，指定要返回的标量或向量字段列表。

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

如果索引的距离方式为cosine，向量字段返回的向量是归一化后的向量。

partition

string/int

否

"default"

子索引名称，类型与 partitionBy 的 FieldType 一致，字段值对应 partitionBy 的 FieldValue。

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

dense_weight

float

否

0.5

对于标量过滤检索，dense_weight 用于控制稠密向量在检索中的权重。范围为[0.2，1]。仅在检索的索引为混合索引时有效。

sparse_vectors

map

否

稀疏向量，格式是字典，k 为 string 类型，表示关键词的字面量，v 为 float 类型，表示该关键词的权重数值。

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（小于），用以圈定一维范围。
另外，支持用 center 和 radius 表示二维圆内范围。

// 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
}

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的任意数量的条件进行组合
    }
  ]
}

Id

主键 id。

Fields

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

Score

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