Skip to content
40 changes: 20 additions & 20 deletions features/playground.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,46 +7,46 @@

<DarkLightImage
lightSrc="/images/playground-light.png"
caption="Playground overview."
alt="Screenshot of the playground in the UI."
darkSrc="/images/playground-dark.png"
caption="Playground overview showing the three-panel interface."
alt="Screenshot of the Playground showing testset selection, prompt editing, and preview panels."
/>

## Getting Started

### 1. Select Your Test Data (Left Panel)

**Choose a Testset:**

Check warning on line 19 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L19

Did you really mean 'Testset'?
- Click the testset dropdown at the top of the left panel
- Click the "Choose Testset" dropdown at the top left

Check warning on line 20 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L20

Did you really mean 'Testset'?

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with other documentation pages (e.g., testsets.mdx, prompts.mdx), UI element labels are typically wrapped in bold markdown with quotes. Please update this line to use **"Choose Testset"** for consistency.

- Click the **"Choose Testset"** dropdown at the top left

- Select a testset that contains the data you want to test your prompt against

Check warning on line 21 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L21

Did you really mean 'testset'?
- If no testsets exist, click "Create testset" to create one directly from the Playground
- The first testcase will be automatically selected
- If no testsets exist, create one from the [Testsets](/features/testsets) page first

Check warning on line 22 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L22

Did you really mean 'testsets'?
- Once selected, testcases from the testset will appear in the left panel

Check warning on line 23 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L23

Did you really mean 'testcases'?

Check warning on line 23 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L23

Did you really mean 'testset'?

**Select Testcases:**

Check warning on line 25 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L25

Did you really mean 'Testcases'?
- Click on individual testcases to select them

Check warning on line 26 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L26

Did you really mean 'testcases'?
- Hold Shift and click to select multiple testcases

Check warning on line 27 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L27

Did you really mean 'testcases'?
- Selected testcases have a blue left border
- Selected testcases have a highlighted left border

Check warning on line 28 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L28

Did you really mean 'testcases'?
- Hover over the info icon to see the full testcase data

Check warning on line 29 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L29

Did you really mean 'testcase'?
- Testcases with a green flask icon have been tested

### 2. Edit Your Prompt (Middle Panel)

**Choose a Prompt:**
- Select a prompt from the dropdown in the header
- If no prompts exist, click "Create prompt" to create one directly from the Playground
- Select a prompt from the "Prompt" dropdown at the top of the middle panel

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with other documentation pages, UI element labels are typically wrapped in bold markdown with quotes. Please update this line to use **"Prompt"** for consistency.

- Select a prompt from the **"Prompt"** dropdown at the top of the middle panel

- If no prompts exist, create one from the [Prompts](/features/prompts) page first

**Work with Prompt Versions:**
- The left sidebar shows all versions of your selected prompt
- The "Prompt Versions" section shows all versions of your selected prompt
- Click any version to switch to it
- Versions with unsaved changes show a save indicator
- The production version is marked with a badge
- The status indicator shows "All changes saved" when there are no pending changes
- The production version is marked with a "Production" badge

**Edit Prompt Templates:**
- Use the "Prompt Templates" tab to write your prompts
- The editor supports **Jinja syntax** for dynamic content
- Insert variables from your testcase data like `{{variable_name}}`
- Add multiple messages by clicking "+ Add Message"
- Set message roles (System, User, Assistant) using the dropdown
- Remove messages with the trash can icon
- The editor supports [Jinja syntax](https://jinja.palletsprojects.com/) for dynamic content
- Insert variables from your testcase data like `{{variable_name}}` or use `{{allInputs}}` for all inputs

Check warning on line 46 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L46

Did you really mean 'testcase'?
- Add multiple messages by clicking "+ ADD MESSAGE"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with other documentation pages, UI element labels are typically wrapped in bold markdown with quotes. Please update this line to use **"+ ADD MESSAGE"** for consistency.

- Add multiple messages by clicking **"+ ADD MESSAGE"**

- Set message roles (System, User, Assistant) using the role dropdown
- Remove messages with the trash icon

**Configure Model Settings:**
- Switch to the "Model Settings" tab
Expand All @@ -58,16 +58,16 @@

**Template Preview:**
- The "Template Preview" tab shows how your prompt looks with real data
- Variables are automatically replaced with values from selected testcases

Check warning on line 61 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L61

Did you really mean 'testcases'?
- This helps you verify your Jinja templating is working correctly

**Run Tests:**
- Click "Try" to test your prompt on selected testcases

Check warning on line 65 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L65

Did you really mean 'testcases'?
- Click "Kickoff Run" to create a full run for the entire testset, which will appear in your run history

Check warning on line 66 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L66

Did you really mean 'testset'?
- Results appear in the "Results" tab automatically

**View Results:**
- The "Results" tab shows AI responses for each testcase

Check warning on line 70 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L70

Did you really mean 'testcase'?
- See response time, token count, and full output
- Click the completion badge to open a detailed results modal
- Green indicates successful completion, yellow shows partial results
Expand All @@ -81,15 +81,15 @@
```

### Multi-testcase Testing
- Test individual testcases for quick iteration

Check warning on line 84 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L84

Did you really mean 'testcases'?
- Run all testcases for comprehensive evaluation

Check warning on line 85 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L85

Did you really mean 'testcases'?
- Kickoff full runs that are tracked in your run history
- Compare results across different prompt versions

### Version Management
- Save new versions of your prompts with the "Save" button
- Switch between versions to compare performance
- Publish versions to production when ready
- Save new versions of your prompts with the "SAVE" button in the header

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with other documentation pages, UI element labels are typically wrapped in bold markdown with quotes. Please update this line to use **"SAVE"** for consistency.

- Save new versions of your prompts with the **"SAVE"** button in the header

- Switch between versions in the "Prompt Versions" panel to compare performance
- Mark versions as production when ready to deploy

### Real-time Preview
- See exactly how your prompt will look with real data
Expand All @@ -98,9 +98,9 @@

## Best Practices

1. **Start Small**: Select one testcase first to quickly iterate on your prompt

Check warning on line 101 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L101

Did you really mean 'testcase'?
2. **Use Variables**: Leverage Jinja templating to make prompts dynamic and reusable
3. **Test Thoroughly**: Run all testcases before publishing to production

Check warning on line 103 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L103

Did you really mean 'testcases'?
4. **Save Versions**: Create new versions when making significant changes
5. **Monitor Results**: Check response times and token usage to optimize costs

Expand All @@ -108,11 +108,11 @@

**Quick Testing:**

Select a testcase → Edit prompt → Preview → Try → Review results

Check warning on line 111 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L111

Did you really mean 'testcase'?

**Comprehensive Evaluation:**

Select all testcases → Edit prompt → Try All → Analyze results modal

Check warning on line 115 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L115

Did you really mean 'testcases'?

**Version Comparison:**

Expand All @@ -120,5 +120,5 @@

**Full Run Creation:**

Select testset → Edit prompt → Kickoff Run → Monitor in run history

Check warning on line 123 in features/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (scorecard-d65b5e8a) - vale-spellcheck

features/playground.mdx#L123

Did you really mean 'testset'?

Expand Down
Binary file modified images/playground-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/playground-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.