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

Class MessageImageFileDetails

java.lang.Object
com.azure.ai.openai.assistants.models.MessageImageFileDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<MessageImageFileDetails>
public final class MessageImageFileDetails extends Object implements com.azure.json.JsonSerializable<MessageImageFileDetails>
An image reference, as represented in thread message content.

  • Constructor Summary

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

  • Method Summary

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

    • MessageImageFileDetails

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

  • Method Details

    • getFileId

      public String getFileId()
      Get the fileId property: The ID for the file associated with this image.
      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<MessageImageFileDetails>
      Throws:
      IOException

    • fromJson

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