昇腾社区首页
中文
注册

函数:create_search_result

产品支持情况

产品

是否支持

Atlas A3 训练系列产品 / Atlas A3 推理系列产品

x

Atlas A2 训练系列产品 / Atlas 800I A2 推理产品 /A200I A2 Box 异构组件

x

Atlas 训练系列产品

x

Atlas 推理系列产品

Atlas 200I/500 A2 推理产品

x

Atlas 200/300/500 推理产品

x

功能说明

创建aclfvSearchResult类型的数据,表示创建检索结果信息。

如需销毁aclfvSearchResult类型的数据,请参见函数:destroy_search_result

Atlas 推理系列产品 中的 Atlas 推理系列加速模块产品 不支持该接口。

函数原型

  • C函数原型
    1
    aclfvSearchResult *aclfvCreateSearchResult(uint32_t queryCnt, uint32_t *resultNum, uint32_t resultNumDataLen,uint32_t *id0, uint32_t *id1, uint32_t *resultOffset, float *resultDistance, uint32_t dataLen)
    
  • python函数
    1
    search_result = acl.fv.create_search_result(query_cnt, result_num, result_num_data_len, id_0, id_1, result_offset, result_distance, data_len)
    

参数说明

参数名

说明

query_cnt

int,检索请求个数,1:N场景为1。

result_num

int,每个检索请求的结果个数。

result_num_data_len

int,resultNum的内存总长度。

id_0

int,一级库id,总个数为topK*queryCnt。

id_1

int,二级库id,总个数为topK*queryCnt。

result_offset

int,指定迭代信息,需提前调用acl.prof.create_step_info接口创建aclprofStepInfo类型的数据。

result_distance

int,每个检索结果与检索请求间的距离,总个数为topK*queryCnt。

data_len

int,申请的内存大小,计算公式为:topK*queryCnt*4Byte。

返回值说明

返回值

说明

search_result

int,指针地址。

  • 返回aclfvSearchResult类型,表示成功。
  • 返回0,表示失败。

资源参考

接口调用流程及示例代码,参见特征向量检索