Package com.microsoft.semantickernel.data.vectorstorage.annotations

Annotation Type VectorStoreRecordVector

@Retention(RUNTIME)
@Target(FIELD)
public @interface VectorStoreRecordVector

Represents a vector field in a record.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
int	dimensions	Number of dimensions in the vector.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
DistanceFunction	distanceFunction	Distance function to be used for to compute the distance between vectors.
IndexKind	indexKind	Type of index to be used for the vector.
String	storageName	Storage name of the field.

Element Detail

dimensions

int dimensions

Number of dimensions in the vector.

Returns:

The number of dimensions in the vector.

storageName

String storageName

Storage name of the field.

Returns:

The storage name of the field.

Default:

""

indexKind

@Nullable
IndexKind indexKind

Type of index to be used for the vector.

Returns:

The type of index to be used for the vector.

Default:

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

distanceFunction

@Nullable
DistanceFunction distanceFunction

Distance function to be used for to compute the distance between vectors.

Returns:

The distance function to be used for to compute the distance between vectors.

Default:

com.microsoft.semantickernel.data.vectorstorage.definition.DistanceFunction.UNDEFINED