aclfvSearch

The Atlas 200/300/500 Inference Product does not support this API.

The Atlas Training Series Product does not support this API.

Description

Performs 1:N or N:M feature search.

Restrictions

  • In N:M mode, multithreaded adding, search, or deletion is not allowed.
  • In 1:N or N:M mode, if no repository is added, zero results are returned by the aclfvSearch call.
  • This API call automatically creates a stream for synchronous task execution within the API. When the tasks are complete, the stream is automatically destroyed.

    Hardware has restrictions on the total number of streams. For details, see aclrtCreateStream.

Prototype

aclError aclfvSearch(aclfvSearchType type, aclfvSearchInput *searchInput, aclfvSearchResult *searchRst)

Parameters

Parameter

Input/Output

Description

type

Input

Type of feature search scenario.

searchInput

Input

Pointer to the search input.

Call aclfvCreateSearchInput to create data of the aclfvSearchInput type in advance.

searchRst

Output

Pointer to the search result.

Call aclfvCreateSearchResult to create data of the aclfvSearchResult type in advance. The queryCnt argument must be the same as that of searchInput.

The number of returned search results is specified by the topk argument passed to the aclfvCreateSearchInput call and is also related to the topk setting when aclfvInit is called for initialization. If the topk argument passed to the aclfvCreateSearchInput call is greater than or equal to the topk setting, the number of returned search results is determined by the topk setting; otherwise, the number of returned search results is determined by the topk argument passed to the aclfvCreateSearchInput call.

Returns

The value 0 indicates success, and other values indicate failure. For details, see aclError.