ChatModel (LangChain4j :: Aggregator 1.1.0-beta7-SNAPSHOT API)

All Known Implementing Classes:: AnthropicChatModel, AzureOpenAiChatModel, BedrockChatModel, DisabledChatModel, GitHubModelsChatModel, GoogleAiGeminiChatModel, HuggingFaceChatModel, JlamaChatModel, LocalAiChatModel, MistralAiChatModel, OllamaChatModel, OpenAiChatModel, OpenAiOfficialChatModel, VertexAiChatModel, VertexAiGeminiChatModel, WorkersAiChatModel

public interface ChatModel

Represents a language model that has a chat API.

See Also:

Method Summary

Modifier and Type

Method

Description

default ChatResponse

chat(ChatMessage... messages)

default ChatResponse

chat(ChatRequest chatRequest)

This is the main API to interact with the chat model.

default String

chat(String userMessage)

default ChatResponse

chat(List<ChatMessage> messages)

default ChatRequestParameters

defaultRequestParameters()

default ChatResponse

doChat(ChatRequest chatRequest)

default List<ChatModelListener>

listeners()

default ModelProvider

provider()

default Set<Capability>

supportedCapabilities()

Method Details
- chat
  
  default ChatResponse chat(ChatRequest chatRequest)
  
  This is the main API to interact with the chat model.
  
  Parameters:
  
  chatRequest - a ChatRequest, containing all the inputs to the LLM
  
  Returns:
  
  a ChatResponse, containing all the outputs from the LLM
- doChat
  
  default ChatResponse doChat(ChatRequest chatRequest)
- defaultRequestParameters
  
  default ChatRequestParameters defaultRequestParameters()
- listeners
  
  default List<ChatModelListener> listeners()
- provider
  
  default ModelProvider provider()
- chat
  
  default String chat(String userMessage)
- chat
  
  default ChatResponse chat(ChatMessage... messages)
- chat
  
  default ChatResponse chat(List<ChatMessage> messages)
- supportedCapabilities
  
  default Set<Capability> supportedCapabilities()