Skip to main content
PATCH
/
v5
/
evaluation-groups
/
{group_id}
Patch Evaluation Group
curl --request PATCH \
  --url https://api.egp.scale.com/v5/evaluation-groups/{group_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "description": "<string>",
  "metadata": {}
}'
{
  "id": "<string>",
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "object": "evaluation_group",
  "description": "<string>",
  "evaluation_group_metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "members": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "id": "<string>",
        "type": "user",
        "object": "identity"
      },
      "tags": [
        "<string>"
      ],
      "datasets": [
        {
          "id": "<string>",
          "created_by": {
            "id": "<string>",
            "type": "user",
            "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"
        }
      ],
      "status": "failed",
      "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": {}
    }
  ],
  "row_identifiers": [
    {
      "evaluation_id": "<string>",
      "column_name": "<string>",
      "object": "evaluation_group.row_identifier"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Path Parameters

group_id
string
required

Body

application/json

Request model for partial update of evaluation group attributes (name, description, tags, metadata) (PATCH)

tags
string[]

The tags associated with the entity

name
string

Name of the evaluation group

Maximum string length: 128
description
string

Optional description

metadata
Metadata · object

Optional metadata key-value pairs

Response

Successful Response

Response model for evaluation group

id
string
required

Unique identifier of the evaluation group

tags
string[]
required

The tags associated with the entity

name
string
required

Name of the evaluation group

created_at
string<date-time>
required

When the group was created

account_id
string
required

Account that owns this evaluation group

object
string
default:evaluation_group
Allowed value: "evaluation_group"
description
string

Optional description

evaluation_group_metadata
Evaluation Group Metadata · object

Optional metadata key-value pairs

deleted_at
string<date-time>

When the group was soft-deleted

members
Members · object[]

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

  • Option 1
  • Option 2
row_identifiers
Row Identifiers · object[]

Row identifier mappings. Populated with 'row_identifiers' view.