Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions build/agents/build-your-agent/evals.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: 'Evals'
sidebarTitle: 'Evals'

Check warning on line 3 in build/agents/build-your-agent/evals.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

build/agents/build-your-agent/evals.mdx#L3

Did you really mean 'Evals'?
description: 'Test and evaluate your AI Agents with scenario-based evaluations and reusable Checks'
---

<Info>
**Rollout Status**: Evals is rolling out progressively, starting with Enterprise customers. If you don't see this feature in your account yet, reach out to your account manager to discuss access.

Check warning on line 8 in build/agents/build-your-agent/evals.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

build/agents/build-your-agent/evals.mdx#L8

Did you really mean 'Evals'?
</Info>

The Evals section is your command center for testing and evaluating AI Agent performance. Located in the **Evaluate** tab (next to the Build and Use tabs) in the Agent builder, Evals lets you create test sets, define reusable Checks, run automated evaluations, and monitor live Agent quality — all without manual testing. Evals apply to both individual Agents and Workforces, including the sub-agents and tools inside a Workforce.

Check warning on line 11 in build/agents/build-your-agent/evals.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

build/agents/build-your-agent/evals.mdx#L11

Did you really mean 'Evals'?

Check warning on line 11 in build/agents/build-your-agent/evals.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

build/agents/build-your-agent/evals.mdx#L11

Did you really mean 'Evals'?

Check warning on line 11 in build/agents/build-your-agent/evals.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

build/agents/build-your-agent/evals.mdx#L11

Did you really mean 'Evals'?

![Evaluate tab showing the Evals sidebar (Test, Runs, Checks, Publish, Monitor) and a Monitor dashboard with overall score, total runs, and Checks breakdown](/images/agent/agent-evals.png)

Check warning on line 13 in build/agents/build-your-agent/evals.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

build/agents/build-your-agent/evals.mdx#L13

Did you really mean 'Evals'?

## What you can do with Evals

Check warning on line 15 in build/agents/build-your-agent/evals.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

build/agents/build-your-agent/evals.mdx#L15

Did you really mean 'Evals'?

<CardGroup cols={3}>
<Card title="Run tests" icon="flask-vial">
Expand All @@ -28,11 +28,11 @@

---

## Evals sections

Check warning on line 31 in build/agents/build-your-agent/evals.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

build/agents/build-your-agent/evals.mdx#L31

Did you really mean 'Evals'?

The Evals area has five sections, shown in the left sidebar of the Evaluate tab:

Check warning on line 33 in build/agents/build-your-agent/evals.mdx

View check run for this annotation

Mintlify / Mintlify Validation (relevanceai) - vale-spellcheck

build/agents/build-your-agent/evals.mdx#L33

Did you really mean 'Evals'?

- **Test** — Create and manage test sets. Each test set holds scenarios that simulate users; running a scenario produces a conversation with your Agent that gets scored by attached Checks.

Check warning on line 35 in build/agents/build-your-agent/evals.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

5 settings listed as bullet points — consider using a table instead so they're easier to scan. [technical: 5 consecutive bullet items matching **Key**: value or **Key** — value pattern]
- **Runs** — Past evaluation run results. Browse average scores, tasks evaluated, progress status, cost (Credits and Actions), and creation date for every run.
- **Checks** — The reusable set of evaluation criteria. Create a Check once, then attach it to scenarios, to Monitor dashboards, or to one-off evaluations of completed tasks.
- **Publish** — Choose which test sets must pass before your Agent can be published. Set a minimum pass rate and optionally block publishing on failure.
Expand Down Expand Up @@ -290,7 +290,7 @@

You also get:

- **Overall score timeseries** to spot regressions or improvements over time.

Check warning on line 293 in build/agents/build-your-agent/evals.mdx

View workflow job for this annotation

GitHub Actions / Documentation Lint Checks

4 features listed as bullet points — consider using cards instead so they stand out visually. [technical: 4 consecutive bullet items matching **Feature** pattern, use <CardGroup> with <Card> components]
- **Per-Check charts** so you can see which criteria are slipping.
- **Version markers** that line up score changes with Agent publishes.
- **A list of evaluation runs** with score, name, and a drill-in to the full conversation.
Expand All @@ -301,6 +301,49 @@

---

## Alarms

An alarm monitors scores on a Monitor dashboard and sends a notification when the overall score drops below a threshold you set. Configure alarms per dashboard to catch regressions as they happen.

### Creating an alarm

To create or edit an alarm:

1. Go to the **Evaluate** tab and select **Monitor** from the left sidebar.
2. Open the dashboard you want to monitor.
3. Click the **Alarms** button in the top right corner of the dashboard.
4. Click **+ New alarm** to create one, or click an existing alarm to edit it.
5. Configure the alarm settings (see table below).
6. Click **Save**.

Alarms fire on the initial breach only. During a cooldown period, additional breaches do not trigger new notifications. Alarms do not send a notification when scores recover.

| Setting | Description |
|---------|-------------|
| **Score threshold (%)** | The minimum acceptable score. The alarm fires when the dashboard's overall score drops below this value. |
| **Notification channels** | Where to send the alert — email, Slack, or both. At least one channel must be configured. |
| **Cooldown period** | How long to suppress repeat notifications after an alarm fires. During this window, additional breaches do not trigger new notifications. |

### Auto-diagnosis by Inventor

When the **Auto-diagnosis by Inventor** toggle is enabled on an alarm, the Inventor AI assistant automatically investigates the breach the moment the alarm first fires and delivers a diagnosis to the alert channels configured by the alarm creator.

The diagnosis identifies which Checks degraded, which tasks contributed to the drop, and likely causes — giving you a starting point for investigation without manually reviewing the Monitor dashboard.

To enable auto-diagnosis:

1. Open the alarm create or edit modal.
2. Toggle on **Auto-diagnosis by Inventor**.
3. Save the alarm.

Auto-diagnosis fires only on the initial alarm trigger. It does not run during cooldown re-notifications or on score recovery.

<Info>
Auto-diagnosis by Inventor requires at least one alert channel configured on the alarm — see [Alerts](/build/agents/build-your-agent/alerts) for setup instructions. Inventor is an Enterprise-only feature — see [Invent](/build/invent/invent) for details. This feature is currently behind a feature flag and may not be available in all accounts.
</Info>

---

## Publish

The **Publish** section lets you choose which test sets must pass before your Agent can be published. If the results don't meet your minimum pass rate, publishing can be blocked.
Expand Down
Loading