search
API Definition
def search(q: numpy.ndarray, final_num_neighbors: int, pre_reorder_num_neighbors: int, leaves_to_search: int) -> tuple(index, distance)
Function
Perform single-query search, which is executed by a single thread. It is consistent with the open source algorithm API.
Parameters
Parameter |
Description |
Data Type |
Value Range |
|---|---|---|---|
q |
The query. |
numpy.ndarray |
The value cannot be null. |
final_num_neighbors |
Number of returned results (Top K). |
int |
[1, number_of_base_libraries] |
pre_reorder_num_neighbors |
Number of results saved before reordering. |
int |
[final_num_neighbors, number_of_base_libraries] |
leaves_to_search |
Number of subspaces to be searched. |
int |
[1, num_leaves], where num_leaves indicates the total number of subspaces in the IVF index partition. |
Return Value
Data Type |
Description |
|---|---|
tuple(index, distance) |
index is the numpy.ndarray type data that contains final_num_neighbors base library IDs. distance is the numpy.ndarray type data that contains final_num_neighbors distances. |