Package org.springframework.ai.openai

Class OpenAiChatClient

java.lang.Object

org.springframework.ai.model.function.AbstractFunctionCallSupport<OpenAiApi.ChatCompletionMessage,OpenAiApi.ChatCompletionRequest,org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion>>

org.springframework.ai.openai.OpenAiChatClient

All Implemented Interfaces:

ChatClient, StreamingChatClient, ModelClient<Prompt,ChatResponse>, StreamingModelClient<Prompt,ChatResponse>

public class OpenAiChatClient
extends AbstractFunctionCallSupport<OpenAiApi.ChatCompletionMessage,OpenAiApi.ChatCompletionRequest,org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion>>
implements ChatClient, StreamingChatClient

ChatClient and StreamingChatClient implementation for OpenAI backed by OpenAiApi.

Author:

Mark Pollack, Christian Tzolov, Ueibin Kim, John Blum, Josh Long, Jemin Huh

See Also:

• ChatClient
• StreamingChatClient
• OpenAiApi

Field Summary

Fields

Modifier and Type	Field	Description
final org.springframework.retry.support.RetryTemplate	retryTemplate	The retry template used to retry the OpenAI API calls.

Fields inherited from class org.springframework.ai.model.function.AbstractFunctionCallSupport

functionCallbackContext, functionCallbackRegister, IS_RUNTIME_CALL

Constructor Summary

Constructors

Constructor	Description
OpenAiChatClient(OpenAiApi openAiApi)	Creates an instance of the OpenAiChatClient.
OpenAiChatClient(OpenAiApi openAiApi, OpenAiChatOptions options)	Initializes an instance of the OpenAiChatClient.
OpenAiChatClient(OpenAiApi openAiApi, OpenAiChatOptions options, FunctionCallbackContext functionCallbackContext, org.springframework.retry.support.RetryTemplate retryTemplate)	Initializes a new instance of the OpenAiChatClient.

Method Summary

Modifier and Type	Method	Description
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
protected org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion>	doChatCompletion(OpenAiApi.ChatCompletionRequest request)
protected OpenAiApi.ChatCompletionRequest	doCreateToolResponseRequest(OpenAiApi.ChatCompletionRequest previousRequest, OpenAiApi.ChatCompletionMessage responseMessage, List<OpenAiApi.ChatCompletionMessage> conversationHistory)
protected OpenAiApi.ChatCompletionMessage	doGetToolResponseMessage(org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion> chatCompletion)
protected List<OpenAiApi.ChatCompletionMessage>	doGetUserMessages(OpenAiApi.ChatCompletionRequest request)
protected boolean	isToolFunctionCall(org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion> chatCompletion)
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.

Methods inherited from class org.springframework.ai.model.function.AbstractFunctionCallSupport

callWithFunctionSupport, getFunctionCallbackRegister, handleFunctionCallbackConfigurations, handleFunctionCallOrReturn, resolveFunctionCallbacks

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.ChatClient

call

Methods inherited from interface org.springframework.ai.chat.StreamingChatClient

stream

Field Details

retryTemplate

public final org.springframework.retry.support.RetryTemplate retryTemplate

The retry template used to retry the OpenAI API calls.

Constructor Details

OpenAiChatClient

public OpenAiChatClient(OpenAiApi openAiApi)

Creates an instance of the OpenAiChatClient.

Parameters:

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

Throws:

IllegalArgumentException - if openAiApi is null

OpenAiChatClient

public OpenAiChatClient(OpenAiApi openAiApi,
 OpenAiChatOptions options)

Initializes an instance of the OpenAiChatClient.

Parameters:

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

options - The OpenAiChatOptions to configure the chat client.

OpenAiChatClient

public OpenAiChatClient(OpenAiApi openAiApi,
 OpenAiChatOptions options,
 FunctionCallbackContext functionCallbackContext,
 org.springframework.retry.support.RetryTemplate retryTemplate)

Initializes a new instance of the OpenAiChatClient.

Parameters:

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

options - The OpenAiChatOptions to configure the chat client.

functionCallbackContext - The function callback context.

retryTemplate - The retry template.

Method Details

call

public ChatResponse call(Prompt prompt)

Description copied from interface: ModelClient

Executes a method call to the AI model.

Specified by:

call in interface ChatClient

Specified by:

call in interface ModelClient<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: StreamingModelClient

Executes a method call to the AI model.

Specified by:

stream in interface StreamingChatClient

Specified by:

stream in interface StreamingModelClient<Prompt,ChatResponse>

Parameters:

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

Returns:

the streaming response from the AI model

doCreateToolResponseRequest

protected OpenAiApi.ChatCompletionRequest doCreateToolResponseRequest(OpenAiApi.ChatCompletionRequest previousRequest,
 OpenAiApi.ChatCompletionMessage responseMessage,
 List<OpenAiApi.ChatCompletionMessage> conversationHistory)

Specified by:

doCreateToolResponseRequest in class AbstractFunctionCallSupport<OpenAiApi.ChatCompletionMessage,OpenAiApi.ChatCompletionRequest,org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion>>

doGetUserMessages

protected List<OpenAiApi.ChatCompletionMessage> doGetUserMessages(OpenAiApi.ChatCompletionRequest request)

Specified by:

doGetUserMessages in class AbstractFunctionCallSupport<OpenAiApi.ChatCompletionMessage,OpenAiApi.ChatCompletionRequest,org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion>>

doGetToolResponseMessage

protected OpenAiApi.ChatCompletionMessage doGetToolResponseMessage(org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion> chatCompletion)

Specified by:

doGetToolResponseMessage in class AbstractFunctionCallSupport<OpenAiApi.ChatCompletionMessage,OpenAiApi.ChatCompletionRequest,org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion>>

doChatCompletion

protected org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion> doChatCompletion(OpenAiApi.ChatCompletionRequest request)

Specified by:

doChatCompletion in class AbstractFunctionCallSupport<OpenAiApi.ChatCompletionMessage,OpenAiApi.ChatCompletionRequest,org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion>>

isToolFunctionCall

protected boolean isToolFunctionCall(org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion> chatCompletion)

Specified by:

isToolFunctionCall in class AbstractFunctionCallSupport<OpenAiApi.ChatCompletionMessage,OpenAiApi.ChatCompletionRequest,org.springframework.http.ResponseEntity<OpenAiApi.ChatCompletion>>