Connect your existing evaluation system to Maxim by exposing it via an API endpoint. This lets you reuse your Evaluators without rebuilding them.

1

Navigate to Create Menu

Select API-based from the create menu to start building.

Create a new API evaluator

2

Configure Endpoint Details

Add your API endpoint details including:

  • Headers
  • Query parameters
  • Request body

For advanced transformations, use pre and post scripts under the Scripts tab.

Use variables in the body, query parameters and headers

Configure API endpoint details

3

Map Response Fields

Test your endpoint using the playground. On successful response, map your API response fields to:

  • Score (required)
  • Reasoning (optional)

This mapping allows you to keep your API structure unchanged.

Map API response to evaluator fields

4

Configure Pass Criteria

Configure two types of pass criteria:

Pass query Define criteria for individual evaluation metrics

Example: Pass if clarity score > 0.8

Pass evaluator (%) Set threshold for overall evaluation across multiple entries

Example: Pass if 80% of entries meet the clarity criteria

Pass criteria configuration

5

Test in Playground

Test your Evaluator in the playground before using it in your workflows. The right panel shows input fields for all variables used in your Evaluator.

  1. Fill in sample values for each variable
  2. Click Run to see how your Evaluator performs
  3. Iterate and improve your evaluator based on the results

Testing an evaluator in the playground with input fields for variables