接口说明

KScaNN不提供对外接口，基于开源ScaNN算法做侵入式修改，对开源核心工具类ScannInterface里的类方法有新增。为获得最优性能，KScaNN接口内部不做完整入参校验，入参合法性由调用方业务来保证。KScaNN侵入式修改后的ScannInterface类方法如表1所示。

表1 KScaNN修改后的ScannInterface类方法
接口名称	接口作用
SetNumThreads	配置搜索时启用线程数（相比开源算法新增方法）。
SearchAdditionalParams	用于拓展ScaNN检索功能，提供额外的检索参数配置方法（相比开源算法新增方法）。
Search	单query搜索方法，单线程执行（与开源算法方法保持一致）。
SearchBatched	批量query搜索方法，单线程执行（与开源算法方法保持一致）。
SearchBatchedParallel	并行批量query搜索方法，多线程并发执行（与开源算法方法保持一致）。
Initialize	用于构建索引（与开源算法方法保持一致）。
SerializeToMemory	将索引序列化储存在内存中（相比开源算法新增方法）。
LoadFromMemory	从内存中还原索引实例（相比开源算法新增方法）。
GetNum	获取底库向量的数量（相比开源算法新增方法）。
GetDim	获取底库向量的维度（相比开源算法新增方法）。

父主题： C++接口