agents-features-longterm-memory/ai.koog.agents.longtermmemory.retrieval.augmentation/PromptAugmenter/Companion

Companion

object Companion(source)

Companion object with constants, static methods, and builder entry point.

Properties

DEFAULT_CONTEXT_PREFIX

const val DEFAULT_CONTEXT_PREFIX: String

The prefix to add before relevant context.

RELEVANT_CONTEXT_PLACEHOLDER

const val RELEVANT_CONTEXT_PLACEHOLDER: String

Placeholder in prompt templates for insertion of relevant context.

SECTION_SEPARATOR

const val SECTION_SEPARATOR: String

Separator inserted between logical sections of a message (e.g. between the original system content and an appended retrieved-context section, or between multiple retrieved-context sections). Shared by all built-in PromptAugmenter implementations to keep the rendered layout consistent.

Functions

builder

@JvmStatic

fun builder(): PromptAugmenterBuilder

Returns a builder that lets you choose a default PromptAugmenter implementation.

formatContext

fun formatContext(relevantContext: List<SearchResult<TextDocument>>, contextPrefix: String = DEFAULT_CONTEXT_PREFIX): String

Formats a list of search results into a numbered text block with the given prefix.

formatTemplate

fun formatTemplate(template: String, relevantContextText: String): String

Formats the template by replacing placeholders with actual content.