OpenAIMessage
@JsonInclude(JsonInclude.Include.NON_NULL) @JsonIgnoreProperties(ignoreUnknown = true) public class OpenAIMessageio/agentscope/extensions/model/openai/dto/OpenAIMessage.java:51–271OpenAI 消息，与模型服务通信并返回生成或向量化结果。位于 io.agentscope.extensions.model.openai.dto 包。核心成员包括 getRole、setRole、getContent、setContent、getName、setName。
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"}}
]
}
`
嵌套类摘要Nested Class Summary
| 类Class | 类型Kind | 说明Description |
|---|---|---|
Builder | 类class | 构建器，用于构建并配置目标实例。 A class in io.agentscope.extensions.model.openai.dto that talks to model services and returns generated or embedded output. |
构造器摘要Constructor Summary
| 构造器Constructor | 说明Description |
|---|---|
public OpenAIMessage() | 初始化 `OpenAIMessage` 实例。 Creates a new instance. |
方法摘要Method Summary
构造器详情Constructor Detail
OpenAIMessage
public OpenAIMessage()初始化 OpenAIMessage 实例。
Creates a new instance.
io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:99方法详情Method Detail
getRole
public String getRole()获取角色。
Returns the role.
Stringio/agentscope/extensions/model/openai/dto/OpenAIMessage.java:101–103setRole
public void setRole(String role)设置角色。
Sets the role.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
role | String | 角色（类型 `String`）。The role. |
io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:105–107getContent
public Object getContent()获取内容。
Returns the content.
Objectio/agentscope/extensions/model/openai/dto/OpenAIMessage.java:109–111setContent
public void setContent(Object content)设置内容。
Sets the content.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
content | Object | 内容（类型 `Object`）。The content. |
io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:113–115getName
public String getName()获取名称。
Returns the name.
Stringio/agentscope/extensions/model/openai/dto/OpenAIMessage.java:117–119setName
public void setName(String name)设置名称。
Sets the name.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
name | String | 名称（类型 `String`）。The name. |
io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:121–123getToolCallId
public String getToolCallId()获取工具调用标识。
Returns the tool call id.
Stringio/agentscope/extensions/model/openai/dto/OpenAIMessage.java:125–127setToolCallId
public void setToolCallId(String toolCallId)设置工具调用标识。
Sets the tool call id.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
toolCallId | String | 工具调用标识（类型 `String`）。The tool call id. |
io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:129–131getToolCalls
public List<OpenAIToolCall> getToolCalls()获取工具调用。
Returns the tool calls.
List<OpenAIToolCall>io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:133–135setToolCalls
public void setToolCalls(List<OpenAIToolCall> toolCalls)设置工具调用。
Sets the tool calls.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
toolCalls | List<OpenAIToolCall> | 工具调用（类型 `List`）。The tool calls. |
io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:137–139getReasoningContent
public String getReasoningContent()获取推理内容。
Returns the reasoning content.
Stringio/agentscope/extensions/model/openai/dto/OpenAIMessage.java:141–143setReasoningContent
public void setReasoningContent(String reasoningContent)设置推理内容。
Sets the reasoning content.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
reasoningContent | String | 推理内容（类型 `String`）。The reasoning content. |
io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:145–147getReasoningDetails
public List<OpenAIReasoningDetail> getReasoningDetails()获取推理详情。
Returns the reasoning details.
List<OpenAIReasoningDetail>io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:149–151setReasoningDetails
public void setReasoningDetails(List<OpenAIReasoningDetail> reasoningDetails)设置推理详情。
Sets the reasoning details.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
reasoningDetails | List<OpenAIReasoningDetail> | 推理详情（类型 `List`）。The reasoning details. |
io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:153–155getRefusal
public String getRefusal()获取拒答。
Returns the refusal.
Stringio/agentscope/extensions/model/openai/dto/OpenAIMessage.java:157–159setRefusal
public void setRefusal(String refusal)设置拒答。
Sets the refusal.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
refusal | String | 拒答（类型 `String`）。The refusal. |
io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:161–163getContentAsString
public String getContentAsString()获取 getContentAsString。
Get content as String (for text-only messages).
Stringio/agentscope/extensions/model/openai/dto/OpenAIMessage.java:170–187getContentAsList
public List<OpenAIContentPart> getContentAsList()获取内容 as 列出(用于多模态消息)。
Get content as List (for multimodal messages).
List<OpenAIContentPart>io/agentscope/extensions/model/openai/dto/OpenAIMessage.java:194–201isMultimodal
public boolean isMultimodal()检查if 此消息有多模态内容。
Check if this message has multimodal content.
booleanio/agentscope/extensions/model/openai/dto/OpenAIMessage.java:208–211builder
public static Builder builder()返回构建器实例。
Returns the builder.
Builderio/agentscope/extensions/model/openai/dto/OpenAIMessage.java:213–215嵌套类详情Nested Class Detail
Builder
public static class Builder构建器，用于构建并配置目标实例。位于 io.agentscope.extensions.model.openai.dto 包。核心成员包括 role、content、name、toolCallId、toolCalls、reasoningContent。
A class in io.agentscope.extensions.model.openai.dto that talks to model services and returns generated or embedded output. Declared in io.agentscope.extensions.model.openai.dto.