Class OpenAiOfficialDecisionModel.Builder

java.lang.Object

dev.langchain4j.model.openaiofficial.OpenAiOfficialDecisionModel.Builder

Enclosing class:

OpenAiOfficialDecisionModel

public static class OpenAiOfficialDecisionModel.Builder
extends Object

Since:

1.22.0

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenAiOfficialDecisionModel.Builder	apiKey(String apiKey)
OpenAiOfficialDecisionModel.Builder	baseUrl(String baseUrl)
OpenAiOfficialDecisionModel	build()
OpenAiOfficialDecisionModel.Builder	customHeaders(Map<String,String> customHeaders)
OpenAiOfficialDecisionModel.Builder	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.
OpenAiOfficialDecisionModel.Builder	listeners(DecisionModelListener... listeners)
OpenAiOfficialDecisionModel.Builder	listeners(List<DecisionModelListener> listeners)
OpenAiOfficialDecisionModel.Builder	maxRetries(Integer maxRetries)	The number of retries of the OpenAI SDK for transient errors such as timeouts, rate limits and server errors.
OpenAiOfficialDecisionModel.Builder	modelName(String modelName)	The model to use when a request does not specify one, for example gpt-6-luna.
OpenAiOfficialDecisionModel.Builder	openAIClient(com.openai.client.OpenAIClient openAIClient)	Sets a preconfigured OpenAI client.
OpenAiOfficialDecisionModel.Builder	organizationId(String organizationId)
OpenAiOfficialDecisionModel.Builder	promptCacheKey(String promptCacheKey)	A key that separates prompt caching between groups of requests, sent as prompt_cache_key.
OpenAiOfficialDecisionModel.Builder	proxy(Proxy proxy)
OpenAiOfficialDecisionModel.Builder	timeout(Duration timeout)	The timeout of a call.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

baseUrl

public OpenAiOfficialDecisionModel.Builder baseUrl(String baseUrl)

apiKey

public OpenAiOfficialDecisionModel.Builder apiKey(String apiKey)

organizationId

public OpenAiOfficialDecisionModel.Builder organizationId(String organizationId)

openAIClient

public OpenAiOfficialDecisionModel.Builder openAIClient(com.openai.client.OpenAIClient openAIClient)

Sets a preconfigured OpenAI client. The other client settings (base URL, API key, timeout...) are then ignored.

modelName

public OpenAiOfficialDecisionModel.Builder 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.

timeout

public OpenAiOfficialDecisionModel.Builder timeout(Duration timeout)

The timeout of a call. Default value is 60 seconds.

maxRetries

public OpenAiOfficialDecisionModel.Builder maxRetries(Integer maxRetries)

The number of retries of the OpenAI SDK for transient errors such as timeouts, rate limits and server errors. Default value is 3.

proxy

public OpenAiOfficialDecisionModel.Builder proxy(Proxy proxy)

customHeaders

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

promptCacheKey

public OpenAiOfficialDecisionModel.Builder 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 OpenAiOfficialDecisionRequestParameters.Builder.promptCacheKey(String). See the prompt caching guide.

customParameters

public OpenAiOfficialDecisionModel.Builder 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 OpenAiOfficialDecisionRequestParameters.Builder.customParameters(Map).

listeners

public OpenAiOfficialDecisionModel.Builder listeners(List<DecisionModelListener> listeners)

listeners

public OpenAiOfficialDecisionModel.Builder listeners(DecisionModelListener... listeners)

build

public OpenAiOfficialDecisionModel build()