Class OpenAiDecisionModel.OpenAiDecisionModelBuilder

java.lang.Object

dev.langchain4j.model.openai.OpenAiDecisionModel.OpenAiDecisionModelBuilder

Enclosing class:

OpenAiDecisionModel

public static class OpenAiDecisionModel.OpenAiDecisionModelBuilder
extends Object

Since:

1.22.0

Constructor Summary

Constructors

Constructor	Description
OpenAiDecisionModelBuilder()

Method Summary

Modifier and Type	Method	Description
OpenAiDecisionModel.OpenAiDecisionModelBuilder	apiKey(String apiKey)
OpenAiDecisionModel.OpenAiDecisionModelBuilder	baseUrl(String baseUrl)	The base URL of the API.
OpenAiDecisionModel	build()
OpenAiDecisionModel.OpenAiDecisionModelBuilder	customHeaders(Supplier<Map<String,String>> customHeadersSupplier)	Sets a supplier for custom HTTP headers.
OpenAiDecisionModel.OpenAiDecisionModelBuilder	customHeaders(Map<String,String> customHeaders)	Sets custom HTTP headers.
OpenAiDecisionModel.OpenAiDecisionModelBuilder	customParameters(Map<String,Object> customParameters)	Custom parameters added to the body of every request, for example to use a feature of the OpenAI Decisions API that this class does not support yet.
OpenAiDecisionModel.OpenAiDecisionModelBuilder	customQueryParams(Map<String,String> customQueryParams)
OpenAiDecisionModel.OpenAiDecisionModelBuilder	httpClientBuilder(HttpClientBuilder httpClientBuilder)	Sets a custom HTTP client builder, allowing fine-grained control over the HTTP client configuration such as timeouts and proxy settings.
OpenAiDecisionModel.OpenAiDecisionModelBuilder	listeners(DecisionModelListener... listeners)
OpenAiDecisionModel.OpenAiDecisionModelBuilder	listeners(List<DecisionModelListener> listeners)
OpenAiDecisionModel.OpenAiDecisionModelBuilder	logger(org.slf4j.Logger logger)
OpenAiDecisionModel.OpenAiDecisionModelBuilder	logRequests(Boolean logRequests)	Whether to log requests.
OpenAiDecisionModel.OpenAiDecisionModelBuilder	logResponses(Boolean logResponses)	Whether to log responses.
OpenAiDecisionModel.OpenAiDecisionModelBuilder	maxRetries(Integer maxRetries)	The number of retries after the first attempt, for transient errors such as timeouts, rate limits and server errors.
OpenAiDecisionModel.OpenAiDecisionModelBuilder	modelName(OpenAiDecisionModelName modelName)	The model to use when a request does not specify one.
OpenAiDecisionModel.OpenAiDecisionModelBuilder	modelName(String modelName)	The model to use when a request does not specify one, for example gpt-6-luna.
OpenAiDecisionModel.OpenAiDecisionModelBuilder	organizationId(String organizationId)
OpenAiDecisionModel.OpenAiDecisionModelBuilder	projectId(String projectId)
OpenAiDecisionModel.OpenAiDecisionModelBuilder	promptCacheKey(String promptCacheKey)	A key that separates prompt caching between groups of requests, sent as prompt_cache_key.
OpenAiDecisionModel.OpenAiDecisionModelBuilder	timeout(Duration timeout)	The connect and read timeout.

Methods inherited from class Object

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

Constructor Details

OpenAiDecisionModelBuilder

public OpenAiDecisionModelBuilder()

Method Details

httpClientBuilder

public OpenAiDecisionModel.OpenAiDecisionModelBuilder httpClientBuilder(HttpClientBuilder httpClientBuilder)

Sets a custom HTTP client builder, allowing fine-grained control over the HTTP client configuration such as timeouts and proxy settings.

baseUrl

public OpenAiDecisionModel.OpenAiDecisionModelBuilder baseUrl(String baseUrl)

The base URL of the API. Defaults to https://api.openai.com/v1.

apiKey

public OpenAiDecisionModel.OpenAiDecisionModelBuilder apiKey(String apiKey)

organizationId

public OpenAiDecisionModel.OpenAiDecisionModelBuilder organizationId(String organizationId)

projectId

public OpenAiDecisionModel.OpenAiDecisionModelBuilder projectId(String projectId)

modelName

public OpenAiDecisionModel.OpenAiDecisionModelBuilder modelName(String modelName)

The model to use when a request does not specify one, for example gpt-6-luna. The model name must be set either here or on each request.

modelName

public OpenAiDecisionModel.OpenAiDecisionModelBuilder modelName(OpenAiDecisionModelName modelName)

The model to use when a request does not specify one. The model name must be set either here or on each request.

timeout

public OpenAiDecisionModel.OpenAiDecisionModelBuilder timeout(Duration timeout)

The connect and read timeout. Default values are 15 seconds (connect) and 60 seconds (read).

maxRetries

public OpenAiDecisionModel.OpenAiDecisionModelBuilder maxRetries(Integer maxRetries)

The number of retries after the first attempt, for transient errors such as timeouts, rate limits and server errors. Default value is 2.

logRequests

public OpenAiDecisionModel.OpenAiDecisionModelBuilder logRequests(Boolean logRequests)

Whether to log requests. Default value is false.

logResponses

public OpenAiDecisionModel.OpenAiDecisionModelBuilder logResponses(Boolean logResponses)

Whether to log responses. Default value is false.

logger

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

Sets custom HTTP headers.

customHeaders

public OpenAiDecisionModel.OpenAiDecisionModelBuilder 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 OpenAiDecisionModel.OpenAiDecisionModelBuilder customQueryParams(Map<String,String> customQueryParams)

promptCacheKey

public OpenAiDecisionModel.OpenAiDecisionModelBuilder promptCacheKey(String promptCacheKey)

A key that separates prompt caching between groups of requests, sent as prompt_cache_key. OpenAI caches the shared input of requests automatically, also without a key. With a key, only requests with the same key reuse each other's cached input, for example to keep cache reuse and the cached token counts separate per customer or user. Not set by default.

It can be replaced for a single request with OpenAiDecisionRequestParameters.Builder.promptCacheKey(String). See the prompt caching guide.

customParameters

public OpenAiDecisionModel.OpenAiDecisionModelBuilder customParameters(Map<String,Object> customParameters)

Custom parameters added to the body of every request, for example to use a feature of the OpenAI Decisions API that this class does not support yet. A custom parameter with the same name as a parameter set by this class replaces it. They can be replaced for a single request with OpenAiDecisionRequestParameters.Builder.customParameters(Map).

listeners

public OpenAiDecisionModel.OpenAiDecisionModelBuilder listeners(List<DecisionModelListener> listeners)

listeners

public OpenAiDecisionModel.OpenAiDecisionModelBuilder listeners(DecisionModelListener... listeners)

build

public OpenAiDecisionModel build()