GET
/
test_framework
/
v1
/
predefined-metrics
/
cURL
curl --request GET \
  --url https://api.cekura.ai/test_framework/v1/predefined-metrics/ \
  --header 'X-CEKURA-API-KEY: <api-key>'
[
  {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "code": "<string>",
    "type": "basic",
    "eval_type": "binary_workflow_adherence",
    "audio_enabled": true,
    "prompt": "<string>",
    "function_name": "<string>",
    "enum_values": "<any>",
    "custom_code": "<string>",
    "simulation_enabled": true,
    "observability_enabled": true,
    "configuration": "<any>",
    "cost": "<string>",
    "evaluation_trigger": "always",
    "evaluation_trigger_prompt": "<string>",
    "organization": 123
  }
]

Authorizations

​
X-CEKURA-API-KEY
string
header
required

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

Response

200 - application/json
​
id
integer
required
​
name
string
required
Maximum length: 255
​
description
string
required
​
code
string
required
​
audio_enabled
boolean
required
​
function_name
string | null
required
​
cost
string<decimal>
required

Cost in credits for evaluating this metric

​
organization
integer | null
required
​
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
​
prompt
string
​
enum_values
any
​
custom_code
string
​
simulation_enabled
boolean

Enable this metric for simulations

​
observability_enabled
boolean

Enable this metric for observability

​
configuration
any

Custom configuration parameters for metric

​
evaluation_trigger
enum<string>
  • always - Always
  • automatic - Automatic
  • custom - Custom
Available options:
always,
automatic,
custom
​
evaluation_trigger_prompt
string