Package org.springframework.ai.chat.model

Interface ChatModel

All Superinterfaces:

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

All Known Implementing Classes:

AnthropicChatModel, AzureOpenAiChatModel, BedrockProxyChatModel, DeepSeekChatModel, GoogleGenAiChatModel, MiniMaxChatModel, MistralAiChatModel, OllamaChatModel, OpenAiChatModel, OpenAiSdkChatModel

public interface ChatModel
extends Model<Prompt,ChatResponse>, StreamingChatModel

Method Summary

Modifier and Type	Method	Description
default @Nullable String	call(String message)
default @Nullable String	call(Message... messages)
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
default ChatOptions	getDefaultOptions()
default reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.

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

stream, stream

Method Details

call

default @Nullable String call(String message)

call

default @Nullable String call(Message... messages)

call

ChatResponse call(Prompt prompt)

Description copied from interface: Model

Executes a method call to the AI model.

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

getDefaultOptions

default ChatOptions getDefaultOptions()

stream

default 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 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