Skip to content
sgp
API Reference

Span Assessments

Create span assessment
span_assessments.create(SpanAssessmentCreateParams**kwargs) -> SpanAssessment
POST/v5/span-assessments
Get span assessment by ID
span_assessments.retrieve(strspan_assessment_id) -> SpanAssessment
GET/v5/span-assessments/{span_assessment_id}
List span or trace assessments
span_assessments.list(SpanAssessmentListParams**kwargs) -> SyncAPIListPage[SpanAssessment]
GET/v5/span-assessments
Update span assessment
span_assessments.update(strspan_assessment_id, SpanAssessmentUpdateParams**kwargs) -> SpanAssessment
PATCH/v5/span-assessments/{span_assessment_id}
Permanently delete span assessment
span_assessments.delete(strspan_assessment_id) -> SpanAssessmentDeleteResponse
DELETE/v5/span-assessments/{span_assessment_id}
ModelsExpand Collapse
Literal["approved", "rejected"]

Status options for approval assessments

One of the following:
"approved"
"rejected"
Literal["comment", "rating", "approval", 3 more]

Types of assessments that can be provided

One of the following:
"comment"
"rating"
"approval"
"rubric"
"metadata"
"overwrite"
class SpanAssessment: …

Response model for span assessment

assessment_id: str

Unique identifier for the assessment

assessment_type: AssessmentType

Type of assessment

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

User who submitted the assessment

span_id: str

The span this assessment is attached to

trace_id: str

The trace this assessment is attached to

account_id: Optional[str]

Account this assessment belongs to

approval: Optional[ApprovalStatus]

Approval status (approved/rejected)

One of the following:
"approved"
"rejected"
comment: Optional[str]

Raw text feedback

created_at: Optional[datetime]

When this assessment was created

formatdate-time
metadata: Optional[Dict[str, object]]

Arbitrary JSON object for additional data

object: Optional[Literal["span.assessment"]]
overwrite: Optional[Dict[str, object]]

User corrections to span output

rating: Optional[int]

Numerical rating (1-5)

maximum5
minimum1
rubric: Optional[Dict[str, str]]

Rule key-value pairs for rubric evaluation

updated_at: Optional[datetime]

When this assessment was last updated

formatdate-time
class SpanAssessmentDeleteResponse: …
id: str
deleted: bool
object: Optional[Literal["span.assessment"]]