Package org.hibernate.search.engine.backend.types.dsl

Interface VectorFieldTypeOptionsStep<S extends VectorFieldTypeOptionsStep<?,F>,F>

Type Parameters:

S - The "self" type (the actual exposed type of this step).

F - The type of field values.

All Superinterfaces:

IndexFieldTypeConverterStep<S,F>, IndexFieldTypeFinalStep<F>, IndexFieldTypeOptionsStep<S,F>, SearchableProjectableIndexFieldTypeOptionsStep<S,F>

@Incubating
public interface VectorFieldTypeOptionsStep<S extends VectorFieldTypeOptionsStep<?,F>,F>
extends SearchableProjectableIndexFieldTypeOptionsStep<S,F>

The initial and final step in a "vector" index field type definition, where optional parameters can be set.

Method Summary

Modifier and Type	Method	Description
S	beamWidth(int beamWidth)
S	maxConnections(int maxConnections)
S	vectorSimilarity(VectorSimilarity vectorSimilarity)

Methods inherited from interface org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeConverterStep

dslConverter, projectionConverter

Methods inherited from interface org.hibernate.search.engine.backend.types.dsl.IndexFieldTypeFinalStep

toIndexFieldType

Methods inherited from interface org.hibernate.search.engine.backend.types.dsl.SearchableProjectableIndexFieldTypeOptionsStep

indexNullAs, projectable, searchable

Method Details

vectorSimilarity

S vectorSimilarity(VectorSimilarity vectorSimilarity)

Parameters:

vectorSimilarity - Defines how vector similarity is calculated.

Returns:

this, for method chaining.

beamWidth

S beamWidth(int beamWidth)

Parameters:

beamWidth - Defines the size of the dynamic list used during k-NN graph creation.

Returns:

this, for method chaining.

maxConnections

S maxConnections(int maxConnections)

Parameters:

maxConnections - Defines the number of neighbors each node will be connected to in the HNSW graph.

Returns:

this, for method chaining.