Get span assessment by ID

curl --request GET \
  --url https://api.egp.scale.com/v5/span-assessments/{span_assessment_id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.egp.scale.com/v5/span-assessments/{span_assessment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.egp.scale.com/v5/span-assessments/{span_assessment_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.egp.scale.com/v5/span-assessments/{span_assessment_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.egp.scale.com/v5/span-assessments/{span_assessment_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "assessment_id": "<string>",
  "trace_id": "<string>",
  "span_id": "<string>",
  "created_by": "<string>",
  "assessment_type": "comment",
  "object": "span.assessment",
  "comment": "<string>",
  "rating": 3,
  "approval": "approved",
  "rubric": {},
  "metadata": {},
  "overwrite": {},
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>",
  "error_code": "TRACES_SERVICE_CONFIGURATION_ERROR"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>",
  "error_code": "TRACES_SERVICE_CONFIGURATION_ERROR"
}

Span Assessment

Get span assessment by 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.

x-project-id answers 404 for an assessment on a trace outside that project, when PROJECT_SCOPED_SPAN_LISTING is on for the account.

GET

span-assessments

{span_assessment_id}

Get span assessment by ID

curl --request GET \
  --url https://api.egp.scale.com/v5/span-assessments/{span_assessment_id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.egp.scale.com/v5/span-assessments/{span_assessment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.egp.scale.com/v5/span-assessments/{span_assessment_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.egp.scale.com/v5/span-assessments/{span_assessment_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.egp.scale.com/v5/span-assessments/{span_assessment_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "assessment_id": "<string>",
  "trace_id": "<string>",
  "span_id": "<string>",
  "created_by": "<string>",
  "assessment_type": "comment",
  "object": "span.assessment",
  "comment": "<string>",
  "rating": 3,
  "approval": "approved",
  "rubric": {},
  "metadata": {},
  "overwrite": {},
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>",
  "error_code": "TRACES_SERVICE_CONFIGURATION_ERROR"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>",
  "error_code": "TRACES_SERVICE_CONFIGURATION_ERROR"
}

Authorizations

x-api-key

string

header

required

Headers

x-selected-account-id

string | null

x-project-id

string | null

Path Parameters

span_assessment_id

string

required

Response

Successful Response

Response model for span assessment

assessment_id

string

required

Unique identifier for the assessment

trace_id

string

required

The trace this assessment is attached to

span_id

string

required

The span this assessment is attached to

created_by

string

required

User who submitted the assessment

assessment_type

enum<string>

required

Type of assessment

Available options:

comment,

rating,

approval,

rubric,

metadata,

overwrite

object

string

default:span.assessment

Allowed value: "span.assessment"

comment

string | null

Raw text feedback

rating

integer | null

Numerical rating (1-5)

Required range: 1 <= x <= 5

approval

enum<string> | null

Approval status (approved/rejected)

Available options:

approved,

rejected

rubric

Rubric · object | null

Rule key-value pairs for rubric evaluation

Show child attributes

metadata

Metadata · object | null

Arbitrary JSON object for additional data

overwrite

Overwrite · object | null

User corrections to span output

account_id

string | null

Account this assessment belongs to

created_at

string<date-time> | null

When this assessment was created

updated_at

string<date-time> | null

When this assessment was last updated

Inference

Questions

Rubrics

Vector Stores

Files

Models

Agent Configs

Datasets

Dataset Items

Evaluations

Evaluation Groups

Evaluation Charts

Evaluation Dashboards

Evaluation Items

Spans

Span Assessment

Annotation Tasks

Credentials

Agentex Cloud Build

Agentex Cloud Deploy

Agentex Agent

SGP Cloud Secrets

Get span assessment by ID

Authorizations

Headers

Path Parameters

Response