Working in deepset Cloud

In deepset Cloud, you work in a workspace where you keep your data and your pipelines. You can have multiple workspaces, each with different content. There are three interfaces (GUI, API, and SDK) you can use to interact with deepset Cloud, depending what's most convenient to you.


In deepset Cloud, you work within an organization to which you were invited. Each organization may have multiple workspaces with different data. Users that are part of an organization can access all the workspaces in this organization. Pipelines and data are not shared among workspaces.

After logging in, you land on the Dashboard, where you can view your workspace statistics, the number of searches run last week, and the details of the last five searches. These include the top answer (the answer with the highest relevance score) and the top file (the file containing the top answer). The search time is in seconds.

You can quickly switch between workspaces. Just click the workspace name and choose the one you want to switch to.

Common Actions

Here's an explanation of what each navigation item does:

Navigation StepAction
Workspace nameSwitch between workspaces
Creating a workspace (just type the name of the new workspace). You can create up to 10 workspaces.
DashboardAccess a guided workflow to create a pipeline.
Check your workspace statistics like the number of files or latest searches.
Data>FilesUpload files. These are the files your pipeline uses for search.
Manage existing files (view, delete, preview, filter by metadata).
Data>Evaluation SetsUpload evaluation sets. These are the CSV files used in experiments to evaluate your pipeline.
Manage existing evaluation sets (download, export, view, and delete).
PipelinesCreate pipelines.
Manage existing pipelines (deploy, undeploy, edit, view pipeline details, share pipelines, and export user feedback).
Click the name of a pipeline to check its details, such as feedback, queries, logs, and so on.
ExperimentsCreate experiments. They're a way of systematically evaluating your pipelines.
Manage existing experiments (edit, delete, check details).
Prompt ExplorerEngineer your prompts, try out different prompts, and compare them across up to three pipelines.
Choose a prompt from a library of curated prompts.
SearchRun searches using the pipeline you choose.
NotebooksWork in a Jupyter notebook.

To access your personal settings, your organization and workspace settings, your connections to model providers, and documentation, click your name in the top right corner.

Three Interfaces

You can work in deepset Cloud through one of these interfaces:

  • An intuitive, user-friendly graphical user interface, where you can see real-life updates and get immediate feedback on your actions.
  • REST API for a platform-independent way to communicate with deepset Cloud. It supports all the tasks available in GUI.
  • An open source SDK package you can customize. Currently, it contains methods for efficient file operations, such as upload or listing.