Class WatsonxChatModel

java.lang.Object

dev.langchain4j.model.watsonx.WatsonxChatModel

All Implemented Interfaces:

ChatModel

public class WatsonxChatModel
extends Object
implements ChatModel

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

Example usage:

ChatModel chatModel = WatsonxChatModel.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	WatsonxChatModel.Builder	Builder class for constructing WatsonxChatModel 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 WatsonxChatModel.Builder	builder()	Returns a new WatsonxChatModel.Builder instance.
ChatRequestParameters	defaultRequestParameters()
ChatResponse	doChat(ChatRequest chatRequest)
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

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

Specified by:

doChat in interface ChatModel

listeners

public List<ChatModelListener> listeners()

Specified by:

listeners in interface ChatModel

defaultRequestParameters

public ChatRequestParameters defaultRequestParameters()

Specified by:

defaultRequestParameters in interface ChatModel

provider

public ModelProvider provider()

Specified by:

provider in interface ChatModel

supportedCapabilities

public Set<Capability> supportedCapabilities()

Specified by:

supportedCapabilities in interface ChatModel

builder

public static WatsonxChatModel.Builder builder()

Returns a new WatsonxChatModel.Builder instance.

Example usage:

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

Returns:

WatsonxChatModel.Builder instance.