PATCH
/
test_framework
/
v1
/
metrics-external
/
{id}
curl --request PATCH \
  --url https://new-prod.vocera.ai/test_framework/v1/metrics-external/{id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-VOCERA-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "audio_enabled": true,
  "prompt": "<string>",
  "agent": 123,
  "assistant_id": "<string>",
  "type": "<string>",
  "eval_type": "<string>",
  "enum_values": {},
  "display_order": 123
}'
{
  "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>",
  "display_order": -1,
  "overall_score": "<string>",
  "total_score": "<string>"
}

Authorizations

​
X-VOCERA-API-KEY
string
header
required

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

Path Parameters

​
id
string
required

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

The AI agent this metric is associated with

​
assistant_id
string

External identifier for the assistant

​
type
string

Type of metric (e.g., basic, custom_prompt, custom_code)

​
eval_type
string

Type of evaluation (e.g., boolean, enum, score)

​
enum_values
object

Possible values for enum-type metrics

​
display_order
integer

Order in which to display this metric in the UI

Response

200
application/json
​
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

​
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
​
display_order
integer
Required range: -2147483648 <= x <= 2147483647