List quality evaluation metrics
curl --request GET \
--url https://backend.trusys.ai/api/external/metrics/eval \
--header 'x-api-key: <api-key>'import requests
url = "https://backend.trusys.ai/api/external/metrics/eval"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://backend.trusys.ai/api/external/metrics/eval', 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://backend.trusys.ai/api/external/metrics/eval",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://backend.trusys.ai/api/external/metrics/eval"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://backend.trusys.ai/api/external/metrics/eval")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.trusys.ai/api/external/metrics/eval")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "answer-relevance",
"name": "answer-relevance",
"label": "Answer Relevance",
"description": "Measures how relevant the response is to the user prompt",
"valueType": "number",
"mandatory": 0,
"additionalFields": [
{
"name": "threshold",
"type": "number",
"label": "Threshold score",
"mandatory": true
}
]
}
]
}{
"message": "Error while verifying api key"
}List quality evaluation metrics
Returns the catalog of quality evaluation metrics available for monitoring β for example answer relevance, faithfulness, and custom criteria.
Use each entryβs name as the type when building the metrics array in PUT /applications/{applicationId}/monitoring. Use additionalFields to know which extra keys (for example threshold) each metric accepts.
GET
/
metrics
/
eval
List quality evaluation metrics
curl --request GET \
--url https://backend.trusys.ai/api/external/metrics/eval \
--header 'x-api-key: <api-key>'import requests
url = "https://backend.trusys.ai/api/external/metrics/eval"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://backend.trusys.ai/api/external/metrics/eval', 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://backend.trusys.ai/api/external/metrics/eval",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://backend.trusys.ai/api/external/metrics/eval"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://backend.trusys.ai/api/external/metrics/eval")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.trusys.ai/api/external/metrics/eval")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "answer-relevance",
"name": "answer-relevance",
"label": "Answer Relevance",
"description": "Measures how relevant the response is to the user prompt",
"valueType": "number",
"mandatory": 0,
"additionalFields": [
{
"name": "threshold",
"type": "number",
"label": "Threshold score",
"mandatory": true
}
]
}
]
}{
"message": "Error while verifying api key"
}Authorizations
Your Trusys API key. Create and manage keys in the Trusys UI under Settings β API Keys.
Include the key on every request:
x-api-key: <your-api-key>
βI