Class OpenAiOfficialDecisionRequestParameters.Builder

java.lang.Object

dev.langchain4j.model.decision.request.DefaultDecisionRequestParameters.Builder<OpenAiOfficialDecisionRequestParameters.Builder>

dev.langchain4j.model.openaiofficial.OpenAiOfficialDecisionRequestParameters.Builder

Enclosing class:

OpenAiOfficialDecisionRequestParameters

public static class OpenAiOfficialDecisionRequestParameters.Builder
extends DefaultDecisionRequestParameters.Builder<OpenAiOfficialDecisionRequestParameters.Builder>

Since:

1.23.0

Field Summary

Fields inherited from class DefaultDecisionRequestParameters.Builder

modelName

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenAiOfficialDecisionRequestParameters	build()
OpenAiOfficialDecisionRequestParameters.Builder	customParameters(Map<String,Object> customParameters)	Custom parameters added to the body of the request, for example to use a feature of the OpenAI Decisions API that OpenAiOfficialDecisionModel does not support yet.
OpenAiOfficialDecisionRequestParameters.Builder	overrideWith(DecisionRequestParameters parameters)	Copies the populated parameters from the given instance into this builder.
OpenAiOfficialDecisionRequestParameters.Builder	promptCacheKey(String promptCacheKey)	A key that separates prompt caching between groups of requests, sent as prompt_cache_key.

Methods inherited from class DefaultDecisionRequestParameters.Builder

modelName, self

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

overrideWith

public OpenAiOfficialDecisionRequestParameters.Builder overrideWith(DecisionRequestParameters parameters)

Description copied from class: DefaultDecisionRequestParameters.Builder

Copies the populated parameters from the given instance into this builder.

Overrides:

overrideWith in class DefaultDecisionRequestParameters.Builder<OpenAiOfficialDecisionRequestParameters.Builder>

Parameters:

parameters - the parameters to copy, may be null.

Returns:

this.

promptCacheKey

public OpenAiOfficialDecisionRequestParameters.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.

If set, it replaces the key set on the OpenAiOfficialDecisionModel builder for this request. See the prompt caching guide.

customParameters

public OpenAiOfficialDecisionRequestParameters.Builder customParameters(Map<String,Object> customParameters)

Custom parameters added to the body of the request, for example to use a feature of the OpenAI Decisions API that OpenAiOfficialDecisionModel does not support yet. A custom parameter with the same name as a parameter that OpenAiOfficialDecisionModel sends replaces it.

If not empty, they replace (are not merged with) the custom parameters set on the OpenAiOfficialDecisionModel builder for this request. If not set or empty, the custom parameters of the builder are used.

build

public OpenAiOfficialDecisionRequestParameters build()

Overrides:

build in class DefaultDecisionRequestParameters.Builder<OpenAiOfficialDecisionRequestParameters.Builder>