PUT
/
metrics

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
metric_id
string
required

Unique identifier of the metric

criteria
string

Criteria for human or composite metrics

name
string

Updated name of the metric

description
string

Short description of what the metric does

code_snippet
string

Updated code block for the metric

prompt
string

Updated Evaluator prompt for the metric

type
enum<string>

Type of the metric - "custom", "model", "human" or "composite"

Available options:
custom,
model,
human,
composite
enabled_in_prod
boolean

Whether to compute on all production events automatically

needs_ground_truth
boolean

Whether a ground truth (on metadata) is required to compute it

return_type
enum<string>

The data type of the metric value - "boolean", "float", "string"

Available options:
boolean,
float,
string
threshold
object

Threshold for numeric metrics to decide passing or failing in tests

pass_when
boolean

Threshold for boolean metrics to decide passing or failing in tests

event_name
string

Name of event that the metric is set to be computed on

event_type
enum<string>

Type of event that the metric is set to be computed on

Available options:
model,
tool,
chain,
session
child_metrics
object[]

Child metrics added under composite events

Get all metricsCreate a new metric