Package com.azure.search.documents.indexes.models

Class SimilarityAlgorithm

java.lang.Object
com.azure.search.documents.indexes.models.SimilarityAlgorithm
All Implemented Interfaces:
com.azure.json.JsonSerializable<SimilarityAlgorithm>
Direct Known Subclasses:
BM25SimilarityAlgorithm, ClassicSimilarityAlgorithm
public class SimilarityAlgorithm extends Object implements com.azure.json.JsonSerializable<SimilarityAlgorithm>
Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant the document is to that specific query. Those scores are used to rank the search results.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SimilarityAlgorithm()
    Creates an instance of SimilarityAlgorithm class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SimilarityAlgorithm
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of SimilarityAlgorithm from the JsonReader.
    String
    getOdataType()
    Get the odataType property: The @odata.type property.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • SimilarityAlgorithm

      public SimilarityAlgorithm()
      Creates an instance of SimilarityAlgorithm class.

  • Method Details

    • getOdataType

      public String getOdataType()
      Get the odataType property: The @odata.type property.
      Returns:
      the odataType value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<SimilarityAlgorithm>
      Throws:
      IOException

    • fromJson

      public static SimilarityAlgorithm fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of SimilarityAlgorithm from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of SimilarityAlgorithm if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the SimilarityAlgorithm.