Class WatsonxStreamingChatModel.Builder

java.lang.Object

dev.langchain4j.model.watsonx.WatsonxStreamingChatModel.Builder

Enclosing class:

WatsonxStreamingChatModel

public static class WatsonxStreamingChatModel.Builder
extends Object

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

url

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

modelName

public WatsonxStreamingChatModel.Builder modelName(String modelName)

projectId

public WatsonxStreamingChatModel.Builder projectId(String projectId)

spaceId

public WatsonxStreamingChatModel.Builder spaceId(String spaceId)

temperature

public WatsonxStreamingChatModel.Builder temperature(Double temperature)

topP

public WatsonxStreamingChatModel.Builder topP(Double topP)

frequencyPenalty

public WatsonxStreamingChatModel.Builder frequencyPenalty(Double frequencyPenalty)

presencePenalty

public WatsonxStreamingChatModel.Builder presencePenalty(Double presencePenalty)

maxOutputTokens

public WatsonxStreamingChatModel.Builder maxOutputTokens(Integer maxOutputTokens)

stopSequences

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

stopSequences

public WatsonxStreamingChatModel.Builder stopSequences(String... stopSequences)

toolChoice

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

responseFormat

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

logitBias

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

logprobs

public WatsonxStreamingChatModel.Builder logprobs(Boolean logprobs)

topLogprobs

public WatsonxStreamingChatModel.Builder topLogprobs(Integer topLogprobs)

seed

public WatsonxStreamingChatModel.Builder seed(Integer seed)

toolChoiceName

public WatsonxStreamingChatModel.Builder toolChoiceName(String toolChoiceName)

timeLimit

public WatsonxStreamingChatModel.Builder timeLimit(Duration timeLimit)

supportedCapabilities

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

supportedCapabilities

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

toolSpecifications

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

toolSpecifications

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

listeners

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

defaultRequestParameters

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

thinking

public WatsonxStreamingChatModel.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 WatsonxStreamingChatModel.Builder url(String url)

url

public WatsonxStreamingChatModel.Builder url(URI url)

version

public WatsonxStreamingChatModel.Builder version(String version)

apiKey

public WatsonxStreamingChatModel.Builder apiKey(String apiKey)

logRequests

public WatsonxStreamingChatModel.Builder logRequests(Boolean logRequests)

logResponses

public WatsonxStreamingChatModel.Builder logResponses(Boolean logResponses)

authenticationProvider

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