Documentation | Rubrics › Criteria › list

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

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

Parameters

rubric_id: str

rubric_criteria_id: str

ending_before: Optional[str]

limit: Optional[int]

(maximum: 10000, minimum: 1, default: 100)

sort_by: Optional[str]

sort_order: Optional[

SortOrder

]

starting_after: Optional[str]

Returns

class CriterionListVersionsResponse:

has_more:

bool

Whether there are more items left to be fetched.

items: List[

RubricCriteriaResponse

]

total: int

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: Optional[int]

(default: 100)

The maximum number of items to return.

object: Optional[Literal["list"]]

(default: "list")

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.rubrics.criteria.list_versions(
    rubric_criteria_id="rubric_criteria_id",
    rubric_id="rubric_id",
)
print(response.has_more)

200Example

{
  "has_more": true,
  "items": [
    {
      "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
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Domain types

class CriterionListVersionsResponse: ...

class RubricCriteriaInput: ...

class RubricCriteriaResponse: ...

class RubricCriteriaSummaryResponse: ...

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