deepset-cloud-sdk 1.2.0

deepset Cloud SDK

The deepset Cloud SDK is an open source software development kit that provides convenient access to and integration with deepset Cloud, a powerful cloud offering for various natural language processing (NLP) tasks. This README provides an overview of the SDK and its features, and information on contributing to the project and exploring related resources.

• Official SDK Docs)
• Tutorials:
  • Uploading with CLI
  • Uploading with Python Methods

Supported Features

In its current shape, the SDK offers a suite of tools for seamless data upload to deepset Cloud. The following examples demonstrate how to use the deepset Cloud SDK to interact with deepset Cloud using Python. You can use the deepset Cloud SDK in the command line as well. For more information, see the CLI documentation.

• SDK Examples - Upload datasets
• CLI Examples - Upload datasets

Installation

The deepset Cloud SDK is available on PyPI and you can install it using pip:

pip install deepset-cloud-sdk

After installing the deepset Cloud SDK, you can use it to interact with deepset Cloud. It comes with a command line interface (CLI), that you can use by calling:

deepset-cloud --help

Development Installation

To install the deepset Cloud SDK for development, clone the repository and install the package in editable mode:

pip install hatch==1.7.0
hatch build

Instead of calling the CLI from the build package, you can call it directly from the source code:

python3 -m deepset_cloud_sdk.cli --help

Contributing

We welcome contributions from the open source community to enhance the deepset Cloud SDK. If you would like to contribute, have a look at CONTRIBUTING.md for guidelines and instructions on how to get started. We appreciate your contributions, whether they're bug fixes, new features, or documentation improvements.

---

Interested in Haystack?

deepset Cloud is powered by Haystack, an open source framework for building end-to-end NLP pipelines.

• Project website
• GitHub repository

---

Licenses

The SDK is licensed under Apache 2.0, you can see the license here

We use several libraries in this SDK that are licensed under the MPL 2.0 license

• tqdm for progress bars
• pathspec for pattern matching file paths
• certifi for validating trustworthiness of SSL certificates