Get Evaluation Group

evaluation_groups.retrieve(, ) -> EvaluationGroup

GET/v5/evaluation-groups/{group_id}

Fetch a single evaluation group by its ID.

By default only non-archived groups are returned; set include_deleted to also resolve a soft-deleted group, whose response includes its soft-deleted member rows.

members is always returned, so a client can confirm membership without passing a view, and views adds further expansions on top (e.g. views=row_identifiers). The full member set is returned with no cap, and each member is enriched with its evaluation’s name, tags, and creation time where that evaluation is readable from this account; those fields are null otherwise. Use the schema endpoint instead when you need the per-evaluation column schemas of the group’s members.

ParametersExpand Collapse

group_id: str

include_deleted: Optional[bool]

views: Optional[List[EvaluationGroupViews]]

Additional relationships to include; ‘members’ is always returned

One of the following:

"members"

"row_identifiers"

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

Get 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.retrieve(
    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"
    }
  ]
}