Class OpenAiOfficialChatRequestParameters

java.lang.Object

dev.langchain4j.model.chat.request.DefaultChatRequestParameters

dev.langchain4j.model.openaiofficial.OpenAiOfficialChatRequestParameters

All Implemented Interfaces:

ChatRequestParameters

@Experimental
public class OpenAiOfficialChatRequestParameters
extends DefaultChatRequestParameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiOfficialChatRequestParameters.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final OpenAiOfficialChatRequestParameters	EMPTY

Method Summary

Modifier and Type	Method	Description
static OpenAiOfficialChatRequestParameters.Builder	builder()
OpenAiOfficialChatRequestParameters	defaultedBy(ChatRequestParameters that)	Creates a new ChatRequestParameters by combining the current parameters with the specified ones.
boolean	equals(Object o)
int	hashCode()
Map<String,Integer>	logitBias()
Integer	maxCompletionTokens()
Map<String,String>	metadata()
OpenAiOfficialChatRequestParameters	overrideWith(ChatRequestParameters that)	Creates a new ChatRequestParameters by combining the current parameters with the specified ones.
Boolean	parallelToolCalls()
String	promptCacheKey()	Returns prompt_cache_key, an optional string that steers routing so that related requests are more likely to hit a machine holding the cache entry.
OpenAiOfficialPromptCacheOptions	promptCacheOptions()	Returns prompt_cache_options, supported by gpt-5.6 and later.
String	reasoningEffort()
Integer	seed()
String	serviceTier()
Boolean	store()
String	user()

Methods inherited from class DefaultChatRequestParameters

frequencyPenalty, maxOutputTokens, modelName, presencePenalty, responseFormat, stopSequences, temperature, toolChoice, toolSpecifications, topK, topP, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY

public static final OpenAiOfficialChatRequestParameters EMPTY

Method Details

maxCompletionTokens

public Integer maxCompletionTokens()

logitBias

public Map<String,Integer> logitBias()

parallelToolCalls

public Boolean parallelToolCalls()

seed

public Integer seed()

user

public String user()

store

public Boolean store()

metadata

public Map<String,String> metadata()

serviceTier

public String serviceTier()

promptCacheKey

public String promptCacheKey()

Returns prompt_cache_key, an optional string that steers routing so that related requests are more likely to hit a machine holding the cache entry.

Since:

1.21.0

promptCacheOptions

public OpenAiOfficialPromptCacheOptions promptCacheOptions()

Returns prompt_cache_options, supported by gpt-5.6 and later.

Since:

1.21.0

reasoningEffort

public String reasoningEffort()

overrideWith

public OpenAiOfficialChatRequestParameters overrideWith(ChatRequestParameters that)

Description copied from interface: ChatRequestParameters

Creates a new ChatRequestParameters by combining the current parameters with the specified ones. Values from the specified parameters override values from the current parameters when there is overlap. Neither the current nor the specified ChatRequestParameters objects are modified.

Example:

Current parameters:
  temperature = 1.0
  maxOutputTokens = 100

Specified parameters:
  temperature = 0.5
  modelName = my-model

Result:
  temperature = 0.5        // Overridden from specified
  maxOutputTokens = 100    // Preserved from current
  modelName = my-model     // Added from specified

Specified by:

overrideWith in interface ChatRequestParameters

Overrides:

overrideWith in class DefaultChatRequestParameters

Parameters:

that - the parameters whose values will override the current ones

Returns:

a new ChatRequestParameters instance combining both sets of parameters

defaultedBy

public OpenAiOfficialChatRequestParameters defaultedBy(ChatRequestParameters that)

Description copied from interface: ChatRequestParameters

Creates a new ChatRequestParameters by combining the current parameters with the specified ones. Values from the current parameters take precedence over values from the specified parameters when there is overlap. Neither the current nor the specified ChatRequestParameters objects are modified.

Example:

Current parameters:
  temperature = 1.0
  maxOutputTokens = 100

Specified parameters:
  temperature = 0.5
  modelName = my-model

Result:
  temperature = 1.0        // Preserved from current
  maxOutputTokens = 100    // Preserved from current
  modelName = my-model     // Added from specified

Specified by:

defaultedBy in interface ChatRequestParameters

Overrides:

defaultedBy in class DefaultChatRequestParameters

Parameters:

that - the parameters whose values will be used as a default for the current ones

Returns:

a new ChatRequestParameters instance combining both sets of parameters

equals

public boolean equals(Object o)

Overrides:

equals in class DefaultChatRequestParameters

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultChatRequestParameters

builder

public static OpenAiOfficialChatRequestParameters.Builder builder()