Package org.hibernate.search.mapper.pojo.mapping.definition.programmatic

Interface PropertyMappingVectorFieldOptionsStep

All Superinterfaces:

PropertyMappingFieldOptionsStep<PropertyMappingVectorFieldOptionsStep>, PropertyMappingStep

@Incubating
public interface PropertyMappingVectorFieldOptionsStep
extends PropertyMappingFieldOptionsStep<PropertyMappingVectorFieldOptionsStep>

The step in a property-to-index-field mapping where optional parameters can be set, when the index field is a vector field.

See Also:

• VectorField

Method Summary

Modifier and Type	Method	Description
PropertyMappingVectorFieldOptionsStep	efConstruction(int efConstruction)
PropertyMappingVectorFieldOptionsStep	indexNullAs(String indexNullAs)
PropertyMappingVectorFieldOptionsStep	m(int m)
PropertyMappingVectorFieldOptionsStep	projectable(Projectable projectable)
PropertyMappingVectorFieldOptionsStep	searchable(Searchable searchable)
PropertyMappingVectorFieldOptionsStep	vectorSimilarity(VectorSimilarity vectorSimilarity)

Methods inherited from interface org.hibernate.search.mapper.pojo.mapping.definition.programmatic.PropertyMappingFieldOptionsStep

extractor, extractors, noExtractors, valueBinder, valueBinder, valueBridge, valueBridge, valueBridge

Methods inherited from interface org.hibernate.search.mapper.pojo.mapping.definition.programmatic.PropertyMappingStep

associationInverseSide, binder, binder, documentId, fullTextField, fullTextField, genericField, genericField, hostingType, indexedEmbedded, indexedEmbedded, indexingDependency, keywordField, keywordField, marker, marker, nonStandardField, nonStandardField, scaledNumberField, scaledNumberField, vectorField, vectorField, vectorField, vectorField

Method Details

projectable

PropertyMappingVectorFieldOptionsStep projectable(Projectable projectable)

Parameters:

projectable - Whether this field should be projectable.

Returns:

this, for method chaining.

See Also:

• VectorField.projectable()
• Projectable

searchable

PropertyMappingVectorFieldOptionsStep searchable(Searchable searchable)

Parameters:

searchable - Whether this field should be searchable.

Returns:

this, for method chaining.

See Also:

• VectorField.searchable()
• Searchable

vectorSimilarity

PropertyMappingVectorFieldOptionsStep vectorSimilarity(VectorSimilarity vectorSimilarity)

Parameters:

vectorSimilarity - method of calculating the vector similarity, i.e. distance between vectors.

Returns:

this, for method chaining.

See Also:

• VectorField.vectorSimilarity()
• VectorSimilarity

efConstruction

PropertyMappingVectorFieldOptionsStep efConstruction(int efConstruction)

Parameters:

efConstruction - The size of the dynamic list used during k-NN graph creation.

Returns:

this, for method chaining.

See Also:

• VectorField.efConstruction()

m

PropertyMappingVectorFieldOptionsStep m(int m)

Parameters:

m - The number of neighbors each node will be connected to in the HNSW graph.

Returns:

this, for method chaining.

See Also:

• VectorField.m()

indexNullAs

PropertyMappingVectorFieldOptionsStep indexNullAs(String indexNullAs)

Parameters:

indexNullAs - A value used instead of null values when indexing.

Returns:

this, for method chaining.

See Also:

• VectorField.indexNullAs()