Create a new metric

Add a new metric

POST /v1/metrics

Create a new metric

cURL

curl --request POST \
  --url https://api.dp1.us.honeyhive.ai/v1/metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "criteria": "<string>",
  "description": "",
  "return_type": "float",
  "enabled_in_prod": false,
  "needs_ground_truth": false,
  "sampling_percentage": 10,
  "model_provider": "<string>",
  "model_name": "<string>",
  "scale": 123,
  "threshold": {
    "min": 123,
    "max": 123,
    "pass_when": true,
    "passing_categories": [
      "<string>"
    ]
  },
  "categories": [
    {
      "category": "<string>",
      "score": 123
    }
  ],
  "child_metrics": [
    {
      "name": "<string>",
      "weight": 123,
      "id": "<string>",
      "scale": 123
    }
  ],
  "filters": {
    "filterArray": []
  }
}
'

200

{
  "inserted": true,
  "metric_id": "<string>"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Request body for POST /metrics

name · string · required

Maximum string length: 200

type · enum<string> · required

Available options: PYTHON, LLM, HUMAN, COMPOSITE

criteria · string · required

Minimum string length: 1

description · string · default: ""

return_type · enum<string> · default: float

Available options: float, boolean, string, categorical

enabled_in_prod · boolean · default: false

needs_ground_truth · boolean · default: false

sampling_percentage · number · default: 10

Required range: 0 <= x <= 100

model_provider · string | null

model_name · string | null

scale · integer | null

threshold · object

Show child attributes

categories · object[] | null

Minimum array length: 1

Show child attributes

child_metrics · object[] | null

Minimum array length: 1

Show child attributes

filters · object

Show child attributes

Response

200 - application/json

Metric created successfully

Response for POST /metrics

inserted · boolean · required

metric_id · string · required

Minimum string length: 1