Interface IPromptQueryConfig_SystemPrompt

public interface IPromptQueryConfig_SystemPrompt
Mixin for a query connection configuration model that allows the user to enter an optional system prompt message. A system message provides instructions to the prompt service and receives more weight than a user message. Use of this mixin is optional, but ensures a consistent name for the property. When different prompt service handlers use the same property name, switching between different prompt service handlers preserves the configured system prompt.

See also the <xp:systemPrompt/> 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 Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ATTR_SYSTEM_PROMPT
    The name of the system prompt attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    SystemPrompt
    getSystemPrompt()
    Gets the system prompt for the prompt query.
    void
    setSystemPrompt(SystemPrompt systemPrompt)
    Sets the system prompt for the prompt query.

  • Field Details

    • ATTR_SYSTEM_PROMPT

      static final String ATTR_SYSTEM_PROMPT
      The name of the system 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:

  • Method Details

    • getSystemPrompt

      SystemPrompt getSystemPrompt()
      Gets the system prompt for the prompt query. The system prompt is a message that provides context or instructions to the query service, and it is given more weight than a user prompt.
      Returns:
      The system prompt.

    • setSystemPrompt

      void setSystemPrompt(SystemPrompt systemPrompt)
      Sets the system prompt for the prompt query. The system prompt is a message that provides context or instructions to the query service, and it is given more weight than a user prompt.
      Parameters:
      systemPrompt - The system prompt to set.