程序包 io.agentscope.core.formatter.openai.dto

类 OpenAIMessage

java.lang.Object
io.agentscope.core.formatter.openai.dto.OpenAIMessage
public class OpenAIMessage extends Object
OpenAI message DTO.

This class represents a message in the OpenAI Chat Completion API format. Content can be either a String (for text-only) or a List of OpenAIContentPart (for multimodal).

Example text message: 


 {
   "role": "user",
   "content": "Hello"
 }

Example multimodal message: 


 {
   "role": "user",
   "content": [
     {"type": "text", "text": "What's in this image?"},
     {"type": "image_url", "image_url": {"url": "https://example.com/image.jpg"}}
   ]
 }

  • 构造器详细资料

    • OpenAIMessage

      public OpenAIMessage()

  • 方法详细资料

    • getRole

      public String getRole()

    • setRole

      public void setRole(String role)

    • getContent

      public Object getContent()

    • setContent

      public void setContent(Object content)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getToolCallId

      public String getToolCallId()

    • setToolCallId

      public void setToolCallId(String toolCallId)

    • getToolCalls

      public List<OpenAIToolCall> getToolCalls()

    • setToolCalls

      public void setToolCalls(List<OpenAIToolCall> toolCalls)

    • getReasoningContent

      public String getReasoningContent()

    • setReasoningContent

      public void setReasoningContent(String reasoningContent)

    • getReasoningDetails

      public List<OpenAIReasoningDetail> getReasoningDetails()

    • setReasoningDetails

      public void setReasoningDetails(List<OpenAIReasoningDetail> reasoningDetails)

    • getRefusal

      public String getRefusal()

    • setRefusal

      public void setRefusal(String refusal)

    • getCacheControl

      public Map<String,String> getCacheControl()

    • setCacheControl

      public void setCacheControl(Map<String,String> cacheControl)

    • getContentAsString

      public String getContentAsString()
      Get content as String (for text-only messages).
      返回:
      the content as String, or null if multimodal

    • getContentAsList

      public List<OpenAIContentPart> getContentAsList()
      Get content as List (for multimodal messages).
      返回:
      the content as List, or null if text-only

    • isMultimodal

      public boolean isMultimodal()
      Check if this message has multimodal content.
      返回:
      true if content is a List

    • builder

      public static OpenAIMessage.Builder builder()