Execute topic-adherence evaluator

Evaluate topic adherence

Request Body:

• input.question (string, required): The original question
• input.completion (string, required): The completion to evaluate
• input.reference_topics (string, required): Comma-separated list of expected topics

POST /v2/evaluators/topic-adherence/execute

Execute topic-adherence evaluator

cURL

curl --request POST \
  --url https://api.traceloop.com/v2/evaluators/topic-adherence/execute \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "completion": "Machine learning is a subset of AI that enables systems to learn from data.",
    "question": "Tell me about machine learning",
    "reference_topics": "artificial intelligence, data science, algorithms"
  }
}
'

import requests

url = "https://api.traceloop.com/v2/evaluators/topic-adherence/execute"

payload = { "input": {
        "completion": "Machine learning is a subset of AI that enables systems to learn from data.",
        "question": "Tell me about machine learning",
        "reference_topics": "artificial intelligence, data science, algorithms"
    } }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    input: {
      completion: 'Machine learning is a subset of AI that enables systems to learn from data.',
      question: 'Tell me about machine learning',
      reference_topics: 'artificial intelligence, data science, algorithms'
    }
  })
};

fetch('https://api.traceloop.com/v2/evaluators/topic-adherence/execute', 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/topic-adherence/execute",
  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' => [
        'completion' => 'Machine learning is a subset of AI that enables systems to learn from data.',
        'question' => 'Tell me about machine learning',
        'reference_topics' => 'artificial intelligence, data science, algorithms'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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/topic-adherence/execute"

	payload := strings.NewReader("{\n  \"input\": {\n    \"completion\": \"Machine learning is a subset of AI that enables systems to learn from data.\",\n    \"question\": \"Tell me about machine learning\",\n    \"reference_topics\": \"artificial intelligence, data science, algorithms\"\n  }\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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/topic-adherence/execute")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": {\n    \"completion\": \"Machine learning is a subset of AI that enables systems to learn from data.\",\n    \"question\": \"Tell me about machine learning\",\n    \"reference_topics\": \"artificial intelligence, data science, algorithms\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.traceloop.com/v2/evaluators/topic-adherence/execute")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input\": {\n    \"completion\": \"Machine learning is a subset of AI that enables systems to learn from data.\",\n    \"question\": \"Tell me about machine learning\",\n    \"reference_topics\": \"artificial intelligence, data science, algorithms\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "adherence_score": 0.95
}

{
  "error": "error message"
}

{
  "error": "error message"
}

Authorizations

Authorization · string · header · required

Type "Bearer" followed by a space and JWT token.

Body

application/json

Request body

input · object · required

Show child attributes

Response

200

application/json

OK

adherence_score · number

Example:

0.95