Skip to content
sgp
API Reference
Evaluation Groups

Patch Evaluation Group

evaluation_groups.update(strgroup_id, EvaluationGroupUpdateParams**kwargs) -> EvaluationGroup
PATCH/v5/evaluation-groups/{group_id}

Partially update an evaluation group’s attributes.

Only the fields present in the request are changed; unset fields are left untouched. Unlike the PUT endpoint, metadata is merged into the existing metadata key-by-key rather than replaced wholesale, and group membership (evaluation_ids) cannot be changed here — use PUT to replace members. At least one field must be supplied or the request fails with a 400. Supplying row_identifiers replaces the group’s entire row identifier set (an evaluation_id-to-column-name mapping for cross-dataset joins); passing an empty mapping clears it.

ParametersExpand Collapse
group_id: str
description: Optional[str]

Optional description

metadata: Optional[Dict[str, object]]

Optional metadata key-value pairs

name: Optional[str]

Name of the evaluation group

maxLength128
row_identifiers: Optional[Dict[str, str]]

Optional mapping of evaluation_id to column name for cross-dataset joins

tags: Optional[Sequence[str]]

The tags associated with the entity

ReturnsExpand Collapse
class EvaluationGroup: …

Response model for evaluation group

id: str

Unique identifier of the evaluation group

account_id: str

Account that owns this evaluation group

created_at: datetime

When the group was created

formatdate-time
name: str

Name of the evaluation group

tags: Optional[List[str]]

The tags associated with the entity

deleted_at: Optional[datetime]

When the group was soft-deleted

formatdate-time
description: Optional[str]

Optional description

members: Optional[List[EvaluationGroupMember]]

Evaluation members in this group. Returned by default on GET by id; on list endpoints, populated only with the ‘members’ view.

id: str

Unique identifier of the member record

created_at: datetime

When this member was added to the group

formatdate-time
evaluation_group_id: str

ID of the evaluation group

evaluation_id: str

ID of the evaluation

deleted_at: Optional[datetime]

When this membership was soft-deleted (if applicable)

formatdate-time
evaluation_created_at: Optional[datetime]

When the evaluation was created

formatdate-time
evaluation_name: Optional[str]

Name of the evaluation

evaluation_tags: Optional[List[str]]

Tags of the evaluation

object: Optional[Literal["evaluation_group.member"]]
metadata: Optional[Dict[str, object]]

Optional metadata key-value pairs

object: Optional[Literal["evaluation_group"]]
row_identifiers: Optional[List[EvaluationGroupRowIdentifier]]

Row identifier mappings. Populated with ‘row_identifiers’ view.

column_name: str

Name of the column used as row identifier

evaluation_id: str

ID of the evaluation

object: Optional[Literal["evaluation_group.row_identifier"]]

Patch Evaluation Group

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
evaluation_group = client.evaluation_groups.update(
    group_id="group_id",
)
print(evaluation_group.id)
{
  "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",
  "members": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "evaluation_group_id": "evaluation_group_id",
      "evaluation_id": "evaluation_id",
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "evaluation_created_at": "2019-12-27T18:11:19.117Z",
      "evaluation_name": "evaluation_name",
      "evaluation_tags": [
        "string"
      ],
      "object": "evaluation_group.member"
    }
  ],
  "metadata": {
    "foo": "bar"
  },
  "object": "evaluation_group",
  "row_identifiers": [
    {
      "column_name": "column_name",
      "evaluation_id": "evaluation_id",
      "object": "evaluation_group.row_identifier"
    }
  ]
}
Returns Examples
{
  "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",
  "members": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "evaluation_group_id": "evaluation_group_id",
      "evaluation_id": "evaluation_id",
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "evaluation_created_at": "2019-12-27T18:11:19.117Z",
      "evaluation_name": "evaluation_name",
      "evaluation_tags": [
        "string"
      ],
      "object": "evaluation_group.member"
    }
  ],
  "metadata": {
    "foo": "bar"
  },
  "object": "evaluation_group",
  "row_identifiers": [
    {
      "column_name": "column_name",
      "evaluation_id": "evaluation_id",
      "object": "evaluation_group.row_identifier"
    }
  ]
}