Package com.alibaba.cloud.ai.dashscope.spec

Record Class DashScopeApiSpec.ChatCompletionMessage

java.lang.Object
java.lang.Record
com.alibaba.cloud.ai.dashscope.spec.DashScopeApiSpec.ChatCompletionMessage
Record Components:
rawContent - The contents of the message. Can be either a DashScopeApiSpec.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 DashScopeApiSpec.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 DashScopeApiSpec.ChatCompletionMessage.Role.TOOL role and null otherwise.
toolCalls - The tool calls generated by the model, such as function calls.
reasoningContent - The reasoning content of the message. DeepSeek ReasoningContent Applicable only for DashScopeApiSpec.ChatCompletionMessage.Role.ASSISTANT role and null otherwise.
partial - Indicates whether this message is a partial prefix for code completion. When set to true, the model will continue generating from the provided content. Applicable only for DashScopeApiSpec.ChatCompletionMessage.Role.ASSISTANT role and null otherwise.
Enclosing class:
DashScopeApiSpec
public static record DashScopeApiSpec.ChatCompletionMessage(Object rawContent, DashScopeApiSpec.ChatCompletionMessage.Role role, String name, String toolCallId, List<DashScopeApiSpec.ChatCompletionMessage.ToolCall> toolCalls, String reasoningContent, Boolean partial, String phase, List<DashScopeApiSpec.ChatCompletionAnnotations> annotations, String status) extends Record
Message comprising the conversation.

  • Constructor Details

  • Method Details

    • content

      public String content()
      Get message content as String. If content contains both audio and text, audio takes precedence. Audio content is wrapped in tags.

    • 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

      public DashScopeApiSpec.ChatCompletionMessage.Role 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

      public List<DashScopeApiSpec.ChatCompletionMessage.ToolCall> toolCalls()
      Returns the value of the toolCalls record component.
      Returns:
      the value of the toolCalls record component

    • reasoningContent

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

    • partial

      public Boolean partial()
      Returns the value of the partial record component.
      Returns:
      the value of the partial record component

    • phase

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

    • annotations

      public List<DashScopeApiSpec.ChatCompletionAnnotations> annotations()
      Returns the value of the annotations record component.
      Returns:
      the value of the annotations record component

    • status

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