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

Class FileSearchToolDefinitionDetails

java.lang.Object
com.azure.ai.agents.persistent.models.FileSearchToolDefinitionDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<FileSearchToolDefinitionDetails>
public final class FileSearchToolDefinitionDetails extends Object implements com.azure.json.JsonSerializable<FileSearchToolDefinitionDetails>
Options overrides for the file search tool.

  • Constructor Details

    • FileSearchToolDefinitionDetails

      public FileSearchToolDefinitionDetails()
      Creates an instance of FileSearchToolDefinitionDetails class.

  • Method Details

    • getMaxNumResults

      public Integer getMaxNumResults()
      Get the maxNumResults property: The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive. Note that the file search tool may output fewer than `max_num_results` results. See the file search tool documentation for more information.
      Returns:
      the maxNumResults value.

    • setMaxNumResults

      public FileSearchToolDefinitionDetails setMaxNumResults(Integer maxNumResults)
      Set the maxNumResults property: The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive. Note that the file search tool may output fewer than `max_num_results` results. See the file search tool documentation for more information.
      Parameters:
      maxNumResults - the maxNumResults value to set.
      Returns:
      the FileSearchToolDefinitionDetails object itself.

    • getRankingOptions

      public FileSearchRankingOptions getRankingOptions()
      Get the rankingOptions property: Ranking options for file search.
      Returns:
      the rankingOptions value.

    • setRankingOptions

      public FileSearchToolDefinitionDetails setRankingOptions(FileSearchRankingOptions rankingOptions)
      Set the rankingOptions property: Ranking options for file search.
      Parameters:
      rankingOptions - the rankingOptions value to set.
      Returns:
      the FileSearchToolDefinitionDetails object itself.

    • toJson

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

    • fromJson

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