SDK Documentation

Haystack Enterprise Platform offers a Python SDKs for working with the platform from your code or the command line. We recommend using the Haystack Enterprise SDK for new projects. We'll be deprecating the deepset Cloud SDK in the future.

Haystack Enterprise SDK Documentation

The Haystack Enterprise SDK is the current Python SDK and command-line tool for Haystack Enterprise Platform. Use it to upload files, validate and run pipelines, and deploy pipelines as services from your local environment. This is the SDK we recommend for new projects.

Get Started

• Haystack Enterprise SDK overview
• Quickstart
• Install the SDK
• Set Up Configuration

Guides

• Deploy a Pipeline
• Upload Files
• Migrate from the deepset Cloud SDK

Reference

• CLI Reference
• Quick Reference
• Haystack Enterprise SDK on GitHub

Troubleshooting

• Troubleshooting overview
• Troubleshoot Installation
• Troubleshoot Configuration
• Troubleshoot Pipelines
• Troubleshoot Deployments
• Troubleshoot Uploads

deepset Cloud SDK Documentation (legacy)

The deepset Cloud SDK is the earlier SDK for Haystack Enterprise Platform. It's still available, but for new projects we recommend the Haystack Enterprise SDK. If you're moving from the deepset Cloud SDK, see the migration guide.

Guides

• Working with the SDK
• Install the SDK

Using the command-line interface (CLI):

• Set Up the SDK CLI
• Upload Files with CLI
• Download Files with CLI
• List Existing Files with CLI

Using Python methods:

• Using Python Methods
• Upload Files with Python
• List Existing Files with Python
• Get Upload Sessions Details
• Download Files with Python
• Import a Haystack Pipeline

Reference

• Data Classes
• Synchronous Client
• Asynchronous Client
• deepset CLI