Documentation | Span Assessments

Span Assessments

SpanAssessmentsResource

Methods

client.span_assessments.create() ->

SpanAssessment

post/v5/span-assessments

Create new assessment for a span (comment, rating, approval, rubric, overwrite, or metadata)

client.span_assessments.retrieve() ->

SpanAssessment

get/v5/span-assessments/{span_assessment_id}

Get an assessment by ID

Parameters

span_assessment_id: str

Returns

SpanAssessment

assessment_id: str

Unique identifier for the assessment

assessment_type:

AssessmentType

Type of assessment

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)

comment: Optional[str]

Raw text feedback

created_at: Optional[datetime]

(format: date-time)

When this assessment was created

metadata: Optional[Dict[str,

object

]]

Arbitrary JSON object for additional data

object: Optional[Literal["span.assessment"]]

(default: "span.assessment")

overwrite: Optional[Dict[str,

object

]]

User corrections to span output

rating: Optional[int]

(maximum: 5, minimum: 1)

Numerical rating (1-5)

rubric: Optional[Dict[str, str]]

Rule key-value pairs for rubric evaluation

updated_at: Optional[datetime]

(format: date-time)

When this assessment was last updated

Request example

from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
span_assessment = client.span_assessments.retrieve(
    "span_assessment_id",
)
print(span_assessment.assessment_id)

200Example

{
  "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"
}