Class WatsonxStreamingChatModel

java.lang.Object

dev.langchain4j.model.watsonx.WatsonxStreamingChatModel

All Implemented Interfaces:

StreamingChatModel

public class WatsonxStreamingChatModel
extends Object
implements StreamingChatModel

A StreamingChatModel implementation that integrates IBM watsonx.ai with LangChain4j.

Example usage:

StreamingChatModel chatModel = WatsonxStreamingChatModel.builder()
    .url("https://...") // or use CloudRegion
    .apiKey("...")
    .projectId("...")
    .modelName("ibm/granite-3-8b-instruct")
    .maxOutputTokens(0)
    .temperature(0.7)
    .build();

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WatsonxStreamingChatModel.Builder	Builder class for constructing WatsonxStreamingChatModel instances with configurable parameters.

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.ibm.watsonx.ai.chat.ChatService	chatService
protected final ChatRequestParameters	defaultRequestParameters
protected final List<ChatModelListener>	listeners
protected final Set<Capability>	supportedCapabilities
protected final com.ibm.watsonx.ai.chat.model.ExtractionTags	tags
protected static final com.ibm.watsonx.ai.chat.model.ControlMessage	THINKING

Method Summary

Modifier and Type	Method	Description
static WatsonxStreamingChatModel.Builder	builder()	Returns a new WatsonxStreamingChatModel.Builder instance.
ChatRequestParameters	defaultRequestParameters()
void	doChat(ChatRequest chatRequest, StreamingChatResponseHandler handler)
List<ChatModelListener>	listeners()
ModelProvider	provider()
Set<Capability>	supportedCapabilities()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface StreamingChatModel

chat, chat, chat

Field Details

THINKING

protected static final com.ibm.watsonx.ai.chat.model.ControlMessage THINKING

chatService

protected final com.ibm.watsonx.ai.chat.ChatService chatService

listeners

protected final List<ChatModelListener> listeners

defaultRequestParameters

protected final ChatRequestParameters defaultRequestParameters

supportedCapabilities

protected final Set<Capability> supportedCapabilities

tags

protected final com.ibm.watsonx.ai.chat.model.ExtractionTags tags

Method Details

doChat

public void doChat(ChatRequest chatRequest,
 StreamingChatResponseHandler handler)

Specified by:

doChat in interface StreamingChatModel

listeners

public List<ChatModelListener> listeners()

Specified by:

listeners in interface StreamingChatModel

defaultRequestParameters

public ChatRequestParameters defaultRequestParameters()

Specified by:

defaultRequestParameters in interface StreamingChatModel

supportedCapabilities

public Set<Capability> supportedCapabilities()

Specified by:

supportedCapabilities in interface StreamingChatModel

provider

public ModelProvider provider()

Specified by:

provider in interface StreamingChatModel

builder

public static WatsonxStreamingChatModel.Builder builder()

Returns a new WatsonxStreamingChatModel.Builder instance.

Example usage:

StreamingChatModel chatModel = WatsonxStreamingChatModel.builder()
    .url("https://...") // or use CloudRegion
    .apiKey("...")
    .projectId("...")
    .modelName("ibm/granite-3-8b-instruct")
    .maxOutputTokens(0)
    .temperature(0.7)
    .build();

Returns:

WatsonxStreamingChatModel.Builder instance.