Class WatsonxDeploymentStreamingChatModel.Builder

java.lang.Object

dev.langchain4j.model.watsonx.WatsonxDeploymentStreamingChatModel.Builder

Enclosing class:

WatsonxDeploymentStreamingChatModel

public static class WatsonxDeploymentStreamingChatModel.Builder
extends Object

Builder class for constructing WatsonxDeploymentStreamingChatModel instances with configurable parameters.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiKey
protected com.ibm.watsonx.ai.core.auth.Authenticator	authenticator
protected URI	baseUrl
protected ChatRequestParameters	defaultRequestParameters
protected String	deploymentId
protected Double	frequencyPenalty
protected Set<String>	guidedChoice
protected String	guidedGrammar
protected String	guidedRegex
protected HttpClient	httpClient
protected Double	lengthPenalty
protected List<ChatModelListener>	listeners
protected Map<String,Integer>	logitBias
protected Boolean	logprobs
protected Boolean	logRequests
protected Boolean	logResponses
protected Integer	maxOutputTokens
protected String	modelName
protected Double	presencePenalty
protected Double	repetitionPenalty
protected ResponseFormat	responseFormat
protected Integer	seed
protected List<String>	stopSequences
protected Boolean	strictJsonSchema
protected Set<Capability>	supportedCapabilities
protected Double	temperature
protected com.ibm.watsonx.ai.chat.model.Thinking	thinking
protected Duration	timeout
protected ToolChoice	toolChoice
protected String	toolChoiceName
protected List<ToolSpecification>	toolSpecifications
protected Integer	topLogprobs
protected Double	topP
protected boolean	verifySsl
protected String	version

Method Summary

Modifier and Type	Method	Description
WatsonxDeploymentStreamingChatModel.Builder	apiKey(String apiKey)	Sets the IBM Cloud API key used to generate IAM access tokens for authentication.
WatsonxDeploymentStreamingChatModel.Builder	authenticator(com.ibm.watsonx.ai.core.auth.Authenticator authenticator)	Sets a custom Authenticator for generating bearer tokens.
WatsonxDeploymentStreamingChatModel.Builder	baseUrl(com.ibm.watsonx.ai.CloudRegion baseUrl)	Sets the IBM watsonx.ai endpoint from a predefined CloudRegion.
WatsonxDeploymentStreamingChatModel.Builder	baseUrl(String url)	Sets the base URL of the IBM watsonx.ai API.
WatsonxDeploymentStreamingChatModel.Builder	baseUrl(URI url)	Sets the base URL of the IBM watsonx.ai API as a URI.
WatsonxDeploymentStreamingChatModel	build()
WatsonxDeploymentStreamingChatModel.Builder	defaultRequestParameters(ChatRequestParameters defaultRequestParameters)	Sets default request parameters that are merged into every chat request.
WatsonxDeploymentStreamingChatModel.Builder	deploymentId(String deploymentId)	Sets the id of the on-demand model to call.
WatsonxDeploymentStreamingChatModel.Builder	frequencyPenalty(Double frequencyPenalty)	Sets the frequency penalty in the range [-2.0, 2.0].
WatsonxDeploymentStreamingChatModel.Builder	guidedChoice(String... guidedChoice)	Constrains the model output to one of the given string choices (guided decoding).
WatsonxDeploymentStreamingChatModel.Builder	guidedChoice(Set<String> guidedChoices)	Constrains the model output to one of the given string choices (guided decoding).
WatsonxDeploymentStreamingChatModel.Builder	guidedGrammar(String guidedGrammar)	Constrains the model output to conform to the given EBNF grammar (guided decoding).
WatsonxDeploymentStreamingChatModel.Builder	guidedRegex(String guidedRegex)	Constrains the model output to match the given regular expression (guided decoding).
WatsonxDeploymentStreamingChatModel.Builder	httpClient(HttpClient httpClient)	Sets a custom HttpClient to use for all API calls.
WatsonxDeploymentStreamingChatModel.Builder	lengthPenalty(Double lengthPenalty)	Sets the length penalty applied to the sequence score during beam search.
WatsonxDeploymentStreamingChatModel.Builder	listeners(List<ChatModelListener> listeners)	Sets the list of ChatModelListener instances for observing chat model interactions.
WatsonxDeploymentStreamingChatModel.Builder	logitBias(Map<String,Integer> logitBias)	Sets per-token logit biases to increase or decrease the likelihood of specific tokens.
WatsonxDeploymentStreamingChatModel.Builder	logprobs(Boolean logprobs)	Enables returning log probabilities of the output tokens.
WatsonxDeploymentStreamingChatModel.Builder	logRequests(Boolean logRequests)	Enables debug logging of request bodies sent to the watsonx.ai API.
WatsonxDeploymentStreamingChatModel.Builder	logResponses(Boolean logResponses)	Enables debug logging of response bodies received from the watsonx.ai API.
WatsonxDeploymentStreamingChatModel.Builder	maxOutputTokens(Integer maxOutputTokens)	Sets the maximum number of tokens to generate in the response.
WatsonxDeploymentStreamingChatModel.Builder	presencePenalty(Double presencePenalty)	Sets the presence penalty in the range [-2.0, 2.0].
WatsonxDeploymentStreamingChatModel.Builder	repetitionPenalty(Double repetitionPenalty)	Sets the repetition penalty.
WatsonxDeploymentStreamingChatModel.Builder	responseFormat(ResponseFormat responseFormat)	Sets the response format to control structured output, e.g.
WatsonxDeploymentStreamingChatModel.Builder	seed(Integer seed)	Sets the random seed for deterministic sampling.
WatsonxDeploymentStreamingChatModel.Builder	stopSequences(String... stopSequences)	Sets the sequences that will stop generation when encountered.
WatsonxDeploymentStreamingChatModel.Builder	stopSequences(List<String> stopSequences)	Sets the sequences that will stop generation when encountered.
WatsonxDeploymentStreamingChatModel.Builder	strictJsonSchema(Boolean strictJsonSchema)	Enables the strict mode for the JSON Schema used by structured outputs.
WatsonxDeploymentStreamingChatModel.Builder	supportedCapabilities(Capability... supportedCapabilities)	Declares the capabilities supported by this model instance.
WatsonxDeploymentStreamingChatModel.Builder	supportedCapabilities(Set<Capability> supportedCapabilities)	Declares the capabilities supported by this model instance.
WatsonxDeploymentStreamingChatModel.Builder	temperature(Double temperature)	Sets the sampling temperature in the range [0.0, 2.0].
WatsonxDeploymentStreamingChatModel.Builder	thinking(boolean enabled)	Enables or disables thinking.
WatsonxDeploymentStreamingChatModel.Builder	thinking(com.ibm.watsonx.ai.chat.model.ExtractionTags tags)	Configures thinking with custom extraction tags for parsing the thinking block.
WatsonxDeploymentStreamingChatModel.Builder	thinking(com.ibm.watsonx.ai.chat.model.Thinking thinking)	Sets a fully configured Thinking object for thinking.
WatsonxDeploymentStreamingChatModel.Builder	thinking(com.ibm.watsonx.ai.chat.model.ThinkingEffort thinkingEffort)	Configures thinking with a specific effort level.
WatsonxDeploymentStreamingChatModel.Builder	timeout(Duration timeout)	Sets the HTTP request timeout.
WatsonxDeploymentStreamingChatModel.Builder	toolChoice(ToolChoice toolChoice)	Sets how the model selects tools.
WatsonxDeploymentStreamingChatModel.Builder	toolChoiceName(String toolChoiceName)	Sets the name of the specific tool to force when toolChoice is set to force a particular tool.
WatsonxDeploymentStreamingChatModel.Builder	toolSpecifications(ToolSpecification... toolSpecifications)	Sets the tool definitions available to the model for function calling.
WatsonxDeploymentStreamingChatModel.Builder	toolSpecifications(List<ToolSpecification> toolSpecifications)	Sets the tool definitions available to the model for function calling.
WatsonxDeploymentStreamingChatModel.Builder	topLogprobs(Integer topLogprobs)	Sets the number of most likely tokens to return log probabilities for at each position.
WatsonxDeploymentStreamingChatModel.Builder	topP(Double topP)	Sets the nucleus sampling probability in the range (0.0, 1.0]
WatsonxDeploymentStreamingChatModel.Builder	verifySsl(boolean verifySsl)	Controls whether SSL certificate verification is performed.
WatsonxDeploymentStreamingChatModel.Builder	version(String version)	Sets the watsonx.ai API version date, e.g.

Methods inherited from class Object

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

Field Details

deploymentId

protected String deploymentId

thinking

protected com.ibm.watsonx.ai.chat.model.Thinking thinking

guidedChoice

protected Set<String> guidedChoice

guidedRegex

protected String guidedRegex

guidedGrammar

protected String guidedGrammar

repetitionPenalty

protected Double repetitionPenalty

lengthPenalty

protected Double lengthPenalty

modelName

protected String modelName

temperature

protected Double temperature

topP

protected Double topP

frequencyPenalty

protected Double frequencyPenalty

presencePenalty

protected Double presencePenalty

maxOutputTokens

protected Integer maxOutputTokens

stopSequences

protected List<String> stopSequences

toolChoice

protected ToolChoice toolChoice

responseFormat

protected ResponseFormat responseFormat

strictJsonSchema

protected Boolean strictJsonSchema

toolSpecifications

protected List<ToolSpecification> toolSpecifications

listeners

protected List<ChatModelListener> listeners

defaultRequestParameters

protected ChatRequestParameters defaultRequestParameters

supportedCapabilities

protected Set<Capability> supportedCapabilities

logitBias

protected Map<String,Integer> logitBias

logprobs

protected Boolean logprobs

topLogprobs

protected Integer topLogprobs

seed

protected Integer seed

toolChoiceName

protected String toolChoiceName

baseUrl

protected URI baseUrl

version

protected String version

apiKey

protected String apiKey

logRequests

protected Boolean logRequests

logResponses

protected Boolean logResponses

timeout

protected Duration timeout

authenticator

protected com.ibm.watsonx.ai.core.auth.Authenticator authenticator

httpClient

protected HttpClient httpClient

verifySsl

protected boolean verifySsl

Method Details

build

public WatsonxDeploymentStreamingChatModel build()

deploymentId

public WatsonxDeploymentStreamingChatModel.Builder deploymentId(String deploymentId)

Sets the id of the on-demand model to call.

Parameters:

deploymentId - the deployment id

Returns:

this

thinking

public WatsonxDeploymentStreamingChatModel.Builder thinking(boolean enabled)

Enables or disables thinking.

Parameters:

enabled - true to enable thinking

Returns:

this

thinking

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

Configures thinking with custom extraction tags for parsing the thinking block.

Parameters:

tags - the extraction tags

Returns:

this

thinking

public WatsonxDeploymentStreamingChatModel.Builder thinking(com.ibm.watsonx.ai.chat.model.ThinkingEffort thinkingEffort)

Configures thinking with a specific effort level.

Parameters:

thinkingEffort - the thinking effort level

Returns:

this

thinking

public WatsonxDeploymentStreamingChatModel.Builder thinking(com.ibm.watsonx.ai.chat.model.Thinking thinking)

Sets a fully configured Thinking object for thinking.

Parameters:

thinking - the thinking configuration

Returns:

this

guidedChoice

public WatsonxDeploymentStreamingChatModel.Builder guidedChoice(String... guidedChoice)

Constrains the model output to one of the given string choices (guided decoding).

Parameters:

guidedChoice - the allowed output values

Returns:

this

guidedChoice

public WatsonxDeploymentStreamingChatModel.Builder guidedChoice(Set<String> guidedChoices)

Constrains the model output to one of the given string choices (guided decoding).

Parameters:

guidedChoices - the set of allowed output values

Returns:

this

guidedRegex

public WatsonxDeploymentStreamingChatModel.Builder guidedRegex(String guidedRegex)

Constrains the model output to match the given regular expression (guided decoding).

Parameters:

guidedRegex - the regular expression pattern

Returns:

this

guidedGrammar

public WatsonxDeploymentStreamingChatModel.Builder guidedGrammar(String guidedGrammar)

Constrains the model output to conform to the given EBNF grammar (guided decoding).

Parameters:

guidedGrammar - the EBNF grammar string

Returns:

this

repetitionPenalty

public WatsonxDeploymentStreamingChatModel.Builder repetitionPenalty(Double repetitionPenalty)

Sets the repetition penalty. Values greater than 1.0 discourage repetition; values less than 1.0 encourage it.

Parameters:

repetitionPenalty - the repetition penalty

Returns:

this

lengthPenalty

public WatsonxDeploymentStreamingChatModel.Builder lengthPenalty(Double lengthPenalty)

Sets the length penalty applied to the sequence score during beam search. Values greater than 1.0 favor longer sequences.

Parameters:

lengthPenalty - the length penalty

Returns:

this

temperature

public WatsonxDeploymentStreamingChatModel.Builder temperature(Double temperature)

Sets the sampling temperature in the range [0.0, 2.0].

Parameters:

temperature - the sampling temperature

Returns:

this

topP

public WatsonxDeploymentStreamingChatModel.Builder topP(Double topP)

Sets the nucleus sampling probability in the range (0.0, 1.0]

Parameters:

topP - the nucleus sampling threshold

Returns:

this

frequencyPenalty

public WatsonxDeploymentStreamingChatModel.Builder frequencyPenalty(Double frequencyPenalty)

Sets the frequency penalty in the range [-2.0, 2.0].

Parameters:

frequencyPenalty - the frequency penalty

Returns:

this

presencePenalty

public WatsonxDeploymentStreamingChatModel.Builder presencePenalty(Double presencePenalty)

Sets the presence penalty in the range [-2.0, 2.0].

Parameters:

presencePenalty - the presence penalty

Returns:

this

maxOutputTokens

public WatsonxDeploymentStreamingChatModel.Builder maxOutputTokens(Integer maxOutputTokens)

Sets the maximum number of tokens to generate in the response.

Parameters:

maxOutputTokens - the maximum number of output tokens

Returns:

this

stopSequences

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

Sets the sequences that will stop generation when encountered.

Parameters:

stopSequences - the stop sequences

Returns:

this

stopSequences

public WatsonxDeploymentStreamingChatModel.Builder stopSequences(String... stopSequences)

Sets the sequences that will stop generation when encountered.

Parameters:

stopSequences - the stop sequences

Returns:

this

toolChoice

public WatsonxDeploymentStreamingChatModel.Builder toolChoice(ToolChoice toolChoice)

Sets how the model selects tools. Controls whether tool use is automatic, forced, or disabled.

Parameters:

toolChoice - the tool choice mode

Returns:

this

responseFormat

public WatsonxDeploymentStreamingChatModel.Builder responseFormat(ResponseFormat responseFormat)

Sets the response format to control structured output, e.g. JSON mode.

Parameters:

responseFormat - the response format

Returns:

this

strictJsonSchema

public WatsonxDeploymentStreamingChatModel.Builder strictJsonSchema(Boolean strictJsonSchema)

Enables the strict mode for the JSON Schema used by structured outputs. Defaults to true.

In strict mode the model is required to adhere to the schema, every property is marked as required and additionalProperties is set to false. Set it to false to let the model treat the schema as a hint instead of a constraint.

Parameters:

strictJsonSchema - true to enable the strict mode

Returns:

this

toolSpecifications

public WatsonxDeploymentStreamingChatModel.Builder toolSpecifications(List<ToolSpecification> toolSpecifications)

Sets the tool definitions available to the model for function calling.

Parameters:

toolSpecifications - the list of tool specifications

Returns:

this

toolSpecifications

public WatsonxDeploymentStreamingChatModel.Builder toolSpecifications(ToolSpecification... toolSpecifications)

Sets the tool definitions available to the model for function calling.

Parameters:

toolSpecifications - the tool specifications

Returns:

this

listeners

public WatsonxDeploymentStreamingChatModel.Builder listeners(List<ChatModelListener> listeners)

Sets the list of ChatModelListener instances for observing chat model interactions.

Parameters:

listeners - the listeners to register

Returns:

this

defaultRequestParameters

public WatsonxDeploymentStreamingChatModel.Builder defaultRequestParameters(ChatRequestParameters defaultRequestParameters)

Sets default request parameters that are merged into every chat request.

Parameters:

defaultRequestParameters - the default request parameters

Returns:

this

supportedCapabilities

public WatsonxDeploymentStreamingChatModel.Builder supportedCapabilities(Set<Capability> supportedCapabilities)

Declares the capabilities supported by this model instance.

Parameters:

supportedCapabilities - the set of supported capabilities

Returns:

this

supportedCapabilities

public WatsonxDeploymentStreamingChatModel.Builder supportedCapabilities(Capability... supportedCapabilities)

Declares the capabilities supported by this model instance.

Parameters:

supportedCapabilities - the supported capabilities

Returns:

this

logitBias

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

Sets per-token logit biases to increase or decrease the likelihood of specific tokens. Keys are token IDs; values are bias offsets in the range [-100, 100].

Parameters:

logitBias - the logit bias map

Returns:

this

logprobs

public WatsonxDeploymentStreamingChatModel.Builder logprobs(Boolean logprobs)

Enables returning log probabilities of the output tokens.

Parameters:

logprobs - true to include log probabilities in the response

Returns:

this

topLogprobs

public WatsonxDeploymentStreamingChatModel.Builder topLogprobs(Integer topLogprobs)

Sets the number of most likely tokens to return log probabilities for at each position. Requires logprobs to be true. Value must be between 0 and 20.

Parameters:

topLogprobs - the number of top log probabilities to return

Returns:

this

seed

public WatsonxDeploymentStreamingChatModel.Builder seed(Integer seed)

Sets the random seed for deterministic sampling. Using the same seed and parameters should produce the same output across calls.

Parameters:

seed - the random seed

Returns:

this

toolChoiceName

public WatsonxDeploymentStreamingChatModel.Builder toolChoiceName(String toolChoiceName)

Sets the name of the specific tool to force when toolChoice is set to force a particular tool.

Parameters:

toolChoiceName - the tool name to force

Returns:

this

baseUrl

public WatsonxDeploymentStreamingChatModel.Builder baseUrl(com.ibm.watsonx.ai.CloudRegion baseUrl)

Sets the IBM watsonx.ai endpoint from a predefined CloudRegion.

Parameters:

baseUrl - the IBM Cloud region whose ML endpoint will be used

Returns:

this

baseUrl

public WatsonxDeploymentStreamingChatModel.Builder baseUrl(String url)

Sets the base URL of the IBM watsonx.ai API.

Parameters:

url - the base URL string, e.g. "https://us-south.ml.cloud.ibm.com"

Returns:

this

baseUrl

public WatsonxDeploymentStreamingChatModel.Builder baseUrl(URI url)

Sets the base URL of the IBM watsonx.ai API as a URI.

Parameters:

url - the base URL URI

Returns:

this

version

public WatsonxDeploymentStreamingChatModel.Builder version(String version)

Sets the watsonx.ai API version date, e.g. "2024-05-31".

Parameters:

version - the API version date string

Returns:

this

apiKey

public WatsonxDeploymentStreamingChatModel.Builder apiKey(String apiKey)

Sets the IBM Cloud API key used to generate IAM access tokens for authentication.

Parameters:

apiKey - the IBM Cloud API key

Returns:

this

logRequests

public WatsonxDeploymentStreamingChatModel.Builder logRequests(Boolean logRequests)

Enables debug logging of request bodies sent to the watsonx.ai API.

Parameters:

logRequests - true to enable request logging

Returns:

this

logResponses

public WatsonxDeploymentStreamingChatModel.Builder logResponses(Boolean logResponses)

Enables debug logging of response bodies received from the watsonx.ai API.

Parameters:

logResponses - true to enable response logging

Returns:

this

timeout

public WatsonxDeploymentStreamingChatModel.Builder timeout(Duration timeout)

Sets the HTTP request timeout. Defaults to 60 seconds.

Parameters:

timeout - the request timeout

Returns:

this

authenticator

public WatsonxDeploymentStreamingChatModel.Builder authenticator(com.ibm.watsonx.ai.core.auth.Authenticator authenticator)

Sets a custom Authenticator for generating bearer tokens.

Parameters:

authenticator - the authenticator

Returns:

this

httpClient

public WatsonxDeploymentStreamingChatModel.Builder httpClient(HttpClient httpClient)

Sets a custom HttpClient to use for all API calls.

Parameters:

httpClient - the HTTP client

Returns:

this

verifySsl

public WatsonxDeploymentStreamingChatModel.Builder verifySsl(boolean verifySsl)

Controls whether SSL certificate verification is performed. Defaults to true.

Parameters:

verifySsl - false to disable SSL verification

Returns:

this