List test metrics

GET

tests

test_framework

metrics

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const response of client.ai.tests.testFramework.v1.metrics.list()) {
  console.log(response);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.ai.tests.test_framework.v1.metrics.list()
print(page)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	metrics, err := client.AI.Tests.TestFramework.V1.Metrics.List(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", metrics.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var page = client.ai().tests().testFramework().v1().metrics().list();
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->ai->tests->testFramework->v1->metrics->list();

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

[
  {
    "id": 266881,
    "slug": "ai_interrupting_user",
    "project": 16003,
    "agent": null,
    "agents": [],
    "agent_names": [],
    "name": "AI interrupting user",
    "description": "Tells if the AI (main agent) interrupted user (testing agent) during the interaction.",
    "function_name": "get_main_agent_interruption",
    "type": "custom_code",
    "eval_type": "numeric",
    "enum_values": [],
    "audio_enabled": false,
    "observability_enabled": true,
    "simulation_enabled": true,
    "sampling_enabled": false,
    "sample_rate": null,
    "prompt": "",
    "display_order": 1,
    "evaluation_trigger": "always",
    "trigger_type": "llm_judge",
    "evaluation_trigger_prompt": "",
    "evaluation_trigger_custom_code": "",
    "priority_assignment_prompt": "",
    "configuration": {},
    "overall_score": 0,
    "total_score": 0,
    "kb_file_ids": [],
    "knowledge_base_files": [],
    "metric_cost": 0,
    "alert_type": "disabled",
    "significant_change_alert_status": "disabled",
    "significant_change_alert_direction": "",
    "window_size": 50,
    "std_multiplier": 2,
    "ewma_alpha": 0.1,
    "add_to_new_agents": true,
    "alert_filters": {},
    "uses_llm_judge": false,
    "user_defined": false
  }
]

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The AI Tests service rejected the request."
    }
  ]
}

{
  "errors": [
    {
      "code": "10003",
      "title": "Unauthorized",
      "detail": "The API key is missing or invalid."
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Not Found",
      "detail": "The requested resource or URL could not be found."
    }
  ]
}

{
  "errors": [
    {
      "code": "10018",
      "title": "Unprocessable Entity",
      "detail": "Validation failed for the request payload."
    }
  ]
}

{
  "errors": [
    {
      "code": "10029",
      "title": "Too Many Requests",
      "detail": "Too many requests; retry later."
    }
  ]
}

{
  "errors": [
    {
      "code": "10063",
      "title": "Service Unavailable",
      "detail": "The test framework service is temporarily unavailable."
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

agent_id

integer

Filter metrics attached to the specified test agent.

assistant_id

string

Filter metrics attached to the specified Telnyx assistant.

Response

List of test metrics.

integer

required

name

string

required

type

string

required

How the metric is evaluated: custom_code or llm_judge.

eval_type

string

required

What the metric scores: numeric, continuous_qualitative, or binary_workflow_adherence.

slug

string | null

Stable identifier of a built-in metric.

project

integer | null

agent

integer | null

agents

integer[]

Test agent IDs the metric is attached to.

agent_names

string[]

description

string

function_name

string | null

Built-in evaluation function used by custom_code metrics.

enum_values

string[]

Allowed values for qualitative enum metrics.

audio_enabled

boolean

observability_enabled

boolean

simulation_enabled

boolean

sampling_enabled

boolean

sample_rate

number | null

prompt

string

Judge prompt used by llm_judge metrics.

display_order

integer

evaluation_trigger

string

trigger_type

string

evaluation_trigger_prompt

string

evaluation_trigger_custom_code

string

priority_assignment_prompt

string

configuration

object | null

overall_score

total_score

kb_file_ids

integer[]

knowledge_base_files

string[]

metric_cost

number

alert_type

string

significant_change_alert_status

string

significant_change_alert_direction

string

window_size

integer

Sliding window size the alert status is computed over.

std_multiplier

number

Standard-deviation multiplier for significant-change alerts.

ewma_alpha

number

Smoothing factor for the alert trend.

add_to_new_agents

boolean | null

Whether the metric is attached to newly created test agents by default.

alert_filters

object | null

uses_llm_judge

boolean

user_defined

boolean

Example:

[
  {
    "id": 266881,
    "slug": "ai_interrupting_user",
    "project": 16003,
    "agent": null,
    "agents": [],
    "agent_names": [],
    "name": "AI interrupting user",
    "description": "Tells if the AI (main agent) interrupted user (testing agent) during the interaction.",
    "function_name": "get_main_agent_interruption",
    "type": "custom_code",
    "eval_type": "numeric",
    "enum_values": [],
    "audio_enabled": false,
    "observability_enabled": true,
    "simulation_enabled": true,
    "sampling_enabled": false,
    "sample_rate": null,
    "prompt": "",
    "display_order": 1,
    "evaluation_trigger": "always",
    "trigger_type": "llm_judge",
    "evaluation_trigger_prompt": "",
    "evaluation_trigger_custom_code": "",
    "priority_assignment_prompt": "",
    "configuration": {},
    "overall_score": 0,
    "total_score": 0,
    "kb_file_ids": [],
    "knowledge_base_files": [],
    "metric_cost": 0,
    "alert_type": "disabled",
    "significant_change_alert_status": "disabled",
    "significant_change_alert_direction": "",
    "window_size": 50,
    "std_multiplier": 2,
    "ewma_alpha": 0.1,
    "add_to_new_agents": true,
    "alert_filters": {},
    "uses_llm_judge": false,
    "user_defined": false
  }
]

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const response of client.ai.tests.testFramework.v1.metrics.list()) {
  console.log(response);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.ai.tests.test_framework.v1.metrics.list()
print(page)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	metrics, err := client.AI.Tests.TestFramework.V1.Metrics.List(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", metrics.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var page = client.ai().tests().testFramework().v1().metrics().list();
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->ai->tests->testFramework->v1->metrics->list();

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

[
  {
    "id": 266881,
    "slug": "ai_interrupting_user",
    "project": 16003,
    "agent": null,
    "agents": [],
    "agent_names": [],
    "name": "AI interrupting user",
    "description": "Tells if the AI (main agent) interrupted user (testing agent) during the interaction.",
    "function_name": "get_main_agent_interruption",
    "type": "custom_code",
    "eval_type": "numeric",
    "enum_values": [],
    "audio_enabled": false,
    "observability_enabled": true,
    "simulation_enabled": true,
    "sampling_enabled": false,
    "sample_rate": null,
    "prompt": "",
    "display_order": 1,
    "evaluation_trigger": "always",
    "trigger_type": "llm_judge",
    "evaluation_trigger_prompt": "",
    "evaluation_trigger_custom_code": "",
    "priority_assignment_prompt": "",
    "configuration": {},
    "overall_score": 0,
    "total_score": 0,
    "kb_file_ids": [],
    "knowledge_base_files": [],
    "metric_cost": 0,
    "alert_type": "disabled",
    "significant_change_alert_status": "disabled",
    "significant_change_alert_direction": "",
    "window_size": 50,
    "std_multiplier": 2,
    "ewma_alpha": 0.1,
    "add_to_new_agents": true,
    "alert_filters": {},
    "uses_llm_judge": false,
    "user_defined": false
  }
]

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The AI Tests service rejected the request."
    }
  ]
}

{
  "errors": [
    {
      "code": "10003",
      "title": "Unauthorized",
      "detail": "The API key is missing or invalid."
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Not Found",
      "detail": "The requested resource or URL could not be found."
    }
  ]
}

{
  "errors": [
    {
      "code": "10018",
      "title": "Unprocessable Entity",
      "detail": "Validation failed for the request payload."
    }
  ]
}

{
  "errors": [
    {
      "code": "10029",
      "title": "Too Many Requests",
      "detail": "Too many requests; retry later."
    }
  ]
}

{
  "errors": [
    {
      "code": "10063",
      "title": "Service Unavailable",
      "detail": "The test framework service is temporarily unavailable."
    }
  ]
}

Guides

Missions

AI Insights

Assistants API

Missions API

AI Tests API

Conversations API

For AI Agents

List test metrics

Authorizations

Query Parameters

Response