Sign in

v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Evaluators

Update evaluator

Update an evaluator's metadata. At least one field must be provided. Omitted fields are left unchanged.

Payload Requirements

  • At least one of name or description must be provided.
  • name, if provided, must be unique within the space.
  • System-managed fields (id, type, space_id, created_at, updated_at, created_by_user_id) cannot be modified.

Valid example

{
  "name": "Hallucination Detector v2",
  "description": "Updated evaluator for production hallucination checks"
}

Invalid example (no updatable fields provided)

{}

<Note>This endpoint is in beta, read more here.</Note>

patch/v2/evaluators/{evaluator_id}

Path parameters

evaluator_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique evaluator identifier (base64)

Request body

namestring

New evaluator name

descriptionstring nullable

New description

Response

An evaluator object

idstring required

The unique identifier for the evaluator

namestring required

The name of the evaluator

descriptionstring nullable

The description of the evaluator

type'TEMPLATE' | 'CODE' | 'HARNESS' | 'REMOTE' required

The evaluator type:

  • TEMPLATE — LLM-based evaluator.
  • CODE — managed built-in evaluators or custom Python code (both are subtypes of CODE, discriminated by the nested CodeConfig.type = MANAGED | CUSTOM).
  • HARNESS — test harness evaluator.
  • REMOTE — remote evaluator.

Applies to both the parent Evaluator.type field and every version's type discriminator — a version's type must always match its parent evaluator's type.

space_idstring required

The unique identifier for the space the evaluator belongs to

created_atstring date-time required

When the evaluator was created

updated_atstring date-time required

When the evaluator was last updated

created_by_user_idstring nullable required

The unique identifier for the user who created the evaluator