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

类 OpenAIChatFormatter

java.lang.Object

io.agentscope.core.formatter.AbstractBaseFormatter<OpenAIMessage,OpenAIResponse,OpenAIRequest>

io.agentscope.core.formatter.openai.OpenAIBaseFormatter

io.agentscope.core.formatter.openai.OpenAIChatFormatter

所有已实现的接口:

Formatter<OpenAIMessage,OpenAIResponse,OpenAIRequest>

直接已知子类:

DeepSeekFormatter, GLMFormatter, OpenAIMultiAgentFormatter

public class OpenAIChatFormatter
extends OpenAIBaseFormatter

Formatter for OpenAI Chat Completion HTTP API. Converts between AgentScope Msg objects and OpenAI DTO types.

This formatter is used with the HTTP-based OpenAI client for standard OpenAI GPT models. It provides full support for:

• All sampling parameters (temperature, top_p, penalties)
• Tool calling with strict mode support
• Full tool_choice options (auto, none, required, specific)

字段概要

从类继承的字段 io.agentscope.core.formatter.openai.OpenAIBaseFormatter

messageConverter, responseParser

构造器概要

构造器

构造器	说明
OpenAIChatFormatter()

方法概要

修饰符和类型	方法	说明
protected void	applyAdditionalBodyParams(OpenAIRequest request, GenerateOptions opts)	Apply additional body parameters from GenerateOptions to OpenAI request.
protected void	applyMaxTokens(OpenAIRequest request, GenerateOptions options, GenerateOptions defaultOptions)
void	applyOptions(OpenAIRequest request, GenerateOptions options, GenerateOptions defaultOptions)	Apply generation options to the request.
void	applyToolChoice(OpenAIRequest request, ToolChoice toolChoice)	Apply tool choice configuration to the request.
void	applyTools(OpenAIRequest request, List<ToolSchema> tools)	Apply tool schemas to the request.
protected List<OpenAIMessage>	doFormat(List<Msg> msgs)
protected boolean	supportsStrict()	Returns whether this formatter's target API supports the strict parameter in tool definitions.

从类继承的方法 io.agentscope.core.formatter.openai.OpenAIBaseFormatter

applyCacheControl, applyToolChoice, applyTools, buildRequest, buildRequest, parseResponse

从类继承的方法 io.agentscope.core.formatter.AbstractBaseFormatter

convertToolResultToString, extractTextContent, extractTextContent, format, formatRoleLabel, getOptionOrDefault, hasMediaContent, saveBase64DataToTempFile, shouldBypassHistory

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

OpenAIChatFormatter

public OpenAIChatFormatter()

方法详细资料

doFormat

protected List<OpenAIMessage> doFormat(List<Msg> msgs)

指定者:

doFormat 在类中 AbstractBaseFormatter<OpenAIMessage,OpenAIResponse,OpenAIRequest>

applyOptions

public void applyOptions(OpenAIRequest request,
 GenerateOptions options,
 GenerateOptions defaultOptions)

从类复制的说明: OpenAIBaseFormatter

Apply generation options to the request. Subclasses implement provider-specific option handling.

指定者:

applyOptions 在接口中 Formatter<OpenAIMessage,OpenAIResponse,OpenAIRequest>

指定者:

applyOptions 在类中 OpenAIBaseFormatter

参数:

request - OpenAI request DTO

options - Generation options to apply

defaultOptions - Default options to use if options parameter is null

applyMaxTokens

protected void applyMaxTokens(OpenAIRequest request,
 GenerateOptions options,
 GenerateOptions defaultOptions)

applyTools

public void applyTools(OpenAIRequest request,
 List<ToolSchema> tools)

从类复制的说明: OpenAIBaseFormatter

Apply tool schemas to the request. Subclasses implement provider-specific tool handling.

指定者:

applyTools 在接口中 Formatter<OpenAIMessage,OpenAIResponse,OpenAIRequest>

指定者:

applyTools 在类中 OpenAIBaseFormatter

参数:

request - OpenAI request DTO

tools - List of tool schemas to apply (may be null or empty)

supportsStrict

protected boolean supportsStrict()

Returns whether this formatter's target API supports the strict parameter in tool definitions.

Subclasses can override this method to disable strict parameter for providers that don't support it (e.g., DeepSeek).

返回:

true if strict parameter is supported, false otherwise

applyToolChoice

public void applyToolChoice(OpenAIRequest request,
 ToolChoice toolChoice)

从类复制的说明: OpenAIBaseFormatter

Apply tool choice configuration to the request. Subclasses implement provider-specific tool choice handling.

指定者:

applyToolChoice 在接口中 Formatter<OpenAIMessage,OpenAIResponse,OpenAIRequest>

指定者:

applyToolChoice 在类中 OpenAIBaseFormatter

参数:

request - OpenAI request DTO

toolChoice - Tool choice configuration (null means auto)

applyAdditionalBodyParams

protected void applyAdditionalBodyParams(OpenAIRequest request,
 GenerateOptions opts)

Apply additional body parameters from GenerateOptions to OpenAI request. This handles parameters like reasoning_effort that are set via additionalBodyParam().