Package org.springframework.ai.session.compaction

Class ChatModelSummarizer.Builder

java.lang.Object

org.springframework.ai.session.compaction.ChatModelSummarizer.Builder

Enclosing class:

ChatModelSummarizer

public static final class ChatModelSummarizer.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ChatModelSummarizer	build()
ChatModelSummarizer.Builder	chatOptions(ChatOptions chatOptions)	The options of the summarizing call, a smaller model for example; none by default.
ChatModelSummarizer.Builder	eventFormatter(Function<SessionEvent,String> eventFormatter)	How an event is rendered in the prompt; EventText.of(SessionEvent) by default.
ChatModelSummarizer.Builder	onSummarizationFailure(Consumer<SummaryRequest> onSummarizationFailure)	Called with the request when the model call fails or returns a null or blank summary, after the warning is logged.
ChatModelSummarizer.Builder	overlapSize(int overlapSize)	How many of the preserved events are quoted in the prompt for continuity; 2 by default, 0 for none.
ChatModelSummarizer.Builder	shadowPrompt(String shadowPrompt)	Replaces the synthetic user message that opens each summary turn; ChatModelSummarizer.DEFAULT_SHADOW_PROMPT by default.
ChatModelSummarizer.Builder	systemPrompt(String systemPrompt)	Replaces the default system prompt of the summarizing call.

Methods inherited from class java.lang.Object

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

Method Details

chatOptions

public ChatModelSummarizer.Builder chatOptions(ChatOptions chatOptions)

The options of the summarizing call, a smaller model for example; none by default.

overlapSize

public ChatModelSummarizer.Builder overlapSize(int overlapSize)

How many of the preserved events are quoted in the prompt for continuity; 2 by default, 0 for none.

systemPrompt

public ChatModelSummarizer.Builder systemPrompt(String systemPrompt)

Replaces the default system prompt of the summarizing call.

shadowPrompt

public ChatModelSummarizer.Builder shadowPrompt(String shadowPrompt)

Replaces the synthetic user message that opens each summary turn; ChatModelSummarizer.DEFAULT_SHADOW_PROMPT by default. For another language, or an agent that needs a different framing.

eventFormatter

public ChatModelSummarizer.Builder eventFormatter(Function<SessionEvent,String> eventFormatter)

How an event is rendered in the prompt; EventText.of(SessionEvent) by default.

onSummarizationFailure

public ChatModelSummarizer.Builder onSummarizationFailure(Consumer<SummaryRequest> onSummarizationFailure)

Called with the request when the model call fails or returns a null or blank summary, after the warning is logged.

build

public ChatModelSummarizer build()