Class OpenAiResponsesChatModel.Builder

java.lang.Object

dev.langchain4j.model.openai.OpenAiResponsesChatModel.Builder

Enclosing class:

OpenAiResponsesChatModel

public static class OpenAiResponsesChatModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenAiResponsesChatModel.Builder	apiKey(String apiKey)
OpenAiResponsesChatModel.Builder	baseUrl(String baseUrl)
OpenAiResponsesChatModel	build()
OpenAiResponsesChatModel.Builder	customHeaders(Supplier<Map<String,String>> customHeadersSupplier)	Sets a supplier for custom HTTP headers to be added to each HTTP request.
OpenAiResponsesChatModel.Builder	customHeaders(Map<String,String> customHeaders)	Sets custom HTTP headers to be added to each HTTP request.
OpenAiResponsesChatModel.Builder	defaultRequestParameters(ChatRequestParameters parameters)
OpenAiResponsesChatModel.Builder	httpClientBuilder(HttpClientBuilder httpClientBuilder)
OpenAiResponsesChatModel.Builder	include(List<String> include)
OpenAiResponsesChatModel.Builder	listeners(ChatModelListener... listeners)
OpenAiResponsesChatModel.Builder	listeners(List<ChatModelListener> listeners)
OpenAiResponsesChatModel.Builder	logRequests(Boolean logRequests)
OpenAiResponsesChatModel.Builder	logResponses(Boolean logResponses)
OpenAiResponsesChatModel.Builder	maxOutputTokens(Integer maxOutputTokens)
OpenAiResponsesChatModel.Builder	maxToolCalls(Integer maxToolCalls)
OpenAiResponsesChatModel.Builder	modelName(String modelName)
OpenAiResponsesChatModel.Builder	organizationId(String organizationId)
OpenAiResponsesChatModel.Builder	parallelToolCalls(Boolean parallelToolCalls)
OpenAiResponsesChatModel.Builder	previousResponseId(String previousResponseId)
OpenAiResponsesChatModel.Builder	promptCacheKey(String promptCacheKey)
OpenAiResponsesChatModel.Builder	promptCacheRetention(String promptCacheRetention)
OpenAiResponsesChatModel.Builder	reasoningEffort(String reasoningEffort)
OpenAiResponsesChatModel.Builder	reasoningSummary(String reasoningSummary)
OpenAiResponsesChatModel.Builder	responseFormat(ResponseFormat responseFormat)
OpenAiResponsesChatModel.Builder	safetyIdentifier(String safetyIdentifier)
OpenAiResponsesChatModel.Builder	serverTools(List<Map<String,Object>> serverTools)
OpenAiResponsesChatModel.Builder	serviceTier(String serviceTier)
OpenAiResponsesChatModel.Builder	store(Boolean store)
OpenAiResponsesChatModel.Builder	strictJsonSchema(Boolean strictJsonSchema)
OpenAiResponsesChatModel.Builder	strictTools(Boolean strictTools)
OpenAiResponsesChatModel.Builder	temperature(Double temperature)
OpenAiResponsesChatModel.Builder	textVerbosity(String textVerbosity)
OpenAiResponsesChatModel.Builder	toolChoice(ToolChoice toolChoice)
OpenAiResponsesChatModel.Builder	toolSpecifications(ToolSpecification... toolSpecifications)
OpenAiResponsesChatModel.Builder	toolSpecifications(List<ToolSpecification> toolSpecifications)
OpenAiResponsesChatModel.Builder	topLogprobs(Integer topLogprobs)
OpenAiResponsesChatModel.Builder	topP(Double topP)
OpenAiResponsesChatModel.Builder	truncation(String truncation)

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

httpClientBuilder

public OpenAiResponsesChatModel.Builder httpClientBuilder(HttpClientBuilder httpClientBuilder)

baseUrl

public OpenAiResponsesChatModel.Builder baseUrl(String baseUrl)

apiKey

public OpenAiResponsesChatModel.Builder apiKey(String apiKey)

organizationId

public OpenAiResponsesChatModel.Builder organizationId(String organizationId)

modelName

public OpenAiResponsesChatModel.Builder modelName(String modelName)

temperature

public OpenAiResponsesChatModel.Builder temperature(Double temperature)

topP

public OpenAiResponsesChatModel.Builder topP(Double topP)

maxOutputTokens

public OpenAiResponsesChatModel.Builder maxOutputTokens(Integer maxOutputTokens)

maxToolCalls

public OpenAiResponsesChatModel.Builder maxToolCalls(Integer maxToolCalls)

parallelToolCalls

public OpenAiResponsesChatModel.Builder parallelToolCalls(Boolean parallelToolCalls)

previousResponseId

public OpenAiResponsesChatModel.Builder previousResponseId(String previousResponseId)

topLogprobs

public OpenAiResponsesChatModel.Builder topLogprobs(Integer topLogprobs)

truncation

public OpenAiResponsesChatModel.Builder truncation(String truncation)

include

public OpenAiResponsesChatModel.Builder include(List<String> include)

serviceTier

public OpenAiResponsesChatModel.Builder serviceTier(String serviceTier)

safetyIdentifier

public OpenAiResponsesChatModel.Builder safetyIdentifier(String safetyIdentifier)

promptCacheKey

public OpenAiResponsesChatModel.Builder promptCacheKey(String promptCacheKey)

promptCacheRetention

public OpenAiResponsesChatModel.Builder promptCacheRetention(String promptCacheRetention)

reasoningEffort

public OpenAiResponsesChatModel.Builder reasoningEffort(String reasoningEffort)

reasoningSummary

public OpenAiResponsesChatModel.Builder reasoningSummary(String reasoningSummary)

textVerbosity

public OpenAiResponsesChatModel.Builder textVerbosity(String textVerbosity)

store

public OpenAiResponsesChatModel.Builder store(Boolean store)

strictTools

public OpenAiResponsesChatModel.Builder strictTools(Boolean strictTools)

strictJsonSchema

public OpenAiResponsesChatModel.Builder strictJsonSchema(Boolean strictJsonSchema)

responseFormat

public OpenAiResponsesChatModel.Builder responseFormat(ResponseFormat responseFormat)

toolSpecifications

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

toolSpecifications

public OpenAiResponsesChatModel.Builder toolSpecifications(ToolSpecification... toolSpecifications)

serverTools

public OpenAiResponsesChatModel.Builder serverTools(List<Map<String,Object>> serverTools)

toolChoice

public OpenAiResponsesChatModel.Builder toolChoice(ToolChoice toolChoice)

logRequests

public OpenAiResponsesChatModel.Builder logRequests(Boolean logRequests)

logResponses

public OpenAiResponsesChatModel.Builder logResponses(Boolean logResponses)

listeners

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

listeners

public OpenAiResponsesChatModel.Builder listeners(ChatModelListener... listeners)

customHeaders

public OpenAiResponsesChatModel.Builder customHeaders(Map<String,String> customHeaders)

Sets custom HTTP headers to be added to each HTTP request.

Parameters:

customHeaders - a map of headers

Returns:

this

customHeaders

public OpenAiResponsesChatModel.Builder customHeaders(Supplier<Map<String,String>> customHeadersSupplier)

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

Parameters:

customHeadersSupplier - a supplier that provides a map of headers

Returns:

this

defaultRequestParameters

public OpenAiResponsesChatModel.Builder defaultRequestParameters(ChatRequestParameters parameters)

build

public OpenAiResponsesChatModel build()