The deepset SDK is an open source software development kit that provides convenient access to and integration with deepset AI Platform, a powerful cloud offering for various AI tasks. This README provides an overview of the SDK and its features, and information on contributing to the project and exploring related resources.
Supported Features
In its current shape, the SDK offers a suite of tools for seamless data upload to deepset AI Platform and for importing Haystack pipelines and indexes. The following examples demonstrate how to use the deepset SDK to interact with deepset AI Platform using Python. You can use the deepset SDK in the command line as well. For more information, see the CLI documentation.
Installation
The deepset SDK is available on PyPI and you can install it using pip:
pip install deepset-cloud-sdk
After installing the deepset SDK, you can use it to interact with deepset AI Platform. It comes with a command line interface (CLI), that you can use by calling:
deepset-cloud --help
Development Installation
To install the deepset SDK for development, clone the repository and use uv to manage dependencies:
# Install uv if you don't have it
pip install uv
# Sync all dependencies (including dev dependencies)
uv sync --all-groups
# Build the package
uv build
Instead of calling the CLI from the build package, you can call it directly from the source code:
uv run python -m deepset_cloud_sdk.cli --help
# or
uv run deepset-cloud --help
Contributing
We welcome contributions from the open source community to enhance the deepset 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 AI Platform is powered by Haystack, an open source framework for building end-to-end NLP pipelines.
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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file deepset_cloud_sdk-1.7.7.tar.gz.
File metadata
- Download URL: deepset_cloud_sdk-1.7.7.tar.gz
- Upload date:
- Size: 36.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
63d3ceb714319b462d7433d6dfef58daea90b685dd27b1fc6a3e7f8befc1f6ae
|
|
| MD5 |
d1cb4d3ca36ae078504f57a9daf2be3f
|
|
| BLAKE2b-256 |
15e6c0730b3f4debfd585c8c61e4b319791e9a8f2e609126520bac533d2a754c
|
Provenance
The following attestation bundles were made for deepset_cloud_sdk-1.7.7.tar.gz:
Publisher:
deploy-prod.yml on deepset-ai/deepset-cloud-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
deepset_cloud_sdk-1.7.7.tar.gz -
Subject digest:
63d3ceb714319b462d7433d6dfef58daea90b685dd27b1fc6a3e7f8befc1f6ae - Sigstore transparency entry: 2292197674
- Sigstore integration time:
-
Permalink:
deepset-ai/deepset-cloud-sdk@dd4d31c14f149162f4d1124a3d3af0613b64f318 -
Branch / Tag:
refs/tags/1.7.7 - Owner: https://github.com/deepset-ai
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy-prod.yml@dd4d31c14f149162f4d1124a3d3af0613b64f318 -
Trigger Event:
release
-
Statement type:
File details
Details for the file deepset_cloud_sdk-1.7.7-py3-none-any.whl.
File metadata
- Download URL: deepset_cloud_sdk-1.7.7-py3-none-any.whl
- Upload date:
- Size: 48.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2b0cd2c31ca116ddab7af4fc04349e46ccbd0c83ac3b956ba4d347248011e420
|
|
| MD5 |
63659be280f4e3549bb21a704447c786
|
|
| BLAKE2b-256 |
24fc1752ab2dcaad6490e1698865757c29343f6a86d2a76b58a0563a9a5472a8
|
Provenance
The following attestation bundles were made for deepset_cloud_sdk-1.7.7-py3-none-any.whl:
Publisher:
deploy-prod.yml on deepset-ai/deepset-cloud-sdk
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
deepset_cloud_sdk-1.7.7-py3-none-any.whl -
Subject digest:
2b0cd2c31ca116ddab7af4fc04349e46ccbd0c83ac3b956ba4d347248011e420 - Sigstore transparency entry: 2292197803
- Sigstore integration time:
-
Permalink:
deepset-ai/deepset-cloud-sdk@dd4d31c14f149162f4d1124a3d3af0613b64f318 -
Branch / Tag:
refs/tags/1.7.7 - Owner: https://github.com/deepset-ai
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy-prod.yml@dd4d31c14f149162f4d1124a3d3af0613b64f318 -
Trigger Event:
release
-
Statement type:
