Update span score | Respan Docs

Updates an existing score for a specific log.

numerical_value number: Optional updated numerical score value.
string_value string: Optional updated string score value.
boolean_value boolean: Optional updated boolean score value.
categorical_value array: Optional updated categorical score value (array of strings). Use when evaluator’s score_value_type is categorical.

Python

1 url = "https://api.respan.ai/api/logs/{log_id}/scores/{score_id}/"
2 api_key = "YOUR_KEY" # Replace with your actual Respan API key
3 data = {
4     "numerical_value": 4.8,
5     "string_value": "Excellent quality"
6 }
7 headers = {
8     "Authorization": f"Bearer {api_key}",
9     "Content-Type": "application/json"
10 }
11 
12 response = requests.patch(url, headers=headers, json=data)
13 print(response.json())

Request

1 {
2   "numerical_value": 4.8,
3   "string_value": "Excellent quality"
4 }

200 OK

1 {
2   "id": "eval_result_unique_id",
3   "created_at": "2024-01-15T10:30:00Z",
4   "type": "llm",
5   "environment": "test",
6   "numerical_value": 4.8,
7   "string_value": "Excellent quality",
8   "boolean_value": true,
9   "is_passed": false,
10   "cost": 0.0,
11   "evaluator_id": null,
12   "evaluator_slug": "quality_evaluator",
13   "log_id": "log_unique_id",
14   "dataset_id": null
15 }

Updates an existing score for a specific log. - `numerical_value` *number*: Optional updated numerical score value. - `string_value` *string*: Optional updated string score value. - `boolean_value` *boolean*: Optional updated boolean score value. - `categorical_value` *array*: Optional updated categorical score value (array of strings). Use when evaluator's `score_value_type` is `categorical`. ```Python Python url = "https://api.respan.ai/api/logs/{log_id}/scores/{score_id}/" api_key = "YOUR_KEY" # Replace with your actual Respan API key data = { "numerical_value": 4.8, "string_value": "Excellent quality" } headers = { "Authorization": f"Bearer {api_key}", "Content-Type": "application/json" } response = requests.patch(url, headers=headers, json=data) print(response.json()) ``` ```json Request { "numerical_value": 4.8, "string_value": "Excellent quality" } ``` ```json 200 OK { "id": "eval_result_unique_id", "created_at": "2024-01-15T10:30:00Z", "type": "llm", "environment": "test", "numerical_value": 4.8, "string_value": "Excellent quality", "boolean_value": true, "is_passed": false, "cost": 0.0, "evaluator_id": null, "evaluator_slug": "quality_evaluator", "log_id": "log_unique_id", "dataset_id": null } ```

Authentication

AuthorizationBearer

API key authentication. Get your API key from https://platform.respan.ai/platform/api-keys

Path parameters

log_idstringRequired

Log Id

score_idstringRequired

Score Id

Request

This endpoint expects an object.

numerical_valuedoubleOptional

Optional updated numerical score value.

string_valuestringOptional

Optional updated string score value.

boolean_valuebooleanOptional

Optional updated boolean score value.

categorical_valuelist of stringsOptional

Optional updated categorical score value (array of strings). Use when evaluator’s score_value_type is categorical.

Response

Successful response for Update span score

Errors

401

Unauthorized Error

Updates an existing score for a specific log.

numerical_value number: Optional updated numerical score value.
string_value string: Optional updated string score value.
boolean_value boolean: Optional updated boolean score value.
categorical_value array: Optional updated categorical score value (array of strings). Use when evaluator’s score_value_type is categorical.

Python

1 url = "https://api.respan.ai/api/logs/{log_id}/scores/{score_id}/"
2 api_key = "YOUR_KEY" # Replace with your actual Respan API key
3 data = {
4     "numerical_value": 4.8,
5     "string_value": "Excellent quality"
6 }
7 headers = {
8     "Authorization": f"Bearer {api_key}",
9     "Content-Type": "application/json"
10 }
11 
12 response = requests.patch(url, headers=headers, json=data)
13 print(response.json())

Request

1 {
2   "numerical_value": 4.8,
3   "string_value": "Excellent quality"
4 }

200 OK

1 {
2   "id": "eval_result_unique_id",
3   "created_at": "2024-01-15T10:30:00Z",
4   "type": "llm",
5   "environment": "test",
6   "numerical_value": 4.8,
7   "string_value": "Excellent quality",
8   "boolean_value": true,
9   "is_passed": false,
10   "cost": 0.0,
11   "evaluator_id": null,
12   "evaluator_slug": "quality_evaluator",
13   "log_id": "log_unique_id",
14   "dataset_id": null
15 }

1	curl -X PATCH https://api.respan.ai/api/logs/log_id/scores/score_id/ \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	url = "https://api.respan.ai/api/logs/{log_id}/scores/{score_id}/"
2	api_key = "YOUR_KEY" # Replace with your actual Respan API key
3	data = {
4	"numerical_value": 4.8,
5	"string_value": "Excellent quality"
6	}
7	headers = {
8	"Authorization": f"Bearer {api_key}",
9	"Content-Type": "application/json"
10	}
11
12	response = requests.patch(url, headers=headers, json=data)
13	print(response.json())

1	{
2	"id": "eval_result_unique_id",
3	"created_at": "2024-01-15T10:30:00Z",
4	"type": "llm",
5	"environment": "test",
6	"numerical_value": 4.8,
7	"string_value": "Excellent quality",
8	"boolean_value": true,
9	"is_passed": false,
10	"cost": 0.0,
11	"evaluator_id": null,
12	"evaluator_slug": "quality_evaluator",
13	"log_id": "log_unique_id",
14	"dataset_id": null
15	}