Package com.azure.ai.agents.persistent.models

Class MessageImageFileParam

java.lang.Object
com.azure.ai.agents.persistent.models.MessageImageFileParam
All Implemented Interfaces:
com.azure.json.JsonSerializable<MessageImageFileParam>
public final class MessageImageFileParam extends Object implements com.azure.json.JsonSerializable<MessageImageFileParam>
Defines how an internally uploaded image file is referenced when creating an image-file block.

  • Constructor Details

    • MessageImageFileParam

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

  • Method Details

    • getFileId

      public String getFileId()
      Get the fileId property: The ID of the previously uploaded image file.
      Returns:
      the fileId value.

    • getDetail

      public ImageDetailLevel getDetail()
      Get the detail property: Optional detail level for the image (auto, low, or high).
      Returns:
      the detail value.

    • setDetail

      public MessageImageFileParam setDetail(ImageDetailLevel detail)
      Set the detail property: Optional detail level for the image (auto, low, or high).
      Parameters:
      detail - the detail value to set.
      Returns:
      the MessageImageFileParam object itself.

    • toJson

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

    • fromJson

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