Module org.elasticsearch.server
Package org.elasticsearch.inference

Enum Class SimilarityMeasure

java.lang.Object
java.lang.Enum<SimilarityMeasure>
org.elasticsearch.inference.SimilarityMeasure
All Implemented Interfaces:
Serializable, Comparable<SimilarityMeasure>, Constable
public enum SimilarityMeasure extends Enum<SimilarityMeasure>

  • Enum Constant Details

  • Method Details

    • values

      public static SimilarityMeasure[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SimilarityMeasure valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<SimilarityMeasure>

    • fromString

      public static SimilarityMeasure fromString(String name)

    • translateSimilarity

      public static SimilarityMeasure translateSimilarity(SimilarityMeasure similarityMeasure, TransportVersion version)
      Returns a similarity measure that is known based on the transport version provided. If the similarity enum was not yet introduced it will be defaulted to null.
      Parameters:
      similarityMeasure - the value to translate if necessary
      version - the version that dictates the translation
      Returns:
      the similarity that is known to the version passed in