> This page is for version 0.10.
> For other versions, use one of these documentation indexes:
> - Latest (default): https://docs.nvidia.com/nemo-helix/latest/llms.txt
> - 0.10: https://docs.nvidia.com/nemo-helix/v0.10/llms.txt
> - 0.9: https://docs.nvidia.com/nemo-helix/v0.9/llms.txt
> - 0.8: https://docs.nvidia.com/nemo-helix/v0.8/llms.txt
> - 0.7: https://docs.nvidia.com/nemo-helix/v0.7/llms.txt
> - 0.6: https://docs.nvidia.com/nemo-helix/v0.6/llms.txt
> - 0.5: https://docs.nvidia.com/nemo-helix/v0.5/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo-helix/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo-helix/_mcp/server.

# Patch Evaluation

PATCH http://localhost:8080/apis/intake/v2/workspaces/{workspace}/evaluations/{name}
Content-Type: application/json

Partially update an evaluation: only fields present in the request are changed.

The common case is curating an evaluation into another ExperimentGroup — PATCH with the merged
``experiment_ids``. Membership is replaced (not appended), so send the full desired set; any new
group must exist and the set must be non-empty (an evaluation always belongs to >=1 group). Omitted
fields are left untouched (unlike the full-body PUT, which overwrites them).

Reference: https://docs.nvidia.com/nemo-helix/documentation/reference/api-reference/evaluations/patch-evaluation-apis-intake-v-2-workspaces-workspace-evaluations-name-patch

## Request

### Path parameters

- `workspace` (string, required)
- `name` (string, required)

### Body (application/json)

This endpoint expects an EvaluationPatchRequest.

- `experiment_ids` (list of string, optional) — Replace the Experiments this Evaluation belongs to. Must be non-empty when provided; each experiment must already exist. Omit to leave membership unchanged.
- `source_link` (string, optional) — Optional URL for the source evaluation.
- `metadata` (map from string to string, optional) — Free-form producer metadata.
- `description` (string, optional) — Human-readable description.
- `parent_evaluation_id` (string, optional) — Entity id of the evaluation this one was derived from (e.g. a variant of a baseline), if any.
- `status` (string, optional) — Producer-defined lifecycle status of the evaluation.
- `root_cause` (string, optional) — Human- or agent-authored explanation of the evaluation's outcome (e.g. why it was killed).

## Response

### 200

Successful Response

- `id` (string, required)
- `name` (string, required)
- `workspace` (string, required)
- `experiment_ids` (list of string, required) — Entity ids of the Experiments this Evaluation belongs to (>=1).
- `dataset_name` (string, required)
- `experiment_group_id` (string, required, deprecated) — Deprecated single-experiment alias; the first of experiment_ids. Use experiment_ids.
- `dataset_version` (string, optional)
- `source_link` (string, optional)
- `metadata` (map from string to string, optional)
- `description` (string, optional)
- `parent_evaluation_id` (string, optional)
- `status` (string, optional)
- `root_cause` (string, optional)
- `created_at` (datetime, optional)
- `updated_at` (datetime, optional)
- `pinned_at` (datetime, optional, nullable) — Timestamp at which the evaluation was pinned, or null if unpinned. Managed via POST/DELETE /evaluations/\{name}/pin.
- `evaluator_names` (list of string, optional)
- `model_names` (list of string, optional) — Distinct model names observed across ingested sessions for this evaluation.
- `agent_names` (list of string, optional) — Distinct agent names observed across ingested sessions for this evaluation.
- `agent_versions` (list of string, optional) — Distinct agent versions observed across ingested sessions for this evaluation.
- `aggregate_scores` (map from string to EvaluatorAggregate, optional)
- `run_count` (integer, optional, default: 0) — Number of distinct ingested evaluation sessions; one session is treated as one run.
- `test_case_count` (integer, optional, default: 0) — Number of distinct test cases in the evaluation, i.e. distinct test_case_name values (sessions with no test_case_name each count as their own). A test case run k times counts once; the rollup metrics are averaged per test case before pooling across test cases.
- `cost_usd` (EvaluatorAggregate, optional) — Aggregate statistics over evaluator scores or session-level metric values.
- `latency_ms` (EvaluatorAggregate, optional) — Aggregate statistics over evaluator scores or session-level metric values.
- `tokens` (EvaluatorAggregate, optional) — Average total tokens (input + output) per test case, aggregated across the evaluation.

## Errors

### 400 Bad Request Error

A referenced ExperimentGroup does not exist, or experiment_ids is empty

- `any`

### 404 Not Found Error

Evaluation not found

- `any`

### 409 Conflict Error

Attempt to remove a baseline Evaluation from its Experiment

- `any`

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### EvaluatorAggregate

Aggregate statistics over evaluator scores or session-level metric values.

- `sum` (double, optional)
- `mean` (double, optional)
- `median` (double, optional)
- `p90` (double, optional)
- `p95` (double, optional)
- `p99` (double, optional)
- `count` (integer, optional, default: 0)
- `failed_count` (integer, optional, default: 0) — Sessions whose evaluator recorded a FAILED result (ran, produced no value). They are already counted as 0 in `mean`; this says how many of the attempts behind that mean were failures.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `input` (any, optional)
- `ctx` (map from string to any, optional)

### ValidationErrorLocItems

- string
- integer

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "id": "string",
  "name": "string",
  "workspace": "string",
  "experiment_ids": [
    "string"
  ],
  "dataset_name": "string",
  "experiment_group_id": "string",
  "dataset_version": "string",
  "source_link": "string",
  "metadata": {},
  "description": "string",
  "parent_evaluation_id": "string",
  "status": "string",
  "root_cause": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "pinned_at": "2024-01-15T09:30:00Z",
  "evaluator_names": [
    "string"
  ],
  "model_names": [
    "string"
  ],
  "agent_names": [
    "string"
  ],
  "agent_versions": [
    "string"
  ],
  "aggregate_scores": {},
  "run_count": 0,
  "test_case_count": 0,
  "cost_usd": {
    "sum": 1.1,
    "mean": 1.1,
    "median": 1.1,
    "p90": 1.1,
    "p95": 1.1,
    "p99": 1.1,
    "count": 0,
    "failed_count": 0
  },
  "latency_ms": {
    "sum": 1.1,
    "mean": 1.1,
    "median": 1.1,
    "p90": 1.1,
    "p95": 1.1,
    "p99": 1.1,
    "count": 0,
    "failed_count": 0
  },
  "tokens": {
    "sum": 1.1,
    "mean": 1.1,
    "median": 1.1,
    "p90": 1.1,
    "p95": 1.1,
    "p99": 1.1,
    "count": 0,
    "failed_count": 0
  }
}
```

**SDK Code**

```python
import requests

url = "http://localhost:8080/apis/intake/v2/workspaces/default/evaluations/my-evaluation"
headers = {"Content-Type": "application/json"}
payload = "{\"description\": \"Reviewed evaluation results\"}"

response = requests.request("PATCH", url, headers=headers, data=payload)
response.raise_for_status()
print(response.json())

```

```javascript
const response = await fetch("http://localhost:8080/apis/intake/v2/workspaces/default/evaluations/my-evaluation", {
  method: "PATCH",
  headers: {"Content-Type": "application/json"},
  body: "{\"description\": \"Reviewed evaluation results\"}",
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());

```