Skip to main content
PATCH
/
test_framework
/
v1
/
metrics
/
{id}
cURL
curl --request PATCH \
  --url https://api.cekura.ai/test_framework/v1/metrics/{id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "audio_enabled": true,
  "prompt": "<string>",
  "agent": 123,
  "project": 123,
  "agents": [
    123
  ],
  "assistant_id": "<string>",
  "type": "basic",
  "eval_type": "binary_workflow_adherence",
  "enum_values": {},
  "display_order": 123,
  "configuration": {}
}
'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "audio_enabled": true,
  "prompt": "<string>",
  "agent": 123,
  "project": 123,
  "agents": [
    123
  ],
  "assistant_id": "<string>",
  "type": "basic",
  "eval_type": "binary_workflow_adherence",
  "enum_values": {},
  "display_order": 123,
  "configuration": {}
}

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.

Body

​
name
string

Name of the metric

​
description
string

Description of what this metric evaluates

​
audio_enabled
boolean

Whether this metric evaluates audio content

​
prompt
string

The evaluation prompt used for this metric

​
agent
integer | null

ID of the agent for agent-level metrics. Either agent or project must be provided.

​
project
integer | null

ID of the project for project-level metrics. Either agent or project must be provided.

​
agents
integer[]

List of agent IDs to enable this project-level metric for. Only applicable when project is set.

​
assistant_id
string

External identifier for the assistant

​
type
enum<string>

Type of metric

  • basic - Basic (Deprecated in favor of LLM Judge)
  • custom_prompt - Custom Prompt ( Deprecated in favor of LLM Judge)
  • custom_code - Custom Code
  • llm_judge - LLM Judge
Available options:
basic,
custom_prompt,
custom_code,
llm_judge
​
eval_type
enum<string>

Type of evaluation

  • 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
object

Possible values for enum-type metrics

​
display_order
integer

Order in which to display this metric in the UI

​
configuration
object

Custom configuration parameters for specific metrics. For pronounciation metric, you can set words as 2-tuple (word, phonemes) list example:

{
    "words": [["hello", "hɛl.loʊ"], ["world", "wɝɚɚɚld"]]
}

Response

​
id
integer
​
name
string

Name of the metric

​
description
string

Description of what this metric evaluates

​
audio_enabled
boolean

Whether this metric evaluates audio content

​
prompt
string

The evaluation prompt used for this metric

​
agent
integer | null

ID of the agent for agent-level metrics. Either agent or project must be provided.

​
project
integer | null

ID of the project for project-level metrics. Either agent or project must be provided.

​
agents
integer[]

List of agent IDs to enable this project-level metric for. Only applicable when project is set.

​
assistant_id
string

External identifier for the assistant

​
type
enum<string>

Type of metric

  • basic - Basic (Deprecated in favor of LLM Judge)
  • custom_prompt - Custom Prompt ( Deprecated in favor of LLM Judge)
  • custom_code - Custom Code
  • llm_judge - LLM Judge
Available options:
basic,
custom_prompt,
custom_code,
llm_judge
​
eval_type
enum<string>

Type of evaluation

  • 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
object

Possible values for enum-type metrics

​
display_order
integer

Order in which to display this metric in the UI

​
configuration
object

Custom configuration parameters for specific metrics. For pronounciation metric, you can set words as 2-tuple (word, phonemes) list example:

{
    "words": [["hello", "hɛl.loʊ"], ["world", "wɝɚɚɚld"]]
}