Skip to main content
PATCH
Update eval

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain that identifies the project.

eval_id
string
required
Minimum string length: 1

Query Parameters

source_target_kind
string
target_branch_id
string<uuid> | null

Body

application/json
name
string

Updated eval name. Omit it to keep the name.

Minimum string length: 1
description
string

Updated description. Omit it to keep the description.

target
string

Updated agent identifier. Omit it to keep the target.

Minimum string length: 1
dataset
object

Updated dataset. Omit it to keep the dataset.

metrics
object[]

Updated metrics. Omit them to keep the metrics.

repetitions
integer

Updated repetitions. Omit them to keep the value.

tags
string[]

Updated tags. Omit them to keep the tags.

metadata
object

Updated metadata object. Omit it to keep the metadata.

Response

The updated eval source document.

Eval definition including editable source content.

id
string
required

Eval identifier.

name
string
required

Human-readable eval name.

description
string | null
required

Short description of what the eval checks, or null.

target_kind
enum<string>
required

What the eval runs against: always agent.

Available options:
agent
target
string
required

Identifier of the agent the eval runs against.

source_path
string
required

Source file path where the eval definition lives.

export_name
string
required

Name of the export that declares the eval in its source file.

dataset
object
required

The examples the eval runs.

metrics
object[]
required

The metrics that score each example.

repetitions
integer
required

How often each example runs.

tags
string[]
required

Labels of the eval.

metadata
object
required

Free-form JSON object stored with the eval.

editable_fields
enum<string>[]
required

Fields that update_eval can change.

Available options:
name,
description,
target,
dataset,
repetitions,
tags,
metadata,
metrics,
check
dynamic_fields
enum<string>[]
required

Fields computed in source, which update_eval cannot change.

Available options:
name,
description,
target,
dataset,
repetitions,
tags,
metadata,
metrics,
check
capabilities
string[]
required

Eval capabilities the caller holds on the project.

source
string
required

Source text of the eval file.

edit_mode
enum<string>
required

Editing mode of the eval: structured for field updates, source_only for source edits.

Available options:
structured,
source_only
source_only_reasons
string[]
required

Reasons why the eval can only be edited as source; empty for a structured eval.