Record Class OpenAiApi.ChatCompletionMessage

java.lang.Object
java.lang.Record
org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage
Record Components:
rawContent - The contents of the message. Can be either a OpenAiApi.ChatCompletionMessage.MediaContent or a String. The response message content is always a String.
role - The role of the messages author. Could be one of the OpenAiApi.ChatCompletionMessage.Role types.
name - An optional name for the participant. Provides the model information to differentiate between participants of the same role. In case of Function calling, the name is the function name that the message is responding to.
toolCallId - Tool call that this message is responding to. Only applicable for the OpenAiApi.ChatCompletionMessage.Role.TOOL role and null otherwise.
toolCalls - The tool calls generated by the model, such as function calls. Applicable only for OpenAiApi.ChatCompletionMessage.Role.ASSISTANT role and null otherwise.
refusal - The refusal message by the assistant. Applicable only for OpenAiApi.ChatCompletionMessage.Role.ASSISTANT role and null otherwise.
audioOutput - Audio response from the model. >>>>>>> bdb66e577 (OpenAI - Support audio input modality)
Enclosing class:
OpenAiApi

public static record OpenAiApi.ChatCompletionMessage(Object rawContent, OpenAiApi.ChatCompletionMessage.Role role, String name, String toolCallId, List<OpenAiApi.ChatCompletionMessage.ToolCall> toolCalls, String refusal, OpenAiApi.ChatCompletionMessage.AudioOutput audioOutput) extends Record
Message comprising the conversation.
  • Constructor Details

  • Method Details

    • content

      public String content()
      Get message content as String.
    • 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.
    • rawContent

      public Object rawContent()
      Returns the value of the rawContent record component.
      Returns:
      the value of the rawContent record component
    • role

      Returns the value of the role record component.
      Returns:
      the value of the role record component
    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component
    • toolCallId

      public String toolCallId()
      Returns the value of the toolCallId record component.
      Returns:
      the value of the toolCallId record component
    • toolCalls

      Returns the value of the toolCalls record component.
      Returns:
      the value of the toolCalls record component
    • refusal

      public String refusal()
      Returns the value of the refusal record component.
      Returns:
      the value of the refusal record component
    • audioOutput

      Returns the value of the audioOutput record component.
      Returns:
      the value of the audioOutput record component