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

Record Class VisionRequest

java.lang.Object
java.lang.Record
bg.codexio.ai.openai.api.payload.vision.request.VisionRequest
All Implemented Interfaces:
Streamable
public record VisionRequest(String model, List<MessageContentHolder> messages, Integer maxTokens) extends Record implements Streamable
Represents a Vision request

  • Constructor Details

    • VisionRequest

      public VisionRequest(String model, List<MessageContentHolder> messages, Integer maxTokens)
      Creates an instance of a VisionRequest record class.
      Parameters:
      model - the value for the model record component
      messages - the value for the messages record component
      maxTokens - the value for the maxTokens record component

  • Method Details

    • empty

      public static VisionRequest empty()

    • stream

      public boolean stream()
      Specified by:
      stream in interface Streamable

    • withModel

      public VisionRequest withModel(String model)

    • withMessages

      public VisionRequest withMessages(MessageContentHolder messageHolder)

    • withMessageOn

      public VisionRequest withMessageOn(int index, MessageContentHolder messageHolder)

    • withTokens

      public VisionRequest withTokens(Integer maxTokens)

    • 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.

    • model

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

    • messages

      public List<MessageContentHolder> messages()
      Returns the value of the messages record component.
      Returns:
      the value of the messages record component

    • maxTokens

      public Integer maxTokens()
      Returns the value of the maxTokens record component.
      Returns:
      the value of the maxTokens record component