hetzner-haystack 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ # SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ from .chat.chat_generator import HetznerChatGenerator
6
+
7
+ __all__ = ["HetznerChatGenerator"]
@@ -0,0 +1,7 @@
1
+ # SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ from .chat_generator import HetznerChatGenerator
6
+
7
+ __all__ = ["HetznerChatGenerator"]
@@ -0,0 +1,179 @@
1
+ # SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
2
+ #
3
+ # SPDX-License-Identifier: Apache-2.0
4
+
5
+ from typing import Any, ClassVar
6
+
7
+ from haystack import component, default_to_dict, logging
8
+ from haystack.components.generators.chat import OpenAIChatGenerator
9
+ from haystack.dataclasses import StreamingCallbackT
10
+ from haystack.tools import ToolsType, serialize_tools_or_toolset
11
+ from haystack.utils import serialize_callable
12
+ from haystack.utils.auth import Secret
13
+ from openai.lib._pydantic import to_strict_json_schema
14
+ from pydantic import BaseModel
15
+
16
+ logger = logging.getLogger(__name__)
17
+
18
+
19
+ @component
20
+ class HetznerChatGenerator(OpenAIChatGenerator):
21
+ """
22
+ Enables text generation using the models served by the Hetzner Inference API.
23
+
24
+ For the list of available models, see the
25
+ [Hetzner Inference API docs](https://docs.hetzner.com/general/company-and-policy/experiments/inference/) or query
26
+ the `/v1/models` endpoint of the API, whose response is definitive.
27
+
28
+ You can pass any text generation parameters valid for the Hetzner chat completion API directly to this component
29
+ using the `generation_kwargs` parameter in `__init__` or in the `run` method.
30
+
31
+ The served models accept images alongside text, so
32
+ [`ImageContent`](https://docs.haystack.deepset.ai/docs/imagecontent) parts can be included in the
33
+ [`ChatMessage`](https://docs.haystack.deepset.ai/docs/chatmessage)s passed to `run`.
34
+
35
+ Usage example:
36
+ ```python
37
+ from haystack_integrations.components.generators.hetzner import HetznerChatGenerator
38
+ from haystack.dataclasses import ChatMessage
39
+
40
+ messages = [ChatMessage.from_user("What's Natural Language Processing?")]
41
+
42
+ client = HetznerChatGenerator()
43
+ response = client.run(messages)
44
+ print(response)
45
+
46
+ >>{'replies': [ChatMessage(_content='Natural Language Processing (NLP) is a branch of artificial intelligence
47
+ >>that focuses on enabling computers to understand, interpret, and generate human language in a way that is
48
+ >>meaningful and useful.', _role=<ChatRole.ASSISTANT: 'assistant'>, _name=None,
49
+ >>_meta={'model': 'Qwen/Qwen3.6-35B-A3B-FP8', 'index': 0, 'finish_reason': 'stop',
50
+ >>'usage': {'prompt_tokens': 15, 'completion_tokens': 36, 'total_tokens': 51}})]}
51
+ ```
52
+ """
53
+
54
+ SUPPORTED_MODELS: ClassVar[list[str]] = [
55
+ "Qwen/Qwen3.6-35B-A3B-FP8",
56
+ "Qwen3.8-27B",
57
+ ]
58
+ """The models supported by this component while the Hetzner Inference API is in experimental status.
59
+ The selection changes over time: query the `/v1/models` endpoint of the API for the definitive list.
60
+ Models outside this list are not rejected and are passed on to the API as-is."""
61
+
62
+ def __init__(
63
+ self,
64
+ *,
65
+ api_key: Secret = Secret.from_env_var("HETZNER_API_KEY"),
66
+ model: str = "Qwen/Qwen3.6-35B-A3B-FP8",
67
+ streaming_callback: StreamingCallbackT | None = None,
68
+ api_base_url: str | None = "https://inference.hetzner.com/api/v1",
69
+ generation_kwargs: dict[str, Any] | None = None,
70
+ tools: ToolsType | None = None,
71
+ timeout: float | None = None,
72
+ max_retries: int | None = None,
73
+ http_client_kwargs: dict[str, Any] | None = None,
74
+ ) -> None:
75
+ """
76
+ Creates an instance of HetznerChatGenerator.
77
+
78
+ :param api_key:
79
+ The Hetzner Inference API token.
80
+ :param model:
81
+ The name of the Hetzner chat completion model to use. See `SUPPORTED_MODELS`.
82
+ :param streaming_callback:
83
+ A callback function that is called when a new token is received from the stream.
84
+ The callback function accepts StreamingChunk as an argument.
85
+ :param api_base_url:
86
+ The Hetzner Inference API base url.
87
+ :param generation_kwargs:
88
+ Other parameters to use for the model. These parameters are all sent directly to
89
+ the Hetzner endpoint.
90
+ Some of the supported parameters:
91
+ - `max_tokens`: The maximum number of tokens the output text can have.
92
+ - `temperature`: What sampling temperature to use. Higher values mean the model will take more risks.
93
+ Try 0.9 for more creative applications and 0 (argmax sampling) for ones with a well-defined answer.
94
+ - `top_p`: An alternative to sampling with temperature, called nucleus sampling, where the model
95
+ considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens
96
+ comprising the top 10% probability mass are considered.
97
+ - `stream`: Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent
98
+ events as they become available, with the stream terminated by a data: [DONE] message.
99
+ - `response_format`: A JSON schema or a Pydantic model that enforces the structure of the model's response.
100
+ If provided, the output will always be validated against this
101
+ format (unless the model returns a tool call).
102
+ For details, see the [OpenAI Structured Outputs documentation](https://platform.openai.com/docs/guides/structured-outputs).
103
+ Notes:
104
+ - For structured outputs with streaming,
105
+ the `response_format` must be a JSON schema and not a Pydantic model.
106
+ :param tools:
107
+ A list of Tool and/or Toolset objects, or a single Toolset for which the model can prepare calls.
108
+ Each tool should have a unique name.
109
+ :param timeout:
110
+ The timeout for the Hetzner API call.
111
+ :param max_retries:
112
+ Maximum number of retries to contact Hetzner after an internal error.
113
+ If not set, it defaults to either the `OPENAI_MAX_RETRIES` environment variable, or set to 5.
114
+ :param http_client_kwargs:
115
+ A dictionary of keyword arguments to configure a custom `httpx.Client`or `httpx.AsyncClient`.
116
+ For more information, see the [HTTPX documentation](https://www.python-httpx.org/api/#client).
117
+ """
118
+ if model not in self.SUPPORTED_MODELS:
119
+ logger.warning(
120
+ "Model {model} is not in the list of models known to be served by the Hetzner Inference API: "
121
+ "{supported_models}. The request is sent anyway; check the `/v1/models` endpoint for the "
122
+ "current selection.",
123
+ model=model,
124
+ supported_models=", ".join(self.SUPPORTED_MODELS),
125
+ )
126
+
127
+ # the @component decorator recreates the class, so the zero-argument form of super() cannot be used
128
+ super(HetznerChatGenerator, self).__init__( # noqa: UP008
129
+ api_key=api_key,
130
+ model=model,
131
+ streaming_callback=streaming_callback,
132
+ api_base_url=api_base_url,
133
+ generation_kwargs=generation_kwargs,
134
+ tools=tools,
135
+ timeout=timeout,
136
+ max_retries=max_retries,
137
+ http_client_kwargs=http_client_kwargs,
138
+ )
139
+
140
+ def to_dict(self) -> dict[str, Any]:
141
+ """
142
+ Serialize this component to a dictionary.
143
+
144
+ :returns:
145
+ The serialized component as a dictionary.
146
+ """
147
+ callback_name = serialize_callable(self.streaming_callback) if self.streaming_callback else None
148
+ generation_kwargs = self.generation_kwargs.copy()
149
+ response_format = generation_kwargs.get("response_format")
150
+ # If the response format is a Pydantic model, it's converted to openai's json schema format
151
+ # If it's already a json schema, it's left as is
152
+ if response_format and isinstance(response_format, type) and issubclass(response_format, BaseModel):
153
+ json_schema = {
154
+ "type": "json_schema",
155
+ "json_schema": {
156
+ "name": response_format.__name__,
157
+ "strict": True,
158
+ "schema": to_strict_json_schema(response_format),
159
+ },
160
+ }
161
+
162
+ generation_kwargs["response_format"] = json_schema
163
+
164
+ # if we didn't implement the to_dict method here then the to_dict method of the superclass would be used
165
+ # which would serialize some fields that we don't want to serialize (e.g. the ones we don't have in
166
+ # the __init__)
167
+ # it would be hard to maintain the compatibility as superclass changes
168
+ return default_to_dict(
169
+ self,
170
+ model=self.model,
171
+ streaming_callback=callback_name,
172
+ api_base_url=self.api_base_url,
173
+ generation_kwargs=generation_kwargs,
174
+ api_key=self.api_key.to_dict(),
175
+ tools=serialize_tools_or_toolset(self.tools),
176
+ timeout=self.timeout,
177
+ max_retries=self.max_retries,
178
+ http_client_kwargs=self.http_client_kwargs,
179
+ )
File without changes
@@ -0,0 +1,40 @@
1
+ Metadata-Version: 2.5
2
+ Name: hetzner-haystack
3
+ Version: 1.0.0
4
+ Summary: An integration between the Hetzner Inference API and Haystack
5
+ Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/hetzner#readme
6
+ Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
7
+ Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/hetzner
8
+ Author-email: deepset GmbH <info@deepset.ai>
9
+ License-Expression: Apache-2.0
10
+ License-File: LICENSE.txt
11
+ Keywords: chat generator,haystack,hetzner,inference,llm,qwen
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: License :: OSI Approved :: Apache Software License
14
+ Classifier: Programming Language :: Python
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Programming Language :: Python :: 3.14
20
+ Classifier: Programming Language :: Python :: Implementation :: CPython
21
+ Classifier: Programming Language :: Python :: Implementation :: PyPy
22
+ Requires-Python: >=3.10
23
+ Requires-Dist: haystack-ai>=2.22.0
24
+ Description-Content-Type: text/markdown
25
+
26
+ # hetzner-haystack
27
+
28
+ [![PyPI - Version](https://img.shields.io/pypi/v/hetzner-haystack.svg)](https://pypi.org/project/hetzner-haystack)
29
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hetzner-haystack.svg)](https://pypi.org/project/hetzner-haystack)
30
+
31
+ - [Integration page](https://haystack.deepset.ai/integrations/hetzner)
32
+ - [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/hetzner/CHANGELOG.md)
33
+
34
+ ---
35
+
36
+ ## Contributing
37
+
38
+ Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
39
+
40
+ To run integration tests locally, you need to export the `HETZNER_API_KEY` environment variable.
@@ -0,0 +1,8 @@
1
+ haystack_integrations/components/generators/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ haystack_integrations/components/generators/hetzner/__init__.py,sha256=vbz-hkEoZ4_hZ6ALBKzAguyrKh0noZp1YqkFeZolbvA,201
3
+ haystack_integrations/components/generators/hetzner/chat/__init__.py,sha256=TYxQEXBbjfDAPRCCegyCz15vNHHlROtA4QefEt1deL8,196
4
+ haystack_integrations/components/generators/hetzner/chat/chat_generator.py,sha256=8LtG3FJkXY0TwyoaOmUEfpk3orf0N6x4OdpiBFgnFVg,8876
5
+ hetzner_haystack-1.0.0.dist-info/METADATA,sha256=nzCRieKjtO4Ts7BWFPlmDG3DrQK2s9tMcz772ycK1PU,1963
6
+ hetzner_haystack-1.0.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
7
+ hetzner_haystack-1.0.0.dist-info/licenses/LICENSE.txt,sha256=OrAtTu4aPmrTjKDSTzkSPgo_ji6NOMWO2N9JOTFyAzM,11350
8
+ hetzner_haystack-1.0.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.32.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2023-present deepset GmbH
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.