Class OpenAiOfficialPromptCacheOptions

java.lang.Object

dev.langchain4j.model.openaiofficial.OpenAiOfficialPromptCacheOptions

public class OpenAiOfficialPromptCacheOptions
extends Object

Represents the prompt_cache_options request object supported by gpt-5.6 and later.

On these models a cached prefix is matched exactly at a breakpoint, without falling back to a shorter unmarked prefix. The mode controls where breakpoints come from:

• MODE_IMPLICIT - OpenAI places a breakpoint at the end of the newest eligible message.
• MODE_EXPLICIT - only the breakpoints set via OpenAiOfficialPromptCacheBreakpoint are used. Without any breakpoint, nothing is cached.

Note that prompt_cache_options.ttl supersedes prompt_cache_retention, which applies to earlier models only. Setting both on the same request is rejected by OpenAI.

Since:

1.21.0

See Also:

• Prompt caching

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiOfficialPromptCacheOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODE_EXPLICIT	Only explicitly set breakpoints are used.
static final String	MODE_IMPLICIT	OpenAI places a breakpoint at the end of the newest eligible message.
static final String	TTL_30M	The only TTL currently accepted by OpenAI.

Method Summary

Modifier and Type	Method	Description
static OpenAiOfficialPromptCacheOptions.Builder	builder()
boolean	equals(Object o)
static OpenAiOfficialPromptCacheOptions	explicit()	Creates options with MODE_EXPLICIT.
int	hashCode()
static OpenAiOfficialPromptCacheOptions	implicit()	Creates options with MODE_IMPLICIT.
String	mode()	Returns prompt_cache_options.mode.
String	toString()
String	ttl()	Returns prompt_cache_options.ttl.

Methods inherited from class Object

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

Field Details

MODE_IMPLICIT

public static final String MODE_IMPLICIT

OpenAI places a breakpoint at the end of the newest eligible message.

See Also:

• Constant Field Values

MODE_EXPLICIT

public static final String MODE_EXPLICIT

Only explicitly set breakpoints are used.

See Also:

• OpenAiOfficialPromptCacheBreakpoint
• Constant Field Values

TTL_30M

public static final String TTL_30M

The only TTL currently accepted by OpenAI. It is also the default.

See Also:

• Constant Field Values

Method Details

mode

public String mode()

Returns prompt_cache_options.mode.

ttl

public String ttl()

Returns prompt_cache_options.ttl.

implicit

public static OpenAiOfficialPromptCacheOptions implicit()

Creates options with MODE_IMPLICIT.

explicit

public static OpenAiOfficialPromptCacheOptions explicit()

Creates options with MODE_EXPLICIT.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static OpenAiOfficialPromptCacheOptions.Builder builder()