Documentation | Rubrics › Criteria

Rubrics

RubricsResource

Methods

client.rubrics.create() ->

RubricResponse

post/v5/rubrics

Create Rubric

client.rubrics.list() -> SyncCursorPage[

RubricResponse

]

get/v5/rubrics

List Rubrics

client.rubrics.retrieve() ->

RubricResponse

get/v5/rubrics/{rubric_id}

Get Rubric

client.rubrics.update(, ) ->

RubricResponse

patch/v5/rubrics/{rubric_id}

Update or Restore Rubric

client.rubrics.archive() ->

RubricArchiveResponse

delete/v5/rubrics/{rubric_id}

Archive Rubric

Domain types

class RestoreRequest: ...

class RubricArchiveResponse: ...

class RubricResponse: ...

Rubrics

Criteria

RubricsResource.CriteriaResource

Methods

client.rubrics.criteria.create(, ) ->

RubricCriteriaResponse

post/v5/rubrics/{rubric_id}/criteria

Add Criterion to Rubric

Parameters

rubric_id: str

title: str

(minLength: 1)

The Criteria text

annotations: Optional[Dict[str,

object

]]

Free-form metadata for the Criteria

weight: Optional[float]

(minimum: 0)

Weight multiplier for scoring

Returns

RubricCriteriaResponse

id: str

created_at:

datetime

(format: date-time)

rubric_id: str

title: str

version: int

annotations: Optional[Dict[str,

object

]]

object: Optional[Literal["rubric_criteria"]]

(default: "rubric_criteria")

weight: Optional[float]

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
)
rubric_criteria_response = client.rubrics.criteria.create(
    rubric_id="rubric_id",
    title="x",
)
print(rubric_criteria_response.id)

200Example

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "rubric_id": "rubric_id",
  "title": "title",
  "version": 0,
  "annotations": {
    "foo": "bar"
  },
  "object": "rubric_criteria",
  "weight": 0
}

client.rubrics.criteria.update(, ) ->

RubricCriteriaResponse

patch/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}

Update Criterion

client.rubrics.criteria.list_versions(, ) ->

CriterionListVersionsResponse

get/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}/versions

List Criterion Versions

Domain types

class CriterionListVersionsResponse: ...

class RubricCriteriaInput: ...

class RubricCriteriaResponse: ...

class RubricCriteriaSummaryResponse: ...

Slim criteria projection for list endpoints (title + weight only).