Skip to main content
GET
/
metrics
Python
import honeyhive

s = honeyhive.HoneyHive(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.metrics.get_metrics(project_name='<value>')

if res.metrics is not None:
    # handle response
    pass
[
  {
    "name": "<string>",
    "task": "<string>",
    "type": "custom",
    "description": "<string>",
    "return_type": "boolean",
    "criteria": "<string>",
    "code_snippet": "<string>",
    "prompt": "<string>",
    "enabled_in_prod": true,
    "needs_ground_truth": true,
    "threshold": {
      "min": 123,
      "max": 123
    },
    "pass_when": true,
    "_id": "<string>",
    "event_name": "<string>",
    "event_type": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
project_name
string
required

Project name associated with metrics

Response

200 - application/json

A list of metrics

​
name
string
required

Name of the metric

​
task
string
required

Name of the project associated with metric

​
type
enum<string>
required

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

Available options:
custom,
model,
human
​
description
string
required

Short description of what the metric does

​
return_type
enum<string>
required

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

Available options:
boolean,
float,
string
​
criteria
string

Criteria for human metrics

​
code_snippet
string

Associated code block for the metric

​
prompt
string

Evaluator prompt for the metric

​
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

​
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

​
_id
string

Unique idenitifier

​
event_name
string

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

​
event_type
string

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