Class OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder

java.lang.Object

dev.langchain4j.model.openai.OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder

Enclosing class:

OpenAiStreamingChatModel

public static class OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
OpenAiStreamingChatModelBuilder()

Method Summary

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

Methods inherited from class Object

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

Constructor Details

OpenAiStreamingChatModelBuilder

public OpenAiStreamingChatModelBuilder()

Method Details

httpClientBuilder

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder httpClientBuilder(HttpClientBuilder httpClientBuilder)

defaultRequestParameters

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder 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 OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder modelName(String modelName)

modelName

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder modelName(OpenAiChatModelName modelName)

baseUrl

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder baseUrl(String baseUrl)

apiKey

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder apiKey(String apiKey)

organizationId

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder organizationId(String organizationId)

projectId

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder projectId(String projectId)

temperature

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder temperature(Double temperature)

topP

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder topP(Double topP)

stop

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder stop(List<String> stop)

maxTokens

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder maxTokens(Integer maxTokens)

maxCompletionTokens

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder maxCompletionTokens(Integer maxCompletionTokens)

presencePenalty

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder presencePenalty(Double presencePenalty)

frequencyPenalty

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder frequencyPenalty(Double frequencyPenalty)

logitBias

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder logitBias(Map<String,Integer> logitBias)

responseFormat

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder responseFormat(ResponseFormat responseFormat)

responseFormat

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder responseFormat(String responseFormat)

See Also:

• responseFormat(ResponseFormat)

strictJsonSchema

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder strictJsonSchema(Boolean strictJsonSchema)

seed

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder seed(Integer seed)

user

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder user(String user)

strictTools

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder strictTools(Boolean strictTools)

parallelToolCalls

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder parallelToolCalls(Boolean parallelToolCalls)

store

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder store(Boolean store)

metadata

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder metadata(Map<String,String> metadata)

serviceTier

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder serviceTier(String serviceTier)

reasoningEffort

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder reasoningEffort(String reasoningEffort)

returnThinking

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder returnThinking(Boolean returnThinking)

This setting is intended for DeepSeek.

Controls whether to return thinking/reasoning text (if available) inside AiMessage.thinking() and whether to invoke the StreamingChatResponseHandler.onPartialThinking(PartialThinking) callback. 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.

sendThinking

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder sendThinking(Boolean sendThinking,
 String fieldName)

This setting is intended for DeepSeek.

Controls whether to include thinking/reasoning text in assistant messages when sending requests to the API. This is needed for some APIs (like DeepSeek) when using reasoning mode with tool calls.

Disabled by default.

When enabled, the reasoning content from previous assistant messages (stored in AiMessage.thinking()) will be included in the request during message conversion to API format.

Parameters:

sendThinking - whether to send reasoning content

fieldName - the field name for reasoning content

Returns:

this

sendThinking

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder sendThinking(Boolean sendThinking)

This setting is intended for DeepSeek.

Controls whether to include thinking/reasoning text in assistant messages when sending requests to the API. This is needed for some APIs (like DeepSeek) when using reasoning mode with tool calls. Uses the default field name "reasoning_content" for the reasoning content field.

Disabled by default.

When enabled, the reasoning content from previous assistant messages (stored in AiMessage.thinking()) will be included in the request during message conversion to API format.

Parameters:

sendThinking - whether to send reasoning content

Returns:

this

timeout

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder timeout(Duration timeout)

logRequests

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder logRequests(Boolean logRequests)

logResponses

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder logResponses(Boolean logResponses)

logger

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder 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 OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder customHeaders(Map<String,String> customHeaders)

Sets custom HTTP headers.

customHeaders

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder customHeaders(Supplier<Map<String,String>> customHeadersSupplier)

Sets a supplier for custom HTTP headers. The supplier is called before each request, allowing dynamic header values. For example, this is useful for OAuth2 tokens that expire and need refreshing.

customQueryParams

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder customQueryParams(Map<String,String> customQueryParams)

Sets custom URL query parameters

customParameters

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder customParameters(Map<String,Object> customParameters)

Sets custom HTTP body parameters

listeners

public OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder listeners(List<ChatModelListener> listeners)

build

public OpenAiStreamingChatModel build()