Skip to main content

Create Evaluation

POST 

https://cloud.agenta.ai/api/evaluations

Creates a new comparison table document Raises: HTTPException: description Returns: description

Request

Body

required
    app_id App Id (string)required
    variant_ids string[]required
    evaluators_configs string[]required
    testset_id Testset Id (string)required
    rate_limitobjectrequired
    batch_size Batch Size (integer)required
    max_retries Max Retries (integer)required
    retry_delay Retry Delay (integer)required
    delay_between_batches Delay Between Batches (integer)required
    lm_providers_keysobject
    anyOf
    correct_answer_columnobject
    anyOf
    string

Responses

Successful Response
Schema
  • Array [

  • id Id (string)required
    app_id App Id (string)required
    project_id Project Id (string)required
    variant_ids string[]required
    variant_names string[]required
    variant_revision_ids string[]required
    revisions string[]required
    testset_idobject
    anyOf
    string
    testset_nameobject
    anyOf
    string
    statusobjectrequired
    type Type (string)required
    valueobject
    anyOf
    errorobject
    anyOf
    message Message (string)required
    stacktraceobject
    anyOf
    string
    aggregated_resultsobject[]required
  • Array [

  • evaluator_configobject

    required

    anyOf
    id Id (string)required
    name Name (string)required
    project_id Project Id (string)required
    evaluator_key Evaluator Key (string)required
    settings_valuesobject
    anyOf
    created_at Created At (string)required
    updated_at Updated At (string)required
    resultobjectrequired
    type Type (string)required
    valueobject
    anyOf
    errorobject
    anyOf
    message Message (string)required
    stacktraceobject
    anyOf

    string

  • ]

  • average_costobject
    anyOf
    type Type (string)required
    valueobject
    anyOf
    errorobject
    anyOf
    message Message (string)required
    stacktraceobject
    anyOf

    string

    total_costobject
    anyOf
    type Type (string)required
    valueobject
    anyOf
    errorobject
    anyOf
    message Message (string)required
    stacktraceobject
    anyOf

    string

    average_latencyobject
    anyOf
    type Type (string)required
    valueobject
    anyOf
    errorobject
    anyOf
    message Message (string)required
    stacktraceobject
    anyOf

    string

    created_at date-timerequired
    updated_at date-timerequired
  • ]

curl -L 'https://cloud.agenta.ai/api/evaluations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
-d '{
"app_id": "string",
"variant_ids": [
"string"
],
"evaluators_configs": [
"string"
],
"testset_id": "string",
"rate_limit": {
"batch_size": 0,
"max_retries": 0,
"retry_delay": 0,
"delay_between_batches": 0
},
"lm_providers_keys": {},
"correct_answer_column": "string"
}'
Request Collapse all
Base URL
https://cloud.agenta.ai/api
Auth
Body required
{
  "app_id": "string",
  "variant_ids": [
    "string"
  ],
  "evaluators_configs": [
    "string"
  ],
  "testset_id": "string",
  "rate_limit": {
    "batch_size": 0,
    "max_retries": 0,
    "retry_delay": 0,
    "delay_between_batches": 0
  },
  "lm_providers_keys": {},
  "correct_answer_column": "string"
}
ResponseClear

Click the Send API Request button above and see the response here!