AS AgentScopeAPI 手册 / API Reference

OpenAIMessageConverter

public class OpenAIMessageConverter
源码Source io/agentscope/extensions/model/openai/formatter/OpenAIMessageConverter.java:56–580

OpenAI 消息转换器,与模型服务通信并返回生成或向量化结果。位于 io.agentscope.extensions.model.openai.formatter 包。核心成员包括 convertToMessage、OpenAIMessageConverter。

Converts AgentScope Msg objects to OpenAI DTO types (for HTTP API).

This class handles all message role conversions including system, user, assistant, and tool messages. It supports multimodal content (text, images, audio) and tool calling functionality.

构造器摘要Constructor Summary

构造器Constructor说明Description
public OpenAIMessageConverter(Function<Msg, String> textExtractor, Function<List<ContentBlock>, String> toolResultConverter)
初始化 `OpenAIMessageConverter` 实例。
Create an OpenAIMessageConverter with required dependency functions.

方法摘要Method Summary

方法Method说明Description
public OpenAIMessage convertToMessage(Msg msg, boolean hasMediaContent)
转换到消息。
Convert single Msg to OpenAI DTO Message.

构造器详情Constructor Detail

OpenAIMessageConverter

public OpenAIMessageConverter(Function<Msg, String> textExtractor, Function<List<ContentBlock>, String> toolResultConverter)

初始化 OpenAIMessageConverter 实例。

Create an OpenAIMessageConverter with required dependency functions.

参数Parameters
名称Name类型Type说明Description
textExtractorFunction<Msg, String>文本 Extractor(类型 `Function`)。Function to extract text content from Msg
toolResultConverterFunction<List<ContentBlock>, String>工具结果转换器(类型 `Function , String>`)。Function to convert tool result blocks to strings
源码Source io/agentscope/extensions/model/openai/formatter/OpenAIMessageConverter.java:69–74

方法详情Method Detail

convertToMessage

public OpenAIMessage convertToMessage(Msg msg, boolean hasMediaContent)

转换到消息。

Convert single Msg to OpenAI DTO Message.

参数Parameters
名称Name类型Type说明Description
msgMsg消息到转换。The message to convert
hasMediaContentboolean有 Media 内容(类型 `boolean`)。Whether the message contains media (images/audio)
返回Returns OpenAIMessage
用于OpenAI API的OpenAIMessage。OpenAIMessage for OpenAI API
源码Source io/agentscope/extensions/model/openai/formatter/OpenAIMessageConverter.java:83–102
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.