跳到主要内容

aclfvRepoAdd

aclfvInit​

函数功能​

初始化特征检索模块。同步接口。

与aclfvRelease接口配套使用。

Atlas 200/500 A2推理产品不支持该接口。

约束说明​

一个进程内只能调用一次aclfvInit接口。

函数原型​

aclError aclfvInit(****aclfvInitPara *initPara)

参数说明​

参数名输入/输出说明
initPara输入特征向量检索初始化参数的指针。
- 调用aclfvCreateInitPara接口创建aclfvInitPara类型的数据。
- 1:N场景下调用aclfvSet1NTopNum接口设置返回的topK结果数量的最大值，不设置时，默认返回的topK结果数量的最大值为4800。
- N:M场景下调用aclfvSetNMTopNum接口设置返回的topK结果数量的最大值，不设置时，默认返回的topK结果数量的最大值为500。

返回值说明​

返回0表示成功，返回其它值表示失败。

父主题： 特征向量检索

aclfvRelease​

函数功能​

特征检索模块去初始化，释放内存空间，与aclfvInit接口配套使用。同步接口。

Atlas 200/500 A2推理产品不支持该接口。

函数原型​

aclError aclfvRelease()

参数说明​

无

返回值说明​

返回0表示成功，返回其它值表示失败。

父主题： 特征向量检索

aclfvRepoAdd​

函数功能​

添加底库或向已存在底库中添加特征。该章节描述的1:N表示“检索请求的个数:底库的数量”，N:M用于碰撞两个库的相似性。同步接口。

Atlas 200/500 A2推理产品不支持该接口。

约束说明​

  • 1:N添加时，对于每个库，用户需要保证aclfvFeatureInfo结构体中的offset连续；N:M添加时，offset不为0会报错。

  • 非线程安全，N:M场景不允许多线程同时添加\检索\删除。

  • 调用本接口，内部会默认创建一个Stream，用于接口内任务同步执行，在接口执行完成后，该Stream资源会被自动释放。

    受硬件限制，Stream总数有限，请参见aclrtCreateStream处的说明。

函数原型​

aclError aclfvRepoAdd(aclfvSearchType type, aclfvFeatureInfo *featureInfo)

参数说明​

参数名输入/输出说明
type输入检索类型。
featureInfo输入特征描述信息的指针。 需提前调用aclfvCreateFeatureInfo接口创建aclfvFeatureInfo类型的数据。

返回值说明​

返回0表示成功，返回其它值表示失败。

父主题： 特征向量检索

aclfvRepoDel​

函数功能​

删除底库。同步接口。

Atlas 200/500 A2推理产品不支持该接口。

约束说明​

  • 非线程安全，N:M场景不允许多线程同时添加\检索\删除。

  • 调用本接口，内部会默认创建一个Stream，用于接口内任务同步执行，在接口执行完成后，该Stream资源会被自动释放。

    受硬件限制，Stream总数有限，请参见aclrtCreateStream处的说明。

函数原型​

aclError aclfvRepoDel(aclfvSearchType type, aclfvRepoRange *repoRange)

参数说明​

参数名输入/输出说明
type输入检索类型。
repoRange输入特征删除范围的指针。 需提前调用aclfvCreateRepoRange接口创建aclfvRepoRange类型的数据。

返回值说明​

返回0表示成功，返回其它值表示失败。

父主题： 特征向量检索

aclfvDel​

函数功能​

精确删除底库中某个特征，一次只能删除底库中一个特征。N:M场景下不涉及这个接口。同步接口。

Atlas 200/500 A2推理产品不支持该接口。

约束说明​

  • 调用本接口，内部会默认创建一个Stream，用于接口内任务同步执行，在接口执行完成后，该Stream资源会被自动释放。

    受硬件限制，Stream总数有限，请参见aclrtCreateStream处的说明。

函数原型​

aclError aclfvDel(aclfvFeatureInfo *featureInfo)

参数说明​

参数名输入/输出说明
featureInfo输入特征描述信息的指针。 需提前调用aclfvCreateFeatureInfo接口创建aclfvFeatureInfo类型的数据。

返回值说明​

返回0表示成功，返回其它值表示失败。

父主题： 特征向量检索

在线提单