Update or Restore Evaluation

PATCH /v5/evaluations/{evaluation_id}

Update or Restore Evaluation

cURL

curl --request PATCH \
  --url https://api.egp.scale.com/v5/evaluations/{evaluation_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "metadata": {}
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": "<string>",
    "object": "identity"
  },
  "tags": [
    "<string>"
  ],
  "datasets": [
    {
      "id": "<string>",
      "created_by": {
        "id": "<string>",
        "object": "identity"
      },
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "tags": [
        "<string>"
      ],
      "current_version_num": 123,
      "object": "dataset",
      "description": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "object": "evaluation",
  "description": "<string>",
  "archived_at": "2023-11-07T05:31:56Z",
  "status_reason": "<string>",
  "progress": {
    "workflows": {
      "total": 123,
      "completed": 123,
      "failed": 123,
      "pending": 123
    },
    "items": {
      "total": 123,
      "successful": 123,
      "failed": 123,
      "pending": 123,
      "failed_items": []
    }
  },
  "tasks": [
    {
      "configuration": {
        "model": "<string>",
        "messages": [
          {}
        ],
        "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": {}
      },
      "task_type": "chat_completion",
      "alias": "chat_completion"
    }
  ],
  "metadata": {},
  "error_count": 123
}

Authorizations

x-api-key · string · header · required

Headers

x-selected-account-id · string | null

Path Parameters

evaluation_id · string · required

Body

application/json

Partial_EvaluationUpdateRequest

RestoreRequest

name · string

description · string

tags · string[]

The tags associated with the entity

metadata · Metadata · object

Optional metadata key-value pairs for the evaluation

Response

200

application/json

Successful Response

id · string · required

name · string · required

created_at · string<date-time> · required

created_by · Identity · object · required

The identity that created the entity.

Show child attributes

tags · string[] · required

The tags associated with the entity

datasets · Datasets · object[] · required

Show child attributes

status · enum<string> · required

Available options: failed, completed, running

object · string · default: evaluation

Allowed value: "evaluation"

description · string

archived_at · string<date-time>

status_reason · string

Reason for evaluation status

progress · EvaluationTasksProgressSchema · object

Progress of the evaluation's underlying async job

Show child attributes

tasks · (ChatCompletionEvaluationTask · object | GenericInferenceEvaluationTask · object | ApplicationVariantV1EvaluationTask · object | AgentexOutputEvaluationTask · object | MetricEvaluationTask · object | AutoEvaluationQuestionTask · object | AutoEvaluationGuidedDecodingEvaluationTask · object | AutoEvaluationAgentEvaluationTask · object | ContributorEvaluationQuestionTask · object | CustomFunctionEvaluationTask · object)[]

Tasks executed during evaluation. Populated with optional task view.

ChatCompletionEvaluationTask

GenericInferenceEvaluationTask

ApplicationVariantV1EvaluationTask

AgentexOutputEvaluationTask

MetricEvaluationTask

AutoEvaluationQuestionTask

AutoEvaluationGuidedDecodingEvaluationTask

AutoEvaluationAgentEvaluationTask

ContributorEvaluationQuestionTask

CustomFunctionEvaluationTask

Show child attributes

metadata · Metadata · object

Metadata key-value pairs for the evaluation

error_count · integer

Number of task errors across all items in this evaluation.