Skip to main content

Schema introspection

Every command below with arguments supports two read-only flags for tooling and AI agents:
  • --show-file-schema: print the JSON Schema for the full request object (the format --filename accepts).
  • --show-argument-schema <flag-name>: print the JSON Schema for one argument’s value. Pass the kebab flag name without the leading -- (e.g. type, not --type).
Both write pure JSON to stdout and never call the API. They cannot be combined with any other command-specific flag.

list

List all metrics

Usage

honeyhive metrics list [options]

Options

FlagTypeRequiredDescription
--idstringnoFilter by specific metric ID
--typestringnoFilter by metric type
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

create

Create a new metric

Usage

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
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

update

Update an existing metric Update a metric’s editable fields. Only fields included in the request body are modified.

Usage

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.
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

delete

Delete a metric

Usage

honeyhive metrics delete [options]

Options

FlagTypeRequiredDescription
--metric-idstringyesThe unique identifier of the metric to delete
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

run

Run a metric evaluation Execute a metric on a specific event

Usage

honeyhive metrics run [options]

Options

FlagTypeRequiredDescription
--eventjsonyesevent
--metricjsonyesmetric
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.