Package com.azure.ai.openai.models

Class ChatMessageImageUrl

java.lang.Object
com.azure.ai.openai.models.ChatMessageImageUrl
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatMessageImageUrl>
public final class ChatMessageImageUrl extends Object implements com.azure.json.JsonSerializable<ChatMessageImageUrl>
An internet location from which the model may retrieve an image.

  • Constructor Details

    • ChatMessageImageUrl

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

  • Method Details

    • getUrl

      public String getUrl()
      Get the url property: The URL of the image.
      Returns:
      the url value.

    • getDetail

      public ChatMessageImageDetailLevel getDetail()
      Get the detail property: The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and accuracy.
      Returns:
      the detail value.

    • setDetail

      public ChatMessageImageUrl setDetail(ChatMessageImageDetailLevel detail)
      Set the detail property: The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and accuracy.
      Parameters:
      detail - the detail value to set.
      Returns:
      the ChatMessageImageUrl 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<ChatMessageImageUrl>
      Throws:
      IOException

    • fromJson

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