Com Nvidia cuVS Cagraquery

Java package: com.nvidia.cuvs

1 public class CagraQuery

CagraQuery holds the CagraSearchParams and the query vectors to be used while invoking search.

Thread Safety: Each CagraQuery instance should use its own CuVSResources object that is not shared with other threads. Sharing CuVSResources between threads can lead to memory allocation errors or JVM crashes.

Public Members

CagraQuery

1 private CagraQuery( CagraSearchParams cagraSearchParameters, CuVSMatrix queryVectors, LongToIntFunction mapping, int topK, BitSet prefilter, int numDocs, CuVSResources resources)

Constructs an instance of CagraQuery using cagraSearchParameters, preFilter, queryVectors, mapping, and topK.

Parameters

Name	Description
`cagraSearchParameters`	an instance of `CagraSearchParams` holding the search parameters
`queryVectors`	2D float query vector array
`mapping`	a function mapping ordinals (neighbor IDs) to custom user IDs
`topK`	the top k results to return
`prefilter`	A single BitSet to use as filter while searching the CAGRA index
`numDocs`	Total number of dataset vectors; used to align the prefilter correctly
`resources`	CuVSResources instance to use for this query

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:43

getCagraSearchParameters

1 public CagraSearchParams getCagraSearchParameters()

Gets the instance of CagraSearchParams initially set.

Returns

an instance CagraSearchParams

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:66

getQueryVectors

1 public CuVSMatrix getQueryVectors()

Gets the query vector matrix.

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:73

getMapping

1 public LongToIntFunction getMapping()

Gets the function mapping ordinals (neighbor IDs) to custom user IDs

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:80

getTopK

1 public int getTopK()

Gets the topK value.

Returns

the topK value

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:89

getPrefilter

1 public BitSet getPrefilter()

Gets the prefilter BitSet.

Returns

a BitSet object representing the prefilter

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:98

getNumDocs

1 public int getNumDocs()

Gets the number of documents in this index, as used for prefilter

Returns

number of documents as an integer

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:107

getResources

1 public CuVSResources getResources()

Gets the CuVSResources instance for this query.

Returns

the CuVSResources instance

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:116

Builder

1 public Builder(CuVSResources resources)

Constructor that requires CuVSResources.

Important: The provided CuVSResources instance should not be shared with other threads. Each thread performing searches should create its own CuVSResources instance to avoid memory allocation conflicts and potential JVM crashes.

Parameters

Name	Description
`resources`	the CuVSResources instance to use for this query (must not be shared between threads)

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:155

withSearchParams

1 public Builder withSearchParams(CagraSearchParams cagraSearchParams)

Sets the instance of configured CagraSearchParams to be passed for search.

Parameters

Name	Description
`cagraSearchParams`	an instance of the configured CagraSearchParams to be used for this query

Returns

an instance of this Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:166

withQueryVectors

1 public Builder withQueryVectors(CuVSMatrix queryVectors)

Registers the query vectors to be passed in the search call.

Parameters

Name	Description
`queryVectors`	2D query vector array

Returns

an instance of this Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:177

withMapping

1 public Builder withMapping(LongToIntFunction mapping)

Sets the function used to map ordinals (neighbor IDs) to custom user IDs

Parameters

Name	Description
`mapping`	a function mapping ordinals (neighbor IDs) to custom user IDs

Returns

an instance of this Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:188

withTopK

1 public Builder withTopK(int topK)

Registers the topK value.

Parameters

Name	Description
`topK`	the topK value used to retrieve the topK results

Returns

an instance of this Builder

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:199

withPrefilter

1 public Builder withPrefilter(BitSet prefilter, int numDocs)

Sets a global prefilter for all queries in this CagraQuery. The prefilter array must contain exactly one BitSet, which is applied to all queries. A bit value of 1 includes the corresponding dataset vector; 0 excludes it.

Parameters

Name	Description
`prefilter`	an array with the global filter BitSet
`numDocs`	total number of vectors in the dataset (for alignment)

Returns

this Builder instance

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:214

build

1 public CagraQuery build()

Builds an instance of CuVSQuery.

Returns

an instance of CuVSQuery

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:225

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraQuery.java:21