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

Class MessageTextFileCitationDetails

java.lang.Object
com.azure.ai.openai.assistants.models.MessageTextFileCitationDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<MessageTextFileCitationDetails>
public final class MessageTextFileCitationDetails extends Object implements com.azure.json.JsonSerializable<MessageTextFileCitationDetails>
A representation of a file-based text citation, as used in a file-based annotation of text thread message content.

  • Constructor Details

    • MessageTextFileCitationDetails

      public MessageTextFileCitationDetails(String fileId, String quote)
      Creates an instance of MessageTextFileCitationDetails class.
      Parameters:
      fileId - the fileId value to set.
      quote - the quote value to set.

  • Method Details

    • getFileId

      public String getFileId()
      Get the fileId property: The ID of the file associated with this citation.
      Returns:
      the fileId value.

    • getQuote

      public String getQuote()
      Get the quote property: The specific quote cited in the associated file.
      Returns:
      the quote value.

    • toJson

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

    • fromJson

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