Package com.azure.ai.openai.assistants.models

Class FileSearchToolCallResult

java.lang.Object
com.azure.ai.openai.assistants.models.FileSearchToolCallResult
All Implemented Interfaces:
com.azure.json.JsonSerializable<FileSearchToolCallResult>
public final class FileSearchToolCallResult extends Object implements com.azure.json.JsonSerializable<FileSearchToolCallResult>
File search tool call result.

  • Method Details

    • getFileId

      public String getFileId()
      Get the fileId property: The ID of the file that result was found in.
      Returns:
      the fileId value.

    • getFileName

      public String getFileName()
      Get the fileName property: The name of the file that result was found in.
      Returns:
      the fileName value.

    • getScore

      public double getScore()
      Get the score property: The score of the result. All values must be a floating point number between 0 and 1.
      Returns:
      the score value.

    • getContent

      public List<FileSearchToolCallResultContentItem> getContent()
      Get the content property: The content of the result that was found. The content is only included if requested via the include query parameter.
      Returns:
      the content value.

    • toJson

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

    • fromJson

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