📘

You must be an Admin user to perform this task.

Edit a Pipeline Using YAML

This is the default way of editing pipelines. You can use it to replace one node with another or update the parameters quickly.

1. Log in to deepset Cloud and go to Pipelines.
2. Find the pipeline you want to edit, click the three dots menu next to it, and click Edit.
   
3. Modify the YAML file and save it.
   If you're editing a deployed pipeline, you must undeploy it before saving.
4. Deploy the pipeline to use it for search.

Edit a Pipeline Using a Jupyter Notebook

This is a good method if you need to troubleshoot a pipeline. You can then easily share your work by dragging the notebook to your organization's shared folder in the Jupyter lab. All members of your organization will be able to work with it.

1. Log in to deepset Cloud and go to Pipelines.
2. Find the pipeline you want to edit, click the three dots menu next to it, and click Edit.
   
3. Click Open in notebook. If you're editing a deployed pipeline, you need to undeploy it to see this option.
4. Choose the type of server you want to use (If you already have a server started, you're redirected to it without having to select it again.) You can choose one of these server types:
   • CPU - use this server if you want to work with your pipelines in JupyterLab without running them
   • GPU - use this server if you want to run your pipelines in JupyterLab
5. Wait until the server starts. It may take a couple of minutes.
6. When the server's ready, open the notebook.
   A generated Jupyter notebook with your pipeline as code opens.

📘

Under the hood

Here's what happened: We loaded your pipeline from deepset Cloud and generated the code by running pipeline.to_notebook_cell. You can do this yourself for other pipelines, using the SDK.

5. You can now work with your pipeline. When you're done, use the save_to_deepset_cloud method to save your pipeline. To make things easier, we have already added this code at the bottom of your generated notebook.

Edit a Pipeline with REST API

With this method, you can quickly upload an updated pipeline YAML to deepset Cloud. You need to Generate an API Key first. Run:

curl --request PUT \
     --url https://api.cloud.deepset.ai/api/v1/workspaces/<YOUR_WORKSPACE>/pipelines/<YOUR_PIPELINE_NAME>/yaml \
     --header 'accept: application/json'

You can find more information about this endpoint at update pipeline YAML.