Class WatsonxChatModel.Builder

java.lang.Object

dev.langchain4j.model.watsonx.WatsonxChatModel.Builder

Enclosing class:

WatsonxChatModel

public static class WatsonxChatModel.Builder
extends Object

Builder class for constructing WatsonxChatModel instances with configurable parameters.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiKey
protected com.ibm.watsonx.ai.core.auth.AuthenticationProvider	authenticationProvider
protected Boolean	logRequests
protected Boolean	logResponses
protected URI	url
protected String	version

Method Summary

Modifier and Type	Method	Description
WatsonxChatModel.Builder	apiKey(String apiKey)
WatsonxChatModel.Builder	authenticationProvider(com.ibm.watsonx.ai.core.auth.AuthenticationProvider authenticationProvider)
WatsonxChatModel	build()
WatsonxChatModel.Builder	defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters defaultRequestParameters)
WatsonxChatModel.Builder	frequencyPenalty(Double frequencyPenalty)
WatsonxChatModel.Builder	listeners(List<dev.langchain4j.model.chat.listener.ChatModelListener> listeners)
WatsonxChatModel.Builder	logitBias(Map<String,Integer> logitBias)
WatsonxChatModel.Builder	logprobs(Boolean logprobs)
WatsonxChatModel.Builder	logRequests(Boolean logRequests)
WatsonxChatModel.Builder	logResponses(Boolean logResponses)
WatsonxChatModel.Builder	maxOutputTokens(Integer maxOutputTokens)
WatsonxChatModel.Builder	modelName(String modelName)
WatsonxChatModel.Builder	presencePenalty(Double presencePenalty)
WatsonxChatModel.Builder	projectId(String projectId)
WatsonxChatModel.Builder	responseFormat(dev.langchain4j.model.chat.request.ResponseFormat responseFormat)
WatsonxChatModel.Builder	seed(Integer seed)
WatsonxChatModel.Builder	spaceId(String spaceId)
WatsonxChatModel.Builder	stopSequences(String... stopSequences)
WatsonxChatModel.Builder	stopSequences(List<String> stopSequences)
WatsonxChatModel.Builder	supportedCapabilities(dev.langchain4j.model.chat.Capability... supportedCapabilities)
WatsonxChatModel.Builder	supportedCapabilities(Set<dev.langchain4j.model.chat.Capability> supportedCapabilities)
WatsonxChatModel.Builder	temperature(Double temperature)
WatsonxChatModel.Builder	thinking(com.ibm.watsonx.ai.chat.model.ExtractionTags tags)	Sets the tag names used to extract segmented content from the assistant's response.
WatsonxChatModel.Builder	timeLimit(Duration timeLimit)
WatsonxChatModel.Builder	toolChoice(dev.langchain4j.model.chat.request.ToolChoice toolChoice)
WatsonxChatModel.Builder	toolChoiceName(String toolChoiceName)
WatsonxChatModel.Builder	toolSpecifications(dev.langchain4j.agent.tool.ToolSpecification... toolSpecifications)
WatsonxChatModel.Builder	toolSpecifications(List<dev.langchain4j.agent.tool.ToolSpecification> toolSpecifications)
WatsonxChatModel.Builder	topLogprobs(Integer topLogprobs)
WatsonxChatModel.Builder	topP(Double topP)
WatsonxChatModel.Builder	url(com.ibm.watsonx.ai.CloudRegion cloudRegion)
WatsonxChatModel.Builder	url(String url)
WatsonxChatModel.Builder	url(URI url)
WatsonxChatModel.Builder	version(String version)

Methods inherited from class Object

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

Field Details

url

protected URI url

version

protected String version

apiKey

protected String apiKey

logRequests

protected Boolean logRequests

logResponses

protected Boolean logResponses

authenticationProvider

protected com.ibm.watsonx.ai.core.auth.AuthenticationProvider authenticationProvider

Method Details

build

public WatsonxChatModel build()

url

public WatsonxChatModel.Builder url(com.ibm.watsonx.ai.CloudRegion cloudRegion)

modelName

public WatsonxChatModel.Builder modelName(String modelName)

projectId

public WatsonxChatModel.Builder projectId(String projectId)

spaceId

public WatsonxChatModel.Builder spaceId(String spaceId)

temperature

public WatsonxChatModel.Builder temperature(Double temperature)

topP

public WatsonxChatModel.Builder topP(Double topP)

frequencyPenalty

public WatsonxChatModel.Builder frequencyPenalty(Double frequencyPenalty)

presencePenalty

public WatsonxChatModel.Builder presencePenalty(Double presencePenalty)

maxOutputTokens

public WatsonxChatModel.Builder maxOutputTokens(Integer maxOutputTokens)

stopSequences

public WatsonxChatModel.Builder stopSequences(List<String> stopSequences)

stopSequences

public WatsonxChatModel.Builder stopSequences(String... stopSequences)

toolChoice

public WatsonxChatModel.Builder toolChoice(dev.langchain4j.model.chat.request.ToolChoice toolChoice)

responseFormat

public WatsonxChatModel.Builder responseFormat(dev.langchain4j.model.chat.request.ResponseFormat responseFormat)

logitBias

public WatsonxChatModel.Builder logitBias(Map<String,Integer> logitBias)

logprobs

public WatsonxChatModel.Builder logprobs(Boolean logprobs)

topLogprobs

public WatsonxChatModel.Builder topLogprobs(Integer topLogprobs)

seed

public WatsonxChatModel.Builder seed(Integer seed)

toolChoiceName

public WatsonxChatModel.Builder toolChoiceName(String toolChoiceName)

timeLimit

public WatsonxChatModel.Builder timeLimit(Duration timeLimit)

supportedCapabilities

public WatsonxChatModel.Builder supportedCapabilities(Set<dev.langchain4j.model.chat.Capability> supportedCapabilities)

supportedCapabilities

public WatsonxChatModel.Builder supportedCapabilities(dev.langchain4j.model.chat.Capability... supportedCapabilities)

toolSpecifications

public WatsonxChatModel.Builder toolSpecifications(List<dev.langchain4j.agent.tool.ToolSpecification> toolSpecifications)

toolSpecifications

public WatsonxChatModel.Builder toolSpecifications(dev.langchain4j.agent.tool.ToolSpecification... toolSpecifications)

listeners

public WatsonxChatModel.Builder listeners(List<dev.langchain4j.model.chat.listener.ChatModelListener> listeners)

defaultRequestParameters

public WatsonxChatModel.Builder defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters defaultRequestParameters)

thinking

public WatsonxChatModel.Builder thinking(com.ibm.watsonx.ai.chat.model.ExtractionTags tags)

Sets the tag names used to extract segmented content from the assistant's response.

The provided ExtractionTags define which XML-like tags (such as <think> and <response>) will be used to extract the response from the AiMessage.

If the response tag is not specified in ExtractionTags, it will automatically default to "root", meaning that only the text nodes directly under the root element will be treated as the final response.

Example:

// Explicitly set both tags
builder.thinking(ExtractionTags.of("think", "response")).build();

// Only set reasoning tag — response defaults to "root"
builder.thinking(ExtractionTags.of("think")).build();

Parameters:

tags - an ExtractionTags instance containing the reasoning and (optionally) response tag names

url

public WatsonxChatModel.Builder url(String url)

url

public WatsonxChatModel.Builder url(URI url)

version

public WatsonxChatModel.Builder version(String version)

apiKey

public WatsonxChatModel.Builder apiKey(String apiKey)

logRequests

public WatsonxChatModel.Builder logRequests(Boolean logRequests)

logResponses

public WatsonxChatModel.Builder logResponses(Boolean logResponses)

authenticationProvider

public WatsonxChatModel.Builder authenticationProvider(com.ibm.watsonx.ai.core.auth.AuthenticationProvider authenticationProvider)