Skip to content
sgp
API Reference

Span Assessments

Create span assessment
POST/v5/span-assessments
Get span assessment by ID
GET/v5/span-assessments/{span_assessment_id}
List span or trace assessments
GET/v5/span-assessments
Update span assessment
PATCH/v5/span-assessments/{span_assessment_id}
Permanently delete span assessment
DELETE/v5/span-assessments/{span_assessment_id}
ModelsExpand Collapse
ApprovalStatus = "approved" or "rejected"

Status options for approval assessments

One of the following:
"approved"
"rejected"
AssessmentType = "comment" or "rating" or "approval" or 3 more

Types of assessments that can be provided

One of the following:
"comment"
"rating"
"approval"
"rubric"
"metadata"
"overwrite"
SpanAssessment object { assessment_id, assessment_type, created_by, 12 more }

Response model for span assessment

assessment_id: string

Unique identifier for the assessment

assessment_type: AssessmentType

Type of assessment

One of the following:
"comment"
"rating"
"approval"
"rubric"
"metadata"
"overwrite"
created_by: string

User who submitted the assessment

span_id: string

The span this assessment is attached to

trace_id: string

The trace this assessment is attached to

account_id: optional string

Account this assessment belongs to

approval: optional ApprovalStatus

Approval status (approved/rejected)

One of the following:
"approved"
"rejected"
comment: optional string

Raw text feedback

created_at: optional string

When this assessment was created

formatdate-time
metadata: optional map[unknown]

Arbitrary JSON object for additional data

object: optional "span.assessment"
overwrite: optional map[unknown]

User corrections to span output

rating: optional number

Numerical rating (1-5)

maximum5
minimum1
rubric: optional map[string]

Rule key-value pairs for rubric evaluation

updated_at: optional string

When this assessment was last updated

formatdate-time
SpanAssessmentDeleteResponse object { id, deleted, object }
id: string
deleted: boolean
object: optional "span.assessment"