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

Class TextWeights

java.lang.Object
com.azure.search.documents.indexes.models.TextWeights
All Implemented Interfaces:
com.azure.json.JsonSerializable<TextWeights>
public final class TextWeights extends Object implements com.azure.json.JsonSerializable<TextWeights>
Defines weights on index fields for which matches should boost scoring in search queries.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TextWeights(Map<String,Double> weights)
    Creates an instance of TextWeights class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static TextWeights
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of TextWeights from the JsonReader.
    Map<String,Double>
    getWeights()
    Get the weights property: The dictionary of per-field weights to boost document scoring.
    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

    • TextWeights

      public TextWeights(Map<String,Double> weights)
      Creates an instance of TextWeights class.
      Parameters:
      weights - the weights value to set.

  • Method Details

    • getWeights

      public Map<String,Double> getWeights()
      Get the weights property: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field.
      Returns:
      the weights value.

    • toJson

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

    • fromJson

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