List Rules

GEThttps://api.confident-ai.com/v2/evaluation-rules

Lists the evaluation rules in your Confident AI project one page at a time, newest first, as summary rows. Retrieve a rule by id for its full configuration and the metric collection it runs. Requires the Starter plan or above.

GET/v2/evaluation-rules

curl -X GET "https://api.confident-ai.com/v2/evaluation-rules" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "evaluationRules": [
      {
        "id": "<EVALUATION-RULE-ID>",
        "name": "Score production answers",
        "enabled": true,
        "dataModel": "TRACE"
      }
    ],
    "totalEvaluationRules": 4,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/workflows",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

dataModelenum
pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of results per page, at most 100. Defaults to 25.

Response

List Rules succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of evaluation rules, with the total across all pages.
Show 4 propertiesHide 4 properties
- evaluationRuleslist of objects
  The rules for the current page, newest first.
  Show 4 propertiesHide 4 properties
  - idstring
    The id of the rule, generated by Confident AI.
  - namestring
    The name of the rule.
  - enabledboolean
    Whether the rule is currently evaluating.
  - dataModelenum
    What kind of production item a rule evaluates: TRACE for a whole trace, SPAN for a single step within one, THREAD for a finished conversation.
    Show 3 enum valuesHide 3 enum values
    TRACE
    SPAN
    THREAD
- totalEvaluationRulesinteger
  The total number of rules matching the query, across all pages.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of rules per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI