Package de.espirit.firstspirit.ai

Interface PromptConfigurationPlugin

All Superinterfaces:
Plugin, Public
public interface PromptConfigurationPlugin extends Plugin
Plugin providing default prompt configuration.
Since:
5.2.240903

  • Method Details

    • getTags

      @NotNull @NotNull Set<String> getTags()
      A standard tag assignable to operations. The returned tags are mainly used for displaying checkboxes instead of relying on a textual input.
      Returns:
      The set of standard tags.
      Since:
      5.2.240903

    • getSystemPrompts

      @NotNull @NotNull List<SystemPrompt> getSystemPrompts()
      Returns a list of system prompts and their default prompt. The implementation is expected to assign unique names for the system prompts, as multiple plugins sharing the same namespace may provide system prompts.
      Returns:
      The list of system prompts.
      Since:
      5.2.240903

    • getOperations

      @NotNull @NotNull List<PromptOperation> getOperations()
      Returns a list of preset operations to be available in the prompt configuration. FirstSpirit will update any unmodified preset-based operation automatically based on the operation identifiers. A preset operation removed in the future may still be available afterward when configuring the prompt configuration, but will be classified as custom operation.
      Returns:
      The list of preset operations.
      Since:
      5.2.240903

    • getOptions

      @NotNull @NotNull List<PromptOption> getOptions()
      Returns a list of preset options to be available in the prompt configuration. FirstSpirit will update any unmodified preset-based option automatically based on the option identifiers. A preset option removed in the future may still be available afterward when configuring the prompt configuration, but will be classified as custom option.
      Returns:
      The list of preset options.
      Since:
      5.2.240903