Record Class OpenAIResponse

java.lang.Object
java.lang.Record
com.bluebell.greenhouse.sol.models.responses.openai.OpenAIResponse
Record Components:
id - response id
status - response status
outputText - convenience structured output text
output - response output items
error - response error payload
All Implemented Interfaces:
GenericIntegrationResponse
public record OpenAIResponse(String id, String status, String outputText, List<OpenAIResponseOutputItem> output, OpenAIResponseError error) extends Record implements GenericIntegrationResponse
Raw response representation for the OpenAI Responses API.
Version:
1.0.9
Author:
Stephen Prizio

  • Constructor Details

    • OpenAIResponse

      public OpenAIResponse(String id, String status, String outputText, List<OpenAIResponseOutputItem> output, OpenAIResponseError error)
      Creates an instance of a OpenAIResponse record class.
      Parameters:
      id - the value for the id record component
      status - the value for the status record component
      outputText - the value for the outputText record component
      output - the value for the output record component
      error - the value for the error record component

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Returns true when the response does not contain any structured output text.
      Specified by:
      isEmpty in interface GenericIntegrationResponse
      Returns:
      boolean

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

    • id

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

    • status

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

    • outputText

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

    • output

      public List<OpenAIResponseOutputItem> output()
      Returns the value of the output record component.
      Returns:
      the value of the output record component

    • error

      public OpenAIResponseError error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component