List Metrics

GET

metrics

{
  "request_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "success",
  "metrics": [
    {
      "name": "my_metric",
      "description": "An example metric demonstrating functionality.",
      "metric_type": "binary",
      "required_fields": [
        "model_input",
        "model_output",
        "model_context",
        "expected_model_output"
      ],
      "active_prompt_version": 1,
      "prompts": {
        "1": {
          "content": "This is an example prompt for the metric. It is active.",
          "created_at": "2025-01-01T12:34:56.789000Z",
          "updated_at": "2025-01-01T12:34:56.789000Z",
          "version": 1
        },
        "2": {
          "content": "This is an updated example prompt for the metric.",
          "created_at": "2025-01-01T12:34:56.789000Z",
          "updated_at": "2025-01-01T12:34:56.789000Z",
          "version": 2
        }
      },
      "few_shot_examples": [
        {
          "model_input": "Few-shot `model_input`.",
          "model_output": "Few-shot `model_output`.",
          "model_context": "Few-shot `model_context`.",
          "expected_model_output": "Few-shot `expected_model_output`.",
          "score": "1",
          "critique": "Critique for the few-shot example explaining why the score is 1."
        }
      ],
      "_id": "<string>",
      "project_id": "<string>",
      "created_at": "2025-01-01T12:34:56.789Z",
      "updated_at": "2025-01-01T12:34:56.789Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

include_default

boolean

default:true

Whether to include default metrics.

Response

200

application/json

Successful Response

A response containing a list of retrieved metrics.

request_id

string

required

The ID of the request the response is for.

Example:

"123e4567-e89b-12d3-a456-426614174000"

metrics

object[]

required

The metrics retrieved.

A metric in the database.

metrics.name

string

required

The name of the metric. Metric names must contain only lowercase letters, numbers, hyphens, or underscores, and must start with a lowercase letter and end with either a lowercase letter or number. Metric names must be unique within a project.

Example:

"my_metric"

metrics.metric_type

enum<string>

required

The type of metric.

Available options:

binary,

likert_1_to_5

metrics.project_id

string | null

required

The ID of the project that the metric belongs to. If the metric is shared, this field will be null.

metrics.description

string | null

An optional description of the metric.

Example:

"An example metric demonstrating functionality."

metrics.required_fields

enum<string>[]

The fields that are required for the metric. All metrics must require at least model_input and model_output, which are the default values.

An enum for the fields that can be used as inputs to an Atla evaluator.

Available options:

model_input,

model_output,

model_context,

expected_model_output

Example:

[
  "model_input",
  "model_output",
  "model_context",
  "expected_model_output"
]

metrics.active_prompt_version

integer | null

The version of the prompt that is currently active for the metric.

Required range: x > 0

Example:

1

metrics.prompts

object

The prompts for the metric, keyed by version.

Example:

{
  "1": {
    "content": "This is an example prompt for the metric. It is active.",
    "created_at": "2025-01-01T12:34:56.789000Z",
    "updated_at": "2025-01-01T12:34:56.789000Z",
    "version": 1
  },
  "2": {
    "content": "This is an updated example prompt for the metric.",
    "created_at": "2025-01-01T12:34:56.789000Z",
    "updated_at": "2025-01-01T12:34:56.789000Z",
    "version": 2
  }
}

metrics.few_shot_examples

object[]

The few-shot examples for the metric. At most 3 examples are allowed.

A few-shot example for a metric.

metrics._id

string

The ID of the metric in the database.

metrics.created_at

string

The creation time of the metric.

Example:

"2025-01-01T12:34:56.789Z"

metrics.updated_at

string

The last update time of the metric.

Example:

"2025-01-01T12:34:56.789Z"

status

string

default:success

Allowed value: "success"

Get Metric Create Metric Prompt

{
  "request_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "success",
  "metrics": [
    {
      "name": "my_metric",
      "description": "An example metric demonstrating functionality.",
      "metric_type": "binary",
      "required_fields": [
        "model_input",
        "model_output",
        "model_context",
        "expected_model_output"
      ],
      "active_prompt_version": 1,
      "prompts": {
        "1": {
          "content": "This is an example prompt for the metric. It is active.",
          "created_at": "2025-01-01T12:34:56.789000Z",
          "updated_at": "2025-01-01T12:34:56.789000Z",
          "version": 1
        },
        "2": {
          "content": "This is an updated example prompt for the metric.",
          "created_at": "2025-01-01T12:34:56.789000Z",
          "updated_at": "2025-01-01T12:34:56.789000Z",
          "version": 2
        }
      },
      "few_shot_examples": [
        {
          "model_input": "Few-shot `model_input`.",
          "model_output": "Few-shot `model_output`.",
          "model_context": "Few-shot `model_context`.",
          "expected_model_output": "Few-shot `expected_model_output`.",
          "score": "1",
          "critique": "Critique for the few-shot example explaining why the score is 1."
        }
      ],
      "_id": "<string>",
      "project_id": "<string>",
      "created_at": "2025-01-01T12:34:56.789Z",
      "updated_at": "2025-01-01T12:34:56.789Z"
    }
  ]
}

API Documentation

Authorizations

Query Parameters

Response