Skip to content

Metrics

Define and run evaluators — automated quality checks that score traces against criteria like accuracy, safety, or correctness.

list

Get all metrics

Retrieve a list of all metrics

Usage

sh
honeyhive metrics list [options]

Options

FlagTypeRequiredDescription
--idstringnoFilter by specific metric ID
--typestringnoFilter by metric type

create

Create a new metric

Add a new metric

Usage

sh
honeyhive metrics create [options]

Options

FlagTypeRequiredDescription
--criteriastringyescriteria
--namestringyesname
--typestringyestype Allowed: PYTHON, LLM, HUMAN, COMPOSITE.
--categoriesjsonnocategories
--child-metricsjsonnochild_metrics
--descriptionstringnodescription
--enabled-in-prod / --no-enabled-in-prodbooleannoenabled_in_prod
--filtersjsonnofilters
--model-namestringnomodel_name
--model-providerstringnomodel_provider
--needs-ground-truth / --no-needs-ground-truthbooleannoneeds_ground_truth
--return-typestringnoreturn_type Allowed: float, boolean, string, categorical.
--sampling-percentagenumbernosampling_percentage
--scalenumbernoscale
--thresholdjsonnothreshold

update

Update an existing metric

Update a metric's editable fields. Only fields included in the request body are modified.

Usage

sh
honeyhive metrics update [options]

Options

FlagTypeRequiredDescription
--metric-idstringyesThe unique identifier of the metric to update
--categoriesjsonnocategories
--child-metricsjsonnochild_metrics
--criteriastringnocriteria
--descriptionstringnodescription
--enabled-in-prod / --no-enabled-in-prodbooleannoenabled_in_prod
--filtersjsonnofilters
--model-namestringnomodel_name
--model-providerstringnomodel_provider
--namestringnoname
--needs-ground-truth / --no-needs-ground-truthbooleannoneeds_ground_truth
--return-typestringnoreturn_type Allowed: float, boolean, string, categorical.
--sampling-percentagenumbernosampling_percentage
--scalenumbernoscale
--thresholdjsonnothreshold
--typestringnotype Allowed: PYTHON, LLM, HUMAN, COMPOSITE.

delete

Delete a metric

Remove a metric by id.

Usage

sh
honeyhive metrics delete [options]

Options

FlagTypeRequiredDescription
--metric-idstringyesThe unique identifier of the metric to delete

run

Run a metric evaluation

Execute a metric on a specific event

Usage

sh
honeyhive metrics run [options]

Options

FlagTypeRequiredDescription
--eventjsonyesevent
--metricjsonyesmetric