Skip to content
sgp
API Reference

Evaluation Groups

Create Evaluation Group
evaluation_groups.create(EvaluationGroupCreateParams**kwargs) -> EvaluationGroup
POST/v5/evaluation-groups
List Evaluation Groups
evaluation_groups.list(EvaluationGroupListParams**kwargs) -> SyncCursorPage[EvaluationGroup]
GET/v5/evaluation-groups
Get Evaluation Group
evaluation_groups.retrieve(strgroup_id, EvaluationGroupRetrieveParams**kwargs) -> EvaluationGroup
GET/v5/evaluation-groups/{group_id}
Patch Evaluation Group
evaluation_groups.update(strgroup_id, EvaluationGroupUpdateParams**kwargs) -> EvaluationGroup
PATCH/v5/evaluation-groups/{group_id}
Update Evaluation Group
evaluation_groups.replace(strgroup_id, EvaluationGroupReplaceParams**kwargs) -> EvaluationGroup
PUT/v5/evaluation-groups/{group_id}
Archive Evaluation Group
evaluation_groups.archive(strgroup_id) -> EvaluationGroup
DELETE/v5/evaluation-groups/{group_id}
Get Evaluation Group Schema
evaluation_groups.retrieve_schema(strgroup_id, EvaluationGroupRetrieveSchemaParams**kwargs) -> EvaluationGroupRetrieveSchemaResponse
GET/v5/evaluation-groups/{group_id}/schema
ModelsExpand 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"]]
class EvaluationGroupMember: …

Response model for evaluation group member

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"]]
class EvaluationGroupRowIdentifier: …

Response model for evaluation group row identifier

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"]]
Literal["members", "row_identifiers"]

Views for evaluation group responses

One of the following:
"members"
"row_identifiers"
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

evaluation_id: str

The ID of the evaluation

fields: List[Field]

List of all discovered fields, ordered alphabetically by field_name

data_type: str

JSON type: ‘string’, ‘number’, ‘boolean’, ‘object’, ‘array’, or ‘null’

field_name: str

The flattened JSON key path (e.g., ‘metadata.category’)

item_count: int

Number of evaluation items containing this field

minimum0
source: Literal["data", "task_result_cache"]

The source of the field: ‘data’ or ‘task_result_cache’

One of the following:
"data"
"task_result_cache"
object: Optional[Literal["field_schema"]]
total_items: int

Total number of evaluation items

minimum0
is_sampled: Optional[bool]

Whether schema was computed from a sample of items (for large evaluations)

object: Optional[Literal["evaluation_schema"]]
sample_size: Optional[int]

Number of items sampled for schema inference, if applicable

minimum0
object: Optional[Literal["evaluation_group_schema"]]