Execute conversation-quality evaluator

Evaluate conversation quality based on tone, clarity, flow, responsiveness, and transparency

Request Body:

• input.prompts (string, required): JSON array of prompts in the conversation
• input.completions (string, required): JSON array of completions in the conversation

POST /v2/evaluators/conversation-quality/execute

Execute conversation-quality evaluator

cURL

curl --request POST \
  --url https://api.traceloop.com/v2/evaluators/conversation-quality/execute \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "input": {
    "completions": "[\"Hi! I'd be happy to assist you today.\", \"We offer consulting, development, and support services.\"]",
    "prompts": "[\"Hello, how can I help?\", \"What services do you offer?\"]"
  }
}
EOF

import requests

url = "https://api.traceloop.com/v2/evaluators/conversation-quality/execute"

payload = { "input": {
        "completions": "[\"Hi! I'd be happy to assist you today.\", \"We offer consulting, development, and support services.\"]",
        "prompts": "[\"Hello, how can I help?\", \"What services do you offer?\"]"
    } }
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: {
      completions: '["Hi! I\'d be happy to assist you today.", "We offer consulting, development, and support services."]',
      prompts: '["Hello, how can I help?", "What services do you offer?"]'
    }
  })
};

fetch('https://api.traceloop.com/v2/evaluators/conversation-quality/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/conversation-quality/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' => [
        'completions' => '["Hi! I\'d be happy to assist you today.", "We offer consulting, development, and support services."]',
        'prompts' => '["Hello, how can I help?", "What services do you offer?"]'
    ]
  ]),
  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/conversation-quality/execute"

	payload := strings.NewReader("{\n  \"input\": {\n    \"completions\": \"[\\\"Hi! I'd be happy to assist you today.\\\", \\\"We offer consulting, development, and support services.\\\"]\",\n    \"prompts\": \"[\\\"Hello, how can I help?\\\", \\\"What services do you offer?\\\"]\"\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/conversation-quality/execute")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": {\n    \"completions\": \"[\\\"Hi! I'd be happy to assist you today.\\\", \\\"We offer consulting, development, and support services.\\\"]\",\n    \"prompts\": \"[\\\"Hello, how can I help?\\\", \\\"What services do you offer?\\\"]\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.traceloop.com/v2/evaluators/conversation-quality/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    \"completions\": \"[\\\"Hi! I'd be happy to assist you today.\\\", \\\"We offer consulting, development, and support services.\\\"]\",\n    \"prompts\": \"[\\\"Hello, how can I help?\\\", \\\"What services do you offer?\\\"]\"\n  }\n}"

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

200

{
  "conversation_quality_score": 0.82
}

{
  "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

conversation_quality_score · number

Example:

0.82