search
接口定义
def search(q: numpy.ndarray, final_num_neighbors: int, pre_reorder_num_neighbors: int, leaves_to_search: int) -> tuple(index, distance)
接口用途
单query搜索接口，单线程执行。与开源算法接口保持一致。
参数说明
参数名称 |
描述 |
数据类型 |
取值范围 |
|---|---|---|---|
q |
Query。 |
numpy.ndarray |
限制非空。 |
final_num_neighbors |
最终返回结果数量，TopK。 |
int |
[1, 底库数量] |
pre_reorder_num_neighbors |
重排前保存结果数量。 |
int |
[final_num_neighbors, 底库数量] |
leaves_to_search |
搜索子空间数量。 |
int |
[1, num_leaves]，其中“num_leaves”“”为IVF倒排索引分区总子空间个数。 |
返回值
数据类型 |
说明 |
|---|---|
tuple(index, distance) |
index为包含final_num_neighbors个底库id的numpy.ndarray；distance为包含final_num_neighbors个距离的numpy.ndarray。 |
父主题： KScaNN接口说明