GET
/
test_framework
/
v1
/
metrics
/
{id}
/
cURL
curl --request GET \
  --url https://api.cekura.ai/test_framework/v1/metrics/{id}/ \
  --header 'X-CEKURA-API-KEY: <api-key>'
{
  "id": 123,
  "agent": 123,
  "name": "<string>",
  "description": "<string>",
  "type": "basic",
  "eval_type": "binary_workflow_adherence",
  "enum_values": "<any>",
  "audio_enabled": true,
  "prompt": "<string>",
  "evaluation_trigger": "always",
  "evaluation_trigger_prompt": "<string>",
  "priority_assignment_prompt": "<string>",
  "configuration": "<any>",
  "display_order": -1,
  "overall_score": "<string>",
  "total_score": "<string>",
  "knowledge_base_files": "<string>",
  "observability_enabled": true,
  "simulation_enabled": true,
  "alert_enabled": true,
  "function_name": "<string>",
  "custom_code": "<string>",
  "vocera_defined_metric_code": "<string>",
  "reviews": "<string>"
}

Authorizations

​
X-CEKURA-API-KEY
string
header
required

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

Path Parameters

​
id
integer
required

A unique integer value identifying this metric.

Response

​
id
integer
required
​
agent
integer
required
​
name
string
required
Maximum length: 255
​
overall_score
string
required

The overall score for this metric across all test sets

​
total_score
string
required

The total score for this metric

​
knowledge_base_files
string
required

Knowledge base files associated with this metric

​
reviews
string
required

Reviews associated with the metric

​
description
string
​
type
enum<string>
  • basic - Basic
  • custom_prompt - Custom Prompt
  • custom_code - Custom Code
Available options:
basic,
custom_prompt,
custom_code
​
eval_type
enum<string>
  • binary_workflow_adherence - Binary Workflow Adherence
  • binary_qualitative - Binary Qualitative
  • continuous_qualitative - Continuous Qualitative
  • numeric - Numeric
  • enum - Enum
Available options:
binary_workflow_adherence,
binary_qualitative,
continuous_qualitative,
numeric,
enum
​
enum_values
any
​
audio_enabled
boolean
​
prompt
string
​
evaluation_trigger
enum<string>
  • always - Always
  • automatic - Automatic
  • custom - Custom
Available options:
always,
automatic,
custom
​
evaluation_trigger_prompt
string
​
priority_assignment_prompt
string
​
configuration
any

Custom configuration parameters for specific metrics

​
display_order
integer
Required range: -2147483648 <= x <= 2147483647
​
observability_enabled
boolean

Enable this metric for observability

​
simulation_enabled
boolean

Enable this metric for simulations

​
alert_enabled
boolean

Enable alerts for this metric when it fails

​
function_name
string | null
Maximum length: 255
​
custom_code
string
​
vocera_defined_metric_code
string
Maximum length: 255