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

Class VectorStoreRecordDataField

java.lang.Object

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

com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDataField

public class VectorStoreRecordDataField
extends VectorStoreRecordField

Represents a data field in a record.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VectorStoreRecordDataField.Builder	Builder for the VectorStoreRecordDataField class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VectorStoreRecordDataField.Builder	builder()	Create a builder for the VectorStoreRecordDataField class.
boolean	isFilterable()	Gets a value indicating whether the field is filterable.
boolean	isFullTextSearchable()	Gets a value indicating whether the field is full text searchable.

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

VectorStoreRecordDataField

public VectorStoreRecordDataField(@Nonnull
                                  String name,
                                  @Nullable
                                  String storageName,
                                  @Nonnull
                                  Class<?> fieldType,
                                  boolean isFilterable,
                                  boolean isFullTextSearchable)

Creates a new instance of the VectorStoreRecordDataField class.

Parameters:

name - the name of the field

storageName - the storage name of the field

fieldType - the field type

isFilterable - a value indicating whether the field is filterable

isFullTextSearchable - a value indicating whether the field is full text searchable

Method Detail

builder

public static VectorStoreRecordDataField.Builder builder()

Create a builder for the VectorStoreRecordDataField class.

Returns:

a new instance of the builder

isFilterable

public boolean isFilterable()

Gets a value indicating whether the field is filterable.

Returns:

a value indicating whether the field is filterable

isFullTextSearchable

public boolean isFullTextSearchable()

Gets a value indicating whether the field is full text searchable.

Returns:

a value indicating whether the field is full text searchable