Record Class VectorIndexMetadata

java.lang.Object

java.lang.Record

io.micronaut.data.model.schema.sql.metadata.VectorIndexMetadata

Record Components:

vectorIndexType - The index type

distanceType - The distance metric

accuracy - Target accuracy

sparse - Whether sparse vector storage is requested

@Internal
public record VectorIndexMetadata(@NonNull VectorIndexType vectorIndexType, @NonNull VectorIndexType.DistanceType distanceType, int accuracy, boolean sparse)
extends Record

Vector index metadata.

Constructor Summary

Constructors

Constructor	Description
VectorIndexMetadata(@NonNull VectorIndexType vectorIndexType, @NonNull VectorIndexType.DistanceType distanceType, int accuracy, boolean sparse)	Creates an instance of a VectorIndexMetadata record class.

Method Summary

Modifier and Type	Method	Description
int	accuracy()	Returns the value of the accuracy record component.
@NonNull VectorIndexType.DistanceType	distanceType()	Returns the value of the distanceType record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	sparse()	Returns the value of the sparse record component.
final String	toString()	Returns a string representation of this record class.
@NonNull VectorIndexType	vectorIndexType()	Returns the value of the vectorIndexType record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

VectorIndexMetadata

public VectorIndexMetadata(@NonNull VectorIndexType vectorIndexType,
 @NonNull VectorIndexType.DistanceType distanceType,
 int accuracy,
 boolean sparse)

Creates an instance of a VectorIndexMetadata record class.

Parameters:

vectorIndexType - the value for the vectorIndexType record component

distanceType - the value for the distanceType record component

accuracy - the value for the accuracy record component

sparse - the value for the sparse record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

vectorIndexType

public @NonNull VectorIndexType vectorIndexType()

Returns the value of the vectorIndexType record component.

Returns:

the value of the vectorIndexType record component

distanceType

public @NonNull VectorIndexType.DistanceType distanceType()

Returns the value of the distanceType record component.

Returns:

the value of the distanceType record component

accuracy

public int accuracy()

Returns the value of the accuracy record component.

Returns:

the value of the accuracy record component

sparse

public boolean sparse()

Returns the value of the sparse record component.

Returns:

the value of the sparse record component