Class WatsonxDeploymentStreamingChatModel

java.lang.Object

dev.langchain4j.model.watsonx.WatsonxDeploymentStreamingChatModel

All Implemented Interfaces:

StreamingChatModel

public class WatsonxDeploymentStreamingChatModel
extends Object
implements StreamingChatModel

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

Example usage:

StreamingChatModel chatModel = WatsonxDeploymentStreamingChatModel.builder()
    .baseUrl("https://...") // or use CloudRegion
    .apiKey("...")
    .deploymentId("...")
    .maxOutputTokens(0)
    .temperature(0.7)
    .build();

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final ChatRequestParameters	defaultRequestParameters
protected final String	deploymentId
protected final com.ibm.watsonx.ai.deployment.DeploymentService	deploymentService
protected final List<ChatModelListener>	listeners
protected final boolean	strictJsonSchema
protected final Set<Capability>	supportedCapabilities

Method Summary

Modifier and Type	Method	Description
protected static final void	applyCommonParameters(DefaultChatRequestParameters.Builder<?> target, dev.langchain4j.model.watsonx.WatsonxChatBase.Builder<?> builder)
protected static void	applyTextChatParameters(WatsonxChatRequestParameters.Builder target, dev.langchain4j.model.watsonx.WatsonxTextChatBase.Builder<?> builder)	Merges into target the builder values and the default request parameters that both services accept.
protected com.ibm.watsonx.ai.deployment.DeploymentChatRequest	buildChatRequest(List<com.ibm.watsonx.ai.chat.model.ChatMessage> messages, List<com.ibm.watsonx.ai.chat.model.Tool> tools, ChatRequestParameters parameters)
static WatsonxDeploymentStreamingChatModel.Builder	builder()	Returns a new WatsonxDeploymentStreamingChatModel.Builder instance.
protected com.ibm.watsonx.ai.chat.ChatProvider<com.ibm.watsonx.ai.deployment.DeploymentChatRequest, com.ibm.watsonx.ai.chat.TextChatResponse>	chatProvider()
ChatRequestParameters	defaultRequestParameters()
void	doChat(ChatRequest chatRequest, StreamingChatResponseHandler handler)
protected final ChatResponse	executeChat(ChatRequest chatRequest)
protected final void	executeChatStreaming(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, chat, defaultRequestParameters, listeners, provider, supportedCapabilities

Field Details

deploymentService

protected final com.ibm.watsonx.ai.deployment.DeploymentService deploymentService

deploymentId

protected final String deploymentId

listeners

protected final List<ChatModelListener> listeners

defaultRequestParameters

protected final ChatRequestParameters defaultRequestParameters

supportedCapabilities

protected final Set<Capability> supportedCapabilities

strictJsonSchema

protected final boolean strictJsonSchema

Method Details

doChat

public void doChat(ChatRequest chatRequest,
 StreamingChatResponseHandler handler)

Specified by:

doChat in interface StreamingChatModel

builder

public static WatsonxDeploymentStreamingChatModel.Builder builder()

Returns a new WatsonxDeploymentStreamingChatModel.Builder instance.

Example usage:

StreamingChatModel chatModel = WatsonxDeploymentStreamingChatModel.builder()
    .baseUrl("https://...") // or use CloudRegion
    .apiKey("...")
    .deploymentId("...")
    .maxOutputTokens(0)
    .temperature(0.7)
    .build();

Returns:

WatsonxDeploymentStreamingChatModel.Builder instance.

buildChatRequest

protected com.ibm.watsonx.ai.deployment.DeploymentChatRequest buildChatRequest(List<com.ibm.watsonx.ai.chat.model.ChatMessage> messages,
 List<com.ibm.watsonx.ai.chat.model.Tool> tools,
 ChatRequestParameters parameters)

chatProvider

protected com.ibm.watsonx.ai.chat.ChatProvider<com.ibm.watsonx.ai.deployment.DeploymentChatRequest, com.ibm.watsonx.ai.chat.TextChatResponse> chatProvider()

applyTextChatParameters

protected static void applyTextChatParameters(WatsonxChatRequestParameters.Builder target,
 dev.langchain4j.model.watsonx.WatsonxTextChatBase.Builder<?> builder)

Merges into target the builder values and the default request parameters that both services accept.

Parameters:

target - the parameters builder to fill

builder - the model builder holding the values set by the caller

listeners

public List<ChatModelListener> listeners()

defaultRequestParameters

public ChatRequestParameters defaultRequestParameters()

supportedCapabilities

public Set<Capability> supportedCapabilities()

provider

public ModelProvider provider()

executeChat

protected final ChatResponse executeChat(ChatRequest chatRequest)

executeChatStreaming

protected final void executeChatStreaming(ChatRequest chatRequest,
 StreamingChatResponseHandler handler)

applyCommonParameters

protected static final void applyCommonParameters(DefaultChatRequestParameters.Builder<?> target,
 dev.langchain4j.model.watsonx.WatsonxChatBase.Builder<?> builder)