Prerequisites

• Install the SDK.
• Generate an API key to access deepset Cloud, and have it at hand.
• You can run the following command to ensure you have the latest version of the SDK installed:

deepset-cloud --version

Log In

1. Run the following command:
   Python

   deepset-cloud login
   

2. Choose the deepset Cloud environment:
   1. eu (default): For deployments in Europe, sets the environment to https://api.cloud.deepset.ai/.
   2. us: For deployments in the US, sets the environment to: https://api.us.deepset.ai/.
   3. custom: For on-premise deployments, you must provide the API URL.
3. When prompted, paste your API key.
4. Type the name of the deepset Cloud workspace you want to set as default for all operations.

Running the login command creates an .ENV file ~/.deepset-cloud/.env containing your API key and default workspace. The SDK uses this file as the default configuration for all subsequent CLI commands.

Getting Help

Use --help to see available commands:

deepset-cloud --help

Log Out

To delete the .ENV file with your credentials, run:

deepset-cloud logout

Check the SDK Version

To verify if you have the latest SDK version installed, run:

deepset-cloud --version