POST
/
test_framework
/
v1
/
metrics-external
/
generate_metrics
curl --request POST \
  --url https://new-prod.vocera.ai/test_framework/v1/metrics-external/generate_metrics/ \
  --header 'Content-Type: application/json' \
  --header 'X-VOCERA-API-KEY: <api-key>' \
  --data '{
  "agent_id": 123,
  "assistant_id": "<string>",
  "num_metrics": 1
}'
[
  {
    "id": 123,
    "agent": 123,
    "name": "<string>",
    "description": "<string>",
    "function_name": "<string>",
    "type": "basic",
    "eval_type": "binary_workflow_adherence",
    "enum_values": "<any>",
    "audio_enabled": true,
    "prompt": "<string>",
    "display_order": -1,
    "evaluation_trigger": "always",
    "evaluation_trigger_prompt": "<string>",
    "priority_assignment_prompt": "<string>",
    "vocera_defined_metric_code": "<string>",
    "scenarios": [
      123
    ],
    "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.

Body

​
agent_id
integer

The ID of the AI agent to generate metrics for

​
assistant_id
string

The assistant ID to look up the agent by. Alternative to providing agent ID directly

​
num_metrics
integer
default:1

Number of metrics to generate

Required range: 1 <= x <= 100

Response

200
application/json
​
id
integer
required
​
agent
integer
required
​
name
string
required
Maximum length: 255
​
overall_score
string
required
​
total_score
string
required
​
description
string
​
function_name
string | null
Maximum length: 255
​
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
​
display_order
integer
Required range: -2147483648 <= x <= 2147483647
​
evaluation_trigger
enum<string>
  • always - Always
  • automatic - Automatic
  • custom - Custom
Available options:
always,
automatic,
custom
​
evaluation_trigger_prompt
string
​
priority_assignment_prompt
string
​
vocera_defined_metric_code
string
Maximum length: 255
​
scenarios
integer[]

List of scenario IDs associated with this metric