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>
All Known Subinterfaces:
LuceneVectorFieldTypeOptionsStep<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 Details

    • vectorSimilarity

      S vectorSimilarity(VectorSimilarity vectorSimilarity)
      Parameters:
      vectorSimilarity - Defines how vector similarity is calculated.
      Returns:
      this, for method chaining.

    • efConstruction

      S efConstruction(int efConstruction)
      Parameters:
      efConstruction - Defines the size of the dynamic list used during k-NN graph creation.
      Returns:
      this, for method chaining.

    • m

      S m(int m)
      Parameters:
      m - Defines the number of neighbors each node will be connected to in the HNSW graph.
      Returns:
      this, for method chaining.

    • dimension

      S dimension(int dimension)
      Parameters:
      dimension - The number of dimensions (array length) of vectors to be indexed.
      Returns:
      this, for method chaining.