CEcekura
test_framework

Generate clean metric description

Changed on

Turn a rough metric description into a clean one suited to the agent, and return it. Usually takes under 30 seconds.

post/test_framework/v3/metrics/generate_clean_description/

Request

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

Request body

agentinteger required
metric_descriptionstring required
eval_type'boolean' | 'numeric' | 'rating' | 'enum' required
  • boolean - boolean
  • numeric - numeric
  • rating - rating
  • enum - enum

Response

status'completed' | 'failed'

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

agent_idinteger
clean_descriptionstring
errorstring nullable

Why the job failed, when it did.

Changes