Package bg.codexio.ai.openai.api.payload.vision.request

Record Class ImageUrlRequest

java.lang.Object
java.lang.Record
bg.codexio.ai.openai.api.payload.vision.request.ImageUrlRequest
public record ImageUrlRequest(String url, String detail) extends Record

  • Constructor Details

    • ImageUrlRequest

      public ImageUrlRequest(String url, String detail)
      Creates an instance of a ImageUrlRequest record class.
      Parameters:
      url - the value for the url record component
      detail - the value for the detail record component

  • Method Details

    • fromLocalFile

      public static ImageUrlRequest fromLocalFile(File image)

    • withUrlOrBase64

      public ImageUrlRequest withUrlOrBase64(String urlOrBase64)

    • withFile

      public ImageUrlRequest withFile(File file)

    • withDetail

      public ImageUrlRequest withDetail(String detail)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • url

      public String url()
      Returns the value of the url record component.
      Returns:
      the value of the url record component

    • detail

      public String detail()
      Returns the value of the detail record component.
      Returns:
      the value of the detail record component