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.Authenticator	authenticator
protected URI	baseUrl
protected HttpClient	httpClient
protected Boolean	logRequests
protected Boolean	logResponses
protected String	projectId
protected String	spaceId
protected Duration	timeout
protected boolean	verifySsl
protected String	version

Method Summary

Modifier and Type	Method	Description
WatsonxChatModel.Builder	apiKey(String apiKey)
WatsonxChatModel.Builder	authenticator(com.ibm.watsonx.ai.core.auth.Authenticator authenticator)
WatsonxChatModel.Builder	baseUrl(com.ibm.watsonx.ai.CloudRegion baseUrl)
WatsonxChatModel.Builder	baseUrl(String url)
WatsonxChatModel.Builder	baseUrl(URI url)
WatsonxChatModel	build()
WatsonxChatModel.Builder	defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters defaultRequestParameters)
WatsonxChatModel.Builder	frequencyPenalty(Double frequencyPenalty)
WatsonxChatModel.Builder	guidedChoice(String... guidedChoice)
WatsonxChatModel.Builder	guidedChoice(Set<String> guidedChoices)
WatsonxChatModel.Builder	guidedGrammar(String guidedGrammar)
WatsonxChatModel.Builder	guidedRegex(String guidedRegex)
WatsonxChatModel.Builder	httpClient(HttpClient httpClient)
WatsonxChatModel.Builder	lengthPenalty(Double lengthPenalty)
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	repetitionPenalty(Double repetitionPenalty)
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(boolean enabled)
WatsonxChatModel.Builder	thinking(com.ibm.watsonx.ai.chat.model.ExtractionTags tags)
WatsonxChatModel.Builder	thinking(com.ibm.watsonx.ai.chat.model.Thinking thinking)
WatsonxChatModel.Builder	thinking(com.ibm.watsonx.ai.chat.model.ThinkingEffort thinkingEffort)
WatsonxChatModel.Builder	timeout(Duration timeout)
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	verifySsl(boolean verifySsl)
WatsonxChatModel.Builder	version(String version)

Methods inherited from class Object

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

Field Details

baseUrl

protected URI baseUrl

version

protected String version

apiKey

protected String apiKey

projectId

protected String projectId

spaceId

protected String spaceId

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 WatsonxChatModel build()

modelName

public WatsonxChatModel.Builder modelName(String modelName)

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)

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(boolean enabled)

thinking

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

thinking

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

thinking

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

guidedChoice

public WatsonxChatModel.Builder guidedChoice(String... guidedChoice)

guidedChoice

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

guidedRegex

public WatsonxChatModel.Builder guidedRegex(String guidedRegex)

guidedGrammar

public WatsonxChatModel.Builder guidedGrammar(String guidedGrammar)

repetitionPenalty

public WatsonxChatModel.Builder repetitionPenalty(Double repetitionPenalty)

lengthPenalty

public WatsonxChatModel.Builder lengthPenalty(Double lengthPenalty)

baseUrl

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

baseUrl

public WatsonxChatModel.Builder baseUrl(String url)

baseUrl

public WatsonxChatModel.Builder baseUrl(URI url)

version

public WatsonxChatModel.Builder version(String version)

projectId

public WatsonxChatModel.Builder projectId(String projectId)

spaceId

public WatsonxChatModel.Builder spaceId(String spaceId)

apiKey

public WatsonxChatModel.Builder apiKey(String apiKey)

logRequests

public WatsonxChatModel.Builder logRequests(Boolean logRequests)

logResponses

public WatsonxChatModel.Builder logResponses(Boolean logResponses)

timeout

public WatsonxChatModel.Builder timeout(Duration timeout)

authenticator

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

httpClient

public WatsonxChatModel.Builder httpClient(HttpClient httpClient)

verifySsl

public WatsonxChatModel.Builder verifySsl(boolean verifySsl)