Skip to content
sgp
API Reference
Evaluation Groups

Create Evaluation Group

evaluation_groups.create(EvaluationGroupCreateParams**kwargs) -> EvaluationGroup
POST/v5/evaluation-groups

Create a new evaluation group bundling one or more existing evaluations.

The request must list at least one evaluation ID, and duplicate IDs are rejected. Every listed evaluation is validated for existence and account access before the group is created; an unknown or inaccessible evaluation ID fails the whole request with a 400 rather than creating a partial group. The named evaluations are added as group members in the same transaction, and any supplied row_identifiers (an evaluation_id-to-column-name mapping used for cross-dataset joins) are persisted alongside them, ignoring entries for evaluation IDs not in the group. The returned group includes its members enriched with each evaluation’s name, tags, and creation time. Unlike the PUT and PATCH update endpoints, creation does not trigger any dashboard-widget recomputation.

ParametersExpand Collapse
evaluation_ids: Sequence[str]

List of evaluation IDs to include in the group

name: str

Name of the evaluation group

maxLength128
description: Optional[str]

Optional description

metadata: Optional[Dict[str, object]]

Optional metadata key-value pairs

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"]]

Create 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.create(
    evaluation_ids=["string"],
    name="name",
)
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"
    }
  ]
}