Prerequisites

• You must be an Admin to perform this task.
• If you work from your local SDK, you must have Haystack installed. For more information, see Haystack Installation. If you use Jupyter Notebooks in deepset Cloud, you don't have to worry about that.
• Add API endpoint and API key to the environment variables. The API endpoint is <https://api.cloud.deepset.ai/api/v1>. See Generate an API Key.

📘

Server restart

If the Notebooks server closes while you're still working, all the files you saved are still there. When you restart the server, you'll be able to work on them again.

Upload Files

Upload text or PDF files.

This table lists the parameters that you can use with the upload_files() method:

from haystack.utils import DeepsetCloud
from pathlib import Path

file_client = DeepsetCloud.get_file_client()

file_paths = [
  Path("C:\Users\OneDrive\Documents\file1.txt"),
  Path("C:\Users\OneDrive\Documents\file2.pdf")
]
metas = [{"file_id": "file1.txt"}, {"file_id": "file2.txt"}]
my_files = file_client.upload_files(file_paths=file_paths, metas=metas)

Delete Files

Delete files from deepset Cloud.

This table lists the parameters that you can use with the delete_file() method:

from haystack.utils import DeepsetCloud

file_client = DeepsetCloud.get_file_client()

file_client.delete_file(file_id="12345566")

List Files

List all files that exist in a deepset Cloud workspace. You can filter the files by their names or metadata.

This table lists the parameters that you can use with the list_files() method:

from haystack.utils import DeepsetCloud

file_client = DeepsetCloud.get_file_client()

my_files = [f for f in file_client.list_files()]
print(my_files)