Package com.azure.ai.agents.persistent.models

Class FileSearchRankingOptions

java.lang.Object
com.azure.ai.agents.persistent.models.FileSearchRankingOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<FileSearchRankingOptions>
public final class FileSearchRankingOptions extends Object implements com.azure.json.JsonSerializable<FileSearchRankingOptions>
Ranking options for file search.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FileSearchRankingOptions(String ranker, double scoreThreshold)
    Creates an instance of FileSearchRankingOptions class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static FileSearchRankingOptions
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of FileSearchRankingOptions from the JsonReader.
    String
    getRanker()
    Get the ranker property: File search ranker.
    double
    getScoreThreshold()
    Get the scoreThreshold property: Ranker search threshold.
    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

    • FileSearchRankingOptions

      public FileSearchRankingOptions(String ranker, double scoreThreshold)
      Creates an instance of FileSearchRankingOptions class.
      Parameters:
      ranker - the ranker value to set.
      scoreThreshold - the scoreThreshold value to set.

  • Method Details

    • getRanker

      public String getRanker()
      Get the ranker property: File search ranker.
      Returns:
      the ranker value.

    • getScoreThreshold

      public double getScoreThreshold()
      Get the scoreThreshold property: Ranker search threshold.
      Returns:
      the scoreThreshold value.

    • toJson

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

    • fromJson

      public static FileSearchRankingOptions fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of FileSearchRankingOptions from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of FileSearchRankingOptions 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 FileSearchRankingOptions.