Syntax
A PromptDX file has two primary components to it.
- Frontmatter
- Body
Frontmatter
Frontmatter is defined in yaml, and its where your configuration and metadata about your prompts are stored. In there, you will find:
- Model Name (required)
- Name of prompt (required)
- Any relevant model settings
- Any test related data (i.e. test props, etc.)
- Any other metadata you want to define like version, author, etc.
Body
The body of your prompt corresponds to the messages being sent to the LLM.
Prompts support the use of 3 different message related tags:
- System
- User
- Assistant
These tags will be sent to the model provider in the order they are used. Any text placed outside of these tags will not be sent to the LLM, but may be used for providing extra context, notes, etc.
Within your body, you'll be able to: