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

Interface IPromptQueryConfig_AllowWebSearch

  • public interface IPromptQueryConfig_AllowWebSearch
    Mixin for a query connection configuration model that allows the user to configure whether the prompt service may perform web searches when executing a prompt query. The model can choose to search the web or not based on the content of the input prompt.

    See also the <xp:allowWebSearch/> 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_ALLOW_WEB_SEARCH

        static final String ATTR_ALLOW_WEB_SEARCH
        The name of the allow web search 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

      • isAllowWebSearch

        boolean isAllowWebSearch()
        Gets whether web search is allowed for the prompt query. If true, the prompt service may perform web searches when executing the prompt query. If false, the prompt service must not perform any web searches.
        Returns:
        Whether web search is allowed.

      • setAllowWebSearch

        void setAllowWebSearch​(boolean allowWebSearch)
        Sets whether web search is allowed for the prompt query. If true, the prompt service may perform web searches when executing the prompt query. If false, the prompt service must not perform any web searches.
        Parameters:
        allowWebSearch - Whether to allow web search.