Skip to content

Commit d850ae6

Browse files
feat: add mutable score configs changelog and docs (#2080)
* feat: add mutable score configs changelog and docs * fix: link * chore: adjust date of changelog post * docs: update score config images in FAQ
1 parent 6e5ff50 commit d850ae6

File tree

4 files changed

+54
-4
lines changed

4 files changed

+54
-4
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
date: 2025-09-29
3+
title: Mutable Score Configs
4+
description: Score configurations can now be updated after creation. Modify existing configs via API/SDK and UI while keeping all your data safe.
5+
author: Marlies
6+
showOgInHeader: false
7+
---
8+
9+
import { ChangelogHeader } from "@/components/changelog/ChangelogHeader";
10+
11+
<ChangelogHeader />
12+
13+
You can now update your score configurations. Previously, once you created a score config, you couldn't change it. Now you can modify them anytime while keeping all your existing data safe.
14+
15+
## What's Changed
16+
17+
- **You can now update score configs**: Modify names, data types, and value ranges of existing configurations
18+
- **Available via API/SDK and UI**: Update configs programmatically through the API/SDK or directly in the Langfuse interface
19+
- **Your existing data stays safe**: All current scores remain unchanged when you update a config
20+
- **Clear update rules**: New scores follow the updated configuration
21+
22+
## Get started
23+
24+
import { Book } from "lucide-react";
25+
26+
<Cards num={1}>
27+
<Card title="Score Config Management Documentation" href="/faq/all/manage-score-configs" icon={<Book />} />
28+
</Cards>

pages/faq/all/manage-score-configs.mdx

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ tags: [evaluation]
1414
To understand detailed properties of the `ScoreConfig` object, see [Scores Data Model](/docs/evaluation/evaluation-methods/data-model#score-config).
1515

1616
## Via SDK
17-
### Create a Score Config
17+
### Create or Update a Score Config
1818

19-
To create a `scoreConfig` via the Langfuse SDK you need to use the `api` property on the Langfuse client as specified [here](/docs/api-and-data-platform/features/public-api#access-via-sdks). The specific `POST` and `GET` API endpoints are documented in the [API reference](/docs/api).
19+
To create or update a `scoreConfig` via the Langfuse SDK you need to use the `api` property on the Langfuse client as specified [here](/docs/api-and-data-platform/features/public-api#access-via-sdks). The specific `POST`, `PATCH` and `GET` API endpoints are documented in the [API reference](/docs/api).
2020

2121
### Use a Score Config
2222

23-
Using `ScoreConfig` via the SDK most commonly happens in the context of [Custom Evaluation via API/SDK (find instructions how to do that here)](/docs/evaluation/evaluation-methods/custom-scores#score-ingestion-referencing-configs-via-sdk).
23+
Using `ScoreConfig` via the SDK most commonly happens in the context of [Custom Evaluation via API/SDK (find instructions how to do that here)](/docs/evaluation/evaluation-methods/custom-scores#score-ingestion-referencing-configs-via-sdk).
2424

2525
## Via Langfuse UI
2626
### Create a Score Config
@@ -53,6 +53,28 @@ Click **"submit"** to create the score config.
5353
Using `ScoreConfig` via the UI most commonly happens in the context of [Human Annotation](/docs/evaluation/evaluation-methods/annotation).
5454

5555

56+
### Update a score config
57+
58+
<Steps>
59+
60+
#### Go to Project Settings
61+
Navigate to `Your Project` > `Project Settings` > `Scores / Evaluation` and click on the "edit" icon of the score config you want to update.
62+
63+
<Frame border className="mt-2" fullWidth>
64+
![Score Configs](/images/docs/modify_score_config.png)
65+
</Frame>
66+
67+
#### Update score config
68+
69+
- Score configs may be updated at any time.
70+
- All existing score data remains unaffected when you update a score config.
71+
- When creating new scores, they must comply with the current score config schema at the time of creation.
72+
- When updating existing scores (such as changing score values or comments), they must comply with the score config schema that is active at the time of the update.
73+
- You can always delete scores regardless of whether their associated score config has been modified or archived.
74+
</Steps>
75+
76+
77+
5678
### Archive a score config
5779

5880
<Steps>
@@ -61,7 +83,7 @@ Using `ScoreConfig` via the UI most commonly happens in the context of [Human An
6183
Navigate to `Your Project` > `Project Settings` > `Scores / Evaluation` and click on the "archive" icon of the score config you want to archive.
6284

6385
<Frame border className="mt-2" fullWidth>
64-
![Score Configs](/images/docs/archive_score_config.png)
86+
![Score Configs](/images/docs/modify_score_config.png)
6587
</Frame>
6688

6789
#### Archive score config
-363 KB
Binary file not shown.
729 KB
Loading

0 commit comments

Comments
 (0)