下载
中文
注册

search

API定义

void search(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, const SearchParameters *params) const override;

功能描述

特征向量查询接口,根据输入的特征向量返回最相似的“k”条特征的ID和对应距离。

输入

idx_t n:查询向量个数。

const uint8_t *x:查询向量。

idx_t k:需要返回的最近似的结果的个数。

const SearchParameters *params: faiss1.7.4的可选参数,默认为“nullptr”,暂不支持该参数。

输出

int32_t *distances:查询向量与距离最近的前“k”个向量间的距离值。

idx_t *labels“k”个最近向量的ID。

返回值

约束说明

  • 查询的特征向量数据“x”的长度应该为dims/8 * n“distances”以及“labels”的长度应该为k * n,否则可能会出现越界读写的情况,引起程序的崩溃。
  • 0 < n ≤ 1e9,0 < k ≤1e5(n ≤ 1e9的限制远超过实际可用资源,请用户根据业务场景选择合适的查询向量个数)。