Package org.springframework.ai.openai

Class OpenAiChatModel

java.lang.Object

org.springframework.ai.openai.OpenAiChatModel

All Implemented Interfaces:

ChatModel, StreamingChatModel, Model<Prompt,ChatResponse>, StreamingModel<Prompt,ChatResponse>

public final class OpenAiChatModel
extends Object
implements ChatModel

Chat Model implementation using the OpenAI Java SDK.

The assistant message of each choice is built from ordered MessageParts:

• the reasoning_content (or reasoning) field that some OpenAI-compatible servers return becomes a ReasoningPart without a payload;
• the content becomes a TextPart;
• each function tool call becomes a ToolCallPart, and the extra fields of the tool call, if any, become its PAYLOAD_TOOL_CALL_ADDITIONAL_PROPERTIES payload;
• the audio output becomes a MediaPart.

Chat Completions has no way to interleave these items on the wire, so an assistant message is replayed as one message: the text parts are joined into the content, the reasoning parts are joined into reasoning_content, unless another provider signed some of them, and the tool call parts become the tool_calls. Media and other parts are not replayed. User message parts are sent in their order, so text and media can interleave.

Author:

Julien Dubois, Christian Tzolov, Soby Chacko, Ilayaperumal Gopinathan, Thomas Vitale, Eric Bottard, Taewoong Kim, Jewoo Shin, guan xu, Raphael Vullriede, Dimitar Proynov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiChatModel.Builder	Builder for creating OpenAiChatModel instances.
static class	OpenAiChatModel.ResponseFormat	Response format (text, json_object, json_schema) for OpenAiChatModel responses.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHAT_COMPLETIONS_PROVIDER	The provider of the payloads this model produces.
static final String	PAYLOAD_TOOL_CALL_ADDITIONAL_PROPERTIES	The kind of a ToolCallPart payload that holds the extra fields an OpenAI-compatible server returned on that tool call, as a JSON object string.

Method Summary

Modifier and Type	Method	Description
static OpenAiChatModel.Builder	builder()	Creates a new builder for OpenAiChatModel.
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
ChatOptions	getDefaultOptions()	Deprecated, for removal: This API element is subject to removal in a future version. use getOptions() instead.
OpenAiChatOptions	getOptions()	Gets the chat options for this model.
static com.openai.models.chat.completions.ChatCompletionToolChoiceOption	parseToolChoice(tools.jackson.databind.JsonNode node)
void	setObservationConvention(ChatModelObservationConvention observationConvention)	Use the provided convention for reporting observation data
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.chat.model.ChatModel

call, call

Methods inherited from interface org.springframework.ai.chat.model.StreamingChatModel

stream, stream

Field Details

CHAT_COMPLETIONS_PROVIDER

public static final String CHAT_COMPLETIONS_PROVIDER

The provider of the payloads this model produces. Only payloads of this provider are replayed by this model.

Since:

2.1.0

See Also:

• Constant Field Values

PAYLOAD_TOOL_CALL_ADDITIONAL_PROPERTIES

public static final String PAYLOAD_TOOL_CALL_ADDITIONAL_PROPERTIES

The kind of a ToolCallPart payload that holds the extra fields an OpenAI-compatible server returned on that tool call, as a JSON object string. The fields are sent back verbatim when the tool call is replayed.

Since:

2.1.0

See Also:

• Constant Field Values

Method Details

builder

public static OpenAiChatModel.Builder builder()

Creates a new builder for OpenAiChatModel.

Returns:

a new builder instance

getOptions

public OpenAiChatOptions getOptions()

Gets the chat options for this model.

Specified by:

getOptions in interface ChatModel

Returns:

the chat options

Since:

2.0.0

getDefaultOptions

@Deprecated(forRemoval=true)
public ChatOptions getDefaultOptions()

Deprecated, for removal: This API element is subject to removal in a future version.

use getOptions() instead.

Specified by:

getDefaultOptions in interface ChatModel

call

public ChatResponse call(Prompt prompt)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface ChatModel

Specified by:

call in interface Model<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the response from the AI model

stream

public reactor.core.publisher.Flux<ChatResponse> stream(Prompt prompt)

Description copied from interface: StreamingModel

Executes a method call to the AI model.

Specified by:

stream in interface ChatModel

Specified by:

stream in interface StreamingChatModel

Specified by:

stream in interface StreamingModel<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the streaming response from the AI model

parseToolChoice

public static com.openai.models.chat.completions.ChatCompletionToolChoiceOption parseToolChoice(tools.jackson.databind.JsonNode node)

setObservationConvention

public void setObservationConvention(ChatModelObservationConvention observationConvention)

Use the provided convention for reporting observation data

Parameters:

observationConvention - The provided convention