文档
注册

Search(faissIndex)

API定义

void Search(std::vector<Index *> indexes, Index::idx_t n, const float *x, Index::idx_t k,float *distances, Index::idx_t *labels, bool merged)

功能描述

实现从多个Index库执行特征向量查询的接口,根据输入的特征向量返回最相似的“k”条特征的距离及ID。

当前支持以下算法:

  • 由Index派生而来的子类型AscendIndexSQ(QuantizerType为QT_8bit)。
  • 由Index派生而来的子类型AscendIndexFlat(FlatIP、FlatL2)。
  • 由Index派生而来的子类型AscendIndexIVFSP。

输入

std::vector<Index *> indexes:待执行检索的多个Index。

Index::idx_t n:执行检索的query数。

const float *x:执行检索的query特征向量。

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

bool merged:是否要合并多个Index上执行检索的结果。

输出

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

idx_t *labels:查询的距离最近的前“k”个向量的ID。

返回值

约束说明

  • 多Index批量检索功能仅支持单卡环境,暂不支持多卡环境。
  • 当前“indexes”支持类型参见如下。
    • “indexes”为AscendIndexSQ的指针且QuantizerType为QT_8bit,并且需满足0 < indexes.size() ≤ 10000。
    • “indexes”为AscendIndexIVFSP的指针且对应的QuantizerType为QT_8bit、MetricType为METRIC_L2,并且需满足0 < indexes.size() ≤ 10000。
    • “indexes”为AscendIndexFlat的指针并且需满足0 < indexes.size() ≤ 10000。
  • 此处“n”不超过1024。
  • 此处“k”不超过1024。
  • 此处“x”需要为非空指针,且长度应该为dim * n,否则可能出现越界读写的错误并引起程序崩溃。
  • “distances”/“labels”需要为非空指针,且满足:
    • 当merged = true,长度应该为k * n,否则可能出现越界读写的错误并引起程序崩溃。
    • 当merged = false,长度应该为indexes.size() * k * n,否则可能出现越界读写的错误并引起程序崩溃。
搜索结果
找到“0”个结果

当前产品无相关内容

未找到相关内容,请尝试其他搜索词