Skip to main content
POST
/
v2
/
evaluators
/
execute
/
semantic-similarity
Execute semantic-similarity evaluator
curl --request POST \
  --url https://api.traceloop.com/v2/evaluators/execute/semantic-similarity \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "completion": "The cat sat on the mat.",
    "reference": "A feline was resting on the rug."
  }
}
'
import requests

url = "https://api.traceloop.com/v2/evaluators/execute/semantic-similarity"

payload = { "input": {
        "completion": "The cat sat on the mat.",
        "reference": "A feline was resting on the rug."
    } }
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: 'The cat sat on the mat.',
      reference: 'A feline was resting on the rug.'
    }
  })
};

fetch('https://api.traceloop.com/v2/evaluators/execute/semantic-similarity', 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/execute/semantic-similarity",
  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' => 'The cat sat on the mat.',
        'reference' => 'A feline was resting on the rug.'
    ]
  ]),
  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/execute/semantic-similarity"

	payload := strings.NewReader("{\n  \"input\": {\n    \"completion\": \"The cat sat on the mat.\",\n    \"reference\": \"A feline was resting on the rug.\"\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/execute/semantic-similarity")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": {\n    \"completion\": \"The cat sat on the mat.\",\n    \"reference\": \"A feline was resting on the rug.\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

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

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\": \"The cat sat on the mat.\",\n    \"reference\": \"A feline was resting on the rug.\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "similarity_score": 0.92
}
{
  "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

Response

OK

​
similarity_score
number
Example:

0.92