Class OpenAiOfficialResponsesChatRequestParameters

java.lang.Object

dev.langchain4j.model.chat.request.DefaultChatRequestParameters

dev.langchain4j.model.openaiofficial.OpenAiOfficialResponsesChatRequestParameters

All Implemented Interfaces:

ChatRequestParameters

@Experimental
public class OpenAiOfficialResponsesChatRequestParameters
extends DefaultChatRequestParameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiOfficialResponsesChatRequestParameters.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final OpenAiOfficialResponsesChatRequestParameters	EMPTY

Method Summary

Modifier and Type	Method	Description
static OpenAiOfficialResponsesChatRequestParameters.Builder	builder()
OpenAiOfficialResponsesChatRequestParameters	defaultedBy(ChatRequestParameters that)	Creates a new ChatRequestParameters by combining the current parameters with the specified ones.
boolean	equals(Object o)
int	hashCode()
List<String>	include()
Integer	maxToolCalls()
OpenAiOfficialResponsesChatRequestParameters	overrideWith(ChatRequestParameters that)	Creates a new ChatRequestParameters by combining the current parameters with the specified ones.
Boolean	parallelToolCalls()
String	previousResponseId()
String	promptCacheKey()
String	promptCacheRetention()
com.openai.models.ReasoningEffort	reasoningEffort()
com.openai.models.Reasoning.Summary	reasoningSummary()
String	safetyIdentifier()
String	serviceTier()
Boolean	store()
Boolean	streamIncludeObfuscation()
Boolean	strictJsonSchema()
Boolean	strictTools()
String	textVerbosity()
Integer	topLogprobs()
String	truncation()

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 OpenAiOfficialResponsesChatRequestParameters EMPTY

Method Details

previousResponseId

public String previousResponseId()

maxToolCalls

public Integer maxToolCalls()

parallelToolCalls

public Boolean parallelToolCalls()

topLogprobs

public Integer topLogprobs()

truncation

public String truncation()

include

public List<String> include()

serviceTier

public String serviceTier()

safetyIdentifier

public String safetyIdentifier()

promptCacheKey

public String promptCacheKey()

promptCacheRetention

public String promptCacheRetention()

reasoningEffort

public com.openai.models.ReasoningEffort reasoningEffort()

reasoningSummary

public com.openai.models.Reasoning.Summary reasoningSummary()

textVerbosity

public String textVerbosity()

streamIncludeObfuscation

public Boolean streamIncludeObfuscation()

store

public Boolean store()

strictTools

public Boolean strictTools()

strictJsonSchema

public Boolean strictJsonSchema()

overrideWith

public OpenAiOfficialResponsesChatRequestParameters 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 OpenAiOfficialResponsesChatRequestParameters 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 OpenAiOfficialResponsesChatRequestParameters.Builder builder()