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

Class MessageTextFilePathDetails

java.lang.Object
com.azure.ai.openai.assistants.models.MessageTextFilePathDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<MessageTextFilePathDetails>
public final class MessageTextFilePathDetails extends Object implements com.azure.json.JsonSerializable<MessageTextFilePathDetails>
An encapsulation of an image file ID, as used by message image content.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MessageTextFilePathDetails(String fileId)
    Creates an instance of MessageTextFilePathDetails class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static MessageTextFilePathDetails
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of MessageTextFilePathDetails from the JsonReader.
    String
    getFileId()
    Get the fileId property: The ID of the specific file that the citation is from.
    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

    • MessageTextFilePathDetails

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

  • Method Details

    • getFileId

      public String getFileId()
      Get the fileId property: The ID of the specific file that the citation is from.
      Returns:
      the fileId value.

    • toJson

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

    • fromJson

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