Package com.microsoft.semantickernel.data.vectorstorage.definition

Enum IndexKind

java.lang.Object

java.lang.Enum<IndexKind>

com.microsoft.semantickernel.data.vectorstorage.definition.IndexKind

All Implemented Interfaces:

Serializable, Comparable<IndexKind>

public enum IndexKind
extends Enum<IndexKind>

Represents the kind of index to use for a vector store.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FLAT	Flat index, which performs an exact nearest neighbour search.
HNSW	Hierarchical Navigable Small World, which performs an approximate nearest neighbour (ANN) search.
IVFFLAT	Inverted file index, which performs an approximate nearest neighbour (ANN) search.
UNDEFINED	No index specified.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Gets the string value of the index kind.
static IndexKind	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IndexKind[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HNSW

public static final IndexKind HNSW

Hierarchical Navigable Small World, which performs an approximate nearest neighbour (ANN) search.

FLAT

public static final IndexKind FLAT

Flat index, which performs an exact nearest neighbour search. Also referred to as exhaustive k nearest neighbor in some databases. High recall accuracy, but slower and more expensive than HNSW. Better with smaller datasets.

IVFFLAT

public static final IndexKind IVFFLAT

Inverted file index, which performs an approximate nearest neighbour (ANN) search.

UNDEFINED

public static final IndexKind UNDEFINED

No index specified. It will default to the database's default index.

Method Detail

values

public static IndexKind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IndexKind c : IndexKind.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IndexKind valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Gets the string value of the index kind.

Returns:

the string value of the index kind