Documentation | Evaluation Groups › retrieve

Evaluation Groups

EvaluationGroupsResource

Methods

client.evaluation_groups.create() ->

EvaluationGroup

post/v5/evaluation-groups

Create a new evaluation group

client.evaluation_groups.list() -> SyncCursorPage[

EvaluationGroup

]

get/v5/evaluation-groups

List all evaluation groups for the current account

client.evaluation_groups.retrieve(, ) ->

EvaluationGroup

get/v5/evaluation-groups/{group_id}

Get a single evaluation group by ID

Parameters

group_id: str

include_deleted: Optional[

bool

]

views: Optional[List[

EvaluationGroupViews

]]

(default: [])

Optional relationships to include: 'members', 'row_identifiers'

"members"

"row_identifiers"

Returns

EvaluationGroup

id: str

Unique identifier of the evaluation group

account_id: str

Account that owns this evaluation group

created_at:

datetime

(format: date-time)

When the group was created

name: str

Name of the evaluation group

tags: List[str]

The tags associated with the entity

deleted_at: Optional[datetime]

(format: date-time)

When the group was soft-deleted

description: Optional[str]

Optional description

members: Optional[List[

EvaluationGroupMember

]]

Evaluation members in this group. Populated with 'members' view.

metadata: Optional[Dict[str,

object

]]

Optional metadata key-value pairs

object: Optional[Literal["evaluation_group"]]

(default: "evaluation_group")

row_identifiers: Optional[List[

EvaluationGroupRowIdentifier

]]

Row identifier mappings. Populated with 'row_identifiers' view.

Request example

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)

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

client.evaluation_groups.update(, ) ->

EvaluationGroup

patch/v5/evaluation-groups/{group_id}

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

client.evaluation_groups.replace(, ) ->

EvaluationGroup

put/v5/evaluation-groups/{group_id}

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

client.evaluation_groups.archive() ->

EvaluationGroup

delete/v5/evaluation-groups/{group_id}

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

client.evaluation_groups.retrieve_schema(, ) ->

EvaluationGroupRetrieveSchemaResponse

get/v5/evaluation-groups/{group_id}/schema

Get per-evaluation schemas for all members of a group. Returns individual schema for each member evaluation, enabling the frontend to filter columns by selected eval subset.

Parameters

group_id: str

include_archived: Optional[

bool

]

Include archived items in schema analysis

Returns

class EvaluationGroupRetrieveSchemaResponse:

Per-evaluation schemas for all members of an evaluation group

evaluation_group_id: str

The ID of the evaluation group

evaluation_schemas: List[

EvaluationSchemaResponse

]

Schema for each member evaluation in the group, one entry per active evaluation

object: Optional[Literal["evaluation_group_schema"]]

(default: "evaluation_group_schema")

Request example

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
)
response = client.evaluation_groups.retrieve_schema(
    group_id="group_id",
)
print(response.evaluation_group_id)

200Example

{
  "evaluation_group_id": "evaluation_group_id",
  "evaluation_schemas": [
    {
      "evaluation_id": "evaluation_id",
      "fields": [
        {
          "data_type": "data_type",
          "field_name": "field_name",
          "item_count": 0,
          "source": "data",
          "object": "field_schema"
        }
      ],
      "total_items": 0,
      "is_sampled": true,
      "object": "evaluation_schema",
      "sample_size": 0
    }
  ],
  "object": "evaluation_group_schema"
}

Domain types

class EvaluationGroup: ...

Response model for evaluation group

class EvaluationGroupMember: ...

Response model for evaluation group member

class EvaluationGroupRetrieveSchemaResponse: ...

Per-evaluation schemas for all members of an evaluation group

class EvaluationGroupRowIdentifier: ...

Response model for evaluation group row identifier

Literal["members", "row_identifiers"]

Views for evaluation group responses