Update Evaluator Version

PATCH

https://api.respan.ai/api/evaluators/:evaluator_id/versions/:version/

PATCH

/api/evaluators/:evaluator_id/versions/:version/

$ curl -X PATCH https://api.respan.ai/api/evaluators/evaluator_id/versions/1/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Updated

1 {
2   "name": "string",
3   "created_at": "2024-01-15T09:30:00Z",
4   "updated_at": "2024-01-15T09:30:00Z",
5   "created_by": {
6     "id": 1,
7     "email": "string",
8     "name": "string",
9     "username": "string",
10     "first_name": "string",
11     "last_name": "string"
12   },
13   "updated_by": {
14     "id": 1,
15     "email": "string",
16     "name": "string",
17     "username": "string",
18     "first_name": "string",
19     "last_name": "string"
20   },
21   "id": "string",
22   "version_id": "string",
23   "version": 1,
24   "is_read_only": true,
25   "version_description": "string",
26   "description": "string",
27   "type": "llm",
28   "score_value_type": "numerical",
29   "score_config": {},
30   "passing_conditions": {},
31   "llm_config": {},
32   "code_config": {},
33   "configurations": {},
34   "categorical_choices": [
35     {}
36   ],
37   "eval_class": "ragas_faithfulness",
38   "starred": true
39 }

Edit version - only allowed if is_read_only=False.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Path parameters

evaluator_idstringRequired

versionintegerRequired

Request

This endpoint expects an object.

idstringOptional1-255 characters

version_idstringOptional1-255 characters

versionintegerOptional-2147483648-2147483647

is_read_onlybooleanOptional

version_descriptionstringOptional

namestringOptional1-255 characters

descriptionstringOptional

typeenumOptional

llm - Llm
code - Code
human - Human
function - Function
human_numerical - Human Numerical
human_categorical - Human Categorical
human_boolean - Human Boolean
human_text - Human Text
custom - Custom

score_value_typeenumOptional

numerical - Numerical
boolean - Boolean
percentage - Percentage
single_select - Single Select
multi_select - Multi Select
text - Text
json - Json
comment - Comment
categorical - Categorical

score_configmap from strings to anyOptional

passing_conditionsmap from strings to any or nullOptional

llm_configmap from strings to any or nullOptional

code_configmap from strings to any or nullOptional

configurationsmap from strings to anyOptional

categorical_choiceslist of maps from strings to anyOptional

eval_classenumOptional

starredbooleanOptional

Response

namestring<=255 characters

created_atdatetimeRead-only

updated_atdatetimeRead-only

created_byobject

updated_byobject

idstringOptional<=255 characters

version_idstringOptional<=255 characters