Skip to main content
POST
/
v2
/
evaluators
Create a custom LLM-as-a-judge evaluator
curl --request POST \
  --url https://api.traceloop.com/v2/evaluators \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input_schema": [
    {
      "name": "<string>",
      "description": "<string>",
      "enum_values": [
        "<string>"
      ],
      "label": "<string>"
    }
  ],
  "messages": [
    {
      "content": "<string>",
      "role": "<string>",
      "tool_call_id": "<string>"
    }
  ],
  "model": "<string>",
  "name": "<string>",
  "output_schema": [
    {
      "name": "<string>",
      "description": "<string>",
      "enum_values": [
        "<string>"
      ],
      "label": "<string>"
    }
  ],
  "provider": "<string>",
  "description": "<string>",
  "frequency_penalty": 123,
  "logprobs": true,
  "max_tokens": 123,
  "mode": "<string>",
  "presence_penalty": 123,
  "slug": "<string>",
  "stop": [
    "<string>"
  ],
  "temperature": 123,
  "top_p": 123
}
'
import requests

url = "https://api.traceloop.com/v2/evaluators"

payload = {
    "input_schema": [
        {
            "name": "<string>",
            "description": "<string>",
            "enum_values": ["<string>"],
            "label": "<string>"
        }
    ],
    "messages": [
        {
            "content": "<string>",
            "role": "<string>",
            "tool_call_id": "<string>"
        }
    ],
    "model": "<string>",
    "name": "<string>",
    "output_schema": [
        {
            "name": "<string>",
            "description": "<string>",
            "enum_values": ["<string>"],
            "label": "<string>"
        }
    ],
    "provider": "<string>",
    "description": "<string>",
    "frequency_penalty": 123,
    "logprobs": True,
    "max_tokens": 123,
    "mode": "<string>",
    "presence_penalty": 123,
    "slug": "<string>",
    "stop": ["<string>"],
    "temperature": 123,
    "top_p": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    input_schema: [
      {
        name: '<string>',
        description: '<string>',
        enum_values: ['<string>'],
        label: '<string>'
      }
    ],
    messages: [{content: '<string>', role: '<string>', tool_call_id: '<string>'}],
    model: '<string>',
    name: '<string>',
    output_schema: [
      {
        name: '<string>',
        description: '<string>',
        enum_values: ['<string>'],
        label: '<string>'
      }
    ],
    provider: '<string>',
    description: '<string>',
    frequency_penalty: 123,
    logprobs: true,
    max_tokens: 123,
    mode: '<string>',
    presence_penalty: 123,
    slug: '<string>',
    stop: ['<string>'],
    temperature: 123,
    top_p: 123
  })
};

fetch('https://api.traceloop.com/v2/evaluators', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.traceloop.com/v2/evaluators",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input_schema' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'enum_values' => [
                                '<string>'
                ],
                'label' => '<string>'
        ]
    ],
    'messages' => [
        [
                'content' => '<string>',
                'role' => '<string>',
                'tool_call_id' => '<string>'
        ]
    ],
    'model' => '<string>',
    'name' => '<string>',
    'output_schema' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'enum_values' => [
                                '<string>'
                ],
                'label' => '<string>'
        ]
    ],
    'provider' => '<string>',
    'description' => '<string>',
    'frequency_penalty' => 123,
    'logprobs' => true,
    'max_tokens' => 123,
    'mode' => '<string>',
    'presence_penalty' => 123,
    'slug' => '<string>',
    'stop' => [
        '<string>'
    ],
    'temperature' => 123,
    'top_p' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.traceloop.com/v2/evaluators"

	payload := strings.NewReader("{\n  \"input_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"enum_values\": [\n        \"<string>\"\n      ],\n      \"label\": \"<string>\"\n    }\n  ],\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"<string>\",\n      \"tool_call_id\": \"<string>\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"enum_values\": [\n        \"<string>\"\n      ],\n      \"label\": \"<string>\"\n    }\n  ],\n  \"provider\": \"<string>\",\n  \"description\": \"<string>\",\n  \"frequency_penalty\": 123,\n  \"logprobs\": true,\n  \"max_tokens\": 123,\n  \"mode\": \"<string>\",\n  \"presence_penalty\": 123,\n  \"slug\": \"<string>\",\n  \"stop\": [\n    \"<string>\"\n  ],\n  \"temperature\": 123,\n  \"top_p\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.traceloop.com/v2/evaluators")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"enum_values\": [\n        \"<string>\"\n      ],\n      \"label\": \"<string>\"\n    }\n  ],\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"<string>\",\n      \"tool_call_id\": \"<string>\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"enum_values\": [\n        \"<string>\"\n      ],\n      \"label\": \"<string>\"\n    }\n  ],\n  \"provider\": \"<string>\",\n  \"description\": \"<string>\",\n  \"frequency_penalty\": 123,\n  \"logprobs\": true,\n  \"max_tokens\": 123,\n  \"mode\": \"<string>\",\n  \"presence_penalty\": 123,\n  \"slug\": \"<string>\",\n  \"stop\": [\n    \"<string>\"\n  ],\n  \"temperature\": 123,\n  \"top_p\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.traceloop.com/v2/evaluators")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"enum_values\": [\n        \"<string>\"\n      ],\n      \"label\": \"<string>\"\n    }\n  ],\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"<string>\",\n      \"tool_call_id\": \"<string>\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"enum_values\": [\n        \"<string>\"\n      ],\n      \"label\": \"<string>\"\n    }\n  ],\n  \"provider\": \"<string>\",\n  \"description\": \"<string>\",\n  \"frequency_penalty\": 123,\n  \"logprobs\": true,\n  \"max_tokens\": 123,\n  \"mode\": \"<string>\",\n  \"presence_penalty\": 123,\n  \"slug\": \"<string>\",\n  \"stop\": [\n    \"<string>\"\n  ],\n  \"temperature\": 123,\n  \"top_p\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "bindings": [
    "<string>"
  ],
  "evaluator_id": "<string>",
  "slug": "<string>",
  "version_id": "<string>"
}
{
  "error": "error message"
}
{
  "error": "error message"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Custom evaluator creation input

​
input_schema
object[]
required

Schemas

​
messages
object[]
required

LLM Message configuration

​
model
string
required

LLM parameters (from BaseLLMConfig)

​
name
string
required

Basic fields

​
output_schema
object[]
required
​
provider
string
required

Provider configuration

​
description
string
​
frequency_penalty
number
​
logprobs
boolean
​
max_tokens
integer
​
mode
string
​
presence_penalty
number
​
slug
string
​
stop
string[]
​
temperature
number
​
top_p
number

Response

OK

​
bindings
string[]
​
evaluator_id
string
​
slug
string
​
type
enum<string>
Available options:
AGENT_GOAL_ACCURACY,
CHAR_COUNT,
CHAR_COUNT_RATIO,
ANSWER_COMPLETENESS,
FAITHFULNESS,
JSON_VALIDATOR,
PERPLEXITY,
PII_DETECTOR,
PLACEHOLDER_REGEX,
PROFANITY_DETECTOR,
SEXISM_DETECTOR,
PROMPT_INJECTION,
TONE_DETECTION,
PROMPT_PERPLEXITY,
TOXICITY_DETECTOR,
ANSWER_RELEVANCY,
ANSWER_CORRECTNESS,
REGEX_VALIDATOR,
SECRETS_DETECTOR,
SQL_VALIDATOR,
SEMANTIC_SIMILARITY,
TOPIC_ADHERENCE,
UNCERTAINTY_DETECTOR,
WORD_COUNT,
WORD_COUNT_RATIO,
INSTRUCTION_ADHERENCE,
AGENT_FLOW_QUALITY,
AGENT_EFFICIENCY,
AGENT_GOAL_COMPLETENESS,
CONVERSATION_QUALITY,
INTENT_CHANGE,
CONTEXT_RELEVANCE,
AGENT_TOOL_ERROR_DETECTOR,
AGENT_TOOL_TRAJECTORY,
HTML_COMPARISON,
LLM_AS_A_JUDGE
​
version_id
string