Skip to main content
PATCH
/
v1
/
metrics
/
{metric_id}
curl --request PATCH \
  --url https://api.coval.dev/v1/metrics/{metric_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "prompt": "Updated evaluation prompt"
}
'
{
  "metric": {
    "name": "metrics/abc123def456ghi789jklm",
    "id": "abc123def456ghi789jklm",
    "metric_name": "Customer Satisfaction",
    "description": "Evaluates customer satisfaction",
    "metric_type": "METRIC_LLM_BINARY",
    "prompt": "Did the agent resolve the issue?",
    "categories": [
      "positive",
      "neutral",
      "negative"
    ],
    "min_value": 1,
    "max_value": 10,
    "metadata_field_type": "STRING",
    "metadata_field_key": "satisfaction_score",
    "regex_pattern": "(hello|hi)",
    "role": "agent",
    "min_pause_duration_seconds": 0.5,
    "include_traces": true,
    "target_condition": {
      "comparison_operator": "eq",
      "target_float": 123,
      "target_values": [
        "value1",
        "value2"
      ]
    },
    "created_by": "<string>",
    "create_time": "2023-11-07T05:31:56Z",
    "update_time": "2023-11-07T05:31:56Z"
  }
}

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
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
​
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
​
include_traces
boolean | null

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

​
target_condition
object

Target condition for metric evaluation

Response

Metric updated

​
metric
object
required

Metric resource