Introduction
The AI Prompts Admin allows authorized Medical School staff to create, edit, and publish configurable AI prompts that are used elsewhere within ARB.
Currently these prompts are used in conjunction with ARB's Instrument Admin, such as where adding an AI prompt to a comment box in an assessment will automatically score that comment's quality using U-M GPT's AI functionality.
The AI Prompts Admin is a component of the ARB Suite. To access, go to ARB > Admin > AI Prompts.
Instructions
Access the Application
- Log into the AI Prompts Admin.
- If you are not authorized to use this area but need to be, contact the ARB software team to request access.
View Existing Promptsets
Upon initial login, a table shows all existing promptsets (promptsets are a set of prompts for a given purpose). Clicking on a row takes you to a page where you can see and edit the details of the selected promptset.
Edit Existing Promptset
After clicking a given row in the table, the promptset's details are displayed. This allows for both review of the promptset's existing details as well as changing configuration details as needed. (Note that changing the configuration of an Active promptset will immediately affect that promptset's behavior.)
See "Adding a New Promptset" section for more information about what can be done on the detail page.
Add a New Promptset
Clicking the New Prompt button will take you to a blank promptset detail page, where a new promptset can be created and configured by adding information about the overall promptset and specific prompts.
The overall promptset details include:
- Name
- Required; this name is what will appear in the Instrument Admin's dropdown menu, when applying this to an instrument component such as a comment box.
- Description
- An optional, private description of the reason/purpose for the promptset.
- Help Link Label and Description
- This is a configurable public element that, if populated, displays a help link with a tooltip containing the description.
- UM-GPT Toolkit API Token
- Required; this enables the promptset to connect with U-M GPT Toolkit.
- U-M Shortcode
- Required; this allows U-M GPT to bill the proper department for AI usage.
Following the overall promptset details, users can add one or more individual prompts, which is what is sent to U-M GPT Toolkit so that it can process the AI request. Each prompt section includes:
- Name
- Required; the public identifier of the specific action/purpose that this AI prompt is accomplishing.
- Description
- An optional, private description of the reason/purpose for the prompt.
- Model
- Required; where the user chooses which model the prompt uses (all available U-M GPT models are listed).
- API Version
- Optional
- Structured Output
- Optional
- System Prompt
- Required; where the user enters the actual AI prompt.
- Parameters
- Optional; where settings like Temperature and Max Tokens can be configured.
- Scoring Display Values
- Optional; where public labels and score descriptions can be configured.
One prompt is required per promptset, and more than one prompt can be added to a promptset as needed.
Clicking the Save button at the bottom of the page saves the information entered above, and sets the promptset to Draft status (see below for more information about status).
Promptset Statuses
There are 3 levels of Status:
- Draft
- Active
- Archived
Initially a new promptset is set to Draft status, meaning its configuration details are saved but it is not yet available for Production use.
Once a user decides that the promptset configuration details are finalized, changing the status to Active will enable its use elsewhere in ARB (typically as a selectable option in other Admin areas, such as Assessment Admin). This means any ARB functionality that connects to an Active promptset will actively be sending and receiving AI requests.
The Archived status is intended to be used for 'retired' promptsets. This status maintains the details of the promptset but disables its action, such that it can no longer be selected for use elsewhere in ARB. (Note that changing the status of an active promptset that is connected to functionality elsewhere in ARB will stop it from functioning; it is important to first disconnect the promptset from existing functionality before switching the status to Archived.)