POST
/
v5
/
evaluations
curl --request POST \
  --url https://api.egp.scale.com/v5/evaluations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "tasks": [
    {
      "task_type": "chat_completion",
      "alias": "<string>",
      "configuration": {
        "top_k": 123,
        "frequency_penalty": 123,
        "function_call": {},
        "functions": [
          {}
        ],
        "logit_bias": {},
        "logprobs": true,
        "max_completion_tokens": 123,
        "max_tokens": 123,
        "metadata": {},
        "modalities": [
          "<string>"
        ],
        "n": 123,
        "parallel_tool_calls": true,
        "prediction": {},
        "presence_penalty": 123,
        "reasoning_effort": "<string>",
        "response_format": {},
        "seed": 123,
        "stop": "<string>",
        "store": true,
        "temperature": 123,
        "tool_choice": "<string>",
        "tools": [
          {}
        ],
        "top_logprobs": 123,
        "top_p": 123,
        "audio": {},
        "model": "<string>",
        "messages": [
          {}
        ]
      }
    }
  ],
  "data": [
    {}
  ]
}'
{
  "id": "<string>",
  "object": "evaluation",
  "name": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by_user_id": "<string>",
  "archived_at": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "datasets": [
    {
      "id": "<string>",
      "object": "dataset",
      "name": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by_user_id": "<string>",
      "archived_at": "2023-11-07T05:31:56Z",
      "tags": [
        "<string>"
      ],
      "current_version_num": 123
    }
  ],
  "status": "failed",
  "tasks": [
    {
      "task_type": "chat_completion",
      "alias": "<string>",
      "configuration": {
        "top_k": 123,
        "frequency_penalty": 123,
        "function_call": {},
        "functions": [
          {}
        ],
        "logit_bias": {},
        "logprobs": true,
        "max_completion_tokens": 123,
        "max_tokens": 123,
        "metadata": {},
        "modalities": [
          "<string>"
        ],
        "n": 123,
        "parallel_tool_calls": true,
        "prediction": {},
        "presence_penalty": 123,
        "reasoning_effort": "<string>",
        "response_format": {},
        "seed": 123,
        "stop": "<string>",
        "store": true,
        "temperature": 123,
        "tool_choice": "<string>",
        "tools": [
          {}
        ],
        "top_logprobs": 123,
        "top_p": 123,
        "audio": {},
        "model": "<string>",
        "messages": [
          {}
        ]
      }
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required
​
data
object[]
required

Items to be evaluated

​
description
string
​
tags
string[]

The tags associated with the entity

​
tasks
object[]

Tasks allow you to augment and evaluate your data

Response

200
application/json
Successful Response
​
id
string
required
​
name
string
required
​
created_at
string
required
​
created_by_user_id
string
required
​
tags
string[]
required

The tags associated with the entity

​
datasets
object[]
required
​
status
enum<string>
required
Available options:
failed,
completed,
running
​
object
enum<string>
default:evaluation
Available options:
evaluation
​
description
string
​
archived_at
string
​
tasks
object[]

Tasks executed during evaluation. Populated with optional task view.