Skip to main content
Version: 6.18 (draft)

Prompts

Introduction to prompts​

The Prompts page is used to create a manage the prompts required for AI features. These are the messages which are sent as requests to an LLM. This allows to edit prompts separately from the code, which increases flexibility and makes it easy to adjust to the latest best practices in prompt engineering.

There are two types of prompts:

  • System prompts are used by the product itself. They are created automatically when a new feature which makes use of AI is introduced. Typically, these don't require manual adjustments as they serve specific pre-defined purposes. Two prompts for the prompts wizard are added by default:
    • prompt generation assistant DE: A German language assistant for generating prompts.
    • prompt generation assistant EN: An English language counterpart serving the same function.
  • Custom prompts are used in scripts which are part of the custom scene created to adjust the product to a specific use case. They are created and managed by the customer.

Settings for prompts​

The following settings exist for prompts:

  • Name: This is the name to reference the prompt in scripts.
  • Type: When you create a prompt, the type is set to Custom prompt. Prompts used by ConSol CM itself are called System prompts. They cannot be deleted.
  • Prompt text: This is the actual text that will be sent to the LLM when the prompt is executed.
  • Description: Optional. You can provide additional context, such as the script where the prompt is used, or any other detail for future reference.

Using the prompt wizard​

The prompt wizard helps you with the creation of suitable prompts, lowering the entry barrier for AI integration. It consists of four steps which guide you through the information which you need to provide for crafting a high-quality prompt tailored to your specific use case.

Please proceed as follows to use the prompt wizard:

  1. Ensure that you have configured the settings for the default connection on the LLM connections page.
  2. Click the Prompt wizard button.
  3. Fill out data in the tabs:
    • Use case: Describe the use case.
    • Input and output: Describe the input and the expected output
    • Rules and output format: Provide additional instructions regarding the expected output and its format
    • Examples: Add examples containing the input and expected output
  4. Click the Generate prompt button.
  5. Review the prompt and click Save changes.

Using prompts in scripts​

Use the methods from AIPromptService to use prompts in scripts. You need to pass the name of the prompt as a parameters:

aIPromptService.getText("myprompt")