Create Evaluator Version

POST

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

POST

/api/evaluators/:evaluator_id/versions/

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

201Created

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

Create a new version (commit). Org derived from parent evaluator.

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, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth 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

Request

This endpoint expects an object.

configurationsmap from strings to anyOptional

categorical_choiceslist of maps from strings to anyOptional

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

projectstring or nullOptional>=1 character

namestringOptional>=1 character

score_value_typestringOptional>=1 character

version_descriptionstringOptionalDefaults to

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

eval_classenumOptional

custom_required_fieldslist of stringsOptional

starredbooleanOptional

created_byinteger or nullOptional

updated_byinteger or nullOptional

Response

version_idstringRead-only

is_publicbooleanRead-only

idstringRead-only

versionintegerRead-only

is_read_onlybooleanRead-only

created_atdatetimeRead-only

updated_atdatetimeRead-only

configurationsmap from strings to any

categorical_choiceslist of maps from strings to any

score_configmap from strings to any

passing_conditionsmap from strings to any or null

llm_configmap from strings to any or null

code_configmap from strings to any or null

projectstring or null

namestring

score_value_typestring

version_descriptionstringDefaults to

descriptionstring

typeenum

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

eval_classenum

custom_required_fieldslist of strings

starredboolean

created_byinteger or null

updated_byinteger or null