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

Class MessageImageFileIdDetails

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

  • Method Summary

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

  • Method Details

    • getFileId

      public String getFileId()
      Get the fileId property: The ID of the specific image file.
      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<MessageImageFileIdDetails>
      Throws:
      IOException

    • fromJson

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