Skip to content
sgp
API Reference
Span Assessments

Get span assessment by ID

span_assessments.retrieve(strspan_assessment_id) -> SpanAssessment
GET/v5/span-assessments/{span_assessment_id}

Retrieve a single span assessment by its identifier.

Returns the assessment’s type and content fields, the span and trace it is attached to, and the identity that created it. Returns 404 if no assessment with that id exists for the caller’s account. Use the list endpoint instead when you have a span or trace id rather than an assessment id.

ParametersExpand Collapse
span_assessment_id: str
ReturnsExpand Collapse
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

Get span assessment by ID

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
)
span_assessment = client.span_assessments.retrieve(
    "span_assessment_id",
)
print(span_assessment.assessment_id)
{
  "assessment_id": "assessment_id",
  "assessment_type": "comment",
  "created_by": "created_by",
  "span_id": "span_id",
  "trace_id": "trace_id",
  "account_id": "account_id",
  "approval": "approved",
  "comment": "comment",
  "created_at": "2019-12-27T18:11:19.117Z",
  "metadata": {
    "foo": "bar"
  },
  "object": "span.assessment",
  "overwrite": {
    "foo": "bar"
  },
  "rating": 1,
  "rubric": {
    "foo": "string"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
Returns Examples
{
  "assessment_id": "assessment_id",
  "assessment_type": "comment",
  "created_by": "created_by",
  "span_id": "span_id",
  "trace_id": "trace_id",
  "account_id": "account_id",
  "approval": "approved",
  "comment": "comment",
  "created_at": "2019-12-27T18:11:19.117Z",
  "metadata": {
    "foo": "bar"
  },
  "object": "span.assessment",
  "overwrite": {
    "foo": "bar"
  },
  "rating": 1,
  "rubric": {
    "foo": "string"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}