Package org.springframework.ai.openai

Class OpenAiChatModel

java.lang.Object

org.springframework.ai.chat.model.AbstractToolCallSupport

org.springframework.ai.openai.OpenAiChatModel

All Implemented Interfaces:

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

public class OpenAiChatModel
extends AbstractToolCallSupport
implements ChatModel

ChatModel and StreamingChatModel implementation for OpenAI backed by OpenAiApi.

Author:

Mark Pollack, Christian Tzolov, Ueibin Kim, John Blum, Josh Long, Jemin Huh, Grogdunn, Hyunjoon Choi, Mariusz Bernacki, luocongqiu, Thomas Vitale, Ilayaperumal Gopinathan, Alexandros Pappas

See Also:

• ChatModel
• StreamingChatModel
• OpenAiApi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiChatModel.Builder

Field Summary

Fields inherited from class org.springframework.ai.chat.model.AbstractToolCallSupport

functionCallbackRegister, functionCallbackResolver, IS_RUNTIME_CALL

Constructor Summary

Constructors

Constructor	Description
OpenAiChatModel(OpenAiApi openAiApi)	Deprecated. Use OpenAiChatModel.Builder.
OpenAiChatModel(OpenAiApi openAiApi, OpenAiChatOptions options)	Deprecated. Use OpenAiChatModel.Builder.
OpenAiChatModel(OpenAiApi openAiApi, OpenAiChatOptions options, FunctionCallbackResolver functionCallbackResolver, List<FunctionCallback> toolFunctionCallbacks, org.springframework.retry.support.RetryTemplate retryTemplate)	Deprecated. Use OpenAiChatModel.Builder.
OpenAiChatModel(OpenAiApi openAiApi, OpenAiChatOptions options, FunctionCallbackResolver functionCallbackResolver, List<FunctionCallback> toolFunctionCallbacks, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)	Deprecated. Use OpenAiChatModel.Builder or OpenAiChatModel(OpenAiApi, OpenAiChatOptions, ToolCallingManager, RetryTemplate, ObservationRegistry).
OpenAiChatModel(OpenAiApi openAiApi, OpenAiChatOptions options, FunctionCallbackResolver functionCallbackResolver, org.springframework.retry.support.RetryTemplate retryTemplate)	Deprecated. Use OpenAiChatModel.Builder.
OpenAiChatModel(OpenAiApi openAiApi, OpenAiChatOptions defaultOptions, ToolCallingManager toolCallingManager, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)

Method Summary

Modifier and Type	Method	Description
static OpenAiChatModel.Builder	builder()
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
ChatOptions	getDefaultOptions()
ChatResponse	internalCall(Prompt prompt, ChatResponse previousChatResponse)
reactor.core.publisher.Flux<ChatResponse>	internalStream(Prompt prompt, ChatResponse previousChatResponse)
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.
String	toString()

Methods inherited from class org.springframework.ai.chat.model.AbstractToolCallSupport

buildToolCallConversation, executeFunctions, getFunctionCallbackRegister, handleToolCalls, isProxyToolCalls, isToolCall, isToolCall, resolveFunctionCallbacks, runtimeFunctionCallbackConfigurations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

Constructor Details

OpenAiChatModel

@Deprecated
public OpenAiChatModel(OpenAiApi openAiApi)

Deprecated.

Use OpenAiChatModel.Builder.

Creates an instance of the OpenAiChatModel.

Parameters:

openAiApi - The OpenAiApi instance to be used for interacting with the OpenAI Chat API.

Throws:

IllegalArgumentException - if openAiApi is null

OpenAiChatModel

@Deprecated
public OpenAiChatModel(OpenAiApi openAiApi,
 OpenAiChatOptions options)

Deprecated.

Use OpenAiChatModel.Builder.

Initializes an instance of the OpenAiChatModel.

Parameters:

openAiApi - The OpenAiApi instance to be used for interacting with the OpenAI Chat API.

options - The OpenAiChatOptions to configure the chat model.

OpenAiChatModel

@Deprecated
public OpenAiChatModel(OpenAiApi openAiApi,
 OpenAiChatOptions options,
 @Nullable
 FunctionCallbackResolver functionCallbackResolver,
 org.springframework.retry.support.RetryTemplate retryTemplate)

Deprecated.

Use OpenAiChatModel.Builder.

Initializes a new instance of the OpenAiChatModel.

Parameters:

openAiApi - The OpenAiApi instance to be used for interacting with the OpenAI Chat API.

options - The OpenAiChatOptions to configure the chat model.

functionCallbackResolver - The function callback resolver.

retryTemplate - The retry template.

OpenAiChatModel

@Deprecated
public OpenAiChatModel(OpenAiApi openAiApi,
 OpenAiChatOptions options,
 @Nullable
 FunctionCallbackResolver functionCallbackResolver,
 @Nullable
 List<FunctionCallback> toolFunctionCallbacks,
 org.springframework.retry.support.RetryTemplate retryTemplate)

Deprecated.

Use OpenAiChatModel.Builder.

Initializes a new instance of the OpenAiChatModel.

Parameters:

openAiApi - The OpenAiApi instance to be used for interacting with the OpenAI Chat API.

options - The OpenAiChatOptions to configure the chat model.

functionCallbackResolver - The function callback resolver.

toolFunctionCallbacks - The tool function callbacks.

retryTemplate - The retry template.

OpenAiChatModel

@Deprecated
public OpenAiChatModel(OpenAiApi openAiApi,
 OpenAiChatOptions options,
 @Nullable
 FunctionCallbackResolver functionCallbackResolver,
 @Nullable
 List<FunctionCallback> toolFunctionCallbacks,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Deprecated.

Use OpenAiChatModel.Builder or OpenAiChatModel(OpenAiApi, OpenAiChatOptions, ToolCallingManager, RetryTemplate, ObservationRegistry).

Initializes a new instance of the OpenAiChatModel.

Parameters:

openAiApi - The OpenAiApi instance to be used for interacting with the OpenAI Chat API.

options - The OpenAiChatOptions to configure the chat model.

functionCallbackResolver - The function callback resolver.

toolFunctionCallbacks - The tool function callbacks.

retryTemplate - The retry template.

observationRegistry - The ObservationRegistry used for instrumentation.

OpenAiChatModel

public OpenAiChatModel(OpenAiApi openAiApi,
 OpenAiChatOptions defaultOptions,
 ToolCallingManager toolCallingManager,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Method Details

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

internalCall

public ChatResponse internalCall(Prompt prompt,
 ChatResponse previousChatResponse)

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

internalStream

public reactor.core.publisher.Flux<ChatResponse> internalStream(Prompt prompt,
 ChatResponse previousChatResponse)

getDefaultOptions

public ChatOptions getDefaultOptions()

Specified by:

getDefaultOptions in interface ChatModel

toString

public String toString()

Overrides:

toString in class Object

setObservationConvention

public void setObservationConvention(ChatModelObservationConvention observationConvention)

Use the provided convention for reporting observation data

Parameters:

observationConvention - The provided convention

builder

public static OpenAiChatModel.Builder builder()