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

Class VectorStoreRecordVectorField

java.lang.Object

com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField

com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordVectorField

public class VectorStoreRecordVectorField
extends VectorStoreRecordField

Represents a vector field in a record.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VectorStoreRecordVectorField.Builder	A builder for the VectorStoreRecordVectorField class.

Constructor Summary

Constructors

Constructor	Description
VectorStoreRecordVectorField(String name, String storageName, Class<?> fieldType, int dimensions, IndexKind indexKind, DistanceFunction distanceFunction)	Creates a new instance of the VectorStoreRecordVectorField class.

Method Summary

Modifier and Type	Method	Description
static VectorStoreRecordVectorField.Builder	builder()	Create a builder for the VectorStoreRecordVectorField class.
int	getDimensions()	Gets the number of dimensions in the vector.
DistanceFunction	getDistanceFunction()	Gets the distance function.
IndexKind	getIndexKind()	Gets the index kind.

Methods inherited from class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField

getEffectiveStorageName, getFieldType, getName, getStorageName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VectorStoreRecordVectorField

public VectorStoreRecordVectorField(@Nonnull
                                    String name,
                                    @Nullable
                                    String storageName,
                                    @Nonnull
                                    Class<?> fieldType,
                                    int dimensions,
                                    @Nullable
                                    IndexKind indexKind,
                                    @Nullable
                                    DistanceFunction distanceFunction)

Creates a new instance of the VectorStoreRecordVectorField class.

Parameters:

name - the name of the field

storageName - the storage name of the field

fieldType - the field type

dimensions - the number of dimensions in the vector

indexKind - the index kind

distanceFunction - the distance function

Method Detail

builder

public static VectorStoreRecordVectorField.Builder builder()

Create a builder for the VectorStoreRecordVectorField class.

Returns:

a new instance of the builder

getDimensions

public int getDimensions()

Gets the number of dimensions in the vector.

Returns:

the number of dimensions in the vector

getIndexKind

public IndexKind getIndexKind()

Gets the index kind.

Returns:

the index kind

getDistanceFunction

public DistanceFunction getDistanceFunction()

Gets the distance function.

Returns:

the distance function