Class KnnVectorsFormat

    • Field Detail

      • DEFAULT_MAX_DIMENSIONS

        public static final int DEFAULT_MAX_DIMENSIONS
        The maximum number of vector dimensions
        See Also:
        Constant Field Values
      • name

        private final java.lang.String name
      • EMPTY

        public static final KnnVectorsFormat EMPTY
        EMPTY throws an exception when written. It acts as a sentinel indicating a Codec that does not support vectors.
    • Constructor Detail

      • KnnVectorsFormat

        protected KnnVectorsFormat​(java.lang.String name)
        Sole constructor
    • Method Detail

      • forName

        public static KnnVectorsFormat forName​(java.lang.String name)
        looks up a format by name
      • getMaxDimensions

        public int getMaxDimensions​(java.lang.String fieldName)
        Returns the maximum number of vector dimensions supported by this codec for the given field name

        Codecs should override this method to specify the maximum number of dimensions they support.

        Parameters:
        fieldName - the field name
        Returns:
        the maximum number of vector dimensions.