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

Class VectorStoreRecordField

java.lang.Object

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

Direct Known Subclasses:

VectorStoreRecordDataField, VectorStoreRecordKeyField, VectorStoreRecordVectorField

public class VectorStoreRecordField
extends Object

Represents a field in a record.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VectorStoreRecordField.Builder<T,U extends VectorStoreRecordField.Builder<T,U>>	A builder for the VectorStoreRecordField class.

Constructor Summary

Constructors

Constructor	Description
VectorStoreRecordField(String name, String storageName, Class<?> fieldType)	Creates a new instance of the VectorStoreRecordField class.

Method Summary

Modifier and Type	Method	Description
String	getEffectiveStorageName()	Gets the effective storage name of the field.
Class<?>	getFieldType()	Gets the field type.
String	getName()	Gets the name of the field.
String	getStorageName()	Gets the storage name of the field.

Methods inherited from class java.lang.Object

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

Constructor Detail

VectorStoreRecordField

public VectorStoreRecordField(@Nonnull
                              String name,
                              @Nullable
                              String storageName,
                              @Nonnull
                              Class<?> fieldType)

Creates a new instance of the VectorStoreRecordField class.

Parameters:

name - the name of the field

storageName - the storage name of the field

fieldType - the field type

Method Detail

getName

public String getName()

Gets the name of the field.

Returns:

the name of the field

getStorageName

public String getStorageName()

Gets the storage name of the field.

Returns:

the storage name of the field

getEffectiveStorageName

public String getEffectiveStorageName()

Gets the effective storage name of the field.

If the storage name is not set, the name of the field is returned.

Returns:

the effective storage name of the field

getFieldType

public Class<?> getFieldType()

Gets the field type.

Returns:

the field type