FirstSpirit AI: prompt configuration

You can manage prompts for the Content Assistant, Analyze Assistant, and Image Assistant in the FirstSpirit AI Configuration service and the FirstSpirit AI Configuration ProjectApp .

The Content Assistant and the Analyze Assistant prompts can also be managed directly in the ContentCreator and edited if necessary.

The FirstSpiritAI Configuration ProjectApp is automatically added to all projects on a server if the FirstSpirit AI Configuration service is in use.

As a server admin, in the FirstSpirit AI Configuration service you can configure:

• Plugins: The plugin defines the connection between the FirstSpirit AI API and your chosen AI model.
• System Prompts: These prompts are applied when executing any operation. They are required for correctly interpreting and executing operations. Only server admins can edit system prompts.
• Global Prompts: All projects on a given server incorporate these prompts. You can only change or delete these prompts as a server admin at the server-level.
• Shared Prompts: Like global prompts, all projects on a given server incorporate these prompts. However, you can add, delete, or edit these prompts as a server or project admin at both the server- and project-level.

As a project admin, in the FirstSpirit AI Configuration ProjectApp you can configure:

• Project Prompts: These prompts are specific to individual projects.
• Shared Prompts

For global, shared, and project prompts you can configure:

• Operations: An operation is a task that is performed in one of the assistants or a custom script or module action.
• Options: You can combine an option with one or more operations. Use options to complement a task with predefined values.
• Tags: Use tags to assign operations and options to one or more assistants or custom scripts. You can customize tags on all levels to manage the visibility of operations and options for users.

FirstSpirit AI Configuration Service

To configure prompts in the FirstSpirit AI Configuration service:

• Navigate to the module list.
  ServerManager > Server > Properties > Modules
• Enable Show Services and type "AI" in the search bar.
  → The FirstSpirit AI Configuration service is shown in the results.
  
• Select the service and click Configure.
  → A new configuration window opens.
  

System prompts

System prompts enable the correct parsing of input components and ensure the smooth generation of output for any operation.

System prompts can be of the following types shown in the Type column:

• Default: Crownpeak provides default system prompts for both the Content Assistant and Analyze Assistant. Default system prompts cannot be deleted.
• Modified: These system prompts are default prompts that have been modified by a server admin.
• Custom: Custom system prompts have been added and defined by a server admin.

Default system prompts for the Content Assistant and the Analyze Assistant are already pre-configured and fully functional. They are kept up to date by Crownpeak. We recommend using them unchanged.

Editing a default system prompt

• In the System Prompt tab, select the prompt you want to edit.
• Click Edit.
  → A new window opens in which you can edit the selected system prompt.
  
• Click OK to save your changes.
  → The prompt is marked as Modified in the Type column.

Restoring a default system prompt

• In the System Prompt tab, select a modified the prompt you want to restore.
• Click Edit.
  → A new window opens.
• Click Restore Default.
  
• Click OK to save your changes.
  → The restored system prompt is marked as Default again in the Type column.

Adding a custom system prompt

You can add a task specific system prompt when using the FirstSpirit AI API in a custom script or module action.

• Navigate to the System Prompt tab in the FirstSpirit AI Configuration service.
• Click Add.
  → A new window opens.
• In the Name field, enter a descriptive name for your custom system prompt, e.g. "MyCustomAssistant: System".
  In your custom script, you will use the name defined in this field to call upon your custom system prompt.
• In the Prompt field, enter a prompt.
• Click OK to save your changes.
  → Your newly created system prompt appears in the list and is marked as Custom in the Type column.

Global prompts

You can use global prompts in Content Assistant, Analyze Assistant, Image Assistant or a custom script or module action. Global prompts are available for all projects on a given server. Global operations and options can only be added, edited or deleted at the server-level by server admins.

Global operations and options can have the following sources shown in the Source column of either the Operations or the Options tab:

• Preset: These entries are in the original state as provided by Crownpeak. Preset global prompts cannot be deleted.
• Preset (Modified): These entries were provided by Crownpeak but have been modified by a server admin.
• Global: These entries have been created by a server admin.

Adding an operation

• In the Operations tab, click Add.
  → A new window opens in which you can define the new operation.
  

You can use the ID to reference specific operations in your custom script or module action.

• In the Name field, enter a name for the operation. This name will be shown to the user in the ContentCreator.
• (Un-)select tags for each assistant or custom script or module action in which a user should be able to use this operation.
• Optional: Create a new custom tag in the Tags input line.
  → The operation is directly assigned to the newly created tag.
• In the Prompt field, enter your prompt.

For more information on how to write a successful prompt take a look at the starter pack and prompting hints.

• Optional: Select This operation requires textual context to be performed if your prompt uses input text.
• Optional: Select one or more options to complement your prompt by checking the respective boxes in the Options tab.
• Optional: Test your prompt.
• Optional: Use the Move Up and Move Down button or Drag&Drop to move operations. This represents the order the end user sees in the ContentCreator.
• Click OK to save your changes.
  → Your prompt appears in the list marked as Global in the Source column.

Testing a prompt

• Select a prompt and click Edit.
  → A new window opens.
• Click Test.
  → A new window opens.
  
• Choose a Test Plugin to test your prompt in a specific environment, e.g. ContentAssistantPromptConfigurationTestPlugin to test your prompt for use in the Content Assistant.
  → The text in the Example Text field changes depending on the Test Plugin you have chosen.
• Optional: Edit the text in the Example Text field to better match your envisioned use case.
• Click Test Prompt.
  → Based on your prompt and the provided example text, the generated text is streamed in in the API Response field.
• Optional: Edit your prompt in the Prompt field if the response was unsatisfactory and test it again.
• Click Save Prompt.

Adding an option

• In the Options tab, click Add.
  → A new window opens.
  

Use the ID shown in the window to reference this specific option in a custom script or module action.

• In the Name field, enter a name for the option.
• In the Prompts tab, click Add to add an option value.
  → A new window opens.
  
• In the Name field, enter the option value's name.
  → The user can select the value by this name in the option's dropdown in the Content Creator.

Use the ID shown in the window to reference this specific option value in a custom script or module action

• In the Prompt field, enter a value prompt.
• Click OK to save your changes.
• Create as many values as needed for the option.
• Optional: Use the Move Up and Move Down button or Drag&Drop to move option values. This represents the order the end user sees in the ContentCreator.
• In the Operations tab, select one or more checkboxes.
  → The option is connected with the selected operations.
• Click OK to save your changes.

Duplicating an operation or option

• In the Operations or Options tab, select an entry and click Duplicate.
  → The entry is copied and saved on your current level.
• Optional: If the duplicated operation is combined with options:
  In the pop-up, select Duplicate if the options that are combined with the operation should also be duplicated. Select Reference if the already existing options should be combined with the duplicated operation.
• Optional: Adjust the prompt or other settings of the duplicated operation or option.

Adding a tag

Create a custom tag to assign operations to custom scripts or module actions.

• In the Tags tab, click Add.
  → A new window opens.
  
• In the Tag field, add a name, e.g. MyCustomAssistant.
• In the Operations tab, (un-)select operations for your custom tag.
• Click OK to save your changes.
  → Your custom tag appears in the list and is not marked as default.

Assigning a tag to multiple operations

• In the Tags tab, select an existing tag.
• Click Edit.
  → A new window opens.
• (Un-)Select operations for the tag.
• Click OK to save your changes.

Shared prompts

Shared prompts are available in all projects on a given server. Unlike global prompts, you can also edit shared prompts in any individual project's configuration.

While global operations and options are also visible in the Shared Prompts tab, you can only modify the prompt itself in the Global Prompts tab. You can customize tags for global prompts also in the Shared Prompts tab.

Managing shared operations, options, and tags is identical to managing global prompts:

• Adding an operation
• Testing a prompt
• Adding an option
• Duplicating an operation or option
• Assigning a tag to multiple operations
• Adding a tag

Any operation, option, or tag you add in the Shared Prompts tab will be marked as Shared in the Source column.

FirstSpirit AI Configuration ProjectApp

To configure prompts in the FirstSpirit AI Configuration ProjectApp:

• Navigate to the project's Project components.
  ServerManager > Project > Properties > [Project selection] > Project components
• Select FirstSpirit AI Configuration ProjectApp.
• Click Configure.
  → A new window opens.
  

Project prompts

Project prompts are specific to individual projects and can only be added, edited, or deleted in the FirstSpirit AI Configuration ProjectApp.

Managing project operations, options, and tags is identical to managing global prompts:

• Adding an operation
• Testing a prompt
• Adding an option
• Duplicating an operation or option
• Assigning a tag to multiple operations
• Adding a tag

Any operation, option, or tag you add in the configuration window will be marked as Project in the Source column.

Shared prompts

Additionally to managing projects prompts, you can also configure shared prompts as project admin at the project-level.

• In the configuration window, click Edit Shared Prompts.
  → A new Shared Prompts window opens.
  
• Add, remove, edit, or duplicate a shared prompt.
• Click OK to save your changes.
  → Your changes are applied server-wide.