Update an Experiment Run

Modify the experiment data, such as name, tags, datasets, and the pipeline used. You can only edit an experiment when its status is draft, you can't edit completed experiments.

📘

You must be an Admin to perform this task.

Update an Experiment Run from the UI

🚧

Coming soon!

Currently, you can only change the experiment's tags in the UI. But you can use REST API to update your experiments.

  1. Log in to deepset Cloud and go to Experiments.
  2. Find the experiment you want to update, click the menu to the right of the experiment name, and select Edit.
  3. Modify the experiment run and save your changes.

Update an Experiment Run with REST API

Use the Edit Eval Run API endpoint to update the name, tags, pipeline, files, and evaluation set of an experiment run. You need to Generate an API Key first.

Follow this step-by-step explanation of code:

Or copy and modify this code:

curl --request PATCH \
     --url https://api.cloud.deepset.ai/api/v1/workspaces/<YOUR_WORKSPACE>/eval_runs/<EVALUATION_RUN> \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <YOUR_API_KEY>' \
     --header 'Content-Type: application/json' \
     --data '
{
     "tags": [
          "tag1"
     ],
     "comment": "Add a comment here",
     "evaluation_set_name": "<your_eval_set>",
     "pipeline_name": "<pipeline_name>"
}
'