Package de.xima.fc.prompt.service.support

Interface IPromptQueryConfig_EnhanceUserPrompt

  • public interface IPromptQueryConfig_EnhanceUserPrompt
    Mixin for a query connection configuration model that allows the user to configure whether the prompt service may enhance the user's prompt. For example, some prompt services offer a feature to rewrite the prompt for image generation to improve the results.

    See also the <xp:enhanceUserPrompt/> Faces component from the http://www.xima.de/taglib/xfc/prompt namespace, which provides a user interface for editing the data defined by this mixin.

    Since:
    8.5.0

    • Field Detail

      • ATTR_ENHANCE_USER_PROMPT

        static final String ATTR_ENHANCE_USER_PROMPT
        The name of the enhance user prompt attribute. If you implement a custom serialization / deserialization, use this name for the attribute to increase compatibility with other prompt service handlers.
        See Also:
        Constant Field Values

    • Method Detail

      • isEnhanceUserPrompt

        boolean isEnhanceUserPrompt()
        Gets whether the prompt service is allowed to enhance the user's prompt. If true, the prompt service may enhance the user's prompt when executing the prompt query. If false, the prompt service must use the user's prompt as-is.
        Returns:
        Whether prompt enhancement is allowed.

      • setEnhanceUserPrompt

        void setEnhanceUserPrompt​(boolean enhanceUserPrompt)
        Sets whether the prompt service is allowed to enhance the user's prompt. If true, the prompt service may enhance the user's prompt when executing the prompt query. If false, the prompt service must use the user's prompt as-is.
        Parameters:
        enhanceUserPrompt - Whether to allow prompt enhancement.