Skip to content

Rubrics

Create a rubric
client.Rubrics.New(ctx, body) (*RubricResponse, error)
POST/v5/rubrics
List rubrics
client.Rubrics.List(ctx, query) (*CursorPage[RubricResponse], error)
GET/v5/rubrics
Get a rubric
client.Rubrics.Get(ctx, rubricID) (*RubricResponse, error)
GET/v5/rubrics/{rubric_id}
Update or restore a rubric
client.Rubrics.Update(ctx, rubricID, body) (*RubricResponse, error)
PATCH/v5/rubrics/{rubric_id}
Archive a rubric
client.Rubrics.Archive(ctx, rubricID) (*RubricArchiveResponse, error)
DELETE/v5/rubrics/{rubric_id}
ModelsExpand Collapse
type RestoreRequestParam struct{…}
Restore bool

Set to true to restore the entity from the database.

type RubricResponse struct{…}
ID string
CreatedAt Time
formatdate-time
CreatedBy Identity

The identity that created the entity.

ID string
Type IdentityType
One of the following:
const IdentityTypeUser IdentityType = "user"
const IdentityTypeServiceAccount IdentityType = "service_account"
Object IdentityObjectOptional
Tags []string

The tags associated with the entity

Title string
Version int64
ArchivedAt TimeOptional
formatdate-time
Criteria []RubricResponseCriterionUnionOptional

Full criteria on get, summary (title + weight) on list

One of the following:
type RubricCriteriaResponse struct{…}
ID string
CreatedAt Time
formatdate-time
RubricID string
Title string
Version int64
Annotations map[string, any]Optional
Object RubricCriteriaResponseObjectOptional
Weight float64Optional
type RubricCriteriaSummaryResponse struct{…}

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

Title string
Weight float64Optional
Object RubricResponseObjectOptional
UpdatedAt TimeOptional
formatdate-time

RubricsCriteria

Add a criterion to a rubric
client.Rubrics.Criteria.New(ctx, rubricID, body) (*RubricCriteriaResponse, error)
POST/v5/rubrics/{rubric_id}/criteria
Update a criterion
client.Rubrics.Criteria.Update(ctx, rubricCriteriaID, params) (*RubricCriteriaResponse, error)
PATCH/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}
List criterion versions
client.Rubrics.Criteria.ListVersions(ctx, rubricCriteriaID, params) (*RubricCriterionListVersionsResponse, error)
GET/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}/versions
ModelsExpand Collapse
type RubricCriteriaInput struct{…}
Title string

The Criteria text

minLength1
Annotations map[string, any]Optional

Free-form metadata for the Criteria

Weight float64Optional

Weight multiplier for scoring

minimum0
type RubricCriteriaResponse struct{…}
ID string
CreatedAt Time
formatdate-time
RubricID string
Title string
Version int64
Annotations map[string, any]Optional
Object RubricCriteriaResponseObjectOptional
Weight float64Optional
type RubricCriteriaSummaryResponse struct{…}

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

Title string
Weight float64Optional