haystack-enterprise-sdk 0.1.0__tar.gz

haystack_enterprise_sdk-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2021 deepset GmbH
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

haystack_enterprise_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: haystack-enterprise-sdk
+Version: 0.1.0
+Summary: Haystack Enterprise SDK
+Keywords: 
+Author: deepset.ai
+Author-email: deepset.ai <malte.pietsch@deepset.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: structlog>=24.0.0
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: typer>=0.15.0
+Requires-Dist: click<=8.3.1
+Requires-Dist: tenacity>=8.3.0
+Requires-Dist: aiohttp>=3.10.10
+Requires-Dist: aiofiles>=24.1.0
+Requires-Dist: tabulate>=0.9.0
+Requires-Dist: tqdm>=4.66.4
+Requires-Dist: yaspin>=3.0.0
+Requires-Dist: pyrate-limiter>=3.7.0
+Requires-Dist: pydantic>=2.11.4
+Requires-Dist: ruamel-yaml>=0.18.10
+Requires-Dist: sniffio>=1.3.1
+Requires-Dist: haystack-ai>=2.13.2 ; extra == 'deploy'
+Requires-Python: >=3.10
+Project-URL: Documentation, https://github.com/deepset-ai/haystack-enterprise-sdk#readme
+Project-URL: Issues, https://github.com/deepset-ai/haystack-enterprise-sdk/issues
+Project-URL: Source, https://github.com/deepset-ai/haystack-enterprise-sdk
+Provides-Extra: deploy
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/deepset-ai/haystack-enterprise-sdk/main/assets/logo-dark.svg">
+    <img src="https://raw.githubusercontent.com/deepset-ai/haystack-enterprise-sdk/main/assets/logo.svg" alt="Haystack Enterprise SDK" width="420">
+  </picture>
+</p>
+
+# Haystack Enterprise SDK
+
+> **Experimental.** This SDK is under active development. APIs and CLI commands may change without notice.
+
+Python SDK and CLI for the Haystack Enterprise Platform.
+
+## Installation
+
+Not published to a package registry yet — install directly from this repository with [uv](https://docs.astral.sh/uv/):
+
+```bash
+# Install as a CLI tool
+uv tool install git+https://github.com/deepset-ai/haystack-enterprise-sdk.git
+
+# Or add it as a dependency of your project
+uv add git+https://github.com/deepset-ai/haystack-enterprise-sdk.git
+```
+
+## Usage
+
+```bash
+haystack-enterprise --help
+```
+
+### Authentication
+
+```bash
+haystack-enterprise login
+haystack-enterprise logout
+```
+
+### Files
+
+```bash
+# Upload a folder to a workspace
+haystack-enterprise upload ./my-files
+
+# List files in a workspace
+haystack-enterprise list-files
+
+# Download files to your local machine
+haystack-enterprise download
+```
+
+### Pipelines
+
+```bash
+# Validate a local pipeline against the platform
+haystack-enterprise validate ./pipeline.py
+
+# Run a local pipeline in the platform sandbox (shows a spinner with the elapsed time while it waits)
+haystack-enterprise run ./pipeline.py
+
+# Transient failures (network errors, timeouts, 429, 5xx) are retried twice by default; 0 disables it.
+# Config and input errors always fail immediately.
+haystack-enterprise run ./pipeline.py --retries 0
+
+# Deploy a local pipeline as a service deployment (reused if it exists, otherwise created serverless).
+# Asks at most which socket receives the query and which is the main output -- and nothing at all when
+# your socket names already say so. Prints the service's chat-completions endpoint once it is serving.
+haystack-enterprise deploy ./pipeline.py my-service
+
+# Create a managed (provisioned) service instead, with explicit sizing
+haystack-enterprise deploy ./pipeline.py my-service --managed --cpu 2 --memory 4Gi
+
+# Deploy and get a shareable prototype link (a chat UI). Because that UI routes through the pipeline's
+# input/output mapping, --share is also what asks you to review the mapping.
+haystack-enterprise deploy ./pipeline.py my-service --share
+
+# Check the status of a service deployment
+haystack-enterprise service-status my-service
+```
+
+### Calling a deployed service
+
+A deployed service is served over an OpenAI-compatible chat-completions endpoint, which `deploy` prints
+once the service is running:
+
+```bash
+curl -N https://api.cloud.deepset.ai/api/v1/workspaces/<workspace>/deployments/<deployment-id>/chat/completions \
+  -H "Authorization: Bearer $API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{"model": "<workspace>/<service-name>", "messages": [{"role": "user", "content": "Hello"}]}'
+```
+
+The response is a server-sent-event stream of `chat.completion.chunk` objects. Any OpenAI client works —
+point its `base_url` at everything up to and including `/deployments/<deployment-id>`.
+
+Pass `--verbose` to any command for INFO/DEBUG logs, and `<command> --help` for its arguments.
+
+## Development
+
+```bash
+# Install uv if you don't have it
+pip install uv
+
+# Sync all dependencies (including dev dependencies)
+uv sync --all-groups
+
+# Run the CLI from source
+uv run haystack-enterprise --help
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
+
+## Licenses
+
+The SDK is licensed under Apache 2.0, see [LICENSE](LICENSE).
+
+Some bundled libraries are licensed under the [MPL 2.0 license](https://www.mozilla.org/en-US/MPL/2.0/):
+
+- [tqdm](https://github.com/tqdm/tqdm) for progress bars
+- [pathspec](https://github.com/cpburnz/python-pathspec) for pattern matching file paths
+- [certifi](https://github.com/certifi/python-certifi) for validating trustworthiness of SSL certificates

haystack_enterprise_sdk-0.1.0/README.md

@@ -0,0 +1,121 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/deepset-ai/haystack-enterprise-sdk/main/assets/logo-dark.svg">
+    <img src="https://raw.githubusercontent.com/deepset-ai/haystack-enterprise-sdk/main/assets/logo.svg" alt="Haystack Enterprise SDK" width="420">
+  </picture>
+</p>
+
+# Haystack Enterprise SDK
+
+> **Experimental.** This SDK is under active development. APIs and CLI commands may change without notice.
+
+Python SDK and CLI for the Haystack Enterprise Platform.
+
+## Installation
+
+Not published to a package registry yet — install directly from this repository with [uv](https://docs.astral.sh/uv/):
+
+```bash
+# Install as a CLI tool
+uv tool install git+https://github.com/deepset-ai/haystack-enterprise-sdk.git
+
+# Or add it as a dependency of your project
+uv add git+https://github.com/deepset-ai/haystack-enterprise-sdk.git
+```
+
+## Usage
+
+```bash
+haystack-enterprise --help
+```
+
+### Authentication
+
+```bash
+haystack-enterprise login
+haystack-enterprise logout
+```
+
+### Files
+
+```bash
+# Upload a folder to a workspace
+haystack-enterprise upload ./my-files
+
+# List files in a workspace
+haystack-enterprise list-files
+
+# Download files to your local machine
+haystack-enterprise download
+```
+
+### Pipelines
+
+```bash
+# Validate a local pipeline against the platform
+haystack-enterprise validate ./pipeline.py
+
+# Run a local pipeline in the platform sandbox (shows a spinner with the elapsed time while it waits)
+haystack-enterprise run ./pipeline.py
+
+# Transient failures (network errors, timeouts, 429, 5xx) are retried twice by default; 0 disables it.
+# Config and input errors always fail immediately.
+haystack-enterprise run ./pipeline.py --retries 0
+
+# Deploy a local pipeline as a service deployment (reused if it exists, otherwise created serverless).
+# Asks at most which socket receives the query and which is the main output -- and nothing at all when
+# your socket names already say so. Prints the service's chat-completions endpoint once it is serving.
+haystack-enterprise deploy ./pipeline.py my-service
+
+# Create a managed (provisioned) service instead, with explicit sizing
+haystack-enterprise deploy ./pipeline.py my-service --managed --cpu 2 --memory 4Gi
+
+# Deploy and get a shareable prototype link (a chat UI). Because that UI routes through the pipeline's
+# input/output mapping, --share is also what asks you to review the mapping.
+haystack-enterprise deploy ./pipeline.py my-service --share
+
+# Check the status of a service deployment
+haystack-enterprise service-status my-service
+```
+
+### Calling a deployed service
+
+A deployed service is served over an OpenAI-compatible chat-completions endpoint, which `deploy` prints
+once the service is running:
+
+```bash
+curl -N https://api.cloud.deepset.ai/api/v1/workspaces/<workspace>/deployments/<deployment-id>/chat/completions \
+  -H "Authorization: Bearer $API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{"model": "<workspace>/<service-name>", "messages": [{"role": "user", "content": "Hello"}]}'
+```
+
+The response is a server-sent-event stream of `chat.completion.chunk` objects. Any OpenAI client works —
+point its `base_url` at everything up to and including `/deployments/<deployment-id>`.
+
+Pass `--verbose` to any command for INFO/DEBUG logs, and `<command> --help` for its arguments.
+
+## Development
+
+```bash
+# Install uv if you don't have it
+pip install uv
+
+# Sync all dependencies (including dev dependencies)
+uv sync --all-groups
+
+# Run the CLI from source
+uv run haystack-enterprise --help
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
+
+## Licenses
+
+The SDK is licensed under Apache 2.0, see [LICENSE](LICENSE).
+
+Some bundled libraries are licensed under the [MPL 2.0 license](https://www.mozilla.org/en-US/MPL/2.0/):
+
+- [tqdm](https://github.com/tqdm/tqdm) for progress bars
+- [pathspec](https://github.com/cpburnz/python-pathspec) for pattern matching file paths
+- [certifi](https://github.com/certifi/python-certifi) for validating trustworthiness of SSL certificates

haystack_enterprise_sdk-0.1.0/haystack_enterprise_sdk/README.md

@@ -0,0 +1,42 @@
+# Software development kit for the deepset API
+
+This package is split into multiple layers:
+- API layer
+- Client layer
+- Service layer
+- Workflow layer
+
+
+### API layer
+This layer is the lowest level of abstraction and contains the API definition, including all HTTP methods. It takes care of the authentication.
+You can find this layer in the `haystack_enterprise_sdk/_api/haystack_enterprise_api.py` file. We should implement reties on this lowest layer.
+
+### Client layer
+This layer adds a thin wrapper around the API layer and provides a more convenient interface to the API. It includes explicit methods
+for endpoints by specifying the HTTP methods and endpoints for example for uploading files.
+
+### Service layer
+This layer takes care of combining client methods to provide more complex functionality. Within this layer, we can add functionalities like
+creating sessions, uploading files, and closing sessions.
+
+### Workflow layer
+Public methods for users. These workflows are split into async and sync implementation.
+
+
+## Software architecture principles
+
+### Factories
+We are using factories implemented like this:
+```python
+@classmethod
+async def factory(cls, config: CommonConfig) -> YourClass:
+    """Create a new instance of the API client.
+
+    :param config: CommonConfig object.
+    """
+    yield cls(config)
+```
+
+### Tests
+We are using the classical pyramid of tests: unit tests (for each layer), integration tests. The goal is to gradually test each layer and
+then test the whole stack once within the integration tests.

haystack_enterprise_sdk-0.1.0/haystack_enterprise_sdk/__init__.py

@@ -0,0 +1,89 @@
+"""This is the entrypoint for the package."""
+
+import logging
+
+import structlog
+
+from haystack_enterprise_sdk._api.deployments import (
+    DeploymentMode,
+    DeploymentServiceLevel,
+    PipelineValidationError,
+    PipelineValidationIssue,
+    PipelineValidationResult,
+)
+from haystack_enterprise_sdk._api.pipeline_run import PipelineRunError
+from haystack_enterprise_sdk._api.shared_prototypes import (
+    FailedToCreateSharedPrototypeError,
+    SharedPrototype,
+)
+from haystack_enterprise_sdk._service.deployment_service import (
+    CreateOptions,
+    DeploymentFailedError,
+    DeployResult,
+    ServiceNotFoundError,
+    ShareOptions,
+)
+from haystack_enterprise_sdk._service.pipeline_service import (
+    ErrorDetail,
+    HaystackEnterpriseValidationError,
+)
+from haystack_enterprise_sdk._service.pipeline_transform import (
+    PipelineSettings,
+    PipelineTransformError,
+)
+from haystack_enterprise_sdk.models import (
+    BaseConfig,
+    IndexConfig,
+    IndexInputs,
+    IndexOutputs,
+    PipelineConfig,
+    PipelineInputs,
+    PipelineOutputs,
+    PipelineOutputType,
+)
+from haystack_enterprise_sdk.workflows.async_client.async_pipeline_client import (
+    AsyncPipelineClient,
+)
+from haystack_enterprise_sdk.workflows.async_client.deployment_client import (
+    AsyncDeploymentClient,
+)
+from haystack_enterprise_sdk.workflows.sync_client.deployment_client import DeploymentClient
+from haystack_enterprise_sdk.workflows.sync_client.pipeline_client import PipelineClient
+
+structlog.configure(
+    wrapper_class=structlog.make_filtering_bound_logger(logging.INFO),
+)
+
+log = structlog.get_logger()
+
+__all__ = [
+    "AsyncPipelineClient",
+    "BaseConfig",
+    "ErrorDetail",
+    "PipelineClient",
+    "PipelineConfig",
+    "PipelineInputs",
+    "PipelineOutputs",
+    "IndexConfig",
+    "IndexInputs",
+    "IndexOutputs",
+    "HaystackEnterpriseValidationError",
+    "PipelineOutputType",
+    "DeploymentClient",
+    "AsyncDeploymentClient",
+    "CreateOptions",
+    "DeploymentMode",
+    "DeploymentServiceLevel",
+    "DeployResult",
+    "ShareOptions",
+    "SharedPrototype",
+    "DeploymentFailedError",
+    "ServiceNotFoundError",
+    "FailedToCreateSharedPrototypeError",
+    "PipelineSettings",
+    "PipelineTransformError",
+    "PipelineValidationError",
+    "PipelineValidationResult",
+    "PipelineValidationIssue",
+    "PipelineRunError",
+]