Class OpenAiChatModel.OpenAiChatModelBuilder

java.lang.Object

dev.langchain4j.model.openai.OpenAiChatModel.OpenAiChatModelBuilder

Enclosing class:

OpenAiChatModel

public static class OpenAiChatModel.OpenAiChatModelBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
OpenAiChatModelBuilder()

Method Summary

Modifier and Type	Method	Description
OpenAiChatModel.OpenAiChatModelBuilder	apiKey(String apiKey)
OpenAiChatModel.OpenAiChatModelBuilder	baseUrl(String baseUrl)
OpenAiChatModel	build()
OpenAiChatModel.OpenAiChatModelBuilder	customHeaders(Map<String,String> customHeaders)	Sets custom HTTP headers
OpenAiChatModel.OpenAiChatModelBuilder	customParameters(Map<String,Object> customParameters)	Sets custom HTTP body parameters
OpenAiChatModel.OpenAiChatModelBuilder	customQueryParams(Map<String,String> customQueryParams)	Sets custom URL query parameters
OpenAiChatModel.OpenAiChatModelBuilder	defaultRequestParameters(ChatRequestParameters parameters)	Sets default common ChatRequestParameters or OpenAI-specific OpenAiChatRequestParameters.
OpenAiChatModel.OpenAiChatModelBuilder	frequencyPenalty(Double frequencyPenalty)
OpenAiChatModel.OpenAiChatModelBuilder	httpClientBuilder(HttpClientBuilder httpClientBuilder)
OpenAiChatModel.OpenAiChatModelBuilder	listeners(List<ChatModelListener> listeners)
OpenAiChatModel.OpenAiChatModelBuilder	logger(org.slf4j.Logger logger)
OpenAiChatModel.OpenAiChatModelBuilder	logitBias(Map<String,Integer> logitBias)
OpenAiChatModel.OpenAiChatModelBuilder	logRequests(Boolean logRequests)
OpenAiChatModel.OpenAiChatModelBuilder	logResponses(Boolean logResponses)
OpenAiChatModel.OpenAiChatModelBuilder	maxCompletionTokens(Integer maxCompletionTokens)
OpenAiChatModel.OpenAiChatModelBuilder	maxRetries(Integer maxRetries)
OpenAiChatModel.OpenAiChatModelBuilder	maxTokens(Integer maxTokens)
OpenAiChatModel.OpenAiChatModelBuilder	metadata(Map<String,String> metadata)
OpenAiChatModel.OpenAiChatModelBuilder	modelName(OpenAiChatModelName modelName)
OpenAiChatModel.OpenAiChatModelBuilder	modelName(String modelName)
OpenAiChatModel.OpenAiChatModelBuilder	organizationId(String organizationId)
OpenAiChatModel.OpenAiChatModelBuilder	parallelToolCalls(Boolean parallelToolCalls)
OpenAiChatModel.OpenAiChatModelBuilder	presencePenalty(Double presencePenalty)
OpenAiChatModel.OpenAiChatModelBuilder	projectId(String projectId)
OpenAiChatModel.OpenAiChatModelBuilder	reasoningEffort(String reasoningEffort)
OpenAiChatModel.OpenAiChatModelBuilder	responseFormat(ResponseFormat responseFormat)
OpenAiChatModel.OpenAiChatModelBuilder	responseFormat(String responseFormat)
OpenAiChatModel.OpenAiChatModelBuilder	returnThinking(Boolean returnThinking)	This setting is intended for DeepSeek.
OpenAiChatModel.OpenAiChatModelBuilder	seed(Integer seed)
OpenAiChatModel.OpenAiChatModelBuilder	serviceTier(String serviceTier)
OpenAiChatModel.OpenAiChatModelBuilder	stop(List<String> stop)
OpenAiChatModel.OpenAiChatModelBuilder	store(Boolean store)
OpenAiChatModel.OpenAiChatModelBuilder	strictJsonSchema(Boolean strictJsonSchema)
OpenAiChatModel.OpenAiChatModelBuilder	strictTools(Boolean strictTools)
OpenAiChatModel.OpenAiChatModelBuilder	supportedCapabilities(Capability... supportedCapabilities)
OpenAiChatModel.OpenAiChatModelBuilder	supportedCapabilities(Set<Capability> supportedCapabilities)
OpenAiChatModel.OpenAiChatModelBuilder	temperature(Double temperature)
OpenAiChatModel.OpenAiChatModelBuilder	timeout(Duration timeout)
OpenAiChatModel.OpenAiChatModelBuilder	topP(Double topP)
OpenAiChatModel.OpenAiChatModelBuilder	user(String user)

Methods inherited from class Object

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

Constructor Details

OpenAiChatModelBuilder

public OpenAiChatModelBuilder()

Method Details

httpClientBuilder

public OpenAiChatModel.OpenAiChatModelBuilder httpClientBuilder(HttpClientBuilder httpClientBuilder)

defaultRequestParameters

public OpenAiChatModel.OpenAiChatModelBuilder defaultRequestParameters(ChatRequestParameters parameters)

Sets default common ChatRequestParameters or OpenAI-specific OpenAiChatRequestParameters.
When a parameter is set via an individual builder method (e.g., modelName(String)), its value takes precedence over the same parameter set via ChatRequestParameters.

modelName

public OpenAiChatModel.OpenAiChatModelBuilder modelName(String modelName)

modelName

public OpenAiChatModel.OpenAiChatModelBuilder modelName(OpenAiChatModelName modelName)

baseUrl

public OpenAiChatModel.OpenAiChatModelBuilder baseUrl(String baseUrl)

apiKey

public OpenAiChatModel.OpenAiChatModelBuilder apiKey(String apiKey)

organizationId

public OpenAiChatModel.OpenAiChatModelBuilder organizationId(String organizationId)

projectId

public OpenAiChatModel.OpenAiChatModelBuilder projectId(String projectId)

temperature

public OpenAiChatModel.OpenAiChatModelBuilder temperature(Double temperature)

topP

public OpenAiChatModel.OpenAiChatModelBuilder topP(Double topP)

stop

public OpenAiChatModel.OpenAiChatModelBuilder stop(List<String> stop)

maxTokens

public OpenAiChatModel.OpenAiChatModelBuilder maxTokens(Integer maxTokens)

maxCompletionTokens

public OpenAiChatModel.OpenAiChatModelBuilder maxCompletionTokens(Integer maxCompletionTokens)

presencePenalty

public OpenAiChatModel.OpenAiChatModelBuilder presencePenalty(Double presencePenalty)

frequencyPenalty

public OpenAiChatModel.OpenAiChatModelBuilder frequencyPenalty(Double frequencyPenalty)

logitBias

public OpenAiChatModel.OpenAiChatModelBuilder logitBias(Map<String,Integer> logitBias)

responseFormat

public OpenAiChatModel.OpenAiChatModelBuilder responseFormat(ResponseFormat responseFormat)

responseFormat

public OpenAiChatModel.OpenAiChatModelBuilder responseFormat(String responseFormat)

See Also:

• responseFormat(ResponseFormat)

supportedCapabilities

public OpenAiChatModel.OpenAiChatModelBuilder supportedCapabilities(Set<Capability> supportedCapabilities)

supportedCapabilities

public OpenAiChatModel.OpenAiChatModelBuilder supportedCapabilities(Capability... supportedCapabilities)

strictJsonSchema

public OpenAiChatModel.OpenAiChatModelBuilder strictJsonSchema(Boolean strictJsonSchema)

seed

public OpenAiChatModel.OpenAiChatModelBuilder seed(Integer seed)

user

public OpenAiChatModel.OpenAiChatModelBuilder user(String user)

strictTools

public OpenAiChatModel.OpenAiChatModelBuilder strictTools(Boolean strictTools)

parallelToolCalls

public OpenAiChatModel.OpenAiChatModelBuilder parallelToolCalls(Boolean parallelToolCalls)

store

public OpenAiChatModel.OpenAiChatModelBuilder store(Boolean store)

metadata

public OpenAiChatModel.OpenAiChatModelBuilder metadata(Map<String,String> metadata)

serviceTier

public OpenAiChatModel.OpenAiChatModelBuilder serviceTier(String serviceTier)

reasoningEffort

public OpenAiChatModel.OpenAiChatModelBuilder reasoningEffort(String reasoningEffort)

returnThinking

public OpenAiChatModel.OpenAiChatModelBuilder returnThinking(Boolean returnThinking)

This setting is intended for DeepSeek.

Controls whether to return thinking/reasoning text (if available) inside AiMessage.thinking(). Please note that this does not enable thinking/reasoning for the LLM; it only controls whether to parse the reasoning_content field from the API response and return it inside the AiMessage.

Disabled by default. If enabled, the thinking text will be stored within the AiMessage and may be persisted.

timeout

public OpenAiChatModel.OpenAiChatModelBuilder timeout(Duration timeout)

maxRetries

public OpenAiChatModel.OpenAiChatModelBuilder maxRetries(Integer maxRetries)

logRequests

public OpenAiChatModel.OpenAiChatModelBuilder logRequests(Boolean logRequests)

logResponses

public OpenAiChatModel.OpenAiChatModelBuilder logResponses(Boolean logResponses)

logger

public OpenAiChatModel.OpenAiChatModelBuilder logger(org.slf4j.Logger logger)

Parameters:

logger - an alternate Logger to be used instead of the default one provided by Langchain4J for logging requests and responses.

Returns:

this.

customHeaders

public OpenAiChatModel.OpenAiChatModelBuilder customHeaders(Map<String,String> customHeaders)

Sets custom HTTP headers

customQueryParams

public OpenAiChatModel.OpenAiChatModelBuilder customQueryParams(Map<String,String> customQueryParams)

Sets custom URL query parameters

customParameters

public OpenAiChatModel.OpenAiChatModelBuilder customParameters(Map<String,Object> customParameters)

Sets custom HTTP body parameters

listeners

public OpenAiChatModel.OpenAiChatModelBuilder listeners(List<ChatModelListener> listeners)

build

public OpenAiChatModel build()