Sign in
evaluators

Update an evaluator

Partially update the current draft/latest evaluator configuration. Committed read-only versions cannot be edited.

patch/api/evaluators/{evaluator_id}/

Path parameters

evaluator_idstring required

Evaluator ID. To run a specific version, pass an ID with a version suffix where supported, for example evl_abc123:2.

Headers

Authorizationstring required

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.

Request body

namestring
evaluator_slugstring

Organization-scoped evaluator slug.

type'llm' | 'human' | 'code'
score_value_type'numerical' | 'boolean' | 'percentage' | 'single_select' | 'multi_select' | 'text' | 'json' | 'comment' | 'categorical'
eval_class'keywordsai_custom_llm' | 'custom_code'

Optional pre-built evaluator template.

descriptionstring nullable
passing_conditionsApiEvaluatorsEvaluatorIdPatchRequestBodyContentApplicationJsonSchemaPassingConditions

Passing conditions in the standard Respan filter format.

configurationsobject

Legacy user-facing configuration object. New clients should prefer llm_config, code_config, score_config, and passing_conditions.

starredboolean

Response

Updated evaluator.

idstring required

Stable evaluator ID shared by all versions.

version_idstring

Unique ID for this evaluator version.

versioninteger

Version number. The first draft is version 0.

is_read_onlyboolean

Whether this version is committed and immutable.

version_descriptionstring

Commit message for this version.

namestring required
evaluator_slugstring

Organization-scoped evaluator slug.

type'llm' | 'human' | 'code' required
score_value_type'numerical' | 'boolean' | 'percentage' | 'single_select' | 'multi_select' | 'text' | 'json' | 'comment' | 'categorical' required
eval_class'keywordsai_custom_llm' | 'custom_code'

Optional pre-built evaluator template.

descriptionstring nullable
passing_conditionsApiEvaluatorsEvaluatorIdPatchResponsesContentApplicationJsonSchemaPassingConditions

Passing conditions in the standard Respan filter format.

configurationsobject

Legacy user-facing configuration object. New clients should prefer llm_config, code_config, score_config, and passing_conditions.

starredboolean
created_atstring date-time
updated_atstring date-time

Changes