CEcekura
test_framework

Preview metric

Changed on

Evaluate a metric configuration on up to 10 call logs or runs and return the verdicts, without saving the metric. Use it to check a metric before creating or updating it. Usually 30 seconds to 3 minutes; custom-code metrics can take longer.

post/test_framework/v3/metrics/preview/

Request

  • Base URL
    https://api.cekura.ai
  • URL
    https://api.cekura.ai/test_framework/v3/metrics/preview/
  • Auth
    • API key in header X-CEKURA-API-KEY
    • or HTTP bearer
    • or HTTP bearer
    • or HTTP bearer

Request body

agent_idinteger

Agent ID - all call logs/runs must belong to this agent

project_idinteger

Project ID - all call logs/runs must belong to this project

call_log_idsinteger[]

List of call log IDs to evaluate (maximum 10, required if run_ids not provided)

run_idsinteger[]

List of run IDs to evaluate (maximum 10, required if call_log_ids not provided)

Response

status'completed' | 'failed'

failed when the job could not produce its result; see error / errors.

project_idinteger nullable
agent_idinteger nullable
completedinteger

Items evaluated.

totalinteger
errorstring nullable

Why the job failed, when it did.

Changes