Skip to main content
POST
/
v3
/
evals
/
score
Score inputs using an evaluator
curl --request POST \
  --url https://api.example.com/v3/evals/score \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "evaluator_name": "<string>",
  "parameters": {
    "key1": "value1",
    "key2": "value2"
  },
  "inputs": {
    "key1": "value1",
    "key2": "value2"
  }
}
'
import requests

url = "https://api.example.com/v3/evals/score"

payload = {
    "evaluator_name": "<string>",
    "parameters": {
        "key1": "value1",
        "key2": "value2"
    },
    "inputs": {
        "key1": "value1",
        "key2": "value2"
    }
}
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({
    evaluator_name: '<string>',
    parameters: {key1: 'value1', key2: 'value2'},
    inputs: {key1: 'value1', key2: 'value2'}
  })
};

fetch('https://api.example.com/v3/evals/score', 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.example.com/v3/evals/score",
  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([
    'evaluator_name' => '<string>',
    'parameters' => [
        'key1' => 'value1',
        'key2' => 'value2'
    ],
    'inputs' => [
        'key1' => 'value1',
        'key2' => 'value2'
    ]
  ]),
  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.example.com/v3/evals/score"

	payload := strings.NewReader("{\n  \"evaluator_name\": \"<string>\",\n  \"parameters\": {\n    \"key1\": \"value1\",\n    \"key2\": \"value2\"\n  },\n  \"inputs\": {\n    \"key1\": \"value1\",\n    \"key2\": \"value2\"\n  }\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.example.com/v3/evals/score")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"evaluator_name\": \"<string>\",\n  \"parameters\": {\n    \"key1\": \"value1\",\n    \"key2\": \"value2\"\n  },\n  \"inputs\": {\n    \"key1\": \"value1\",\n    \"key2\": \"value2\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/evals/score")

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  \"evaluator_name\": \"<string>\",\n  \"parameters\": {\n    \"key1\": \"value1\",\n    \"key2\": \"value2\"\n  },\n  \"inputs\": {\n    \"key1\": \"value1\",\n    \"key2\": \"value2\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "scores": [
      {
        "name": "<string>",
        "value": 123,
        "label": "<string>",
        "reasoning": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<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 scoring inputs

evaluator_name
string
required

Name of the evaluator

parameters
object
required

JSON object containing parameters for the evaluator

Example:
{ "key1": "value1", "key2": "value2" }
inputs
object
required

JSON object containing the inputs to be evaluated

Example:
{ "key1": "value1", "key2": "value2" }

Response

Scores returned successfully

Response object for standard API responses.

api_version
enum<string>
default:3.0

API version.

Available options:
2.0,
3.0
kind
enum<string>
default:NORMAL

Type of response, indicating a normal response.

Available options:
NORMAL
data
object