Examples

Upload files to deepset Cloud

You can upload files in three different ways: 1. Upload multiple files by providing explicit file paths. 2. Upload all files from a folder. 3. Upload raw text.

For uploading files from your local machine to deepset Cloud, you can use upload.

Authentication

You will need to either explicitly pass an api_key to the upload function or set the environment variable DEEPSET_CLOUD_API_KEY to your api key. By running deepset-cloud login you can also store your api key globally on your machine. This will allow you to omit the api_key parameter in the following examples.

Example 1: Upload all files from a folder

Uploads all files from a folder to the default workspace.

upload(
    # workspace_name="my_workspace",  # optional, by default the environment variable "DEFAULT_WORKSPACE_NAME" is used
    paths=[Path("./examples/data")],
    blocking=True,  # optional, by default True
    timeout_s=300,  # optional, by default 300
    show_progress=True,  # optional, by default True
    recursive=False,  # optional, by default False
)

Example 2: Upload raw texts

Uploads a list of raw texts to the default workspace. This can be useful if you want to process your text first and later upload the content of the files.

upload_texts(
    # workspace_name="my_workspace",  # optional, by default the environment variable "DEFAULT_WORKSPACE_NAME" is used
    files=[
        DeepsetCloudFile(
            name="example.txt",
            text="this is text",
            meta={"key": "value"},  # optional
        )
    ],
    blocking=True,  # optional, by default True
    timeout_s=300,  # optional, by default 300
)