Reevaluate Calls

Re-run metric evaluation on call logs

curl --request POST \
  --url https://api.cekura.ai/observability/v1/call-logs/rerun_evaluation/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '
{
  "agent_id": 123,
  "assistant_id": 123,
  "call_logs": [
    123
  ]
}
'

import requests

url = "https://api.cekura.ai/observability/v1/call-logs/rerun_evaluation/"

payload = {
    "agent_id": 123,
    "assistant_id": 123,
    "call_logs": [123]
}
headers = {
    "X-CEKURA-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-CEKURA-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({agent_id: 123, assistant_id: 123, call_logs: [123]})
};

fetch('https://api.cekura.ai/observability/v1/call-logs/rerun_evaluation/', 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.cekura.ai/observability/v1/call-logs/rerun_evaluation/",
  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([
    'agent_id' => 123,
    'assistant_id' => 123,
    'call_logs' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-CEKURA-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cekura.ai/observability/v1/call-logs/rerun_evaluation/"

	payload := strings.NewReader("{\n  \"agent_id\": 123,\n  \"assistant_id\": 123,\n  \"call_logs\": [\n    123\n  ]\n}")

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

	req.Header.Add("X-CEKURA-API-KEY", "<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.cekura.ai/observability/v1/call-logs/rerun_evaluation/")
  .header("X-CEKURA-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": 123,\n  \"assistant_id\": 123,\n  \"call_logs\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cekura.ai/observability/v1/call-logs/rerun_evaluation/")

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

request = Net::HTTP::Post.new(url)
request["X-CEKURA-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": 123,\n  \"assistant_id\": 123,\n  \"call_logs\": [\n    123\n  ]\n}"

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

[
  {
    "call_id": "<string>",
    "id": 123,
    "duration": "<string>",
    "voice_recording_url": "<string>",
    "critical_categories": [
      {
        "category_id": 123,
        "category": "<string>",
        "deviation": 123,
        "wrongly_marked": true,
        "feedback": "<string>"
      }
    ],
    "transcript_object": [
      {
        "role": "<string>",
        "content": "<string>",
        "timestamp": 123
      }
    ],
    "agent_id": "<string>",
    "agent_name": "<string>",
    "evaluation": {
      "metrics": [
        {
          "id": 123,
          "name": "<string>",
          "type": "<string>",
          "score": 123,
          "enum": "<string>",
          "value": "<string>",
          "explanation": [
            "<string>"
          ],
          "extra": {}
        }
      ]
    },
    "metadata": {},
    "dynamic_variables": {},
    "testing_channel_index": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "success": true,
    "is_reviewed": true,
    "feedback": "<string>",
    "rubric": "<unknown>",
    "transcript": "<string>",
    "call_ended_reason": "<string>",
    "dropoff_point": "<string>",
    "topic": "<string>",
    "customer_number": "<string>",
    "user_generated_transcript": "<unknown>",
    "error_message": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "trace_id": "<string>",
    "agent": 123,
    "project": 123
  }
]

{
  "field_name": [
    "<string>"
  ]
}

POST

observability

call-logs

rerun_evaluation

Re-run metric evaluation on call logs

curl --request POST \
  --url https://api.cekura.ai/observability/v1/call-logs/rerun_evaluation/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '
{
  "agent_id": 123,
  "assistant_id": 123,
  "call_logs": [
    123
  ]
}
'

import requests

url = "https://api.cekura.ai/observability/v1/call-logs/rerun_evaluation/"

payload = {
    "agent_id": 123,
    "assistant_id": 123,
    "call_logs": [123]
}
headers = {
    "X-CEKURA-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-CEKURA-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({agent_id: 123, assistant_id: 123, call_logs: [123]})
};

fetch('https://api.cekura.ai/observability/v1/call-logs/rerun_evaluation/', 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.cekura.ai/observability/v1/call-logs/rerun_evaluation/",
  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([
    'agent_id' => 123,
    'assistant_id' => 123,
    'call_logs' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-CEKURA-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cekura.ai/observability/v1/call-logs/rerun_evaluation/"

	payload := strings.NewReader("{\n  \"agent_id\": 123,\n  \"assistant_id\": 123,\n  \"call_logs\": [\n    123\n  ]\n}")

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

	req.Header.Add("X-CEKURA-API-KEY", "<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.cekura.ai/observability/v1/call-logs/rerun_evaluation/")
  .header("X-CEKURA-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": 123,\n  \"assistant_id\": 123,\n  \"call_logs\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cekura.ai/observability/v1/call-logs/rerun_evaluation/")

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

request = Net::HTTP::Post.new(url)
request["X-CEKURA-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": 123,\n  \"assistant_id\": 123,\n  \"call_logs\": [\n    123\n  ]\n}"

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

[
  {
    "call_id": "<string>",
    "id": 123,
    "duration": "<string>",
    "voice_recording_url": "<string>",
    "critical_categories": [
      {
        "category_id": 123,
        "category": "<string>",
        "deviation": 123,
        "wrongly_marked": true,
        "feedback": "<string>"
      }
    ],
    "transcript_object": [
      {
        "role": "<string>",
        "content": "<string>",
        "timestamp": 123
      }
    ],
    "agent_id": "<string>",
    "agent_name": "<string>",
    "evaluation": {
      "metrics": [
        {
          "id": 123,
          "name": "<string>",
          "type": "<string>",
          "score": 123,
          "enum": "<string>",
          "value": "<string>",
          "explanation": [
            "<string>"
          ],
          "extra": {}
        }
      ]
    },
    "metadata": {},
    "dynamic_variables": {},
    "testing_channel_index": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "success": true,
    "is_reviewed": true,
    "feedback": "<string>",
    "rubric": "<unknown>",
    "transcript": "<string>",
    "call_ended_reason": "<string>",
    "dropoff_point": "<string>",
    "topic": "<string>",
    "customer_number": "<string>",
    "user_generated_transcript": "<unknown>",
    "error_message": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "trace_id": "<string>",
    "agent": 123,
    "project": 123
  }
]

{
  "field_name": [
    "<string>"
  ]
}

Authorizations

X-CEKURA-API-KEY

string

header

required

API Key Authentication. It should be included in the header of each request.

Body

agent_id

integer

required

Cekura agent ID. Provide this or assistant_id, not both. Example: 2142

assistant_id

integer

required

External assistant identifier. Provide this or agent_id, not both. Example: 2143

call_logs

integer[]

required

List of call log IDs to re-evaluate, or the string "all" for all call logs. Example: [1, 2, 3]

Response

call_id

string

required

Unique identifier for the call. Example:

"call_abc123xyz"
"stereo_audio_session_456"

Maximum string length: 100

integer

read-only

duration

string

read-only

Call duration in minutes in MM:SS format. Example: 01:10

voice_recording_url

string

read-only

URL to access the voice recording. Example: "https://storage.example.com/recordings/call_123_20240315.mp3"

critical_categories

object[]

read-only

Critical categories from call evaluation

Show child attributes

transcript_object

object[]

read-only

Structured transcript data with timestamps. Example:

[
    {
        "role": "Testing Agent",
        "content": "Hello",
        "start_time": 1.2,
        "end_time": 1.8
    },
    {
        "role": "Main Agent",
        "content": "Hello, how can I help you today?",
        "start_time": 1.8,
        "end_time": 2.5
    }
]`

Show child attributes

status

enum<string>

success - Success
failure - Failure
reviewed_success - Reviewed Success
reviewed_failure - Reviewed Failure

Available options:

success,

failure,

reviewed_success,

reviewed_failure

agent_id

string

Agent ID. Example: 2142

agent_name

string

read-only

Agent name

evaluation

object

Evaluation results for the call. Example:

{
    "metrics": [
        {
            "id": 35,
            "name": "Instruction Follow",
            "type": "binary",
            "score": 0,
            "explanation": ["Agent failed to follow the opening script", "Missed key product information"],
            "vocera_defined_metric_code": "5dedc41b",
            "function_name": "check_critical_deviations",
            "extra": {
                "categories": [
                    {
                        "category_id": 5,
                        "category": "Script Adherence Issue",
                        "deviation": "Agent deviated from required script",
                        "priority": "critical"
                    }
                ]
            }
        },
        {
            "id": 18,
            "name": "Customer Satisfaction",
            "type": "binary",
            "score": 5,
            "explanation": ["Customer expressed satisfaction with service"]
        }
    ]
}

Show child attributes

metadata

object

read-only

Additional call metadata. Example:

{
    "ended_reason": "customer-ended-call",
    "ringing_duration": 3.941,
    "call_type": "inbound"
}

Show child attributes

dynamic_variables

object

read-only

Dynamic Variables used in the call. Example:

{
    "customer_name": "John Doe",
    "order_id": "ORD-12345",
    "product_type": "premium"
}

Show child attributes

testing_channel_index

integer | null

read-only

The channel index of the testing agent in the audio recording

timestamp

string<date-time>

When the call occurred. Example: 2024-03-15T10:15:45Z

success

boolean | null

Whether the call was successful. Example: true or false

is_reviewed

boolean

Whether the call has been reviewed. Example: true or false

feedback

string

Feedback about the call. Example: "Great Call"

rubric

any | null

Detailed rubric evaluation data Example:

[
    {
        "metric_id": 100,
        "metric_name": "Call Quality",
        "value": 5,
        "explanation": ["The response was accurate"],
        "passed": true,
        "conditions": "score gte 5",
        "expected_conditions": {"operator": "and", "conditions": [{"field": "score", "op": "gte", "value": 5}]}
    }
]

transcript

string

Full text transcript of the call. Example:

[00:01] Testing Agent: Hello. 
[00:02] Main Agent: Hello, how can I help you today?
[00:03] Testing Agent: Well, I mean, sure. What time exactly are we talking about here
[00:04] Main Agent: 6 PM.
[00:05] Testing Agent: Great. I'll book that for you. Just a sec.
[00:06] Main Agent: Okay.

call_ended_reason

string

Reason why the call ended. Example:

"customer-ended-call"
"agent-ended-call"

Maximum string length: 100

dropoff_point

string

Point in conversation where user disengaged. Example: "end of conversation as no queries remaining"

Maximum string length: 1000

topic

string

Topic of the call. Example:

"product_inquiry"
"technical_support"

Maximum string length: 1000

customer_number

string

Customer's phone number or identifier. Example:

"+1234567890"
"customer_abc123"

Maximum string length: 100

user_generated_transcript

any | null

Manually created or corrected transcript data. Example:

[
    {
        "role": "Testing Agent",
        "content": "I need help with my order",
        "timestamp": "00:15"
    }
]`

error_message

string | null

created_at

string<date-time>

read-only

When this record was created. Example: 2024-03-15T10:30:45Z

updated_at

string<date-time>

read-only

When this record was last updated. Example: 2024-03-15T10:35:11Z

trace_id

string

OpenTelemetry trace ID (32-char hex). Set when OTel tracing is enabled.

Maximum string length: 32

agent

integer | null

Agent ID

project

integer | null

Project ID (denormalized from agent for query performance)

List Calls Evaluate Metrics

⌘I