Package com.azure.ai.openai.responses.models

Class ResponsesFileSearchTool

java.lang.Object
com.azure.ai.openai.responses.models.ResponsesTool
com.azure.ai.openai.responses.models.ResponsesFileSearchTool
All Implemented Interfaces:
com.azure.json.JsonSerializable<ResponsesTool>
public final class ResponsesFileSearchTool extends ResponsesTool
The ResponsesFileSearchTool model.

  • Constructor Details

    • ResponsesFileSearchTool

      public ResponsesFileSearchTool(List<String> vectorStoreIds)
      Creates an instance of ResponsesFileSearchTool class.
      Parameters:
      vectorStoreIds - the vectorStoreIds value to set.

  • Method Details

    • getType

      public ResponsesToolType getType()
      Get the type property: The type property.
      Overrides:
      getType in class ResponsesTool
      Returns:
      the type value.

    • getVectorStoreIds

      public List<String> getVectorStoreIds()
      Get the vectorStoreIds property: The vector_store_ids property.
      Returns:
      the vectorStoreIds value.

    • getMaxNumResults

      public Integer getMaxNumResults()
      Get the maxNumResults property: The max_num_results property.
      Returns:
      the maxNumResults value.

    • setMaxNumResults

      public ResponsesFileSearchTool setMaxNumResults(Integer maxNumResults)
      Set the maxNumResults property: The max_num_results property.
      Parameters:
      maxNumResults - the maxNumResults value to set.
      Returns:
      the ResponsesFileSearchTool object itself.

    • getRankingOptions

      public ResponsesFileSearchToolRankingOptions getRankingOptions()
      Get the rankingOptions property: The ranking_options property.
      Returns:
      the rankingOptions value.

    • setRankingOptions

      public ResponsesFileSearchTool setRankingOptions(ResponsesFileSearchToolRankingOptions rankingOptions)
      Set the rankingOptions property: The ranking_options property.
      Parameters:
      rankingOptions - the rankingOptions value to set.
      Returns:
      the ResponsesFileSearchTool object itself.

    • getFilters

      public com.azure.core.util.BinaryData getFilters()
      Get the filters property: The filters property.
      Returns:
      the filters value.

    • setFilters

      public ResponsesFileSearchTool setFilters(com.azure.core.util.BinaryData filters)
      Set the filters property: The filters property.
      Parameters:
      filters - the filters value to set.
      Returns:
      the ResponsesFileSearchTool 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<ResponsesTool>
      Overrides:
      toJson in class ResponsesTool
      Throws:
      IOException

    • fromJson

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