TieredIndex

Java package: com.nvidia.cuvs

1
public interface TieredIndex extends AutoCloseable

TieredIndex encapsulates a Tiered index, along with methods to interact with it.

Public Members

close

1
@Override void close() throws Exception

Destroys the underlying native TieredIndex object and releases associated resources.

Throws

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:22

search

1
SearchResults search(TieredIndexQuery query) throws Throwable

Searches the index with the specified query and search parameters.

Parameters

Returns

An instance of SearchResults containing the k-nearest neighbors and their distances for each query

Throws

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:34

getIndexType

1
TieredIndexType getIndexType()

Returns the algorithm type backing this TieredIndex.

Returns

The TieredIndexType indicating the underlying algorithm (e.g., CAGRA)

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:42

getCuVSResources

1
CuVSResources getCuVSResources()

Returns the resources handle associated with this TieredIndex.

Returns

The CuVSResources instance used by this index

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:49

newBuilder

1
static Builder newBuilder(CuVSResources cuvsResources)

Creates a new Builder with an instance of CuVSResources.

Parameters

Returns

A new Builder instance for constructing a TieredIndex

Throws

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:58

extend

1
ExtendBuilder extend()

Returns an ExtendBuilder to add new data to the existing index.

Returns

An ExtendBuilder instance for extending the index

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:68

from

1
Builder from(InputStream inputStream)

Parameters

Returns

This Builder instance for method chaining

Throws

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:82

withDataset

1
Builder withDataset(float[][] vectors)

Sets the dataset vectors for building the TieredIndex.

Parameters

Returns

This Builder instance for method chaining

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:91

withDataset

1
Builder withDataset(CuVSMatrix dataset)

Sets the dataset for building the TieredIndex.

Parameters

Returns

This Builder instance for method chaining

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:99

withIndexParams

1
Builder withIndexParams(TieredIndexParams params)

Registers TieredIndex parameters with this Builder.

Parameters

Returns

This Builder instance for method chaining

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:108

withIndexType

1
Builder withIndexType(TieredIndexType indexType)

Sets the index type for the TieredIndex.

Parameters

Returns

This Builder instance for method chaining

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:117

build

1
TieredIndex build() throws Throwable

Builds and returns an instance of TieredIndex with the configured parameters.

Returns

A new TieredIndex instance

Throws

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:129

withDataset

1
ExtendBuilder withDataset(float[][] vectors)

Sets the vectors to add to the existing index.

Parameters

Returns

This ExtendBuilder instance for method chaining

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:152

withDataset

1
ExtendBuilder withDataset(CuVSMatrix dataset)

Sets the dataset to add to the existing index.

Parameters

Returns

This ExtendBuilder instance for method chaining

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:161

execute

1
void execute() throws Throwable

Executes the extend operation, adding the specified data to the index.

Throws

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:171

Source: java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java:15