Package org.springframework.ai.openai

Class OpenAiChatClient

java.lang.Object

org.springframework.ai.openai.OpenAiChatClient

All Implemented Interfaces:

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

public class OpenAiChatClient
extends Object
implements ChatClient, StreamingChatClient

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

Constructor Summary

Constructors

Constructor	Description
OpenAiChatClient(OpenAiApi openAiApi)
OpenAiChatClient(OpenAiApi openAiApi, OpenAiChatOptions options)
OpenAiChatClient(OpenAiApi openAiApi, OpenAiChatOptions options, FunctionCallbackContext functionCallbackContext)

Method Summary

Modifier and Type	Method	Description
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.
OpenAiChatClient	withDefaultOptions(OpenAiChatOptions options)	Deprecated, for removal: This API element is subject to removal in a future version. since 0.8.0, use the OpenAiChatClient(OpenAiApi, OpenAiChatOptions) constructor instead.

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

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)

OpenAiChatClient

public OpenAiChatClient(OpenAiApi openAiApi,
 OpenAiChatOptions options)

OpenAiChatClient

public OpenAiChatClient(OpenAiApi openAiApi,
 OpenAiChatOptions options,
 FunctionCallbackContext functionCallbackContext)

Method Details

withDefaultOptions

@Deprecated(since="0.8.0",
            forRemoval=true)
public OpenAiChatClient withDefaultOptions(OpenAiChatOptions options)

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

since 0.8.0, use the OpenAiChatClient(OpenAiApi, OpenAiChatOptions) constructor instead.

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