Skip to main content
PATCH

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

metric_id
string
required

22-character metric ID

Pattern: ^[a-zA-Z0-9]{22}$

Body

application/json

Update metric request (partial update)

metric_name
string
Required string length: 1 - 200
description
string
Required string length: 1 - 1000
metric_type
enum<string>

Metric evaluation type.

  • METRIC_LLM_BINARY - Yes/no LLM evaluation
  • METRIC_CATEGORICAL - Multi-class classification
  • METRIC_NUMERICAL_LLM_JUDGE - Numerical scoring (1-N)
  • METRIC_AUDIO_LLM_BINARY - Audio-based yes/no
  • METRIC_AUDIO_LLM_CATEGORICAL - Audio-based classification
  • METRIC_AUDIO_LLM_NUMERICAL - Audio-based scoring
  • METRIC_TOOLCALL - Tool/function call evaluation
  • METRIC_METADATA_FIELD - Extract metadata field
  • METRIC_TRANSCRIPT_REGEX - Regex pattern matching
  • METRIC_PAUSE_ANALYSIS - Speech pause detection
  • METRIC_SQL_FLOAT - Custom SQL query over the simulation's data (set sql_query)
Available options:
METRIC_LLM_BINARY,
METRIC_CATEGORICAL,
METRIC_NUMERICAL_LLM_JUDGE,
METRIC_AUDIO_LLM_BINARY,
METRIC_AUDIO_LLM_CATEGORICAL,
METRIC_AUDIO_LLM_NUMERICAL,
METRIC_TOOLCALL,
METRIC_METADATA_FIELD,
METRIC_TRANSCRIPT_REGEX,
METRIC_PAUSE_ANALYSIS,
METRIC_SQL_FLOAT
prompt
string
categories
string[]
Required array length: 2 - 50 elements
min_value
number
max_value
number
metadata_field_type
enum<string>

Data type for metadata field extraction

Available options:
STRING,
NUMBER,
BOOLEAN
metadata_field_key
string
regex_pattern
string
role
enum<string>
Available options:
agent,
user
min_pause_duration_seconds
number
Required range: x >= 0.5
sql_query
string

SQL query that defines the metric (for METRIC_SQL_FLOAT).

Maximum string length: 50000
include_traces
boolean | null

Inject OTel trace context into the LLM judge prompt during evaluation. Supported for LLM judge metric types only.

runtime_config
object | null

Override the LLM model used for metric evaluation. Set to null to revert to the platform default. Use GET /v1/models/metric to list available models. Not supported for audio metric types (METRIC_AUDIO_LLM_BINARY, METRIC_AUDIO_LLM_CATEGORICAL, METRIC_AUDIO_LLM_NUMERICAL), which always use the platform-default audio model.

target_condition
object

Target condition for metric evaluation

Example:
tags
string[] | null

Tags to associate with this metric. Null or omitted leaves tags unchanged. Pass [] to clear all tags.

Example:

Response

Metric updated

metric
object
required

Metric resource