Metrics

Create Metrics

Creates a new metric on your Confident AI project.

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request

namestringRequired
The name of the metric you're creating in your project.
multiTurnbooleanRequired

This is true if your metric is used for evaluating multi-turn test cases.

criteriastringOptional
The criteria for this particular metric, that will be used to evaluate test cases later.
evaluationStepsstringOptional
An alternative to criteria, it is a list of steps to take to evaluate your test cases.
evaluationParamslist of enumsOptional
It is an array of the params that will be used to evaluate your test cases.
rubriclist of objectsOptional
A list of score ranges (0–10 inclusive). Must be in order and non-overlapping. Click here to [learn more](https://deepeval.com/docs/metrics-llm-evals#rubric)

Response

successboolean
This is true if the metric was created successfully.
dataobject
This maps to the id of the metric created.
deprecatedboolean
This is true if this metrics endpoint is deprecated.