Documentation | Evaluation Groups › Patch Evaluation Group

Evaluation Groups

evaluation_groups

Methods

Create Evaluation Group -> { id, account_id, created_at, 8 more... }

post/v5/evaluation-groups

Create a new evaluation group

List Evaluation Groups -> CursorPage<{ id, account_id, created_at, 8 more... }>

get/v5/evaluation-groups

List all evaluation groups for the current account

Get Evaluation Group -> { id, account_id, created_at, 8 more... }

get/v5/evaluation-groups/{group_id}

Get a single evaluation group by ID

Update Evaluation Group -> { id, account_id, created_at, 8 more... }

put/v5/evaluation-groups/{group_id}

Full update of evaluation group. All fields are replaced with provided values. Omitted optional fields are cleared.

Patch Evaluation Group -> { id, account_id, created_at, 8 more... }

patch/v5/evaluation-groups/{group_id}

Partial update of evaluation group attributes (name, description, tags, metadata). Members cannot be modified via PATCH.

path Parameters

group_id: string

Response fields

id: string

Unique identifier of the evaluation group

account_id: string

Account that owns this evaluation group

created_at: string

(format: date-time)

When the group was created

name: string

Name of the evaluation group

tags: Array<string>

The tags associated with the entity

deleted_at: string

Optional

(format: date-time)

When the group was soft-deleted

description: string

Optional

Optional description

evaluation_group_metadata: Record<string, unknown>

Optional

Optional metadata key-value pairs

members: Array<

Evaluation

| { id, created_at, evaluation_group_id, 3 more... }>

Optional

Evaluation members in this group. Populated with 'members' view. Currently returns membership records.

object: "evaluation_group"

Optional

(default: "evaluation_group")

row_identifiers: Array<{ column_name, evaluation_id, object }>

Optional

Row identifier mappings. Populated with 'row_identifiers' view.

Request example

curl https://api.egp.scale.com/v5/evaluation-groups/$GROUP_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{}'

200Example

{
  "id": "id",
  "account_id": "account_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "tags": [
    "string"
  ],
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "evaluation_group_metadata": {
    "foo": "bar"
  },
  "members": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "datasets": [
        {
          "id": "id",
          "created_at": "2019-12-27T18:11:19.117Z",
          "created_by": {
            "id": "id",
            "type": "user",
            "object": "identity"
          },
          "current_version_num": 0,
          "name": "name",
          "tags": [
            "string"
          ],
          "archived_at": "2019-12-27T18:11:19.117Z",
          "description": "description",
          "object": "dataset"
        }
      ],
      "name": "name",
      "status": "failed",
      "tags": [
        "string"
      ],
      "archived_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "error_count": 0,
      "metadata": {
        "foo": "bar"
      },
      "object": "evaluation",
      "progress": {
        "items": {
          "failed": 0,
          "pending": 0,
          "successful": 0,
          "total": 0,
          "failed_items": [
            {
              "item_id": "item_id",
              "error": "error",
              "error_type": "error_type"
            }
          ]
        },
        "workflows": {
          "completed": 0,
          "failed": 0,
          "pending": 0,
          "total": 0
        }
      },
      "status_reason": "status_reason",
      "tasks": [
        {
          "configuration": {
            "messages": [
              {
                "foo": "bar"
              }
            ],
            "model": "model",
            "audio": {
              "foo": "bar"
            },
            "frequency_penalty": 0,
            "function_call": {
              "foo": "bar"
            },
            "functions": [
              {
                "foo": "bar"
              }
            ],
            "logit_bias": {
              "foo": 0
            },
            "logprobs": true,
            "max_completion_tokens": 0,
            "max_tokens": 0,
            "metadata": {
              "foo": "string"
            },
            "modalities": [
              "string"
            ],
            "n": 0,
            "parallel_tool_calls": true,
            "prediction": {
              "foo": "bar"
            },
            "presence_penalty": 0,
            "reasoning_effort": "reasoning_effort",
            "response_format": {
              "foo": "bar"
            },
            "seed": 0,
            "stop": "stop",
            "store": true,
            "temperature": 0,
            "tool_choice": "tool_choice",
            "tools": [
              {
                "foo": "bar"
              }
            ],
            "top_k": 0,
            "top_logprobs": 0,
            "top_p": 0
          },
          "alias": "alias",
          "task_type": "chat_completion"
        }
      ]
    }
  ],
  "object": "evaluation_group",
  "row_identifiers": [
    {
      "column_name": "column_name",
      "evaluation_id": "evaluation_id",
      "object": "evaluation_group.row_identifier"
    }
  ]
}

Archive Evaluation Group -> { id, account_id, created_at, 8 more... }

delete/v5/evaluation-groups/{group_id}

Soft-delete an evaluation group and cascade to members, row identifiers, and charts