Module org.elasticsearch.server
Package org.elasticsearch.index.mapper.vectors

Interface VectorsFormatProvider

public interface VectorsFormatProvider
A service provider interface for obtaining Lucene KnnVectorsFormat instances. Plugins can implement this interface to provide custom vector formats

  • Method Details

    • getKnnVectorsFormat

      org.apache.lucene.codecs.KnnVectorsFormat getKnnVectorsFormat(IndexSettings indexSettings, DenseVectorFieldMapper.DenseVectorIndexOptions indexOptions, DenseVectorFieldMapper.VectorSimilarity similarity)
      Returns a KnnVectorsFormat instance based on the provided index settings and vector index options. May return null if the provider does not support the format for the given index settings or vector index options.
      Parameters:
      indexSettings - The index settings.
      indexOptions - The dense vector index options.
      similarity - The vector similarity function.
      Returns:
      A KnnVectorsFormat instance.