Package de.xima.fc.prompt.service

Interface IPromptExecutionReplacerSettings

public interface IPromptExecutionReplacerSettings

Builder for a replacer that can replace placeholders in strings, used during prompt execution. The defaults for the various configuration settings depend on the context where the execution takes places. For example, when the execution takes place within a workflow execution, form placeholders will be replaced by default. When the execution takes place in a standalone REST API context, form placeholders will not be replaced by default.

Since:

8.5.0

See Also:

IPromptExecutionContext.replacer()

Method Summary

Modifier and Type	Method	Description
IPromptExecutionReplacerContextResolver	contextResolver()	Gets the context resolver used to resolve context placeholders.
IPromptExecutionReplacerEscaper	escaper()	Gets the escaper used to escape replaced values.
boolean	replaceContext()	Gets whether to replace context placeholders.
boolean	replaceForm()	Sets whether to replace form placeholders.
boolean	replaceI18N()	Sets whether to replace i18n placeholders.
boolean	replaceSession()	Sets whether to replace session placeholders.
boolean	replaceSystem()	Sets whether to replace system placeholders.
boolean	replaceTemplate()	Sets whether to replace template placeholders.

Method Detail

contextResolver

IPromptExecutionReplacerContextResolver contextResolver()

Gets the context resolver used to resolve context placeholders. A context placeholder is of the form [%<contextName>.<content>%].

Returns:

The context resolver.

escaper

IPromptExecutionReplacerEscaper escaper()

Gets the escaper used to escape replaced values.

Returns:

The escaper.

replaceContext

boolean replaceContext()

Gets whether to replace context placeholders. A context placeholder is of the form [%<contextName>.<content>%].

Returns:

Whether to replace context placeholders.

replaceForm

boolean replaceForm()

Sets whether to replace form placeholders. Form placeholders are of the form [%<content>%].

Returns:

Whether to replace form placeholders.

replaceI18N

boolean replaceI18N()

Sets whether to replace i18n placeholders. I18n placeholders are of the form [%I18N.<content>%].

Returns:

Whether to replace i18n placeholders.

replaceSession

boolean replaceSession()

Sets whether to replace session placeholders. Session placeholders are of the form [%$<content>%].

Returns:

Whether to replace session placeholders.

replaceSystem

boolean replaceSystem()

Sets whether to replace system placeholders. System placeholders are of the form [%$<content>%].

Returns:

Whether to replace system placeholders.

replaceTemplate

boolean replaceTemplate()

Sets whether to replace template placeholders. Template placeholders are of the form [%$$<content>%].

Returns:

Whether to replace template placeholders.