StreamingChatLanguageModel (LangChain4j :: Aggregator 1.0.0-beta3 API)

All Known Implementing Classes:: AbstractBedrockStreamingChatModel, AnthropicStreamingChatModel, AzureOpenAiStreamingChatModel, BedrockAnthropicStreamingChatModel, BedrockStreamingChatModel, DisabledStreamingChatLanguageModel, GitHubModelsStreamingChatModel, GoogleAiGeminiStreamingChatModel, JlamaStreamingChatModel, LocalAiStreamingChatModel, MistralAiStreamingChatModel, OllamaStreamingChatModel, OpenAiOfficialStreamingChatModel, OpenAiStreamingChatModel, VertexAiGeminiStreamingChatModel

public interface StreamingChatLanguageModel

Represents a language model that has a chat API and can stream a response one token at a time.

See Also:

Method Summary

Modifier and Type

Method

Description

default void

chat(ChatRequest chatRequest, StreamingChatResponseHandler handler)

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

default void

chat(String userMessage, StreamingChatResponseHandler handler)

default void

chat(List<ChatMessage> messages, StreamingChatResponseHandler handler)

default ChatRequestParameters

defaultRequestParameters()

default void

doChat(ChatRequest chatRequest, StreamingChatResponseHandler handler)

default List<ChatModelListener>

listeners()

default ModelProvider

provider()

default Set<Capability>

supportedCapabilities()

Method Details
- chat
  
  default void chat(ChatRequest chatRequest, StreamingChatResponseHandler handler)
  
  This is the main API to interact with the chat model.
  A temporary default implementation of this method is necessary until all StreamingChatLanguageModel implementations adopt it. It should be removed once that occurs.
  
  Parameters:
  
  chatRequest - a ChatRequest, containing all the inputs to the LLM
  
  handler - a StreamingChatResponseHandler that will handle streaming response from the LLM
- defaultRequestParameters
  
  default ChatRequestParameters defaultRequestParameters()
- listeners
  
  default List<ChatModelListener> listeners()
- provider
  
  default ModelProvider provider()
- doChat
  
  default void doChat(ChatRequest chatRequest, StreamingChatResponseHandler handler)
- chat
  
  default void chat(String userMessage, StreamingChatResponseHandler handler)
- chat
  
  default void chat(List<ChatMessage> messages, StreamingChatResponseHandler handler)
- supportedCapabilities
  
  default Set<Capability> supportedCapabilities()