Search

API definition

APP_ERROR Search(const AscendIndexSearchParams& params) const;

Function

Retrieves feature vectors and returns IDs of the most similar topK features based on the input feature vectors.

Input

const AscendIndexSearchParams& params: search parameter. For details, see AscendIndexSearchParams.

size_t n: number of feature vectors to be queried.

std::vector<float>& queryData: feature vector data.

int topK: number of the most similar results to be returned.

Output

std::vector<float>& dists: distance between a vector and the topK nearest vectors.

std::vector<int64_t>& labels: IDs of the topK nearest vectors that are queried.

Return value

APP_ERROR: return status. For details, see Return Code Reference.

Restrictions

  • n ∈ (0, 10000]. Ensure that the value of n × dim × sizeof(float) is less than the remaining memory of the card. Otherwise, the retrieval may fail due to insufficient memory.
  • Length of queryDatan × dim
  • topK ∈ (0, 4096]
  • Length of dists and labelsn × topK