Class WatsonxGatewayChatModel

java.lang.Object

dev.langchain4j.model.watsonx.WatsonxGatewayChatModel

All Implemented Interfaces:

ChatModel

public class WatsonxGatewayChatModel
extends Object
implements ChatModel

A ChatModel implementation that integrates the IBM watsonx.ai Model Gateway with LangChain4j.

Example usage:

ChatModel chatModel = WatsonxGatewayChatModel.builder()
    .baseUrl("https://...") // or use CloudRegion
    .apiKey("...")
    .modelName("gpt-4o")
    .maxOutputTokens(0)
    .temperature(0.7)
    .build();

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final ChatRequestParameters	defaultRequestParameters
protected final List<ChatModelListener>	listeners
protected final com.ibm.watsonx.ai.gateway.chat.ModelGatewayChatService	modelGatewayChatService
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 com.ibm.watsonx.ai.gateway.chat.ModelGatewayChatRequest	buildChatRequest(List<com.ibm.watsonx.ai.chat.model.ChatMessage> messages, List<com.ibm.watsonx.ai.chat.model.Tool> tools, ChatRequestParameters parameters)
static WatsonxGatewayChatModel.Builder	builder()	Returns a new WatsonxGatewayChatModel.Builder instance.
protected com.ibm.watsonx.ai.chat.ChatProvider<com.ibm.watsonx.ai.gateway.chat.ModelGatewayChatRequest, com.ibm.watsonx.ai.gateway.chat.ModelGatewayChatResponse>	chatProvider()
ChatRequestParameters	defaultRequestParameters()
ChatResponse	doChat(ChatRequest chatRequest)
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 ChatModel

chat, chat, chat, chat, chat, chatAsync, chatAsync, chatAsync, chatAsync, chatAsync, defaultRequestParameters, doChatAsync, listeners, provider, supportedCapabilities

Field Details

modelGatewayChatService

protected final com.ibm.watsonx.ai.gateway.chat.ModelGatewayChatService modelGatewayChatService

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 ChatResponse doChat(ChatRequest chatRequest)

Specified by:

doChat in interface ChatModel

builder

public static WatsonxGatewayChatModel.Builder builder()

Returns a new WatsonxGatewayChatModel.Builder instance.

Example usage:

ChatModel chatModel = WatsonxGatewayChatModel.builder()
    .baseUrl("https://...") // or use CloudRegion
    .apiKey("...")
    .modelName("gpt-4o")
    .maxOutputTokens(0)
    .temperature(0.7)
    .build();

Returns:

WatsonxGatewayChatModel.Builder instance.

chatProvider

protected com.ibm.watsonx.ai.chat.ChatProvider<com.ibm.watsonx.ai.gateway.chat.ModelGatewayChatRequest, com.ibm.watsonx.ai.gateway.chat.ModelGatewayChatResponse> chatProvider()

buildChatRequest

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

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)