List Evaluation Rules

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

Lists the evaluation rules in your project, 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/v1/evaluation-rules

curl -X GET "https://api.confident-ai.com/v1/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"
      }
    ]
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/workflows"
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

dataModelenum
Only return rules for this kind of item. Omit to return all of them.

Response

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- evaluationRuleslist of objects
  The project's evaluation rules, newest first, as summary rows.
  Show 4 propertiesHide 4 properties
  - idstring
    The unique identifier of the evaluation rule.
  - namestring
    The name of the evaluation rule.
  - enabledboolean
    Whether the rule is currently evaluating.
  - dataModelenum
    What kind of item the rule evaluates.
    Show 3 enum valuesHide 3 enum values
    TRACE
    SPAN
    THREAD
linkstring
A link to the workflows page.

Built byConfident AI